When above zero, the spring will bounce instead of overshooting when exceeding its goal value.
), }, 'number', null, ], [ { label: 'clamp', content: (When true, stops the spring once it overshoots its boundaries.
), }, 'boolean', 'false', ], [ { label: 'precision', content: (How close to the goal the animated value gets before we consider it to be "done", see precision pifalls for more information.
), }, 'number', '0.01', ], [ { label: 'round', content: (While animating, round to the nearest multiple of this number. The from and to values are never rounded, as well as any value passed to the set method of an animated value.
), }, 'boolean', null, ], [ { label: 'frequency', content: (
The natural frequency (in seconds), which dictates the number of
bounces per second when no damping exists. When defined,
tension is derived from this, and friction{' '}
is derived from tension and damping.
The damping ratio, which dictates how the spring slows down. Only works when frequency is defined.
), }, 'number', '1', ], ['velocity', 'number', '0'], [ { label: 'restVelocity', content: (The smallest velocity before the animation is considered to be "not moving". When undefined, precision is used instead.
), }, 'number', null, ], [ 'decay', { label: 'number | boolean', content: (
If true, default value is 0.998.
Switches to duration based animation. Value should be indicated in milliseconds.
), }, 'number', null, ], [ 'easing', { label: 'function', content:{`(t: number) => number`},
},
't => t',
],
[
{
label: 'progress',
content: (
Decides how far into the easing function to start from. The duration itself is unaffected.
), }, 'number', '0', ], ] export const easingData: CellData[][] = [ ['easeInBack', 'easeOutBack', 'easeInOutBack'], ['easeInBounce', 'easeOutBounce', 'easeOutBounce'], ['easeInCirc', 'easeOutCirc', 'easeOutCirc'], ['easeInCubic', 'easeOutCubic', 'easeOutCubic'], ['easeInElastic', 'easeOutElastic', 'easeOutElastic'], ['easeInExpo', 'easeOutExpo', 'easeOutExpo'], ['easeInQuad', 'easeOutQuad', 'easeOutQuad'], ['easeInQuart', 'easeOutQuart', 'easeOutQuart'], ['easeInQuint', 'easeOutQuint', 'easeOutQuint'], ['easeInSine', 'easeOutSine', 'easeOutSine'], ] const EVENTS_CELL: CellData[] = [ { label: 'events', content: (This is not a prop but rather a collection, see{' '} Events for more information.
), }, 'function', null, ] const REF_CELL: CellData[] = [ { label: 'ref', content: (
Used to access the imperative API. Animations never auto-start when{' '}
ref is defined.
The to prop, is very versatile, for more information checkout
out Async Animations.
{`(next: (props?: object) => Promise, cancel: () => void) => Promise`}
),
},
null,
],
[
'loop',
{
label: 'boolean | object | function',
content: {`() => boolean`},
},
null,
],
[
{
label: 'delay',
content: Delay in ms before the animation starts.
, }, { label: 'number | function', content:{`(key: string) => number`},
},
null,
],
[
{
label: 'immediate',
content: Prevents the animation if true.
, }, { label: 'boolean | function', content:{`(key: string) => boolean`},
},
null,
],
[
{
label: 'reset',
content: (
Resets the spring so it plays from the start again when true.
), }, 'boolean', null, ], [ { label: 'reverse', content: (
Reverse the to and from prop so that{' '}
to is the initial starting state.
Pause an animation at it's current point.
, }, 'boolean', null, ], [ 'cancel', { label: 'boolean | string | string[] | function', content:{`(key: string) => boolean`},
},
null,
],
REF_CELL,
[
{
label: 'config',
content: (
Spring config (mass / tension etc.), see{' '} Config for more information.
), }, { label: 'object | function', content:{`(key: string) => SpringConfig`},
},
{
label: 'object',
content: {`{ mass: 1, tension: 170, friction: 26 }`},
},
],
EVENTS_CELL,
]
export const USE_SCROLL_CONFIG_DATA: CellData[][] = [
['container', 'React.MutableRefObject{`(next: (props?: object) => Promise, cancel: () => void) => Promise`}
),
},
null,
],
[
'loop',
{
label: 'boolean | object | function',
content: {`() => boolean`},
},
null,
],
[
{
label: 'delay',
content: Delay in ms before the animation starts.
, }, { label: 'number | function', content:{`(key: string) => number`},
},
null,
],
[
{
label: 'immediate',
content: (
Prevents the animation if true, applying the `to` styles immediately.
), }, { label: 'boolean | function', content:{`(key: string) => boolean`},
},
null,
],
[
{
label: 'reset',
content: (
Resets the spring so it plays from the start again when true.
), }, 'boolean', null, ], [ { label: 'reverse', content: (
Reverse the to and from prop so that{' '}
to is the initial starting state.
Pause an animation at it's current point.
, }, 'boolean', null, ], [ 'cancel', { label: 'boolean | string | string[] | function', content:{`(key: string) => boolean`},
},
null,
],
[
{
label: 'config',
content: (
Spring config (mass / tension etc.), see{' '} Config for more information.
), }, { label: 'object | function', content:{`(key: string) => SpringConfig`},
},
{
label: 'object',
content: {`{ mass: 1, tension: 170, friction: 26 }`},
},
],
EVENTS_CELL,
]
export const TRANSITION_CONFIG_DATA: CellData[][] = [
[
'from',
{
label: 'object | function',
content: {`(item: Item, index: number) => object`},
},
null,
],
[
'initial',
{
label: 'object | function',
content: {`(item: Item, index: number) => object`},
},
null,
],
[
{
label: 'enter',
content: (
The enter prop is used to pass styles to the animation
when the transition is entering.
{`(item: Item, index: number) => object | object[] | (next: (props?: object) => Promise, cancel: () => void) => Promise`}
),
},
null,
],
[
{
label: 'update',
content: (
The update prop is used to pass styles to the animation
when the transition is updating.
{`(item: Item, index: number) => object | object[] | (next: (props?: object) => Promise, cancel: () => void) => Promise`}
),
},
null,
],
[
{
label: 'leave',
content: (
The leave prop is used to pass styles to the animation
when the transition is leaving.
{`(item: Item, index: number) => object | object[] | (next: (props?: object) => Promise, cancel: () => void) => Promise`}
),
},
null,
],
[
{
label: 'keys',
content: (
Keys are automatically created so this prop is typically not required
), }, { label: 'Array{`(item: Item) => string | number`},
},
null,
],
[
'sort',
{
label: 'function',
content: {`(a: Item, b: Item) => number`},
},
null,
],
['trail', 'number', '0'],
['exitBeforeEnter', 'boolean', 'false'],
[
{
label: 'expires',
content: (
<>
When true or {'<= 0'}, each item is
unmounted immediately after its `leave` animation is finished.
When false, items are never unmounted.
When {'> 0'}, this prop is used in a{' '}
setTimeout call that forces a rerender if the component
that called useTransition doesn't rerender on its own
after an item's leave animation is finished.
{`(item: Item) => boolean | number`},
},
'true',
],
REF_CELL,
[
{
label: 'config',
content: (
Spring config (mass / tension etc.), see{' '} Config for more information.
), }, { label: 'object | function', content: ({`(item: Item, index: number, state: TransitionPhase) => SpringConfig`}
),
},
{
label: 'object',
content: {`{ mass: 1, tension: 170, friction: 26 }`},
},
],
EVENTS_CELL,
]
export const SPRINGVALUE_PROPERTIES_DATA: CellData[][] = [
['animation', 'Animation', 'Animation'],
[
{
label: 'defaultProps',
content: Some props have customizable default values.
, }, 'SpringConfig', '{}', ], ['goal', 'any', null], [ { label: 'hasAnimated', content:When true, this value has been animated at least once.
, }, 'boolean', 'false', ], [ { label: 'idle', content:Equals true when not advancing on each frame.
, }, 'boolean', null, ], [ { label: 'isAnimating', content:When true, this value has been animated at least once.
, }, 'boolean', 'false', ], [ { label: 'isDelayed', content:When true the value has delay before it can animate.
, }, 'boolean', 'false', ], [ { label: 'isPaused', content:When true, all current and future animations are paused.
, }, 'boolean', 'false', ], [ { label: 'key', content: (The property name used when `to` or `from` is an object. Useful when debugging too.
), }, 'string | undefined', 'undefined', ], [ { label: 'queue', content:The queue of pending props
, }, 'SpringUpdate[]', '[]', ], ['velocity', 'number | number[]', null], ] export const CONTROLLER_PROPERTIES_DATA: CellData[][] = [ [ { label: 'idle', content: (
The animated values. This is what you pass to your{' '}
animated component.
The queue of props passed to the update method.
The injected ref. When defined, render-based updates are pushed onto
the queue instead of being auto-started.
The animated values. This is what you pass to your{' '}
animated component.
{`"identity" | "clamp" | "extend"`},
},
'extend',
],
[
'extrapolateRight',
{
label: 'string',
content: {`"identity" | "clamp" | "extend"`},
},
'extend',
],
[
'extrapolate',
{
label: 'string',
content: {`"identity" | "clamp" | "extend"`},
},
'extend',
],
[
{
label: 'range',
content: Array of input ranges
, }, 'number[]', '[0,1]', ], [ { label: 'output', content:Array of mapped output ranges
, }, 'number[]', null, ], [ { label: 'map', content:Value filter applied to input value
, }, { label: 'function', content:{`(value: number) => number`},
},
'null',
],
]
export const PARALLAX_CONFIG_DATA: CellData[][] = [
[
{
label: 'pages',
content: (
Determines the total space of the inner content where each page takes 100% of the visible container.
), }, 'number', null, ], [ { label: 'config', content: (Spring config (mass / tension etc.), see{' '} Config for more information.
), }, { label: 'object | function', content:{`(key: string) => SpringConfig`},
},
{
label: 'object',
content: {`{ mass: 1, tension: 280, friction: 60 }`},
},
],
['enabled', 'boolean', 'true'],
['horizontal', 'boolean', 'false'],
['innerStyle', 'CSSProperties', null],
]
export const PARALLAX_LAYER_CONFIG_DATA: CellData[][] = [
['horizontal', 'boolean', null],
[
{
label: 'factor',
content: Size of a page, (1=100%, 1.5=1 and 1/2, ...)
, }, 'number', '1', ], [ { label: 'offset', content: (Determines where the layer will be at when scrolled to (0=start, 1=1st page, ...)
), }, 'number', '0', ], [ { label: 'speed', content: (Shifts the layer in accordance to its offset, values can be positive or negative
), }, 'number', '0', ], [ { label: 'sticky', content: (Layer will be sticky between these two offsets, all other props are ignored
), }, { label: 'StickyConfig', content:{`{ start?: number; end?: number } | undefined`},
},
null,
],
]
export const USE_INVIEW_INTERSECTION_ARGS: CellData[][] = [
['amount', '"any" | "all" | number | number[]', 'any'],
['root', 'React.MutableRefObject', null],
['rootMargin', 'string', null],
['once', 'boolean', 'false'],
]