framer
Version:
The Framer library is the code that drives Framer projects and components. It helps you build from simple interactive components to whole apps.
1,628 lines • 487 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.1.5",
"schemaVersion": 1000
},
"kind": "Package",
"canonicalReference": "framer",
"docComment": "",
"name": "framer",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "",
"name": "",
"members": [
{
"kind": "Function",
"canonicalReference": "(addPropertyControls:0)",
"docComment": "/**\n * Extends component with property controls\n * ```typescript\n * export const MyComponent = props => <h1>{props.header}</h1>\n *\n * addPropertyControls(MyComponent, {\n * header: { type: ControlType.String, title: \"Header\" },\n * })\n *\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "addPropertyControls"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": " = any>("
},
{
"kind": "Reference",
"text": "component"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "ComponentType"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "propertyControls"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PropertyControls"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 21,
"endIndex": 22
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "component",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 13
}
},
{
"parameterName": "propertyControls",
"parameterTypeTokenRange": {
"startIndex": 16,
"endIndex": 20
}
}
],
"name": "addPropertyControls"
},
{
"kind": "Function",
"canonicalReference": "(Animatable:0)",
"docComment": "/**\n * Creates a Animatable object that can be animated. These objects can be passed into a {@link DeprecatedFrame} instead of a primitive like number and afterwards animated with {@link (animate:function)}.\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate(value, 100)\n * ```\n *\n * @deprecated\n *\n * Use {@link useMotionValue} instead\n *\n * @param value - Value to animate\n *\n * @returns Animatable value\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 18
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 13
}
}
],
"name": "Animatable"
},
{
"kind": "Interface",
"canonicalReference": "(Animatable:interface)",
"docComment": "/**\n * @deprecated\n *\n * Use {@link useMotionValue} instead\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> extends "
},
{
"kind": "Reference",
"text": "UpdateObserver"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"name": "Animatable",
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "(get:0)",
"docComment": "/**\n * Get the current value out of this Animatable object\n *\n * @remarks\n * ```jsx\n * const a = Animatable(0)\n * a.get() // returns 0\n * await animate(a, 42)\n * a.get() // returns 42\n * ```\n *\n * @returns Current value\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "get"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "get"
},
{
"kind": "MethodSignature",
"canonicalReference": "(set:0)",
"docComment": "/**\n * Set a new value to a animatable object\n *\n * @remarks\n *\n * The passed value can be an Animatable value too\n * ```jsx\n * const a = Animatable(0)\n * const b = Animatable(100)\n * a.set(42)\n * a.get() // returns 42\n * a.set(b)\n * a.get() // returns 100\n * ```\n *\n * @param value - New value to set to the animatable\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "set"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 10
}
}
],
"name": "set"
},
{
"kind": "MethodSignature",
"canonicalReference": "(set:1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "set"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "transaction"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "TransactionId"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 15,
"endIndex": 16
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 10
}
},
{
"parameterName": "transaction",
"parameterTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
}
}
],
"name": "set"
}
],
"extendsTokenRanges": [
{
"startIndex": 5,
"endIndex": 9
}
]
},
{
"kind": "Namespace",
"canonicalReference": "(Animatable:namespace)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Animatable",
"members": [
{
"kind": "Function",
"canonicalReference": "(getNumber:0)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "getNumber"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<number> | null | undefined"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "defaultValue"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 8
}
},
{
"parameterName": "defaultValue",
"parameterTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
}
}
],
"name": "getNumber"
}
]
},
{
"kind": "Function",
"canonicalReference": "(animate:0)",
"docComment": "/**\n * Animate an {@link (Animatable:interface)} value to a new value.\n *\n * @remarks\n *\n * Recommended use is to use convenience functions from the `animate` namespace instead of passing an animator. Only use this for low-level animation tweaking.\n * ```jsx\n * const value = Animatable(0)\n * animate(value, 100)\n *\n * const value = Animatable({x: 0, y: 0})\n * animate(value, {x: 100, y: 100})\n * ```\n *\n * @deprecated\n *\n * Use the {@link MotionProps.animate} prop on {@link Frame} instead.\n *\n * @param from - The animatable value or object to start from\n *\n * @param to - Value to animate to\n *\n * @param animator - Animator class to use.\n *\n * @param options - Animation options\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "animate"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Options"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "animator"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "AnimatorClass"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Options"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Options"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Options"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 42,
"endIndex": 48
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 17
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 20,
"endIndex": 21
}
},
{
"parameterName": "animator",
"parameterTypeTokenRange": {
"startIndex": 24,
"endIndex": 30
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 33,
"endIndex": 41
}
}
],
"name": "animate"
},
{
"kind": "Namespace",
"canonicalReference": "(animate:namespace)",
"docComment": "/**\n * @deprecated\n *\n * Use the {@link MotionProps.animate} prop on {@link Frame} instead.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace "
},
{
"kind": "Reference",
"text": "animate"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "animate",
"members": [
{
"kind": "Function",
"canonicalReference": "(bezier:0)",
"docComment": "/**\n * Animate value with a bezier curve\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.bezier(value, 100, {duration: 1, curve: Bezier.EaseIn})\n *\n * animate.bezier(value, 100, {duration: 1, curve: [0.3, 0.1, 0.4, 1]})\n * ```\n *\n * @deprecated\n *\n * Use {@link MotionProps.animate} on {@link Frame} instead.\n *\n * @param from - Value to animate\n *\n * @param to - Value to animate to\n *\n * @param options - Options for the bezier curve\n *\n * - `duration` Duration of the animation - `curve` One of the `Bezier` enum values or an array with 4 control points\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "bezier"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "BezierOptions"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "BezierOptions"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 31,
"endIndex": 37
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 15
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 22,
"endIndex": 30
}
}
],
"name": "bezier"
},
{
"kind": "Function",
"canonicalReference": "(ease:0)",
"docComment": "/**\n * Animate value with a ease animation\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.ease(value, 100)\n *\n * animate.ease(value, 100, {duration: 1})\n * ```\n *\n * @deprecated\n *\n * Use {@link MotionProps.animate} on {@link Frame} instead.\n *\n * @param from - Value to animate\n *\n * @param to - Value to animate to\n *\n * @param options - The options for the animation\n *\n * - `duration` - Duration of the animation\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "ease"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "BezierOptions"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 31,
"endIndex": 37
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 15
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 22,
"endIndex": 30
}
}
],
"name": "ease"
},
{
"kind": "Function",
"canonicalReference": "(easeIn:0)",
"docComment": "/**\n * Animate value with a ease in animation\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.easeIn(value, 100)\n *\n * animate.easeIn(value, 100, {duration: 1})\n * ```\n *\n * @deprecated\n *\n * Use {@link MotionProps.animate} on {@link Frame} instead.\n *\n * @param from - Value to animate\n *\n * @param to - Value to animate to\n *\n * @param options - The options for the animation\n *\n * - `duration` - Duration of the animation\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "easeIn"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "BezierOptions"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 31,
"endIndex": 37
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 15
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 22,
"endIndex": 30
}
}
],
"name": "easeIn"
},
{
"kind": "Function",
"canonicalReference": "(easeInOut:0)",
"docComment": "/**\n * Animate value with a ease in out animation\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.easeInOut(value, 100)\n *\n * animate.easeInOut(value, 100, {duration: 1})\n * ```\n *\n * @deprecated\n *\n * Use {@link MotionProps.animate} on {@link Frame} instead.\n *\n * @param from - Value to animate\n *\n * @param to - Value to animate to\n *\n * @param options - The options for the animation\n *\n * - `duration` - Duration of the animation\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "easeInOut"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "BezierOptions"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 31,
"endIndex": 37
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 15
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 22,
"endIndex": 30
}
}
],
"name": "easeInOut"
},
{
"kind": "Function",
"canonicalReference": "(easeOut:0)",
"docComment": "/**\n * Animate value with a ease out animation\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.easeOut(value, 100)\n *\n * animate.easeOUt(value, 100, {duration: 1})\n * ```\n *\n * @deprecated\n *\n * Use {@link MotionProps.animate} on {@link Frame} instead.\n