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,475 lines (1,474 loc) • 657 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.7.8",
"schemaVersion": 1003,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "framer!",
"docComment": "",
"name": "framer",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "framer!",
"name": "",
"members": [
{
"kind": "Function",
"canonicalReference": "framer!addPropertyControls:function(1)",
"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 addPropertyControls<Props = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ">(component: "
},
{
"kind": "Reference",
"text": "React.ComponentType",
"canonicalReference": "@types/react!~React.ComponentType:type"
},
{
"kind": "Content",
"text": "<Props>"
},
{
"kind": "Content",
"text": ", propertyControls: "
},
{
"kind": "Reference",
"text": "PropertyControls",
"canonicalReference": "framer!PropertyControls:type"
},
{
"kind": "Content",
"text": "<Props>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "component",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
}
},
{
"parameterName": "propertyControls",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
}
}
],
"typeParameters": [
{
"typeParameterName": "Props",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "addPropertyControls"
},
{
"kind": "Function",
"canonicalReference": "framer!Animatable:function(1)",
"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 Animatable<Value>(value: "
},
{
"kind": "Content",
"text": "Value | "
},
{
"kind": "Reference",
"text": "Animatable",
"canonicalReference": "framer!Animatable:interface"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Animatable",
"canonicalReference": "framer!Animatable:interface"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "Animatable"
},
{
"kind": "Interface",
"canonicalReference": "framer!Animatable:interface",
"docComment": "/**\n * @deprecated\n *\n * Use {@link useMotionValue} instead\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Animatable<Value> extends "
},
{
"kind": "Reference",
"text": "UpdateObserver",
"canonicalReference": "framer!UpdateObserver:interface"
},
{
"kind": "Content",
"text": "<Value> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "Animatable",
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "framer!Animatable#get:member(1)",
"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": "Content",
"text": "get(): "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "get"
},
{
"kind": "MethodSignature",
"canonicalReference": "framer!Animatable#set:member(1)",
"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": "Content",
"text": "set(value: "
},
{
"kind": "Content",
"text": "Value | "
},
{
"kind": "Reference",
"text": "Animatable",
"canonicalReference": "framer!Animatable:interface"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
}
],
"name": "set"
},
{
"kind": "MethodSignature",
"canonicalReference": "framer!Animatable#set:member(2)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "set(value: "
},
{
"kind": "Content",
"text": "Value | "
},
{
"kind": "Reference",
"text": "Animatable",
"canonicalReference": "framer!Animatable:interface"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": ", transaction?: "
},
{
"kind": "Reference",
"text": "TransactionId",
"canonicalReference": "framer!TransactionId:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"parameterName": "transaction",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "set"
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
}
]
},
{
"kind": "Namespace",
"canonicalReference": "framer!Animatable:namespace",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace Animatable "
}
],
"releaseTag": "Public",
"name": "Animatable",
"members": [
{
"kind": "Function",
"canonicalReference": "framer!Animatable.getNumber:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function getNumber(value: "
},
{
"kind": "Content",
"text": "number | "
},
{
"kind": "Reference",
"text": "Animatable",
"canonicalReference": "framer!Animatable:interface"
},
{
"kind": "Content",
"text": "<number> | null | undefined"
},
{
"kind": "Content",
"text": ", defaultValue?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"parameterName": "defaultValue",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "getNumber"
}
]
},
{
"kind": "TypeAlias",
"canonicalReference": "framer!AnimatableObject:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type AnimatableObject<T> = "
},
{
"kind": "Content",
"text": "{\n [K in keyof T]: "
},
{
"kind": "Reference",
"text": "ToAnimatableOrValue",
"canonicalReference": "framer!ToAnimatableOrValue:type"
},
{
"kind": "Content",
"text": "<T[K]>;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "AnimatableObject",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "Function",
"canonicalReference": "framer!animate:function(1)",
"docComment": "/**\n * Animate a single value or a `MotionValue`.\n *\n * The first argument is either a `MotionValue` to animate, or an initial animation value.\n *\n * The second is either a value to animate to, or an array of keyframes to animate through.\n *\n * The third argument can be either tween or spring options, and optional lifecycle methods: `onUpdate`, `onPlay`, `onComplete`, `onRepeat` and `onStop`.\n *\n * Returns `PlaybackControls`, currently just a `stop` method.\n * ```javascript\n * const x = useMotionValue(0)\n *\n * useEffect(() => {\n * const controls = animate(x, 100, {\n * type: \"spring\",\n * stiffness: 2000,\n * onComplete: v => {}\n * })\n *\n * return controls.stop\n * })\n * ```\n *\n * @deprecated\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function animate<Value, Options>(from: "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationTarget",
"canonicalReference": "framer!DeprecatedAnimationTarget:type"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": ", to: "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ", animator?: "
},
{
"kind": "Reference",
"text": "AnimatorClass",
"canonicalReference": "framer!AnimatorClass:interface"
},
{
"kind": "Content",
"text": "<Value, Options>"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<Options & "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationOptions",
"canonicalReference": "framer!DeprecatedAnimationOptions:interface"
},
{
"kind": "Content",
"text": "<Value>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation",
"canonicalReference": "framer!FramerAnimation:class"
},
{
"kind": "Content",
"text": "<Value, Options>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 16
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "animator",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 13
}
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Options",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "animate"
},
{
"kind": "Function",
"canonicalReference": "framer!animate:function(2)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function animate<V>(from: "
},
{
"kind": "Reference",
"text": "MotionValue",
"canonicalReference": "framer-motion!MotionValue:class"
},
{
"kind": "Content",
"text": "<V> | V"
},
{
"kind": "Content",
"text": ", to: "
},
{
"kind": "Content",
"text": "V | V[]"
},
{
"kind": "Content",
"text": ", transition?: "
},
{
"kind": "Reference",
"text": "AnimationOptions",
"canonicalReference": "framer!~AnimationOptions:type"
},
{
"kind": "Content",
"text": "<V>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "PlaybackControls",
"canonicalReference": "framer!~PlaybackControls:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "transition",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
}
}
],
"typeParameters": [
{
"typeParameterName": "V",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "animate"
},
{
"kind": "Namespace",
"canonicalReference": "framer!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 animate "
}
],
"releaseTag": "Public",
"name": "animate",
"members": [
{
"kind": "Function",
"canonicalReference": "framer!animate.bezier:function(1)",
"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 bezier<Value>(from: "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationTarget",
"canonicalReference": "framer!DeprecatedAnimationTarget:type"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": ", to: "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "BezierOptions",
"canonicalReference": "framer!BezierOptions:interface"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationOptions",
"canonicalReference": "framer!DeprecatedAnimationOptions:interface"
},
{
"kind": "Content",
"text": "<Value>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation",
"canonicalReference": "framer!FramerAnimation:class"
},
{
"kind": "Content",
"text": "<Value, "
},
{
"kind": "Reference",
"text": "BezierOptions",
"canonicalReference": "framer!BezierOptions:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 17
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 12
}
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "bezier"
},
{
"kind": "Function",
"canonicalReference": "framer!animate.ease:function(1)",
"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 ease<Value>(from: "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationTarget",
"canonicalReference": "framer!DeprecatedAnimationTarget:type"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": ", to: "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions",
"canonicalReference": "framer!EaseOptions:type"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationOptions",
"canonicalReference": "framer!DeprecatedAnimationOptions:interface"
},
{
"kind": "Content",
"text": "<Value>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation",
"canonicalReference": "framer!FramerAnimation:class"
},
{
"kind": "Content",
"text": "<Value, "
},
{
"kind": "Reference",
"text": "BezierOptions",
"canonicalReference": "framer!BezierOptions:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 17
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 12
}
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "ease"
},
{
"kind": "Function",
"canonicalReference": "framer!animate.easeIn:function(1)",
"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 easeIn<Value>(from: "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationTarget",
"canonicalReference": "framer!DeprecatedAnimationTarget:type"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": ", to: "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions",
"canonicalReference": "framer!EaseOptions:type"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationOptions",
"canonicalReference": "framer!DeprecatedAnimationOptions:interface"
},
{
"kind": "Content",
"text": "<Value>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation",
"canonicalReference": "framer!FramerAnimation:class"
},
{
"kind": "Content",
"text": "<Value, "
},
{
"kind": "Reference",
"text": "BezierOptions",
"canonicalReference": "framer!BezierOptions:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 17
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 12
}
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "easeIn"
},
{
"kind": "Function",
"canonicalReference": "framer!animate.easeInOut:function(1)",
"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 easeInOut<Value>(from: "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationTarget",
"canonicalReference": "framer!DeprecatedAnimationTarget:type"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": ", to: "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions",
"canonicalReference": "framer!EaseOptions:type"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationOptions",
"canonicalReference": "framer!DeprecatedAnimationOptions:interface"
},
{
"kind": "Content",
"text": "<Value>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation",
"canonicalReference": "framer!FramerAnimation:class"
},
{
"kind": "Content",
"text": "<Value, "
},
{
"kind": "Reference",
"text": "BezierOptions",
"canonicalReference": "framer!BezierOptions:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 17
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 12
}
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "easeInOut"
},
{
"kind": "Function",
"canonicalReference": "framer!animate.easeOut:function(1)",
"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 *\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 easeOut<Value>(from: "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationTarget",
"canonicalReference": "framer!DeprecatedAnimationTarget:type"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": ", to: "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions",
"canonicalReference": "framer!EaseOptions:type"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationOptions",
"canonicalReference": "framer!DeprecatedAnimationOptions:interface"
},
{
"kind": "Content",
"text": "<Value>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation",
"canonicalReference": "framer!FramerAnimation:class"
},
{
"kind": "Content",
"text": "<Value, "
},
{
"kind": "Reference",
"text": "BezierOptions",
"canonicalReference": "framer!BezierOptions:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 17
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 12
}
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "easeOut"
},
{
"kind": "Function",
"canonicalReference": "framer!animate.linear:function(1)",
"docComment": "/**\n * Animate value with a linear animation\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.linear(value, 100)\n *\n * animate.linear(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 linear<Value>(from: "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationTarget",
"canonicalReference": "framer!DeprecatedAnimationTarget:type"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": ", to: "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions",
"canonicalReference": "framer!EaseOptions:type"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "DeprecatedAnimationOptions",
"canonicalReference": "framer!DeprecatedAnimationOptions:interface"
},
{
"kind": "Content",
"text": "<Value>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation",
"canonicalReference": "framer!FramerAnimation:class"
},
{
"kind": "Content",
"text": "<Value, "
},
{
"kind": "Reference",
"text": "BezierOptions",
"canonicalReference": "framer!BezierOptions:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 17
},