Skip to content

Commit

Permalink
docs: Example live prices animate on transition
Browse files Browse the repository at this point in the history
  • Loading branch information
ntucker committed Oct 19, 2024
1 parent 61fc4f3 commit 439f0f6
Show file tree
Hide file tree
Showing 14 changed files with 161 additions and 189 deletions.
7 changes: 5 additions & 2 deletions docs/core/shared/_useLive.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import HooksPlayground from '@site/src/components/HooksPlayground';

<HooksPlayground row>
<HooksPlayground row defaultTab={props.defaultTab}>

```typescript title="Ticker" {32} collapsed
import { Entity, RestEndpoint } from '@data-client/rest';
Expand Down Expand Up @@ -47,7 +47,10 @@ function AssetPrice({ productId }: Props) {
return (
<center>
{productId}{' '}
<Formatted value={ticker.price} formatter="currency" />
<NumberFlow
value={ticker.price}
format={{ style: 'currency', currency: 'USD' }}
/>
</center>
);
}
Expand Down
5 changes: 4 additions & 1 deletion docs/rest/guides/network-transform.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,10 @@ function AssetPrice({ productId }: Props) {
return (
<center>
{productId}{' '}
<Formatted value={ticker.price} formatter="currency" />
<NumberFlow
value={ticker.price}
format={{ style: 'currency', currency: 'USD' }}
/>
</center>
);
}
Expand Down
9 changes: 6 additions & 3 deletions examples/nextjs/components/AssetPrice.tsx
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
'use client';
import { useLive } from '@data-client/react';
import NumberFlow from '@number-flow/react';

import { getTicker } from '@/resources/Ticker';

import { Formatted } from './Formatted';

export default function AssetPrice({ symbol }: Props) {
const product_id = `${symbol}-USD`;
// Learn more about Reactive Data Client: https://dataclient.io/docs
const ticker = useLive(getTicker, { product_id });
return (
<span>
{symbol} <Formatted value={ticker.price} formatter="currency" />
{symbol}{' '}
<NumberFlow
value={ticker.price}
format={{ style: 'currency', currency: 'USD' }}
/>
</span>
);
}
Expand Down
133 changes: 0 additions & 133 deletions examples/nextjs/components/Formatted.tsx

This file was deleted.

44 changes: 0 additions & 44 deletions examples/nextjs/components/formatters/index.ts

This file was deleted.

27 changes: 27 additions & 0 deletions examples/nextjs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions examples/nextjs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"@babel/core": "^7.24.7",
"@data-client/react": "^0.14.0",
"@data-client/rest": "^0.14.0",
"@number-flow/react": "^0.2.1",
"@types/node": "22.7.7",
"@types/react": "npm:types-react@rc",
"@types/react-dom": "npm:types-react-dom@rc",
Expand Down
1 change: 1 addition & 0 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
"@docusaurus/theme-mermaid": "^3.0.1",
"@js-temporal/polyfill": "^0.4.4",
"@monaco-editor/react": "^4.4.6",
"@number-flow/react": "^0.2.1",
"bignumber.js": "9.1.2",
"clsx": "2.1.1",
"monaco-editor": "^0.52.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ export default function AssetPrice({ symbol }: { symbol: string }) {
<tr>
<th>{symbol}</th>
<td>
<Formatted value={ticker.price} formatter="currency" />
<NumberFlow
value={ticker.price}
format={{ style: 'currency', currency: 'USD' }}
/>
</td>
</tr>
);
Expand Down
1 change: 1 addition & 0 deletions website/src/components/Playground/DesignSystem/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ export { TextInput } from './TextInput';
export { TextArea } from './TextArea';
export { SearchIcon } from './SearchIcon';
export { Loading } from './Loading';
export { default as NumberFlow } from '@number-flow/react';
1 change: 0 additions & 1 deletion website/src/components/Playground/PreviewWithScope.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import * as rest from '@data-client/rest';
import type { Fixture, Interceptor } from '@data-client/test';
import { Temporal, Intl as PolyIntl } from '@js-temporal/polyfill';
import BigNumber from 'bignumber.js';
import React from 'react';
import { LiveProvider } from 'react-live';
import { v4 as uuid } from 'uuid';

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
import { NumberFlowLite, Value, Format } from 'number-flow';
import * as React from 'react';
export { Format, Trend, Value } from 'number-flow';

declare const OBSERVED_ATTRIBUTES: readonly ['parts'];
type ObservedAttribute = (typeof OBSERVED_ATTRIBUTES)[number];
declare class NumberFlowElement extends NumberFlowLite {
static observedAttributes: readonly ['parts'];
attributeChangedCallback(
attr: ObservedAttribute,
_oldValue: string,
newValue: string,
): void;
}
type NumberFlowProps = React.HTMLAttributes<NumberFlowElement> & {
value: Value;
locales?: Intl.LocalesArgument;
format?: Format;
isolate?: boolean;
animated?: boolean;
respectMotionPreference?: boolean;
willChange?: boolean;
onAnimationsStart?: () => void;
onAnimationsFinish?: () => void;
trend?: (typeof NumberFlowElement)['prototype']['trend'];
opacityTiming?: (typeof NumberFlowElement)['prototype']['opacityTiming'];
transformTiming?: (typeof NumberFlowElement)['prototype']['transformTiming'];
spinTiming?: (typeof NumberFlowElement)['prototype']['spinTiming'];
};
declare const NumberFlow: (
options: React.HTMLAttributes<NumberFlowElement> & {
value: Value;
locales?: Intl.LocalesArgument;
format?: Format;
isolate?: boolean;
animated?: boolean;
respectMotionPreference?: boolean;
willChange?: boolean;
onAnimationsStart?: () => void;
onAnimationsFinish?: () => void;
trend?: (typeof NumberFlowElement)['prototype']['trend'];
opacityTiming?: (typeof NumberFlowElement)['prototype']['opacityTiming'];
transformTiming?: (typeof NumberFlowElement)['prototype']['transformTiming'];
spinTiming?: (typeof NumberFlowElement)['prototype']['spinTiming'];
} & React.RefAttributes<NumberFlowElement>,
) => JSX.Element;

declare function useCanAnimate({
respectMotionPreference,
}?: {
respectMotionPreference?: boolean | undefined;
}): boolean;

export {
NumberFlowElement,
type NumberFlowProps,
NumberFlow as default,
useCanAnimate,
};
Loading

0 comments on commit 439f0f6

Please sign in to comment.