{ "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 =>

{props.header}

\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(component: " }, { "kind": "Reference", "text": "React.ComponentType", "canonicalReference": "@types/react!~React.ComponentType:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ", propertyControls: " }, { "kind": "Reference", "text": "PropertyControls", "canonicalReference": "framer!PropertyControls:type" }, { "kind": "Content", "text": "" }, { "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: " }, { "kind": "Content", "text": "Value | " }, { "kind": "Reference", "text": "Animatable", "canonicalReference": "framer!Animatable:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Animatable", "canonicalReference": "framer!Animatable:interface" }, { "kind": "Content", "text": "" }, { "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 extends " }, { "kind": "Reference", "text": "UpdateObserver", "canonicalReference": "framer!UpdateObserver:interface" }, { "kind": "Content", "text": " " } ], "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": "" }, { "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": "" }, { "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": " | 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 = " }, { "kind": "Content", "text": "{\n [K in keyof T]: " }, { "kind": "Reference", "text": "ToAnimatableOrValue", "canonicalReference": "framer!ToAnimatableOrValue:type" }, { "kind": "Content", "text": ";\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(from: " }, { "kind": "Reference", "text": "DeprecatedAnimationTarget", "canonicalReference": "framer!DeprecatedAnimationTarget:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ", to: " }, { "kind": "Content", "text": "Value" }, { "kind": "Content", "text": ", animator?: " }, { "kind": "Reference", "text": "AnimatorClass", "canonicalReference": "framer!AnimatorClass:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "FramerAnimation", "canonicalReference": "framer!FramerAnimation:class" }, { "kind": "Content", "text": "" }, { "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(from: " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": " | 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": "" }, { "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(from: " }, { "kind": "Reference", "text": "DeprecatedAnimationTarget", "canonicalReference": "framer!DeprecatedAnimationTarget:type" }, { "kind": "Content", "text": "" }, { "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": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "FramerAnimation", "canonicalReference": "framer!FramerAnimation:class" }, { "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(from: " }, { "kind": "Reference", "text": "DeprecatedAnimationTarget", "canonicalReference": "framer!DeprecatedAnimationTarget:type" }, { "kind": "Content", "text": "" }, { "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": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "FramerAnimation", "canonicalReference": "framer!FramerAnimation:class" }, { "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(from: " }, { "kind": "Reference", "text": "DeprecatedAnimationTarget", "canonicalReference": "framer!DeprecatedAnimationTarget:type" }, { "kind": "Content", "text": "" }, { "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": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "FramerAnimation", "canonicalReference": "framer!FramerAnimation:class" }, { "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(from: " }, { "kind": "Reference", "text": "DeprecatedAnimationTarget", "canonicalReference": "framer!DeprecatedAnimationTarget:type" }, { "kind": "Content", "text": "" }, { "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": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "FramerAnimation", "canonicalReference": "framer!FramerAnimation:class" }, { "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(from: " }, { "kind": "Reference", "text": "DeprecatedAnimationTarget", "canonicalReference": "framer!DeprecatedAnimationTarget:type" }, { "kind": "Content", "text": "" }, { "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": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "FramerAnimation", "canonicalReference": "framer!FramerAnimation:class" }, { "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(from: " }, { "kind": "Reference", "text": "DeprecatedAnimationTarget", "canonicalReference": "framer!DeprecatedAnimationTarget:type" }, { "kind": "Content", "text": "" }, { "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": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "FramerAnimation", "canonicalReference": "framer!FramerAnimation:class" }, { "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": "linear" }, { "kind": "Function", "canonicalReference": "framer!animate.spring:function(1)", "docComment": "/**\n * Animate value with a spring curve\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.spring(value, 100, {tension: 100, friction: 100})\n *\n * animate.spring(value, 100, {dampingRatio: 0.5, 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 - Options for the spring These can be either `tension`, `friction`, `velocity` and `tolerance` _or_ `dampingRatio`, `duration`, `velocity` and `mass`\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function spring(from: " }, { "kind": "Reference", "text": "DeprecatedAnimationTarget", "canonicalReference": "framer!DeprecatedAnimationTarget:type" }, { "kind": "Content", "text": "" }, { "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": "SpringOptions", "canonicalReference": "framer!SpringOptions:type" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "DeprecatedAnimationOptions", "canonicalReference": "framer!DeprecatedAnimationOptions:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "FramerAnimation", "canonicalReference": "framer!FramerAnimation:class" }, { "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": "spring" } ] }, { "kind": "Interface", "canonicalReference": "framer!ArrayControlDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ArrayControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "ArrayControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!ArrayControlDescription#control:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "control: " }, { "kind": "Reference", "text": "ArrayItemControlDescription", "canonicalReference": "framer!ArrayItemControlDescription:type" }, { "kind": "Content", "text": "

" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "control", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ArrayControlDescription#defaultValue:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "defaultValue?: " }, { "kind": "Content", "text": "any[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ArrayControlDescription#maxCount:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "maxCount?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "maxCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ArrayControlDescription#propertyControl:member", "docComment": "/**\n * @deprecated: This property has been renamed to control.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "propertyControl?: " }, { "kind": "Reference", "text": "ArrayItemControlDescription", "canonicalReference": "framer!ArrayItemControlDescription:type" }, { "kind": "Content", "text": "

" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "propertyControl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ArrayControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.Array", "canonicalReference": "framer!ControlType.Array:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "TypeAlias", "canonicalReference": "framer!ArrayItemControlDescription:type", "docComment": "/**\n * Array sub type\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type ArrayItemControlDescription

= " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "NumberControlDescription", "canonicalReference": "framer!NumberControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EnumControlDescription", "canonicalReference": "framer!EnumControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BooleanControlDescription", "canonicalReference": "framer!BooleanControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "StringControlDescription", "canonicalReference": "framer!StringControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorControlDescription", "canonicalReference": "framer!ColorControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FusedNumberControlDescription", "canonicalReference": "framer!FusedNumberControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SegmentedEnumControlDescription", "canonicalReference": "framer!SegmentedEnumControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ImageControlDescription", "canonicalReference": "framer!ImageControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileControlDescription", "canonicalReference": "framer!FileControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ComponentInstanceDescription", "canonicalReference": "framer!ComponentInstanceDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TransitionControlDescription", "canonicalReference": "framer!TransitionControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ObjectControlDescription", "canonicalReference": "framer!ObjectControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ArrayItemControlDescription", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 51 } }, { "kind": "Function", "canonicalReference": "framer!AutomaticLayoutIds:function(1)", "docComment": "/**\n * Enable or disable the automatic generation of layout ids for canvas layers. By default layout ids are generated for all layers created on the Framer canvas. However, layout ids are not generated for any layer that is a descendant of a code component. Sometimes you will want to enable layout id generation for descendants of your code components when they use children, slots, or import design components, and you want those layers to animate with magic motion transitions.\n *\n * You can enable that behavior by wrapping your code component like this\n * ```typescript\n * \n * \n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function AutomaticLayoutIds({ enabled, ...props }: " }, { "kind": "Reference", "text": "React.PropsWithChildren", "canonicalReference": "@types/react!~React.PropsWithChildren:type" }, { "kind": "Content", "text": "<{\n enabled?: boolean;\n}>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "JSX.Element", "canonicalReference": "@types/react!~__global.JSX.Element:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "{ enabled, ...props }", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "name": "AutomaticLayoutIds" }, { "kind": "TypeAlias", "canonicalReference": "framer!Background:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type Background = " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Gradient", "canonicalReference": "framer!~Gradient:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "BackgroundImage", "canonicalReference": "framer!~BackgroundImage:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Background", "typeTokenRange": { "startIndex": 1, "endIndex": 9 } }, { "kind": "Interface", "canonicalReference": "framer!BackgroundFilterProperties:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BackgroundFilterProperties " } ], "releaseTag": "Public", "name": "BackgroundFilterProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!BackgroundFilterProperties#backgroundBlur:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "backgroundBlur: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "backgroundBlur", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!BackgroundImage:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interface BackgroundImage " } ], "releaseTag": "Public", "name": "BackgroundImage", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!BackgroundImage#fit:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "fit?: " }, { "kind": "Reference", "text": "ImageFit", "canonicalReference": "framer!ImageFit:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BackgroundImage#intrinsicHeight:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "intrinsicHeight?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "intrinsicHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BackgroundImage#intrinsicWidth:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "intrinsicWidth?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "intrinsicWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BackgroundImage#pixelHeight:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "pixelHeight?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "pixelHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BackgroundImage#pixelWidth:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "pixelWidth?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "pixelWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BackgroundImage#src:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "src: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "src", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Namespace", "canonicalReference": "framer!BackgroundImage:namespace", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "declare namespace BackgroundImage " } ], "releaseTag": "Public", "name": "BackgroundImage", "members": [ { "kind": "Variable", "canonicalReference": "framer!BackgroundImage.isImageObject:var", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "isImageObject: " }, { "kind": "Content", "text": "(image: any) => " }, { "kind": "Reference", "text": "image", "canonicalReference": "framer!~image" }, { "kind": "Content", "text": " is object & " }, { "kind": "Reference", "text": "BackgroundImage", "canonicalReference": "framer!~BackgroundImage:interface" } ], "releaseTag": "Public", "name": "isImageObject", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ] }, { "kind": "Interface", "canonicalReference": "framer!BackgroundProperties:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BackgroundProperties " } ], "releaseTag": "Public", "name": "BackgroundProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!BackgroundProperties#background:member", "docComment": "/**\n * Set the background of a `Frame`. Supports color strings, color objects and images by using `src`. Set to a semi-transparent blue color by default. This will override the values set by the `image` property. To use a color and a image, use `backgroundColor` instead\n * ```jsx\n * \n * \n * \n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "background: " }, { "kind": "Reference", "text": "Background", "canonicalReference": "framer!Background:type" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "background", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BackgroundProperties#backgroundColor:member", "docComment": "/**\n * Set the background color of a `Frame`. Supports color strings and objects. Use this property to set a background color alongside the `image` property.\n * ```jsx\n * \n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backgroundColor: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "backgroundColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BackgroundProperties#image:member", "docComment": "/**\n * Sets a background image of a `Frame`. Will wrap the passed value in a `url('')` if needed.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "image: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "image", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!BaseControlDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BaseControlDescription

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "BaseControlDescription", "members": [ { "kind": "MethodSignature", "canonicalReference": "framer!BaseControlDescription#hidden:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "hidden?(props: " }, { "kind": "Content", "text": "P" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "props", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "hidden" }, { "kind": "PropertySignature", "canonicalReference": "framer!BaseControlDescription#title:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "title?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!BaseFrameProps:interface", "docComment": "/**\n * @remarks\n *\n * do no use separately from FrameProps\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BaseFrameProps " } ], "releaseTag": "Public", "name": "BaseFrameProps", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!BaseFrameProps#name:member", "docComment": "/**\n * Add a name to the Frame. This property does not change the behaviour of a Frame, but makes it easier to identify it in your code.\n *\n * @remarks\n *\n * The name will be rendered in the `data-framer-name` attribute of the outputted div, so the Frame is recognizable in the HTML DOM too.\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "framer!BlendingMode:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type BlendingMode = " }, { "kind": "Content", "text": "\"normal\" | \"multiply\" | \"screen\" | \"overlay\" | \"darken\" | \"lighten\" | \"color-dodge\" | \"color-burn\" | \"hard-light\" | \"soft-light\" | \"difference\" | \"exclusion\" | \"hue\" | \"saturation\" | \"color\" | \"luminosity\"" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "BlendingMode", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "framer!BlendingProperties:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BlendingProperties " } ], "releaseTag": "Public", "name": "BlendingProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!BlendingProperties#blendingMode:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "blendingMode: " }, { "kind": "Reference", "text": "BlendingMode", "canonicalReference": "framer!BlendingMode:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "blendingMode", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!BooleanControlDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BooleanControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "BooleanControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!BooleanControlDescription#defaultValue:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "defaultValue?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BooleanControlDescription#disabledTitle:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "disabledTitle?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "disabledTitle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BooleanControlDescription#enabledTitle:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "enabledTitle?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "enabledTitle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BooleanControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.Boolean", "canonicalReference": "framer!ControlType.Boolean:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "TypeAlias", "canonicalReference": "framer!BorderStyle:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type BorderStyle = " }, { "kind": "Content", "text": "\"solid\" | \"dashed\" | \"dotted\" | \"double\"" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "BorderStyle", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "framer!BoxShadow:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BoxShadow " } ], "releaseTag": "Public", "name": "BoxShadow", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!BoxShadow#blur:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "blur: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "blur", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BoxShadow#color:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BoxShadow#inset:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "inset: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "inset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BoxShadow#spread:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "spread: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "spread", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BoxShadow#x:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!BoxShadow#y:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Namespace", "canonicalReference": "framer!BoxShadow:namespace", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare namespace BoxShadow " } ], "releaseTag": "Public", "name": "BoxShadow", "members": [ { "kind": "Function", "canonicalReference": "framer!BoxShadow.is:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function is(shadow: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "shadow", "canonicalReference": "framer!~shadow" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "BoxShadow", "canonicalReference": "framer!BoxShadow:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "shadow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "is" }, { "kind": "Function", "canonicalReference": "framer!BoxShadow.toCSS:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function toCSS(shadow: " }, { "kind": "Reference", "text": "BoxShadow", "canonicalReference": "framer!BoxShadow:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "shadow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toCSS" } ] }, { "kind": "Interface", "canonicalReference": "framer!BoxShadowProperties:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface BoxShadowProperties " } ], "releaseTag": "Public", "name": "BoxShadowProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!BoxShadowProperties#shadows:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "shadows: " }, { "kind": "Reference", "text": "Readonly", "canonicalReference": "!Readonly:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BoxShadow", "canonicalReference": "framer!BoxShadow:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "shadows", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "framer!callEach:var", "docComment": "/**\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "callEach: " }, { "kind": "Content", "text": "(...fns: (" }, { "kind": "Reference", "text": "Function", "canonicalReference": "!Function:interface" }, { "kind": "Content", "text": " | undefined)[]) => void" } ], "releaseTag": "Beta", "name": "callEach", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "framer!Cancel:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type Cancel = " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Cancel", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Function", "canonicalReference": "framer!Color:function(1)", "docComment": "/**\n * The Color function can be used to define colors, either as a string value or as an object. All colors are converted to a Color object with `r, g, b`, `h, s, l` and an `a` value. There are also various helpers on the Color function for working with, modifying and detecting colors.\n * ```jsx\n * // HEX\n * const blue = Color(\"#0099FF\")\n *\n * // RGB\n * const blue = Color(\"rgb(0, 153, 255)\")\n * const blue = Color(0, 153, 255)\n * const blue = Color({r: 0, g: 153, b: 255})\n * const blue = Color({r: 0, g: 153, b: 255, a: 1})\n *\n * // HSL\n * const blue = Color(\"hsl(204, 100%, 50%)\")\n * const blue = Color({h: 204, s: 1, l: 0.5})\n * const blue = Color({h: 204, s: 1, l: 0.5, a: 1})\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "declare function Color(color: " }, { "kind": "Reference", "text": "IncomingColor", "canonicalReference": "framer!IncomingColor:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ", r?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", g?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", b?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 12, "endIndex": 13 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "parameterName": "r", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 } }, { "parameterName": "g", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "b", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "name": "Color" }, { "kind": "Interface", "canonicalReference": "framer!Color:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interface Color " } ], "releaseTag": "Public", "name": "Color", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!Color#a:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "a: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "a", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Color#b:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "b: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "b", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Color#format:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "format: " }, { "kind": "Reference", "text": "ColorFormat", "canonicalReference": "framer!ColorFormat:enum" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "format", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Color#g:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "g: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "g", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Color#h:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "h: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "h", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Color#initialValue:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "initialValue?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "initialValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Color#isValid:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "isValid?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "isValid", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Color#l:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "l: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "l", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Color#mix:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "mix: " }, { "kind": "Reference", "text": "Mixer", "canonicalReference": "framer!~Mixer:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "MixerStateful", "canonicalReference": "framer!~MixerStateful:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "mix", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Color#r:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "r: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "r", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Color#roundA:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "roundA: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "roundA", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Color#s:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "s: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "s", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Color#toValue:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "toValue: " }, { "kind": "Content", "text": "() => string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "toValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Namespace", "canonicalReference": "framer!Color:namespace", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "declare namespace Color " } ], "releaseTag": "Public", "name": "Color", "members": [ { "kind": "Function", "canonicalReference": "framer!Color.alpha:function(1)", "docComment": "/**\n * Set the alpha value, also known as opacity, of the color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * const transparent = Color.alpha(blue, 0.1)\n * ```\n *\n * @param color - The original color to modify.\n *\n * @param alpha - A number from 1 to 0. Set to 1 by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function alpha(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", a?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "a", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "alpha" }, { "kind": "Function", "canonicalReference": "framer!Color.brighten:function(1)", "docComment": "/**\n * Returns a brightened color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const brightblue = Color.lighten(blue, 20)\n * ```\n *\n * @param color - The color to brighten\n *\n * @param amount - A number, from 0 to 100. Set to 10 by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function brighten(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", amount?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "amount", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "brighten" }, { "kind": "Function", "canonicalReference": "framer!Color.darken:function(1)", "docComment": "/**\n * Add black and return a darkened color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const darkblue = Color.darken(blue, 20)\n * ```\n *\n * @param color - The color to darken.\n *\n * @param amount - A number, from 0 to 100. Set to 10 by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function darken(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", amount?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "amount", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "darken" }, { "kind": "Function", "canonicalReference": "framer!Color.desaturate:function(1)", "docComment": "/**\n * Decrease the saturation of a color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const desaturated = Color.desaturate(blue, 100)\n * ```\n *\n * @param color - The color to modify\n *\n * @param amount - A number from 0 to 100. Set to 10 by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function desaturate(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", amount?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "amount", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "desaturate" }, { "kind": "Function", "canonicalReference": "framer!Color.difference:function(1)", "docComment": "/**\n * Calculates the color difference using {@link https://en.wikipedia.org/wiki/Color_difference#Euclidean | Euclidean distance fitting human perception}. Returns a value between 0 and 765\n *\n * @param colorA - A first color.\n *\n * @param colorB - A second color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function difference(colorA: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", colorB: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "colorA", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "colorB", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "difference" }, { "kind": "Function", "canonicalReference": "framer!Color.equal:function(1)", "docComment": "/**\n * Checks whether two Color objects are equal.\n *\n * @remarks\n * ```jsx\n * Color.equal(Color(\"red\"), Color(\"red\")) // true\n * Color.equal(Color(\"red\"), Color(\"blue\")) // false\n *\n * Color.equal(Color(\"#0099FF\"), Color(\"009AFF\")) // false\n * Color.equal(Color(\"#0099FF\"), Color(\"009AFF\"), 2) // true\n * ```\n *\n * @param colorA - The first color\n *\n * @param colorB - The second color\n *\n * @param tolerance - A tolerance for the difference between rgba values. Set to 0.1 by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function equal(colorA: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", colorB: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", tolerance?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "colorA", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "colorB", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "tolerance", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "equal" }, { "kind": "Function", "canonicalReference": "framer!Color.grayscale:function(1)", "docComment": "/**\n * Return a fully desaturated color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const gray = Color.grayscale(blue)\n * ```\n *\n * @param color - The color to convert.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function grayscale(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "grayscale" }, { "kind": "Function", "canonicalReference": "framer!Color.grey:function(1)", "docComment": "/**\n * Creates a greyscale color.\n *\n * @remarks\n * ```jsx\n * const gray = Color.gray(0.5)\n * ```\n *\n * @param amount - A number from 0 to 1 representing the amount of white.\n *\n * @param alphaValue - A number from 0 to 1 representing the alpha. Set to 1 by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function grey(amount?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", alphaValue?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "amount", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "alphaValue", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "grey" }, { "kind": "Function", "canonicalReference": "framer!Color.hueRotate:function(1)", "docComment": "/**\n * Returns a new color for the rotated hue.\n *\n * @param color - The color to manipulate\n *\n * @param angle - The angle in degrees in which to rotate the hue.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function hueRotate(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", angle: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "angle", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "hueRotate" }, { "kind": "Function", "canonicalReference": "framer!Color.inspect:function(1)", "docComment": "/**\n * Formats a Color object into a readable string for debugging.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.inspect(blue)\n * ```\n *\n * @param color - The Color object to format\n *\n * @param initialValue - A canonical hex string to be used instead of an rgba() value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function inspect(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", initialValue?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "initialValue", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "inspect" }, { "kind": "Function", "canonicalReference": "framer!Color.interpolate:function(1)", "docComment": "/**\n * Returns a function that can be used to transition a color from one value to another. By default this will use the RGB `mix` model. Useful for providing to animation tools.\n * ```jsx\n * const blend = Color.interpolate(Color(\"red\"), Color(\"blue\"))\n *\n * blend(0) // Initial state (red)\n * blend(0.5) // Mid state (purple)\n * blend(1) // Final state (blue)\n * ```\n *\n * @param colorA - The starting color\n *\n * @param colorB - The final color\n *\n * @param model - The model to use for the mix. One of {@link ColorMixModelType}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function interpolate(colorA: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", colorB: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", model?: " }, { "kind": "Reference", "text": "ColorMixModelType", "canonicalReference": "framer!ColorMixModelType:enum" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "(progress: number) => " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "colorA", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "colorB", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "model", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "interpolate" }, { "kind": "Function", "canonicalReference": "framer!Color.isColor:function(1)", "docComment": "/**\n * Checks if the value is a valid color object or color string. Returns true or false.\n *\n * @remarks\n * ```jsx\n * Color.isColor(\"#0099FF\") // true\n * Color.isColor(Color(\"#0099FF\")) // true\n * ```\n *\n * @param color - The potential color value to validate\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function isColor(color: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "name": "isColor" }, { "kind": "Function", "canonicalReference": "framer!Color.isColorObject:function(1)", "docComment": "/**\n * Checks if the value is a valid Color object. Returns true or false.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.isColorObject(blue) // true\n * Color.isColorObject(\"#0099FF\") // false\n * ```\n *\n * @param color - An object representing a color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function isColorObject(color: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "color", "canonicalReference": "framer!~color" }, { "kind": "Content", "text": " is object & " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "isColorObject" }, { "kind": "Function", "canonicalReference": "framer!Color.isColorString:function(1)", "docComment": "/**\n * Checks if the value is a valid color string. Returns true or false.\n *\n * @remarks\n * ```jsx\n * Color.isColorString(\"#0099FF\") // true\n * ```\n *\n * @param color - A string representing a color\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function isColorString(colorString: " }, { "kind": "Content", "text": "string | object" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "colorString", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "isColorString" }, { "kind": "Function", "canonicalReference": "framer!Color.lighten:function(1)", "docComment": "/**\n * Add white and return a lightened color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const lightblue = Color.lighten(blue, 20)\n * ```\n *\n * @param color - The color to lighten\n *\n * @param amount - A number, from 0 to 100. Set to 10 by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function lighten(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", amount?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "amount", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "lighten" }, { "kind": "Function", "canonicalReference": "framer!Color.mix:function(1)", "docComment": "/**\n * Create a function that will mix two colors together and output the result as an rgb string.\n *\n * @param colorA - The starting color\n *\n * @param colorB - The final color\n *\n * @param options - Options for the color mixer\n *\n * - `model`: The model to use for the mix. One of {@link ColorMixModelType}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function mix(from: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", toColor: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", { model }?: " }, { "kind": "Content", "text": "{\n model?: " }, { "kind": "Reference", "text": "ColorMixModelType", "canonicalReference": "framer!ColorMixModelType:enum" }, { "kind": "Content", "text": " | undefined;\n }" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "(p: number) => string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "from", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "toColor", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "{ model }", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 } } ], "name": "mix" }, { "kind": "Function", "canonicalReference": "framer!Color.mixAsColor:function(1)", "docComment": "/**\n * Blend two colors together, optionally based on user input. The fraction defines the distribution between the two colors, and is set to 0.5 by default. The `limit` defines if the color can transition beyond its range.\n *\n * @remarks\n * ```jsx\n * // Mix red with yellow\n * const orange = Color.mix(\"red\", \"yellow\", 0.5)\n * ```\n *\n * ```jsx\n * Color.mix(\"red\", \"yellow\", 0.5, true, \"husl\")\n * ```\n *\n * @param colorA - A color, the first one.\n *\n * @param colorB - A color, the second one.\n *\n * @param fraction - An optional number, from 0 to 1, set to 0.5 by default.\n *\n * @param limit - An optional boolean, set to false by default.\n *\n * @param model - The model to use for the mix. One of {@link ColorMixModelType}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function mixAsColor(colorA: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", colorB: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", fraction?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", limit?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", model?: " }, { "kind": "Reference", "text": "ColorMixModelType", "canonicalReference": "framer!ColorMixModelType:enum" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 11, "endIndex": 13 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "colorA", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "colorB", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "fraction", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } }, { "parameterName": "limit", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } }, { "parameterName": "model", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "name": "mixAsColor" }, { "kind": "Function", "canonicalReference": "framer!Color.multiplyAlpha:function(1)", "docComment": "/**\n * Change the alpha value, also know as opacity, by a multiplier.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const transparent = Color.multiplyAlpha(blue, 0.5)\n * ```\n *\n * @param color - The original color to modify.\n *\n * @param alphaValue - A number between 1 and 0, defaults to 1,\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function multiplyAlpha(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", alphaValue?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "alphaValue", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "multiplyAlpha" }, { "kind": "Function", "canonicalReference": "framer!Color.random:function(1)", "docComment": "/**\n * Returns a Color instance with a random color value set.\n *\n * @remarks\n * ```jsx\n * const random = Color.random()\n * ```\n *\n * @param alphaValue - An optional alpha value, set to 1 by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function random(alphaValue?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "alphaValue", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "random" }, { "kind": "Function", "canonicalReference": "framer!Color.saturate:function(1)", "docComment": "/**\n * Increase the saturation of a color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const saturated = Color.saturate(blue, 100)\n * ```\n *\n * @param color - The color to modify\n *\n * @param amount - A number from 0 to 100. Set to 10 by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function saturate(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", amount?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "amount", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "saturate" }, { "kind": "Function", "canonicalReference": "framer!Color.toHex:function(1)", "docComment": "/**\n * Formats a Color instance into an hexidecimal value.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHex(blue) // \"0099FF\"\n * Color.toHex(Color(\"#FFAAFF\"), true) // \"FAF\"\n * ```\n *\n * @param color - The color to format\n *\n * @param allow3Char - If true will return short hand colors if possible (defaults to false).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function toHex(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", allow3Char?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "allow3Char", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "toHex" }, { "kind": "Function", "canonicalReference": "framer!Color.toHexString:function(1)", "docComment": "/**\n * Formats a Color instance into an hexidecimal string.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHexString(blue) // \"#0099FF\"\n * Color.toHexString(Color(\"#FFAAFF\"), true) // \"#FAF\"\n * ```\n *\n * @param color - The color to format\n *\n * @param allow3Char - If true will return short hand colors if possible (defaults to false).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function toHexString(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ", allow3Char?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "allow3Char", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "toHexString" }, { "kind": "Function", "canonicalReference": "framer!Color.toHsl:function(1)", "docComment": "/**\n * Formats a color into an HSL object.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHsl(blue) // {h: 204, s: 1, l: 0.5, a: 1}\n * ```\n *\n * @param color - The color to format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function toHsl(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ColorHSLA", "canonicalReference": "framer!ColorHSLA:type" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toHsl" }, { "kind": "Function", "canonicalReference": "framer!Color.toHslString:function(1)", "docComment": "/**\n * Formats a Color instance into an HSL string.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHslString(blue) // \"hsl(204, 100%, 50%)\"\n * ```\n *\n * @param color - The color to format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function toHslString(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toHslString" }, { "kind": "Function", "canonicalReference": "framer!Color.toHsv:function(1)", "docComment": "/**\n * Formats a Color instance into an HSV object.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHsv(blue) // {h: 204, s: 1, v: 1, a: 1}\"\n * ```\n *\n * @param color - The color to format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function toHsv(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ColorHSVA", "canonicalReference": "framer!ColorHSVA:type" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toHsv" }, { "kind": "Function", "canonicalReference": "framer!Color.toHsvString:function(1)", "docComment": "/**\n * Formats a Color instance into an HSV string.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHslString(blue) // \"hsv(204, 100%, 50%)\"\n * ```\n *\n * @param color - The color to format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function toHsvString(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toHsvString" }, { "kind": "Function", "canonicalReference": "framer!Color.toHusl:function(1)", "docComment": "/**\n * Formats a Color instance into an HUSL object.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHusl(blue) // {h: 250, s: 100, l: 50, a: 1}\n * ```\n *\n * @param color - The color to format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function toHusl(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ColorHSLA", "canonicalReference": "framer!ColorHSLA:type" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toHusl" }, { "kind": "Function", "canonicalReference": "framer!Color.toName:function(1)", "docComment": "/**\n * Formats a Color instance into {@link https://css-tricks.com/snippets/css/named-colors-and-hex-equivalents/ | CSS name} or returns false if unspecified.\n *\n * @remarks\n * ```jsx\n * const green = Color(\"#8FBC8F\")\n *\n * Color.toName(green) // \"darkseagreen\"\n * ```\n *\n * @param color - The color to format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function toName(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string | false" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toName" }, { "kind": "Function", "canonicalReference": "framer!Color.toRgb:function(1)", "docComment": "/**\n * Formats a color into an RGB object.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toRgb(blue) // {r: 40, g: 175, b: 250, a: 1}\n * ```\n *\n * @param color - The color to format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function toRgb(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ColorRGBA", "canonicalReference": "framer!ColorRGBA:type" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toRgb" }, { "kind": "Function", "canonicalReference": "framer!Color.toRgbString:function(1)", "docComment": "/**\n * Formats a Color instance into an RGB string.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toRgbString(blue) // \"rgb(0, 153, 255)\"\n * ```\n *\n * @param color - The color to format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function toRgbString(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toRgbString" }, { "kind": "Function", "canonicalReference": "framer!Color.toString:function(1)", "docComment": "/**\n * Formats a Color instance into an RGB string.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toString(blue) // \"rgb(0, 153, 255)\"\n * ```\n *\n * @param color - The color to format\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function toString(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toString" }, { "kind": "Function", "canonicalReference": "framer!Color.transparent:function(1)", "docComment": "/**\n * Set the alpha value, also known as opacity, of the color to zero.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * const transparent = Color.alpha(blue)\n * ```\n *\n * @param color - The original color to modify.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function transparent(color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "transparent" } ] }, { "kind": "Interface", "canonicalReference": "framer!ColorControlDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ColorControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "ColorControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!ColorControlDescription#defaultValue:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "defaultValue?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ColorControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.Color", "canonicalReference": "framer!ControlType.Color:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Enum", "canonicalReference": "framer!ColorFormat:enum", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum ColorFormat " } ], "releaseTag": "Public", "name": "ColorFormat", "members": [ { "kind": "EnumMember", "canonicalReference": "framer!ColorFormat.HEX:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "HEX = " }, { "kind": "Content", "text": "\"hex\"" } ], "releaseTag": "Public", "name": "HEX", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ColorFormat.HSL:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "HSL = " }, { "kind": "Content", "text": "\"hsl\"" } ], "releaseTag": "Public", "name": "HSL", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ColorFormat.HSV:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "HSV = " }, { "kind": "Content", "text": "\"hsv\"" } ], "releaseTag": "Public", "name": "HSV", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ColorFormat.NAME:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "NAME = " }, { "kind": "Content", "text": "\"name\"" } ], "releaseTag": "Public", "name": "NAME", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ColorFormat.RGB:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "RGB = " }, { "kind": "Content", "text": "\"rgb\"" } ], "releaseTag": "Public", "name": "RGB", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } } ] }, { "kind": "Interface", "canonicalReference": "framer!ColorHSL:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ColorHSL " } ], "releaseTag": "Public", "name": "ColorHSL", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!ColorHSL#h:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "h: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "h", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ColorHSL#l:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "l: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "l", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ColorHSL#s:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "s: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "s", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "framer!ColorHSLA:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type ColorHSLA = " }, { "kind": "Reference", "text": "ColorHSL", "canonicalReference": "framer!ColorHSL:interface" }, { "kind": "Content", "text": " & {\n a: number;\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ColorHSLA", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "TypeAlias", "canonicalReference": "framer!ColorHSVA:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type ColorHSVA = " }, { "kind": "Reference", "text": "ColorHSV", "canonicalReference": "framer!ColorHSV:interface" }, { "kind": "Content", "text": " & {\n a: number;\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ColorHSVA", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Enum", "canonicalReference": "framer!ColorMixModelType:enum", "docComment": "/**\n * Various Color functions, such as {@link (Color:namespace).mix} and {@link (Color:namespace).interpolate}, take an optional color model that determines how two colors are mixed together.\n *\n * @remarks\n * ```javascript\n * const newColor = Color.mix(Color(\"red\"), Color(\"blue\"), {model: ColorMixModelType.HSL})\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum ColorMixModelType " } ], "releaseTag": "Public", "name": "ColorMixModelType", "members": [ { "kind": "EnumMember", "canonicalReference": "framer!ColorMixModelType.HSL:member", "docComment": "/**\n * Use the {@link https://en.wikipedia.org/wiki/HSL_and_HSV | HSL} color space with an alpha value\n *\n * @remarks\n * ```javascript\n * const newColor = Color.mix(Color(\"red\"), Color(\"blue\"), {model: ColorMixModelType.HSL})\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "HSL = " }, { "kind": "Content", "text": "\"hsl\"" } ], "releaseTag": "Public", "name": "HSL", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ColorMixModelType.HSLA:member", "docComment": "/**\n * Use the {@link https://en.wikipedia.org/wiki/HSL_and_HSV | HSL} color space with an alpha value\n *\n * @remarks\n * ```javascript\n * const newColor = Color.mix(Color(\"red\"), Color(\"blue\"), {model: ColorMixModelType.HSLA})\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "HSLA = " }, { "kind": "Content", "text": "\"hsla\"" } ], "releaseTag": "Public", "name": "HSLA", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ColorMixModelType.HUSL:member", "docComment": "/**\n * Use the {@link http://www.hsluv.org | HSLuv} human friendly color model\n *\n * @remarks\n * ```javascript\n * const newColor = Color.mix(Color(\"red\"), Color(\"blue\"), {model: ColorMixModelType.HUSL})\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "HUSL = " }, { "kind": "Content", "text": "\"husl\"" } ], "releaseTag": "Public", "name": "HUSL", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ColorMixModelType.RGB:member", "docComment": "/**\n * Use the {@link https://en.wikipedia.org/wiki/RGB_color_model | RGB color space} without an alpha value\n *\n * @remarks\n * ```javascript\n * const newColor = Color.mix(Color(\"red\"), Color(\"blue\"), {model: ColorMixModelType.RGB})\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "RGB = " }, { "kind": "Content", "text": "\"rgb\"" } ], "releaseTag": "Public", "name": "RGB", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ColorMixModelType.RGBA:member", "docComment": "/**\n * Use the {@link https://en.wikipedia.org/wiki/RGB_color_model | RGB color space} color space with an alpha value\n *\n * @remarks\n * ```javascript\n * const newColor = Color.mix(Color(\"red\"), Color(\"blue\"), {model: ColorMixModelType.RGBA})\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "RGBA = " }, { "kind": "Content", "text": "\"rgba\"" } ], "releaseTag": "Public", "name": "RGBA", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } } ] }, { "kind": "Interface", "canonicalReference": "framer!ColorMixOptions:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ColorMixOptions " } ], "releaseTag": "Public", "name": "ColorMixOptions", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!ColorMixOptions#model:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "model?: " }, { "kind": "Reference", "text": "ColorMixModelType", "canonicalReference": "framer!ColorMixModelType:enum" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "model", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "framer!ColorRGBA:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type ColorRGBA = " }, { "kind": "Reference", "text": "ColorRGB", "canonicalReference": "framer!ColorRGB:interface" }, { "kind": "Content", "text": " & {\n a: number;\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ColorRGBA", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "framer!ComponentInstanceDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ComponentInstanceDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "ComponentInstanceDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!ComponentInstanceDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.ComponentInstance", "canonicalReference": "framer!ControlType.ComponentInstance:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "TypeAlias", "canonicalReference": "framer!ConstraintPercentage:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type ConstraintPercentage = " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ConstraintPercentage", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "framer!ConstraintProperties:interface", "docComment": "/**\n * These properties are used to layout elements within Framer’s constraint system.\n *\n * @internalRemarks\n *\n * Represents model property values for layout constraints. These may be internally inconsistent. Mask and Values are generated from these.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ConstraintProperties extends " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "WithFractionOfFreeSpace", "canonicalReference": "framer!WithFractionOfFreeSpace:interface" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "name": "ConstraintProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!ConstraintProperties#aspectRatio:member", "docComment": "/**\n * Aspect Ratio to keep when resizing\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "aspectRatio: " }, { "kind": "Content", "text": "number | null" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "aspectRatio", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ConstraintProperties#autoSize:member", "docComment": "/**\n * //TODO What is autoSize for? Internal?\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoSize?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "autoSize", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ConstraintProperties#bottom:member", "docComment": "/**\n * Pinned position from bottom\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bottom: " }, { "kind": "Reference", "text": "Animatable", "canonicalReference": "framer!Animatable:interface" }, { "kind": "Content", "text": " | number | null" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "bottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ConstraintProperties#centerX:member", "docComment": "/**\n * Center of horizontal position (X axis)\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "centerX: " }, { "kind": "Reference", "text": "ConstraintPercentage", "canonicalReference": "framer!ConstraintPercentage:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "centerX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ConstraintProperties#centerY:member", "docComment": "/**\n * Center of vertical position (Y axis)\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "centerY: " }, { "kind": "Reference", "text": "ConstraintPercentage", "canonicalReference": "framer!ConstraintPercentage:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "centerY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ConstraintProperties#height:member", "docComment": "/**\n * Element height\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Reference", "text": "ConstraintDimension", "canonicalReference": "framer!ConstraintDimension:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ConstraintProperties#left:member", "docComment": "/**\n * Pinned position from left\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left: " }, { "kind": "Reference", "text": "Animatable", "canonicalReference": "framer!Animatable:interface" }, { "kind": "Content", "text": " | number | null" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ConstraintProperties#right:member", "docComment": "/**\n * Pinned position from right\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "right: " }, { "kind": "Reference", "text": "Animatable", "canonicalReference": "framer!Animatable:interface" }, { "kind": "Content", "text": " | number | null" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "right", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ConstraintProperties#top:member", "docComment": "/**\n * Pinned position from top\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top: " }, { "kind": "Reference", "text": "Animatable", "canonicalReference": "framer!Animatable:interface" }, { "kind": "Content", "text": " | number | null" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ConstraintProperties#width:member", "docComment": "/**\n * Element width\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Reference", "text": "ConstraintDimension", "canonicalReference": "framer!ConstraintDimension:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 5 } ] }, { "kind": "TypeAlias", "canonicalReference": "framer!ControlDescription:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type ControlDescription

= " }, { "kind": "Reference", "text": "NumberControlDescription", "canonicalReference": "framer!NumberControlDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "EnumControlDescription", "canonicalReference": "framer!EnumControlDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "BooleanControlDescription", "canonicalReference": "framer!BooleanControlDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "StringControlDescription", "canonicalReference": "framer!StringControlDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "ColorControlDescription", "canonicalReference": "framer!ColorControlDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "FusedNumberControlDescription", "canonicalReference": "framer!FusedNumberControlDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "SegmentedEnumControlDescription", "canonicalReference": "framer!SegmentedEnumControlDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "ImageControlDescription", "canonicalReference": "framer!ImageControlDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "FileControlDescription", "canonicalReference": "framer!FileControlDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "ComponentInstanceDescription", "canonicalReference": "framer!ComponentInstanceDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "ArrayControlDescription", "canonicalReference": "framer!ArrayControlDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "EventHandlerControlDescription", "canonicalReference": "framer!EventHandlerControlDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "TransitionControlDescription", "canonicalReference": "framer!TransitionControlDescription:interface" }, { "kind": "Content", "text": "

| " }, { "kind": "Reference", "text": "ObjectControlDescription", "canonicalReference": "framer!ObjectControlDescription:interface" }, { "kind": "Content", "text": "

" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ControlDescription", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 31 } }, { "kind": "Enum", "canonicalReference": "framer!ControlType:enum", "docComment": "/**\n * Used by the {@link PropertyControls} and specifies the type of user interface for receiving input. Each field has a distinct set of properties though they all accept `title` and `hidden` properties.\n *\n * @remarks\n * ```javascript\n * export function MyComponent({ title }) {\n * return {title}\n * }\n *\n * addPropertyControls(MyComponent, {\n * title: {\n * type: ControlType.String,\n * title: \"Title\",\n * hidden: (props) => true\n * },\n * }\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare const enum ControlType " } ], "releaseTag": "Public", "name": "ControlType", "members": [ { "kind": "EnumMember", "canonicalReference": "framer!ControlType.Array:member", "docComment": "/**\n * A control that allows multiple values per `ControlType`, provided as an array via properties. For most control types this will be displayed as an additional section in the properties panel allowing as many fields to be provided as required.\n *\n * For a {@link ControlType.ComponentInstance} the Frame will also gain an additional outlet control on the Canvas that allows links to be created between frames.\n *\n * For multiple {@link ControlType.FusedNumber} values, you can pass in an array of single values as the React default prop.\n * ```javascript\n * export function MyComponent(props) {\n * const frames = props.images.map(image => )\n * return {frames}\n * }\n *\n * addPropertyControls(MyComponent, {\n * images: {\n * type: ControlType.Array,\n * control: {\n * type: ControlType.Image\n * }\n * },\n * // Allow up to five items\n * maxCount: 5,\n * })\n *\n * addPropertyControls(MyComponent, {\n * children: {\n * type: ControlType.Array,\n * control: {\n * type: ControlType.ComponentInstance\n * },\n * maxCount: 5,\n * },\n * })\n *\n * // For multiple values, you can pass in an array of single values as the React default prop.\n * MyComponent.defaultProps = {\n * paddings: [5, 10, 15],\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Array = " }, { "kind": "Content", "text": "\"array\"" } ], "releaseTag": "Public", "name": "Array", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.Boolean:member", "docComment": "/**\n * A control that displays an on / off checkbox. The associated property will be `true` or `false`, depending on the state of the checkbox. Includes an optional `defaultValue`, which is set to `true` by default. You can also customize the labels displayed in the property panel with the `enabledTitle` and `disabledTitle` properties.\n *\n * @remarks\n * ```javascript\n * export function MyComponent(props) {\n * return {props.showText ? \"Hello World\" : null}\n * }\n *\n * addPropertyControls(MyComponent, {\n * showText: {\n * type: ControlType.Boolean,\n * title: \"Show Text\",\n * defaultValue: true,\n * enabledTitle: \"On\",\n * disabledTitle: \"Off\",\n * },\n * })\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Boolean = " }, { "kind": "Content", "text": "\"boolean\"" } ], "releaseTag": "Public", "name": "Boolean", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.Color:member", "docComment": "/**\n * A control that represents a color value. It will be included in the component props as a string. This control is displayed as a color field and will provide the selected color in either HEX (`\"#fff\"`) or HSL (`hsla(203, 87%, 50%, 0.5)`) notation, depending on whether there is an alpha channel.\n *\n * @remarks\n * ```javascript\n * function MyComponent(props) {\n * return \n * }\n *\n * addPropertyControls(MyComponent, {\n * background: {\n * type: ControlType.Color,\n * defaultValue: \"#fff\",\n * },\n * })\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Color = " }, { "kind": "Content", "text": "\"color\"" } ], "releaseTag": "Public", "name": "Color", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.ComponentInstance:member", "docComment": "/**\n * A control that references to another component on the canvas, included in the component props as a React node. The component will have an outlet to allow linking to other Frames. Available Frames will also be displayed in a dropdown menu in the properties panel. The component reference will be provided as a property. As a convention, the name for the property is usually just `children`.\n *\n * Multiple components can be linked by combining the `ComponentInstance` type with the {@link ControlType.Array}.\n * ```javascript\n * export function MyComponent(props) {\n * return {props.children}\n * }\n *\n * addPropertyControls(MyComponent, {\n * children: {\n * type: ControlType.ComponentInstance,\n * },\n * })\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "ComponentInstance = " }, { "kind": "Content", "text": "\"componentinstance\"" } ], "releaseTag": "Public", "name": "ComponentInstance", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.Enum:member", "docComment": "/**\n * A property control that represents a list of options. The list contains primitive values and each value has to be unique. The selected option will be provided as a property. This control is displayed as a dropdown menu in which a user can select one of the items. `displaySegmentedControl` can be enabled to display a segmented control instead.\n * ```javascript\n * export function MyComponent(props) {\n * const value = props.value || \"a\"\n * const colors = { a: \"red\", b: \"green\", c: \"blue\" }\n * return {value}\n * }\n *\n * addPropertyControls(MyComponent, {\n * value: {\n * type: ControlType.Enum,\n * defaultValue: \"a\",\n * options: [\"a\", \"b\", \"c\"],\n * optionTitles: [\"Option A\", \"Option B\", \"Option C\"],\n * },\n * })\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Enum = " }, { "kind": "Content", "text": "\"enum\"" } ], "releaseTag": "Public", "name": "Enum", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.EventHandler:member", "docComment": "/**\n * A control that exposes events in the prototyping panel within the Framer UI. When choosing an event from the prototyping panel, you can select from a list of actions to trigger.\n * ```javascript\n * export function MyComponent(props) {\n * return \n * }\n *\n * addPropertyControls(MyComponent, {\n * onTap: {\n * type: ControlType.EventHandler,\n * },\n * })\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "EventHandler = " }, { "kind": "Content", "text": "\"eventhandler\"" } ], "releaseTag": "Public", "name": "EventHandler", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.File:member", "docComment": "/**\n * A control that allows the user to pick a file resource. It will be included in the component props as an URL string. Displayed as an file picker that will open a native file browser. The selected file will be provided as a fully qualified URL. The `allowedFileTypes` property must be provided to specify acceptable file types.\n *\n * @remarks\n * ```javascript\n * export function MyComponent(props) {\n * return (\n * \n * \n * \n * )\n * }\n *\n * addPropertyControls(MyComponent, {\n * filepath: {\n * type: ControlType.File,\n * allowedFileTypes: [\"mov\"],\n * },\n * })\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "File = " }, { "kind": "Content", "text": "\"file\"" } ], "releaseTag": "Public", "name": "File", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.FusedNumber:member", "docComment": "/**\n * A control that can be used to take a single number or four distinct numeric input fields. The typical use case for this control is for visual properties like border, padding or margin. It will display an input field to accept a single value, alongside a segmented control allowing four distinct values to be provided.\n *\n * You can also set the default value for each valueKey as well as the toggleKey by setting their values on `defaultProps`.\n * ```javascript\n * export function MyComponent({\n * radius = 50,\n * topLeft,\n * topRight,\n * bottomRight,\n * bottomLeft,\n * isMixed = false,\n * }) {\n * const borderRadius = isMixed\n * ? `${topLeft}px ${topRight}px ${bottomRight}px ${bottomLeft}px`\n * : `${radius}px`\n * return \n * }\n *\n * addPropertyControls(MyComponent, {\n * radius: {\n * type: ControlType.FusedNumber,\n * title: \"Radius\",\n * defaultValue: 50,\n * toggleKey: \"isMixed\",\n * toggleTitles: [\"All\", \"Individual\"],\n * valueKeys: [\"topLeft\", \"topRight\", \"bottomRight\", \"bottomLeft\"],\n * valueLabels: [\"NW\", \"NE\", \"SE\", \"SW\"],\n * min: 0,\n * },\n * })\n *\n * // Set the default value for each valueKey as well as the toggleKey by setting their values on `defaultProps`:\n * MyComponent.defaultProps = {\n * radius: 10,\n * isMixed: true,\n * topLeft: 5,\n * topRight: 15,\n * bottomRight: 5,\n * bottomLeft: 15,\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "FusedNumber = " }, { "kind": "Content", "text": "\"fusednumber\"" } ], "releaseTag": "Public", "name": "FusedNumber", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.Image:member", "docComment": "/**\n * A control that allows the user to pick an image resource. It will be included in the component props as an URL string. Displayed as an image picker with associated file picker. The chosen asset will be provided as a fully qualified URL.\n *\n * @remarks\n * ```jsx\n * function MyComponent(props) {\n * return \n * }\n *\n * addPropertyControls(MyComponent, {\n * image: {\n * type: ControlType.Image,\n * }\n * })\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Image = " }, { "kind": "Content", "text": "\"image\"" } ], "releaseTag": "Public", "name": "Image", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.Number:member", "docComment": "/**\n * A control that accepts any numeric value. This will be provided directly as a property. Will display an input field with a range slider by default. The `displayStepper` option can be enabled to include a stepper control instead.\n *\n * @remarks\n * ```javascript\n * export function MyComponent(props) {\n * return {rotation}\n * }\n *\n * addPropertyControls(MyComponent, {\n * rotation: {\n * type: ControlType.Number,\n * defaultValue: 0,\n * min: 0,\n * max: 360,\n * unit: \"deg\",\n * step: 0.1,\n * displayStepper: true,\n * },\n * })\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Number = " }, { "kind": "Content", "text": "\"number\"" } ], "releaseTag": "Public", "name": "Number", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.Object:member", "docComment": "/**\n * A control that allows for grouping multiple properties as an object.\n * ```javascript\n * export function MyComponent(props) {\n * return \n * }\n *\n * addPropertyControls(MyComponent, {\n * myObject: {\n * type: ControlType.Object,\n * controls: {\n * opacity: { type: ControlType.Number },\n * tint: { type: ControlType.Color },\n * }\n * }\n * })\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Object = " }, { "kind": "Content", "text": "\"object\"" } ], "releaseTag": "Public", "name": "Object", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.SegmentedEnum:member", "docComment": "/**\n * Deprecated, please use {@link ControlType.Enum} and enable displaySegmentedControl.\n *\n * @remarks\n * ```javascript\n * export function MyComponent(props) {\n * const value = props.value || \"a\"\n * const colors = { a: \"red\", b: \"green\", c: \"blue\" }\n * return {value}\n * }\n *\n * addPropertyControls(MyComponent, {\n * value: {\n * type: ControlType.SegmentedEnum,\n * defaultValue: \"a\",\n * options: [\"a\", \"b\", \"c\"],\n * optionTitles: [\"A\", \"B\", \"C\"],\n * },\n * })\n * ```\n *\n * @deprecated\n *\n * - Please use {@link ControlType.Enum} and enable displaySegmentedControl.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "SegmentedEnum = " }, { "kind": "Content", "text": "\"segmentedenum\"" } ], "releaseTag": "Public", "name": "SegmentedEnum", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.String:member", "docComment": "/**\n * A control that accepts plain text values. This will be provided directly as a property. Will display an input field with an optional placeholder value. If `obscured` attribute is set to true a password input field will be used instead of a regular text input so that the value in the input will be visually obscured, yet still be available as plain text inside the component. `displayTextArea` can be enabled to display a multi-line input area instead.\n *\n * @remarks\n * ```javascript\n * export function MyComponent(props) {\n * return {props.title} — {props.body}\n * }\n *\n * addPropertyControls(MyComponent, {\n * title: {\n * type: ControlType.String,\n * defaultValue: \"Framer\",\n * placeholder: \"Type something…\",\n * },\n * body: {\n * type: ControlType.String,\n * defaultValue: \"Lorem ipsum dolor sit amet.\",\n * placeholder: \"Type something…\",\n * displayTextArea: true,\n * },\n * })\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "String = " }, { "kind": "Content", "text": "\"string\"" } ], "releaseTag": "Public", "name": "String", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!ControlType.Transition:member", "docComment": "/**\n * A control that allows for editing Framer Motion transition options within the Framer UI.\n * ```javascript\n * export function MyComponent(props) {\n * return (\n * \n * )\n * }\n *\n * addPropertyControls(MyComponent, {\n * transition: {\n * type: ControlType.Transition,\n * },\n * })\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Transition = " }, { "kind": "Content", "text": "\"transition\"" } ], "releaseTag": "Public", "name": "Transition", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } } ] }, { "kind": "Namespace", "canonicalReference": "framer!ConvertColor:namespace", "docComment": "/**\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare namespace ConvertColor " } ], "releaseTag": "Beta", "name": "ConvertColor", "members": [ { "kind": "Function", "canonicalReference": "framer!ConvertColor.equals:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function equals(a: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", b: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "a", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "parameterName": "b", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "equals" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.getAlpha:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function getAlpha(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "getAlpha" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.hslToString:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function hslToString(hsl: " }, { "kind": "Reference", "text": "ColorHSL", "canonicalReference": "framer!ColorHSL:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ColorHSLA", "canonicalReference": "framer!ColorHSLA:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "hsl", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 } } ], "name": "hslToString" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.hsvToHSLString:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function hsvToHSLString(hsv: " }, { "kind": "Reference", "text": "ColorHSV", "canonicalReference": "framer!ColorHSV:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ColorHSVA", "canonicalReference": "framer!ColorHSVA:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "hsv", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 } } ], "name": "hsvToHSLString" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.hsvToString:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function hsvToString(hsv: " }, { "kind": "Reference", "text": "ColorHSV", "canonicalReference": "framer!ColorHSV:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ColorHSVA", "canonicalReference": "framer!ColorHSVA:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "hsv", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 } } ], "name": "hsvToString" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.hueRotate:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function hueRotate(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", angle: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "angle", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "hueRotate" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.isValid:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function isValid(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "isValid" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.multiplyAlpha:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function multiplyAlpha(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", alpha: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "alpha", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "multiplyAlpha" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.rgbaToString:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function rgbaToString(color: " }, { "kind": "Reference", "text": "ColorRGB", "canonicalReference": "framer!ColorRGB:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ColorRGBA", "canonicalReference": "framer!ColorRGBA:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 4 } } ], "name": "rgbaToString" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.setAlpha:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function setAlpha(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", alpha: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "alpha", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "setAlpha" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.toColorPickerSquare:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function toColorPickerSquare(h: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "h", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toColorPickerSquare" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.toHex:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function toHex(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toHex" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.toHexOrRgbaString:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function toHexOrRgbaString(input: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "input", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toHexOrRgbaString" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.toHSL:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function toHSL(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ColorHSLA", "canonicalReference": "framer!ColorHSLA:type" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toHSL" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.toHslString:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function toHslString(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toHslString" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.toHSV:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function toHSV(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ColorHSVA", "canonicalReference": "framer!ColorHSVA:type" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toHSV" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.toHsvString:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function toHsvString(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toHsvString" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.toRgb:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function toRgb(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ColorRGBA", "canonicalReference": "framer!ColorRGBA:type" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toRgb" }, { "kind": "Function", "canonicalReference": "framer!ConvertColor.toRgbString:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function toRgbString(color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "color", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "toRgbString" } ] }, { "kind": "Interface", "canonicalReference": "framer!CSSTransformProperties:interface", "docComment": "/**\n * @internalremarks\n *\n * do no use separately from FrameProps\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CSSTransformProperties extends " }, { "kind": "Reference", "text": "MotionTransform", "canonicalReference": "framer-motion!MotionTransform:type" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "CSSTransformProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#originX:member", "docComment": "/**\n * Set the CSS transform `originX` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "originX: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "originX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#originY:member", "docComment": "/**\n * Set the CSS transform `originY` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "originY: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "originY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#originZ:member", "docComment": "/**\n * Set the CSS transform `originZ` property. Defaults to `px` units.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "originZ: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "originZ", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#perspective:member", "docComment": "/**\n * Set the CSS perspective property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "perspective: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "perspective", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#rotate:member", "docComment": "/**\n * Set the CSS transform `rotate` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rotate: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "rotate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#rotateX:member", "docComment": "/**\n * Set the CSS transform `rotateX` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rotateX: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "rotateX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#rotateY:member", "docComment": "/**\n * Set the CSS transform `rotateY` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rotateY: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "rotateY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#rotateZ:member", "docComment": "/**\n * Set the CSS transform `rotateZ` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rotateZ: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "rotateZ", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#scale:member", "docComment": "/**\n * Set the CSS transform `scale` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scale: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "scale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#scaleX:member", "docComment": "/**\n * Set the CSS transform `scaleX` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scaleX: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "scaleX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#scaleY:member", "docComment": "/**\n * Set the CSS transform `scaleY` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scaleY: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "scaleY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#skew:member", "docComment": "/**\n * Set the CSS transform `skew` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "skew: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "skew", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#skewX:member", "docComment": "/**\n * Set the CSS transform `skewX` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "skewX: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "skewX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#skewY:member", "docComment": "/**\n * Set the CSS transform `skewY` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "skewY: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "skewY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#x:member", "docComment": "/**\n * Set the CSS transform `translateX` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#y:member", "docComment": "/**\n * Set the CSS transform `translateY` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!CSSTransformProperties#z:member", "docComment": "/**\n * Set the CSS transform `translateZ` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "z: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "z", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Variable", "canonicalReference": "framer!CycleVariantState:var", "docComment": "/**\n * Flag setVariantState as cycling variants.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "CycleVariantState: " }, { "kind": "Content", "text": "unique symbol" } ], "releaseTag": "Public", "name": "CycleVariantState", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Function", "canonicalReference": "framer!Data:function(1)", "docComment": "/**\n * Allows data to be shared between Frames using Code Overrides. Any changes to the `Data` instance will cause the preview to update and code overrides will re-render. In this example, we’re updating the `scale` property on `press`, setting it to `0.5`.\n * ```jsx\n * import { Data, Override } from \"framer\"\n *\n * const data = Data({\n * scale: 0.5,\n * })\n *\n * export function WhileTap(): Override {\n * return {\n * whileTap: {\n * scale: data.scale,\n * },\n * }\n * }\n *\n * ```\n *\n * @param initial - The initial value of the data to be set.\n *\n * @returns the data object for use across components.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function Data(initial?: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": " | object" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "T" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "initial", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "Data" }, { "kind": "Namespace", "canonicalReference": "framer!Data:namespace", "docComment": "/**\n * @internalremarks\n *\n * The release tag on this should be internal, but API extractor does not support that yet: https://github.com/Microsoft/web-build-tools/issues/972\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare namespace Data " } ], "releaseTag": "Public", "name": "Data", "members": [] }, { "kind": "TypeAlias", "canonicalReference": "framer!DeprecatedAnimationTarget:type", "docComment": "/**\n * @deprecated\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type DeprecatedAnimationTarget = " }, { "kind": "Reference", "text": "Animatable", "canonicalReference": "framer!Animatable:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "AnimatableObject", "canonicalReference": "framer!AnimatableObject:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "DeprecatedAnimationTarget", "typeParameters": [ { "typeParameterName": "Value", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "Interface", "canonicalReference": "framer!DeprecatedCoreFrameProps:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DeprecatedCoreFrameProps extends " }, { "kind": "Reference", "text": "DeprecatedFrameProperties", "canonicalReference": "framer!DeprecatedFrameProperties:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "LayerProps", "canonicalReference": "framer!LayerProps:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "DeprecatedCoreFrameProps", "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Class", "canonicalReference": "framer!DeprecatedFrame:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class DeprecatedFrame extends " }, { "kind": "Reference", "text": "Layer", "canonicalReference": "framer!Layer:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DeprecatedCoreFrameProps", "canonicalReference": "framer!DeprecatedCoreFrameProps:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "DeprecatedFrameState", "canonicalReference": "framer!~DeprecatedFrameState:interface" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "name": "DeprecatedFrame", "members": [ { "kind": "Method", "canonicalReference": "framer!DeprecatedFrame#componentDidMount:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "componentDidMount(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "componentDidMount" }, { "kind": "Method", "canonicalReference": "framer!DeprecatedFrame#componentDidUpdate:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "componentDidUpdate(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "componentDidUpdate" }, { "kind": "Method", "canonicalReference": "framer!DeprecatedFrame#componentWillUnmount:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "componentWillUnmount(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "componentWillUnmount" }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame.defaultFrameSpecificProps:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static defaultFrameSpecificProps: " }, { "kind": "Reference", "text": "DeprecatedFrameProperties", "canonicalReference": "framer!DeprecatedFrameProperties:interface" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultFrameSpecificProps", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame.defaultProps:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly defaultProps: " }, { "kind": "Reference", "text": "DeprecatedCoreFrameProps", "canonicalReference": "framer!DeprecatedCoreFrameProps:interface" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultProps", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame#element:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "element: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "element", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "framer!DeprecatedFrame.getDerivedStateFromProps:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static getDerivedStateFromProps(nextProps: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DeprecatedCoreFrameProps", "canonicalReference": "framer!DeprecatedCoreFrameProps:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", prevState: " }, { "kind": "Reference", "text": "DeprecatedFrameState", "canonicalReference": "framer!~DeprecatedFrameState:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "DeprecatedFrameState", "canonicalReference": "framer!~DeprecatedFrameState:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "nextProps", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "parameterName": "prevState", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 } } ], "name": "getDerivedStateFromProps" }, { "kind": "Method", "canonicalReference": "framer!DeprecatedFrame#getStyle:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "getStyle(): " }, { "kind": "Reference", "text": "React.CSSProperties", "canonicalReference": "@types/react!~React.CSSProperties:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getStyle" }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame#imageDidChange:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "imageDidChange: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "imageDidChange", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "framer!DeprecatedFrame#layoutChildren:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "layoutChildren(): " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "React.ReactElement", "canonicalReference": "@types/react!~React.ReactElement:interface" }, { "kind": "Content", "text": " " }, { "kind": "Reference", "text": "React.ReactElement", "canonicalReference": "@types/react!~React.ReactElement:interface" }, { "kind": "Content", "text": " " }, { "kind": "Reference", "text": "React.Component", "canonicalReference": "@types/react!~React.Component:class" }, { "kind": "Content", "text": ")> | null) | (new (props: any) => " }, { "kind": "Reference", "text": "React.Component", "canonicalReference": "@types/react!~React.Component:class" }, { "kind": "Content", "text": ")> | " }, { "kind": "Reference", "text": "React.FunctionComponentElement", "canonicalReference": "@types/react!~React.FunctionComponentElement:interface" }, { "kind": "Content", "text": "<{\n _forwardedOverrides: {\n [key: string]: any;\n };\n }>)[] | null | undefined" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "layoutChildren" }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame#onPropsChange:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected onPropsChange: " }, { "kind": "Content", "text": "(props: " }, { "kind": "Reference", "text": "Change", "canonicalReference": "framer!Change:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AnimatableObject", "canonicalReference": "framer!AnimatableObject:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DeprecatedCoreFrameProps", "canonicalReference": "framer!DeprecatedCoreFrameProps:interface" }, { "kind": "Content", "text": ">>) => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "onPropsChange", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 8 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame#onSizeChange:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected onSizeChange: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "onSizeChange", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame#propsObserver:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "propsObserver: " }, { "kind": "Reference", "text": "AnimatableObject", "canonicalReference": "framer!AnimatableObject:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DeprecatedCoreFrameProps", "canonicalReference": "framer!DeprecatedCoreFrameProps:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "propsObserver", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame#propsObserverCancel:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "propsObserverCancel?: " }, { "kind": "Reference", "text": "Cancel", "canonicalReference": "framer!Cancel:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "propsObserverCancel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "framer!DeprecatedFrame.rect:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static rect(props: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ConstraintProperties", "canonicalReference": "framer!ConstraintProperties:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "props", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "name": "rect" }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame#rect:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get rect(): " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "rect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "framer!DeprecatedFrame#render:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "render(): " }, { "kind": "Reference", "text": "JSX.Element", "canonicalReference": "@types/react!~__global.JSX.Element:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "render" }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame#setElement:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "setElement: " }, { "kind": "Content", "text": "(element: " }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": " | null) => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "setElement", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame#sizeObserver:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "sizeObserver: " }, { "kind": "Reference", "text": "AnimatableObject", "canonicalReference": "framer!AnimatableObject:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Size", "canonicalReference": "framer!~Size:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "sizeObserver", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame#sizeObserverCancel:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "sizeObserverCancel?: " }, { "kind": "Reference", "text": "Cancel", "canonicalReference": "framer!Cancel:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "sizeObserverCancel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame#state:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "state: " }, { "kind": "Reference", "text": "DeprecatedFrameState", "canonicalReference": "framer!~DeprecatedFrameState:interface" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "framer!DeprecatedFrame.supportsConstraints:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static supportsConstraints: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "supportsConstraints", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true }, { "kind": "Method", "canonicalReference": "framer!DeprecatedFrame.updatedSize:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static updatedSize(props: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DeprecatedCoreFrameProps", "canonicalReference": "framer!DeprecatedCoreFrameProps:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", state: " }, { "kind": "Reference", "text": "DeprecatedFrameState", "canonicalReference": "framer!~DeprecatedFrameState:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "AnimatableObject", "canonicalReference": "framer!AnimatableObject:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Size", "canonicalReference": "framer!~Size:interface" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "Size", "canonicalReference": "framer!~Size:interface" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 13 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "props", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "parameterName": "state", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 } } ], "name": "updatedSize" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 7 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!DeprecatedFrameProperties:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DeprecatedFrameProperties extends " }, { "kind": "Reference", "text": "ConstraintProperties", "canonicalReference": "framer!ConstraintProperties:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "DeprecatedTransformProperties", "canonicalReference": "framer!DeprecatedTransformProperties:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "DeprecatedVisualProperties", "canonicalReference": "framer!DeprecatedVisualProperties:type" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "DeprecatedFrameProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!DeprecatedFrameProperties#backfaceVisible:member", "docComment": "/**\n * Set to `true` to enable backface-visibility.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backfaceVisible?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "Animatable", "canonicalReference": "framer!Animatable:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "backfaceVisible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!DeprecatedFrameProperties#borderColor:member", "docComment": "/**\n * A border color for the Frame. Set to `\"#222\"` by default.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "borderColor: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "borderColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!DeprecatedFrameProperties#borderStyle:member", "docComment": "/**\n * A border style for the Frame. One of `\"solid\", \"dashed\", \"dotted\"` or `\"double\"`. Set to `\"solid\"` by default.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "borderStyle: " }, { "kind": "Reference", "text": "BorderStyle", "canonicalReference": "framer!BorderStyle:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "borderStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!DeprecatedFrameProperties#borderWidth:member", "docComment": "/**\n * A border width for the frame. Can be either a single number for all sides or an object describing each side. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "borderWidth: " }, { "kind": "Content", "text": "number | " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<{\n top: number;\n bottom: number;\n left: number;\n right: number;\n }>" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "borderWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!DeprecatedFrameProperties#className:member", "docComment": "/**\n * An optional className for the Frame.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "className?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "className", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!DeprecatedFrameProperties#name:member", "docComment": "/**\n * An optional name for the Frame.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!DeprecatedFrameProperties#perspective:member", "docComment": "/**\n * Set the perspective on the z-plane.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "perspective?: " }, { "kind": "Content", "text": "number | " }, { "kind": "Reference", "text": "Animatable", "canonicalReference": "framer!Animatable:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "perspective", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!DeprecatedFrameProperties#preserve3d:member", "docComment": "/**\n * Set to `true` to preserve 3D.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preserve3d?: " }, { "kind": "Content", "text": "boolean | " }, { "kind": "Reference", "text": "Animatable", "canonicalReference": "framer!Animatable:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "preserve3d", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!DeprecatedFrameProperties#style:member", "docComment": "/**\n * Additional CSSProperties to apply to the frame. Usage is exactly the same as with the standard React style prop.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "style?: " }, { "kind": "Reference", "text": "React.CSSProperties", "canonicalReference": "@types/react!~React.CSSProperties:interface" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "style", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!DeprecatedFrameProperties#visible:member", "docComment": "/**\n * Determines whether the Frame is current visible. Set to `true` by default.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "visible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "visible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 7 } ] }, { "kind": "Variable", "canonicalReference": "framer!DeprecatedFrameWithEvents:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "DeprecatedFrameWithEvents: " }, { "kind": "Reference", "text": "React.ComponentClass", "canonicalReference": "@types/react!~React.ComponentClass:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DeprecatedFrameWithEventsProps", "canonicalReference": "framer!DeprecatedFrameWithEventsProps:type" }, { "kind": "Content", "text": ">>" } ], "releaseTag": "Public", "name": "DeprecatedFrameWithEvents", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "framer!DeprecatedFrameWithEventsProps:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type DeprecatedFrameWithEventsProps = " }, { "kind": "Reference", "text": "DeprecatedCoreFrameProps", "canonicalReference": "framer!DeprecatedCoreFrameProps:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "WithEventsProperties", "canonicalReference": "framer!WithEventsProperties:interface" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "DeprecatedFrameWithEventsProps", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "framer!DeprecatedVisualProperties:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type DeprecatedVisualProperties = " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BackgroundProperties", "canonicalReference": "framer!BackgroundProperties:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "RadiusProperties", "canonicalReference": "framer!RadiusProperties:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "FilterProperties", "canonicalReference": "framer!FilterProperties:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "BackgroundFilterProperties", "canonicalReference": "framer!BackgroundFilterProperties:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "BlendingProperties", "canonicalReference": "framer!BlendingProperties:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "OverflowProperties", "canonicalReference": "framer!OverflowProperties:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "BoxShadowProperties", "canonicalReference": "framer!BoxShadowProperties:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "WithOpacity", "canonicalReference": "framer!WithOpacity:interface" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "TextColorProperties", "canonicalReference": "framer!TextColorProperties:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "DeprecatedVisualProperties", "typeTokenRange": { "startIndex": 1, "endIndex": 21 } }, { "kind": "Interface", "canonicalReference": "framer!DOMLayoutProps:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface DOMLayoutProps " } ], "releaseTag": "Public", "name": "DOMLayoutProps", "members": [], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "framer!Draggable:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Draggable: " }, { "kind": "Reference", "text": "React.ComponentClass", "canonicalReference": "@types/react!~React.ComponentClass:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DeprecatedFrameWithEventsProps", "canonicalReference": "framer!DeprecatedFrameWithEventsProps:type" }, { "kind": "Content", "text": "> & " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DraggableProps", "canonicalReference": "framer!DraggableProps:interface" }, { "kind": "Content", "text": ">>" } ], "releaseTag": "Public", "name": "Draggable", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 13 } }, { "kind": "Interface", "canonicalReference": "framer!EnumControlDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EnumControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "EnumControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!EnumControlDescription#defaultValue:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "defaultValue?: " }, { "kind": "Content", "text": "string | boolean | number | undefined | null" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!EnumControlDescription#displaySegmentedControl:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "displaySegmentedControl?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "displaySegmentedControl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!EnumControlDescription#options:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Content", "text": "(string | boolean | number | undefined | null)[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!EnumControlDescription#optionTitles:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "optionTitles?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "optionTitles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!EnumControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.Enum", "canonicalReference": "framer!ControlType.Enum:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "framer!EventHandlerControlDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface EventHandlerControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "EventHandlerControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!EventHandlerControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.EventHandler", "canonicalReference": "framer!ControlType.EventHandler:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "TypeAlias", "canonicalReference": "framer!FadeTransitionOptions:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type FadeTransitionOptions = " }, { "kind": "Reference", "text": "NavigationTransitionAnimation", "canonicalReference": "framer!NavigationTransitionAnimation:interface" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "FadeTransitionOptions", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "framer!FileControlDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FileControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "FileControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!FileControlDescription#allowedFileTypes:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "allowedFileTypes: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "allowedFileTypes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FileControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.File", "canonicalReference": "framer!ControlType.File:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "framer!FilterNumberProperties:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FilterNumberProperties " } ], "releaseTag": "Public", "name": "FilterNumberProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!FilterNumberProperties#blur:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "blur: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "blur", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FilterNumberProperties#brightness:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "brightness: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "brightness", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FilterNumberProperties#contrast:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "contrast: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "contrast", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FilterNumberProperties#grayscale:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "grayscale: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "grayscale", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FilterNumberProperties#hueRotate:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "hueRotate: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "hueRotate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FilterNumberProperties#invert:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "invert: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "invert", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FilterNumberProperties#saturate:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "saturate: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "saturate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FilterNumberProperties#sepia:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "sepia: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "sepia", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!FilterProperties:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FilterProperties extends " }, { "kind": "Reference", "text": "FilterNumberProperties", "canonicalReference": "framer!FilterNumberProperties:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "FilterProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!FilterProperties#dropShadows:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "dropShadows: " }, { "kind": "Reference", "text": "Readonly", "canonicalReference": "!Readonly:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Shadow", "canonicalReference": "framer!Shadow:interface" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "dropShadows", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Interface", "canonicalReference": "framer!FlipTransitionOptions:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FlipTransitionOptions extends " }, { "kind": "Reference", "text": "NavigationTransitionAnimation", "canonicalReference": "framer!NavigationTransitionAnimation:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "NavigationTransitionAppearsFrom", "canonicalReference": "framer!NavigationTransitionAppearsFrom:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "FlipTransitionOptions", "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Variable", "canonicalReference": "framer!Frame:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Frame: " }, { "kind": "Reference", "text": "React.ForwardRefExoticComponent", "canonicalReference": "@types/react!~React.ForwardRefExoticComponent:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FrameProps", "canonicalReference": "framer!FrameProps:interface" }, { "kind": "Content", "text": "> & " }, { "kind": "Reference", "text": "React.RefAttributes", "canonicalReference": "@types/react!~React.RefAttributes:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ">>" } ], "releaseTag": "Public", "name": "Frame", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 11 } }, { "kind": "Interface", "canonicalReference": "framer!FrameLayoutProperties:interface", "docComment": "/**\n * @internalremarks\n *\n * do no use separately from FrameProps\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FrameLayoutProperties " } ], "releaseTag": "Public", "name": "FrameLayoutProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!FrameLayoutProperties#bottom:member", "docComment": "/**\n * Distance from the bottom in pixels. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "bottom: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "bottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FrameLayoutProperties#center:member", "docComment": "/**\n * Shortcut for centering Frames.\n *\n * @remarks\n * ```jsx\n * // Center\n * \n *\n * // Center horizontally\n * \n *\n * // Center vertically\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "center: " }, { "kind": "Content", "text": "boolean | \"x\" | \"y\"" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "center", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FrameLayoutProperties#height:member", "docComment": "/**\n * Set the CSS `height` property. Set to `200` by default. Accepts all CSS value types (including pixels, percentages, keywords and more).\n *\n * @remarks\n * ```jsx\n * // Pixels\n * \n *\n * // Percentages\n * \n *\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FrameLayoutProperties#left:member", "docComment": "/**\n * Distance from the left in pixels. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "left: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "left", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FrameLayoutProperties#minHeight:member", "docComment": "/**\n * Set the CSS `min-height` property. Unset by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minHeight: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "minHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FrameLayoutProperties#minWidth:member", "docComment": "/**\n * Set the CSS `min-width` property. Unset by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minWidth: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "minWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FrameLayoutProperties#position:member", "docComment": "/**\n * Set the CSS `position` property. Set to `\"absolute\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "position: " }, { "kind": "Reference", "text": "React.CSSProperties", "canonicalReference": "@types/react!~React.CSSProperties:interface" }, { "kind": "Content", "text": "[\"position\"]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "position", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FrameLayoutProperties#right:member", "docComment": "/**\n * Distance from the right in pixels. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "right: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "right", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FrameLayoutProperties#size:member", "docComment": "/**\n * Shortcut for setting the width and height simultaneously.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "size: " }, { "kind": "Content", "text": "number | string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "size", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FrameLayoutProperties#top:member", "docComment": "/**\n * Distance from the top in pixels. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "top: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "top", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FrameLayoutProperties#width:member", "docComment": "/**\n * Set the CSS `width` property. Set to `200` by default. Accepts all CSS value types (including pixels, percentages, keywords and more).\n *\n * @remarks\n * ```jsx\n * // Pixels\n * \n *\n * // Percentages\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!FrameProps:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FrameProps extends " }, { "kind": "Reference", "text": "BackgroundProperties", "canonicalReference": "framer!BackgroundProperties:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "VisualProperties", "canonicalReference": "framer!VisualProperties:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "framer!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MotionDivProps", "canonicalReference": "framer!MotionDivProps:type" }, { "kind": "Content", "text": ", \"color\">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "CSSTransformProperties", "canonicalReference": "framer!CSSTransformProperties:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "LayerProps", "canonicalReference": "framer!LayerProps:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "FrameLayoutProperties", "canonicalReference": "framer!FrameLayoutProperties:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ConstraintConfiguration", "canonicalReference": "framer!ConstraintConfiguration:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "BaseFrameProps", "canonicalReference": "framer!BaseFrameProps:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "CustomMotionProps", "canonicalReference": "framer!CustomMotionProps:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "FrameProps", "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 9 }, { "startIndex": 10, "endIndex": 11 }, { "startIndex": 12, "endIndex": 13 }, { "startIndex": 14, "endIndex": 15 }, { "startIndex": 16, "endIndex": 17 }, { "startIndex": 18, "endIndex": 19 }, { "startIndex": 20, "endIndex": 22 } ] }, { "kind": "Class", "canonicalReference": "framer!FramerAnimation:class", "docComment": "/**\n * The animation object returned by the {@link (animate:function)} functions\n *\n * @remarks\n *\n * Can be used to control a animation or wait for it to finish. You never create a FramerAnimation yourself, but store the return type from the animate function.\n * ```jsx\n * const animation = animate.ease(value, 100)\n * await animation.finished()\n * const animation = animate.spring(value, 200)\n * animation.cancel()\n * ```\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FramerAnimation` class.\n *\n * @deprecated\n *\n * Use the {@link useAnimation} hook instead\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class FramerAnimation " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Value", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "AnimatorOptions", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "FramerAnimation", "members": [ { "kind": "Method", "canonicalReference": "framer!FramerAnimation#cancel:member(1)", "docComment": "/**\n * Cancels the animation if it is still running.\n *\n * @remarks\n * ```jsx\n * const animation = animate.ease(value, 100, {duration: 3})\n * setTimeout(() => animation.cancel(), 500)\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cancel(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "cancel" }, { "kind": "Property", "canonicalReference": "framer!FramerAnimation#finished:member", "docComment": "/**\n * Wait for the animation to be finished.\n *\n * @remarks\n * ```jsx\n * // async/await syntax\n * const animation = animate.ease(value, 100)\n * await animation.finished()\n * // Animation is finished\n *\n *\n * const animation = animate.ease(value, 100)\n * animation.ready().then(() => {\n * // Animation is finished\n * })\n * ```\n *\n * @returns Promise that is resolved when the animation is ready to play\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get finished(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "finished", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "framer!FramerAnimation#ready:member", "docComment": "/**\n * Wait for the animation to be ready to play.\n *\n * @remarks\n * ```jsx\n * const animation = animate.ease(value, 100)\n * animation.ready().then(() => {\n * // Animation is ready\n * })\n *\n * // async/await syntax\n * const animation = animate.ease(value, 100)\n * await animation.ready()\n * // Animation is ready\n * ```\n *\n * @returns Promise that is resolved when the animation is ready to play\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get ready(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ready", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "framer!FramerEvent:class", "docComment": "/**\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FramerEvent` class.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class FramerEvent " } ], "releaseTag": "Public", "name": "FramerEvent", "members": [], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!FusedNumberControlDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface FusedNumberControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "FusedNumberControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!FusedNumberControlDescription#defaultValue:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "defaultValue?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FusedNumberControlDescription#min:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "min?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "min", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FusedNumberControlDescription#toggleKey:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "toggleKey: " }, { "kind": "Content", "text": "keyof P" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "toggleKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FusedNumberControlDescription#toggleTitles:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "toggleTitles: " }, { "kind": "Content", "text": "[string, string]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "toggleTitles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FusedNumberControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.FusedNumber", "canonicalReference": "framer!ControlType.FusedNumber:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FusedNumberControlDescription#valueKeys:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "valueKeys: " }, { "kind": "Content", "text": "[keyof P, keyof P, keyof P, keyof P]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "valueKeys", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!FusedNumberControlDescription#valueLabels:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "valueLabels: " }, { "kind": "Content", "text": "[string, string, string, string]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "valueLabels", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "TypeAlias", "canonicalReference": "framer!Gradient:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "declare type Gradient = " }, { "kind": "Reference", "text": "LinearGradient", "canonicalReference": "framer!LinearGradient:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "RadialGradient", "canonicalReference": "framer!RadialGradient:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Gradient", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Interface", "canonicalReference": "framer!IdentityProps:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IdentityProps " } ], "releaseTag": "Public", "name": "IdentityProps", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!IdentityProps#duplicatedFrom:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "duplicatedFrom?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "duplicatedFrom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!IdentityProps#id:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "id?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!ImageControlDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ImageControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "ImageControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!ImageControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.Image", "canonicalReference": "framer!ControlType.Image:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "TypeAlias", "canonicalReference": "framer!ImageFit:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type ImageFit = " }, { "kind": "Content", "text": "\"fill\" | \"fit\" | \"stretch\"" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ImageFit", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "framer!IncomingColor:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type IncomingColor = " }, { "kind": "Reference", "text": "ColorRGB", "canonicalReference": "framer!ColorRGB:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ColorHSL", "canonicalReference": "framer!ColorHSL:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ColorRGBA", "canonicalReference": "framer!ColorRGBA:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "ColorHSLA", "canonicalReference": "framer!ColorHSLA:type" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "IncomingColor", "typeTokenRange": { "startIndex": 1, "endIndex": 9 } }, { "kind": "Class", "canonicalReference": "framer!Layer:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Layer

" }, { "kind": "Content", "text": ", S> extends " }, { "kind": "Reference", "text": "React.Component", "canonicalReference": "@types/react!~React.Component:class" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 1, "endIndex": 5 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "S", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "Layer", "members": [ { "kind": "Method", "canonicalReference": "framer!Layer.applyWillChange:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static applyWillChange(props: " }, { "kind": "Reference", "text": "WillChangeTransformProp", "canonicalReference": "framer!WillChangeTransformProp:interface" }, { "kind": "Content", "text": ", style: " }, { "kind": "Reference", "text": "MotionStyle", "canonicalReference": "framer-motion!MotionStyle:type" }, { "kind": "Content", "text": ", usingMotionStyle: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "props", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "style", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "usingMotionStyle", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "applyWillChange" }, { "kind": "Property", "canonicalReference": "framer!Layer.defaultProps:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly defaultProps: " }, { "kind": "Reference", "text": "LayerProps", "canonicalReference": "framer!LayerProps:interface" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultProps", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "framer!Layer#props:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "props: " }, { "kind": "Reference", "text": "Readonly", "canonicalReference": "!Readonly:type" }, { "kind": "Content", "text": "

& " }, { "kind": "Reference", "text": "Readonly", "canonicalReference": "!Readonly:type" }, { "kind": "Content", "text": "<{\n children?: " }, { "kind": "Reference", "text": "ReactNode", "canonicalReference": "@types/react!~React.ReactNode:type" }, { "kind": "Content", "text": ";\n }>" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "props", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 7 }, "isStatic": false } ], "extendsTokenRange": { "startIndex": 6, "endIndex": 8 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!LayerProps:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LayerProps extends " }, { "kind": "Reference", "text": "IdentityProps", "canonicalReference": "framer!IdentityProps:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "WillChangeTransformProp", "canonicalReference": "framer!WillChangeTransformProp:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "DOMLayoutProps", "canonicalReference": "framer!DOMLayoutProps:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "LayerProps", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!LayerProps#children:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "children?: " }, { "kind": "Reference", "text": "ReactNode", "canonicalReference": "@types/react!~React.ReactNode:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!LayerProps#key:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "key?: " }, { "kind": "Reference", "text": "React.Key", "canonicalReference": "@types/react!~React.Key:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "key", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 7 } ] }, { "kind": "Namespace", "canonicalReference": "framer!LinearGradient:namespace", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare namespace LinearGradient " } ], "releaseTag": "Public", "name": "LinearGradient", "members": [ { "kind": "Function", "canonicalReference": "framer!LinearGradient.isLinearGradient:function(1)", "docComment": "/**\n * @param value - \n */\n", "excerptTokens": [ { "kind": "Content", "text": "function isLinearGradient(value: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "value", "canonicalReference": "framer!~value" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "LinearGradient", "canonicalReference": "framer!LinearGradient:type" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "isLinearGradient" } ] }, { "kind": "TypeAlias", "canonicalReference": "framer!LinearGradient:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type LinearGradient = " }, { "kind": "Reference", "text": "LinearGradientBase", "canonicalReference": "framer!LinearGradientBase:interface" }, { "kind": "Content", "text": " & (" }, { "kind": "Reference", "text": "SimpleGradient", "canonicalReference": "framer!SimpleGradient:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "MultiStopGradient", "canonicalReference": "framer!MultiStopGradient:interface" }, { "kind": "Content", "text": ")" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "LinearGradient", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "Interface", "canonicalReference": "framer!LinearGradientBase:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LinearGradientBase " } ], "releaseTag": "Public", "name": "LinearGradientBase", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!LinearGradientBase#alpha:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "alpha: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "alpha", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!LinearGradientBase#angle:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "angle: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "angle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!ModalTransitionOptions:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ModalTransitionOptions extends " }, { "kind": "Reference", "text": "NavigationTransitionAnimation", "canonicalReference": "framer!NavigationTransitionAnimation:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "NavigationTransitionBackdropColor", "canonicalReference": "framer!NavigationTransitionBackdropColor:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ModalTransitionOptions", "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Function", "canonicalReference": "framer!MotionSetup:function(1)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function MotionSetup({ children }: " }, { "kind": "Reference", "text": "Props", "canonicalReference": "framer!~Props:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "JSX.Element", "canonicalReference": "@types/react!~__global.JSX.Element:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "{ children }", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "MotionSetup" }, { "kind": "Variable", "canonicalReference": "framer!NavigationConsumer:var", "docComment": "/**\n * Provides {@link NavigationInterface} that can be used to start transitions in Framer.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "NavigationConsumer: " }, { "kind": "Reference", "text": "React.Consumer", "canonicalReference": "@types/react!~React.Consumer:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "NavigationInterface", "canonicalReference": "framer!NavigationInterface:interface" }, { "kind": "Content", "text": ">" } ], "releaseTag": "Public", "name": "NavigationConsumer", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Interface", "canonicalReference": "framer!NavigationInterface:interface", "docComment": "/**\n * The navigator allows control over the built-in navigation component in Framer.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NavigationInterface " } ], "releaseTag": "Public", "name": "NavigationInterface", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!NavigationInterface#customTransition:member", "docComment": "/**\n * Present a screen using a custom {@link NavigationTransition}.\n *\n * @param component - The incoming component\n *\n * @param transition - {@link NavigationTransition}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "customTransition: " }, { "kind": "Content", "text": "(component: " }, { "kind": "Reference", "text": "React.ReactNode", "canonicalReference": "@types/react!~React.ReactNode:type" }, { "kind": "Content", "text": ", transition: " }, { "kind": "Reference", "text": "NavigationTransition", "canonicalReference": "framer!NavigationTransition:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "customTransition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationInterface#fade:member", "docComment": "/**\n * Fade in new screen.\n *\n * @param component - The incoming component\n *\n * @param options - {@link FadeTransitionOptions}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fade: " }, { "kind": "Content", "text": "(component: " }, { "kind": "Reference", "text": "React.ReactNode", "canonicalReference": "@types/react!~React.ReactNode:type" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "FadeTransitionOptions", "canonicalReference": "framer!FadeTransitionOptions:type" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fade", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationInterface#flip:member", "docComment": "/**\n * Flip incoming and outgoing screen in 3D. The flip direction can be changed using the {@link NavigationTransitionOptions}.\n *\n * @param component - The incoming component\n *\n * @param options - {@link FlipTransitionOptions}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "flip: " }, { "kind": "Content", "text": "(component: " }, { "kind": "Reference", "text": "React.ReactNode", "canonicalReference": "@types/react!~React.ReactNode:type" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "FlipTransitionOptions", "canonicalReference": "framer!FlipTransitionOptions:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "flip", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationInterface#goBack:member", "docComment": "/**\n * Go back to the previous screen. If a stack of overlays is presented, all overlays are dismissed.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "goBack: " }, { "kind": "Content", "text": "() => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "goBack", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationInterface#instant:member", "docComment": "/**\n * Show new screen instantly.\n *\n * @param component - The incoming component\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "instant: " }, { "kind": "Content", "text": "(component: " }, { "kind": "Reference", "text": "React.ReactNode", "canonicalReference": "@types/react!~React.ReactNode:type" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "instant", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationInterface#magicMotion:member", "docComment": "/**\n * Animate layers with matching magicIds between screens. Layers are assigned matching IDs if they share a name, or were copied from one another. The transition can be changed using a custom {@link NavigationTransition}.\n *\n * @param component - The incoming component\n *\n * @param transition - {@link NavigationTransition}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "magicMotion: " }, { "kind": "Content", "text": "(component: " }, { "kind": "Reference", "text": "React.ReactNode", "canonicalReference": "@types/react!~React.ReactNode:type" }, { "kind": "Content", "text": ", transition: " }, { "kind": "Reference", "text": "NavigationTransition", "canonicalReference": "framer!NavigationTransition:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "magicMotion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationInterface#modal:member", "docComment": "/**\n * Present modal overlay in the center.\n *\n * @param component - The incoming component\n *\n * @param options - {@link ModalTransitionOptions}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modal: " }, { "kind": "Content", "text": "(component: " }, { "kind": "Reference", "text": "React.ReactNode", "canonicalReference": "@types/react!~React.ReactNode:type" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "ModalTransitionOptions", "canonicalReference": "framer!ModalTransitionOptions:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "modal", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationInterface#overlay:member", "docComment": "/**\n * Present overlay from one of four edges. The direction can be changed using the {@link NavigationTransitionOptions}.\n *\n * @param component - The incoming component\n *\n * @param options - {@link OverlayTransitionOptions}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "overlay: " }, { "kind": "Content", "text": "(component: " }, { "kind": "Reference", "text": "React.ReactNode", "canonicalReference": "@types/react!~React.ReactNode:type" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "OverlayTransitionOptions", "canonicalReference": "framer!OverlayTransitionOptions:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "overlay", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationInterface#push:member", "docComment": "/**\n * Push new screen. Defaults from right to left, the direction can be changed using the {@link NavigationTransitionOptions}.\n *\n * @param component - The incoming component\n *\n * @param options - {@link PushTransitionOptions}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "push: " }, { "kind": "Content", "text": "(component: " }, { "kind": "Reference", "text": "React.ReactNode", "canonicalReference": "@types/react!~React.ReactNode:type" }, { "kind": "Content", "text": ", options?: " }, { "kind": "Reference", "text": "PushTransitionOptions", "canonicalReference": "framer!PushTransitionOptions:interface" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "push", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!NavigationTransition:interface", "docComment": "/**\n * Can be used to define a custom navigation transition.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NavigationTransition extends " }, { "kind": "Reference", "text": "NavigationTransitionAnimation", "canonicalReference": "framer!NavigationTransitionAnimation:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "NavigationTransitionBackdropColor", "canonicalReference": "framer!NavigationTransitionBackdropColor:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "NavigationTransition", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!NavigationTransition#backfaceVisible:member", "docComment": "/**\n * Defines whether the backface of the incoming and outgoing screens should be visible, necessary for certain 3D transitions. Defaults to true.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backfaceVisible?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "backfaceVisible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationTransition#enter:member", "docComment": "/**\n * Defines the begin state of the incoming screen wrapper.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enter?: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FrameProps", "canonicalReference": "framer!FrameProps:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "enter", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationTransition#exit:member", "docComment": "/**\n * Defines the end state of the outgoing screen wrapper.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "exit?: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FrameProps", "canonicalReference": "framer!FrameProps:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "exit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationTransition#goBackOnTapOutside:member", "docComment": "/**\n * Defines whether a tap in the background should dismiss the screen presented over the current context. Defaults to true.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "goBackOnTapOutside?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "goBackOnTapOutside", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationTransition#overCurrentContext:member", "docComment": "/**\n * Defines whether the incoming screen should render over the current context, like an overlay or modal. Defaults to false.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "overCurrentContext?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "overCurrentContext", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationTransition#position:member", "docComment": "/**\n * Defines the position and size of the incoming screen wrapper. Defaults to top, right, bottom, and left of 0.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "position?: " }, { "kind": "Reference", "text": "NavigationTransitionPosition", "canonicalReference": "framer!NavigationTransitionPosition:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "position", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NavigationTransition#withMagicMotion:member", "docComment": "/**\n * Defines whether the incoming and outgoing screens should auto animate their children. Defaults to false.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "withMagicMotion?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "withMagicMotion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "framer!NavigationTransitionAnimation:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NavigationTransitionAnimation " } ], "releaseTag": "Public", "name": "NavigationTransitionAnimation", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!NavigationTransitionAnimation#animation:member", "docComment": "/**\n * The animation defaults.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "animation?: " }, { "kind": "Reference", "text": "Transition", "canonicalReference": "framer-motion!Transition:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "animation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!NavigationTransitionAppearsFrom:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NavigationTransitionAppearsFrom extends " }, { "kind": "Reference", "text": "NavigationTransitionAnimation", "canonicalReference": "framer!NavigationTransitionAnimation:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "NavigationTransitionAppearsFrom", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!NavigationTransitionAppearsFrom#appearsFrom:member", "docComment": "/**\n * Defines which side the target will appear from.\n *\n * @remarks\n *\n * - `\"left\"` - `\"right\"` - `\"top\"` - `\"bottom\"`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "appearsFrom?: " }, { "kind": "Reference", "text": "NavigationTransitionSide", "canonicalReference": "framer!NavigationTransitionSide:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "appearsFrom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Interface", "canonicalReference": "framer!NavigationTransitionBackdropColor:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NavigationTransitionBackdropColor " } ], "releaseTag": "Public", "name": "NavigationTransitionBackdropColor", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!NavigationTransitionBackdropColor#backdropColor:member", "docComment": "/**\n * Defines the backdrop color when the incoming screen is rendered over the current context. Defaults to the iOS dim color.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backdropColor?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "backdropColor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "framer!NavigationTransitionPosition:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type NavigationTransitionPosition = " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Pick", "canonicalReference": "!Pick:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FrameLayoutProperties", "canonicalReference": "framer!FrameLayoutProperties:interface" }, { "kind": "Content", "text": ", \"top\" | \"right\" | \"bottom\" | \"left\" | \"center\">>" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "NavigationTransitionPosition", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "framer!NavigationTransitionSide:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type NavigationTransitionSide = " }, { "kind": "Content", "text": "\"left\" | \"right\" | \"top\" | \"bottom\"" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "NavigationTransitionSide", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "framer!NumberControlDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface NumberControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "NumberControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!NumberControlDescription#defaultValue:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "defaultValue?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NumberControlDescription#displayStepper:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "displayStepper?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "displayStepper", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NumberControlDescription#max:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "max?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "max", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NumberControlDescription#min:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "min?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "min", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NumberControlDescription#step:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "step?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "step", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NumberControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.Number", "canonicalReference": "framer!ControlType.Number:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!NumberControlDescription#unit:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "unit?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "unit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "framer!ObjectControlDescription:interface", "docComment": "/**\n * @remarks\n *\n * This feature is still in beta\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ObjectControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "ObjectControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!ObjectControlDescription#controls:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "controls: " }, { "kind": "Content", "text": "{\n [key: string]: " }, { "kind": "Reference", "text": "ObjectPropertyControlDescription", "canonicalReference": "framer!ObjectPropertyControlDescription:type" }, { "kind": "Content", "text": ";\n }" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "controls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ObjectControlDescription#defaultValue:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "defaultValue?: " }, { "kind": "Content", "text": "{\n [key: string]: any;\n }" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ObjectControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.Object", "canonicalReference": "framer!ControlType.Object:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "TypeAlias", "canonicalReference": "framer!ObjectPropertyControlDescription:type", "docComment": "/**\n * Object sub type Currently not supported: fused number, component instance, event handler, array\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type ObjectPropertyControlDescription

= " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "NumberControlDescription", "canonicalReference": "framer!NumberControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EnumControlDescription", "canonicalReference": "framer!EnumControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BooleanControlDescription", "canonicalReference": "framer!BooleanControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "StringControlDescription", "canonicalReference": "framer!StringControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ColorControlDescription", "canonicalReference": "framer!ColorControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SegmentedEnumControlDescription", "canonicalReference": "framer!SegmentedEnumControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ImageControlDescription", "canonicalReference": "framer!ImageControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FileControlDescription", "canonicalReference": "framer!FileControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\"> | " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TransitionControlDescription", "canonicalReference": "framer!TransitionControlDescription:interface" }, { "kind": "Content", "text": "

, \"hidden\">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ObjectPropertyControlDescription", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "typeTokenRange": { "startIndex": 3, "endIndex": 39 } }, { "kind": "Interface", "canonicalReference": "framer!OverlayTransitionOptions:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface OverlayTransitionOptions extends " }, { "kind": "Reference", "text": "NavigationTransitionAnimation", "canonicalReference": "framer!NavigationTransitionAnimation:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "NavigationTransitionAppearsFrom", "canonicalReference": "framer!NavigationTransitionAppearsFrom:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "NavigationTransitionBackdropColor", "canonicalReference": "framer!NavigationTransitionBackdropColor:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "OverlayTransitionOptions", "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 7 } ] }, { "kind": "TypeAlias", "canonicalReference": "framer!Override:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type Override = " }, { "kind": "Reference", "text": "OverrideObject", "canonicalReference": "framer!OverrideObject:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "OverrideFunction", "canonicalReference": "framer!OverrideFunction:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Override", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 5 } } ], "typeTokenRange": { "startIndex": 6, "endIndex": 10 } }, { "kind": "TypeAlias", "canonicalReference": "framer!OverrideFunction:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type OverrideFunction

= " }, { "kind": "Content", "text": "(props: P) => " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "

" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "OverrideFunction", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "typeTokenRange": { "startIndex": 5, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "framer!OverrideObject:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type OverrideObject = " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "OverrideObject", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 1, "endIndex": 2 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "typeTokenRange": { "startIndex": 5, "endIndex": 7 } }, { "kind": "Function", "canonicalReference": "framer!Page:function(1)", "docComment": "/**\n * The Page component allows you to create horizontally or vertically swipeable areas. It can be imported from the Framer Library and used in code components. Add children to create pages to swipe between. These children will be stretched to the size of the page component by default, but can also be set to auto to maintain their original size.\n *\n * @remarks\n * ```jsx\n * import * as React from \"react\"\n * import { Frame, Page } from \"framer\"\n * export class Page extends React.Component {\n * render() {\n * return (\n * \n * \n * \n * )\n * }\n * }\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function Page(props: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PageProps", "canonicalReference": "framer!PageProps:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "JSX.Element", "canonicalReference": "@types/react!~__global.JSX.Element:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "props", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ], "name": "Page" }, { "kind": "TypeAlias", "canonicalReference": "framer!PageAlignment:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type PageAlignment = " }, { "kind": "Content", "text": "\"start\" | \"center\" | \"end\"" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "PageAlignment", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "framer!PageEffect:type", "docComment": "/**\n * Page effects change the behavior of the transition when swiping between pages. By default there is no page effect applied.\n *\n * @remarks\n * ```jsx\n * import * as React from \"react\"\n * import { Page, PageEffect } from \"framer\"\n *\n * export function MyComponent() {\n * return \n * }\n * ```\n *\n * `\"none\"` - No custom effect is applied. This is the default. `\"cube\"` - Each page is positioned as a 3D cube, connected to the current page. `\"coverflow\"` - Each page is positioned in 3D, behind the current page. `\"wheel\"` - Each page is gently titled in 3D, like a wheel. `\"pile\"` - Each page is stacked behind the current page.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type PageEffect = " }, { "kind": "Content", "text": "\"none\" | \"cube\" | \"coverflow\" | \"wheel\" | \"pile\"" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "PageEffect", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "framer!PageEffectInfo:interface", "docComment": "/**\n * Information about the current effect.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PageEffectInfo " } ], "releaseTag": "Public", "name": "PageEffectInfo", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!PageEffectInfo#direction:member", "docComment": "/**\n * The direction of page scrolling, `\"horizontal\"` or `\"vertical\"`\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "direction: " }, { "kind": "Reference", "text": "PageDirection", "canonicalReference": "framer!PageDirection:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "direction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageEffectInfo#gap:member", "docComment": "/**\n * The gap between each page, in pixels.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gap: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "gap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageEffectInfo#index:member", "docComment": "/**\n * The index of the current page. The first page is `0`, the second is `1` and so on.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "index: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "index", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageEffectInfo#normalizedOffset:member", "docComment": "/**\n * The offset of this page, normalised to the page size.\n *\n * For instance, if each page is `200` pixels wide, and we're on page index `1`, the `normalizedOffset` of page index `0` will be `-1`.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "normalizedOffset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "normalizedOffset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageEffectInfo#offset:member", "docComment": "/**\n * The offset of this page, in pixels, measured from the left-most part of the container.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "offset: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "offset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageEffectInfo#pageCount:member", "docComment": "/**\n * The total number of pages.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pageCount: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "pageCount", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageEffectInfo#size:member", "docComment": "/**\n * The `width` and `height` of the page.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "size: " }, { "kind": "Reference", "text": "Size", "canonicalReference": "framer!~Size:interface" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "size", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!PageEvents:interface", "docComment": "/**\n * Event callbacks for the Page component, can be used to react to and co-ordinate with other components.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PageEvents " } ], "releaseTag": "Public", "name": "PageEvents", "members": [ { "kind": "MethodSignature", "canonicalReference": "framer!PageEvents#onChangePage:member(1)", "docComment": "/**\n * A callback that will be invoked when changing the page.\n *\n * @remarks\n * ```jsx\n * {\n * console.log(current, previous)\n * }}\n * />\n * ```\n *\n * @param currentIndex - The current page number\n *\n * @param previousIndex - The index of the previous page\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onChangePage(currentIndex: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", previousIndex: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "currentIndex", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "previousIndex", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "onChangePage" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!PageProperties:interface", "docComment": "/**\n * All properties that can be used with the {@link Page} component it also extends all {@link ScrollProps} properties.\n * ```jsx\n * \n * \n * \n * \n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PageProperties " } ], "releaseTag": "Public", "name": "PageProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#alignment:member", "docComment": "/**\n * Alignment of the pages within the component. Either \"start\", \"center\", or \"end\". Set to `\"start\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "alignment: " }, { "kind": "Reference", "text": "PageAlignment", "canonicalReference": "framer!PageAlignment:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "alignment", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#animateCurrentPageUpdate:member", "docComment": "/**\n * Determines whether the component should animate page changes. Set to `true` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "animateCurrentPageUpdate: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Beta", "name": "animateCurrentPageUpdate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#contentHeight:member", "docComment": "/**\n * Height of the pages within the component. Either \"auto\" or \"stretch\" or a numeric value. Set to `\"stretch\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentHeight: " }, { "kind": "Reference", "text": "PageContentDimension", "canonicalReference": "framer!PageContentDimension:type" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "contentHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#contentOffsetX:member", "docComment": "/**\n * Horizontal offset of the scrollable content. Set to `0` by default\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentOffsetX?: " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "contentOffsetX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#contentOffsetY:member", "docComment": "/**\n * Vertical offset of the scrollable content. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentOffsetY?: " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "contentOffsetY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#contentWidth:member", "docComment": "/**\n * Width of the pages within the component. Either \"auto\" or \"stretch\" or a numeric value. Set to `\"stretch\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentWidth: " }, { "kind": "Reference", "text": "PageContentDimension", "canonicalReference": "framer!PageContentDimension:type" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "contentWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#currentPage:member", "docComment": "/**\n * Index of the current page. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "currentPage: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "currentPage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#defaultEffect:member", "docComment": "/**\n * Pick one of the predefined effects. Either \"none\", \"cube\", \"coverflow\", \"wheel\" or \"pile\". Set to `\"none\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultEffect: " }, { "kind": "Reference", "text": "PageEffect", "canonicalReference": "framer!PageEffect:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultEffect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#direction:member", "docComment": "/**\n * Current swipe direction. Either \"horizontal\" or \"vertical\". Set to `\"horizontal\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "direction: " }, { "kind": "Reference", "text": "PageDirection", "canonicalReference": "framer!PageDirection:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "direction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#directionLock:member", "docComment": "/**\n * If `true`, this will lock dragging to the initial direction.\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "directionLock?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "directionLock", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#dragEnabled:member", "docComment": "/**\n * Enable or disable dragging to scroll. Defaults to `true`.\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dragEnabled?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "dragEnabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#effect:member", "docComment": "/**\n * Allows you to provide a custom transition effect for individual pages.\n *\n * This function is called once for every page, every time the scroll offset changes. It returns a new set of styles for this page.\n *\n * @remarks\n * ```jsx\n * function scaleEffect(info) {\n * const { normalizedOffset } = info\n * return {\n * scale: Math.max(0, 1 + Math.min(0, normalizedOffset * -1))\n * }\n * }\n *\n * return \n * ```\n *\n * @param info - A {@link PageEffectInfo} object with information about the current effect.\n *\n * @returns should return a new set of Frame properties.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "effect?: " }, { "kind": "Content", "text": "(info: " }, { "kind": "Reference", "text": "PageEffectInfo", "canonicalReference": "framer!PageEffectInfo:interface" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "PageEffectValues", "canonicalReference": "framer!PageEffectValues:interface" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "effect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#gap:member", "docComment": "/**\n * A number describing the gap between the page elements. Set to `10` by default. Can not be negative.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gap: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "gap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#momentum:member", "docComment": "/**\n * When enabled you can flick through multiple pages at once.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "momentum: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "momentum", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#padding:member", "docComment": "/**\n * Padding to be applied to all sides. Set to `0` by default. To specify different padding for each side, provide individual `paddingTop`, `paddingLeft`, `paddingRight` and `paddingBottom` values.\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "padding: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "padding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#paddingBottom:member", "docComment": "/**\n * ```jsx\n * \n * ```\n *\n * Value for the bottom padding of the container. Set to `0` by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paddingBottom?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "paddingBottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#paddingLeft:member", "docComment": "/**\n * ```jsx\n * \n * ```\n *\n * Value for the left padding of the container. Set to `0` by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paddingLeft?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "paddingLeft", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#paddingPerSide:member", "docComment": "/**\n * Flag to tell the Page to ignore the `padding` prop and apply values per-side.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paddingPerSide?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "paddingPerSide", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#paddingRight:member", "docComment": "/**\n * ```jsx\n * \n * ```\n *\n * Value for the right padding of the container. Set to `0` by default.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paddingRight?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "paddingRight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#paddingTop:member", "docComment": "/**\n * Value for the top padding of the container. Set to `0` by default.\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paddingTop?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "paddingTop", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!PageProperties#wheelEnabled:member", "docComment": "/**\n * Enable or disable wheel scroll. Defaults to `false`.\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wheelEnabled?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "wheelEnabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!PageProps:interface", "docComment": "/**\n * The following are the props accepted by the Page component, these are all in addition to the standard props accepted by all Frame components.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PageProps extends " }, { "kind": "Reference", "text": "PageProperties", "canonicalReference": "framer!PageProperties:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Omit", "canonicalReference": "framer!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FrameProps", "canonicalReference": "framer!FrameProps:interface" }, { "kind": "Content", "text": ", \"size\" | \"onScroll\">>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "LayerProps", "canonicalReference": "framer!LayerProps:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PageEvents", "canonicalReference": "framer!PageEvents:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ScrollEvents", "canonicalReference": "framer!ScrollEvents:interface" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "name": "PageProps", "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 9 }, { "startIndex": 10, "endIndex": 11 }, { "startIndex": 12, "endIndex": 16 }, { "startIndex": 17, "endIndex": 21 } ] }, { "kind": "Function", "canonicalReference": "framer!Point:function(1)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "declare function Point(x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Point", "canonicalReference": "framer!~Point:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "x", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "y", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "Point" }, { "kind": "Interface", "canonicalReference": "framer!Point:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interface Point " } ], "releaseTag": "Public", "name": "Point", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!Point#x:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Point#y:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Namespace", "canonicalReference": "framer!Point:namespace", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "declare namespace Point " } ], "releaseTag": "Public", "name": "Point", "members": [ { "kind": "Variable", "canonicalReference": "framer!Point.isEqual:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEqual: " }, { "kind": "Content", "text": "(a: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "framer!~Point:interface" }, { "kind": "Content", "text": ", b: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "framer!~Point:interface" }, { "kind": "Content", "text": ") => boolean" } ], "releaseTag": "Public", "name": "isEqual", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 6 } } ] }, { "kind": "Function", "canonicalReference": "framer!print:function(1)", "docComment": "/**\n * Prints to the console.\n *\n * @param args - Arguments to print\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function print(...args: " }, { "kind": "Content", "text": "any[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "print" }, { "kind": "TypeAlias", "canonicalReference": "framer!PropertyControls:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type PropertyControls = " }, { "kind": "Content", "text": "{\n [K in keyof ComponentProps]?: " }, { "kind": "Reference", "text": "ControlDescription", "canonicalReference": "framer!ControlDescription:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": ">;\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "PropertyControls", "typeParameters": [ { "typeParameterName": "ComponentProps", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "typeParameterName": "ArrayTypes", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "typeTokenRange": { "startIndex": 5, "endIndex": 10 } }, { "kind": "Interface", "canonicalReference": "framer!PushTransitionOptions:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PushTransitionOptions extends " }, { "kind": "Reference", "text": "NavigationTransitionAnimation", "canonicalReference": "framer!NavigationTransitionAnimation:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "NavigationTransitionAppearsFrom", "canonicalReference": "framer!NavigationTransitionAppearsFrom:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "PushTransitionOptions", "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Namespace", "canonicalReference": "framer!RadialGradient:namespace", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare namespace RadialGradient " } ], "releaseTag": "Public", "name": "RadialGradient", "members": [ { "kind": "Function", "canonicalReference": "framer!RadialGradient.isRadialGradient:function(1)", "docComment": "/**\n * @param value - \n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function isRadialGradient(value: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "value", "canonicalReference": "framer!~value" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "RadialGradient", "canonicalReference": "framer!RadialGradient:type" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "isRadialGradient" } ] }, { "kind": "TypeAlias", "canonicalReference": "framer!RadialGradient:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type RadialGradient = " }, { "kind": "Reference", "text": "RadialGradientBase", "canonicalReference": "framer!RadialGradientBase:interface" }, { "kind": "Content", "text": " & (" }, { "kind": "Reference", "text": "SimpleGradient", "canonicalReference": "framer!SimpleGradient:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "MultiStopGradient", "canonicalReference": "framer!MultiStopGradient:interface" }, { "kind": "Content", "text": ")" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "RadialGradient", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "Interface", "canonicalReference": "framer!RadialGradientBase:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RadialGradientBase " } ], "releaseTag": "Public", "name": "RadialGradientBase", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!RadialGradientBase#alpha:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "alpha: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "alpha", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!RadialGradientBase#centerAnchorX:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "centerAnchorX: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "centerAnchorX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!RadialGradientBase#centerAnchorY:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "centerAnchorY: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "centerAnchorY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!RadialGradientBase#heightFactor:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "heightFactor: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "heightFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!RadialGradientBase#widthFactor:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "widthFactor: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "widthFactor", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!RadiusProperties:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface RadiusProperties " } ], "releaseTag": "Public", "name": "RadiusProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!RadiusProperties#radius:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "radius: " }, { "kind": "Reference", "text": "RadiusValue", "canonicalReference": "framer!RadiusValue:type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<{\n topLeft: " }, { "kind": "Reference", "text": "RadiusValue", "canonicalReference": "framer!RadiusValue:type" }, { "kind": "Content", "text": ";\n topRight: " }, { "kind": "Reference", "text": "RadiusValue", "canonicalReference": "framer!RadiusValue:type" }, { "kind": "Content", "text": ";\n bottomLeft: " }, { "kind": "Reference", "text": "RadiusValue", "canonicalReference": "framer!RadiusValue:type" }, { "kind": "Content", "text": ";\n bottomRight: " }, { "kind": "Reference", "text": "RadiusValue", "canonicalReference": "framer!RadiusValue:type" }, { "kind": "Content", "text": ";\n }>" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "radius", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 13 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!Rect:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Rect extends " }, { "kind": "Reference", "text": "Point", "canonicalReference": "framer!~Point:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Size", "canonicalReference": "framer!~Size:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Rect", "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Namespace", "canonicalReference": "framer!Rect:namespace", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare namespace Rect " } ], "releaseTag": "Public", "name": "Rect", "members": [ { "kind": "Variable", "canonicalReference": "framer!Rect.center:var", "docComment": "/**\n * @param rect - \n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "center: " }, { "kind": "Content", "text": "(rect: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": ") => {\n x: number;\n y: number;\n }" } ], "releaseTag": "Beta", "name": "center", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Variable", "canonicalReference": "framer!Rect.containsPoint:var", "docComment": "/**\n * Checks if a rectangle contains a point\n *\n * @param rect - The rectangle to check\n *\n * @param point - The point to check\n *\n * @returns true if the provided rectangle contains the provided point\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containsPoint: " }, { "kind": "Content", "text": "(rect: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": ", point: " }, { "kind": "Reference", "text": "Point", "canonicalReference": "framer!~Point:interface" }, { "kind": "Content", "text": ") => boolean" } ], "releaseTag": "Beta", "name": "containsPoint", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Variable", "canonicalReference": "framer!Rect.containsRect:var", "docComment": "/**\n * Returns wether a rect contains another rect entirely\n *\n * @param rectA - \n *\n * @param rectB - \n *\n * @returns true if rectA contains rectB\n */\n", "excerptTokens": [ { "kind": "Content", "text": "containsRect: " }, { "kind": "Content", "text": "(rectA: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": ", rectB: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": ") => boolean" } ], "releaseTag": "Public", "name": "containsRect", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Function", "canonicalReference": "framer!Rect.equals:function(1)", "docComment": "/**\n * @param rect - \n *\n * @param other - \n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function equals(rect: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ", other: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "rect", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "parameterName": "other", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "equals" }, { "kind": "Variable", "canonicalReference": "framer!Rect.isEqual:var", "docComment": "/**\n * @param rectA - \n *\n * @param rectB - \n *\n * @returns if the input rectangles are equal in size and position\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isEqual: " }, { "kind": "Content", "text": "(rectA: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": " | null, rectB: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": " | null) => boolean" } ], "releaseTag": "Public", "name": "isEqual", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Variable", "canonicalReference": "framer!Rect.maxX:var", "docComment": "/**\n * @param rect - \n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxX: " }, { "kind": "Content", "text": "(rect: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": ") => number" } ], "releaseTag": "Beta", "name": "maxX", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Variable", "canonicalReference": "framer!Rect.maxY:var", "docComment": "/**\n * @param rect - \n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "maxY: " }, { "kind": "Content", "text": "(rect: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": ") => number" } ], "releaseTag": "Beta", "name": "maxY", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Variable", "canonicalReference": "framer!Rect.minX:var", "docComment": "/**\n * @param rect - \n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minX: " }, { "kind": "Content", "text": "(rect: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": ") => number" } ], "releaseTag": "Beta", "name": "minX", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Variable", "canonicalReference": "framer!Rect.minY:var", "docComment": "/**\n * @param rect - \n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "minY: " }, { "kind": "Content", "text": "(rect: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": ") => number" } ], "releaseTag": "Beta", "name": "minY", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Variable", "canonicalReference": "framer!Rect.transform:var", "docComment": "/**\n * Takes a rect and transforms it by a matrix, resulting in the bounding rectangle of the rotated and/or translated original.\n *\n * @param rect - rectangle to transform\n *\n * @param matrix - matrix to transform by\n *\n * @returns The bounding rectangle of the rotated and/or translated rect.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "transform: " }, { "kind": "Content", "text": "(rect: " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" }, { "kind": "Content", "text": ", matrix: " }, { "kind": "Reference", "text": "DOMMatrixReadOnly", "canonicalReference": "!DOMMatrixReadOnly:interface" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Rect", "canonicalReference": "framer!Rect:interface" } ], "releaseTag": "Public", "name": "transform", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 7 } } ] }, { "kind": "Enum", "canonicalReference": "framer!RenderTarget:enum", "docComment": "/**\n * The `RenderTarget` represents the current environment in which a component is running. This is most commonly either the editor canvas in Framer or in the generated preview window.\n *\n * @remarks\n *\n * Code components can use the `RenderTarget.current()` method to check for the environment within their components and vary rendering accordingly. The most common case would be to improve performance while rendering in the Framer canvas where components that take too long to render will be replaced with a placeholder. The `RenderTarget.hasRestrictions()` method can be used to check explicitly for this case.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum RenderTarget " } ], "releaseTag": "Public", "name": "RenderTarget", "members": [ { "kind": "EnumMember", "canonicalReference": "framer!RenderTarget.canvas:member", "docComment": "/**\n * The component is to be rendered for the Framer canvas.\n *\n * @remarks\n * ```jsx\n * function App() {\n * if (RenderTarget.current() === RenderTarget.canvas) {\n * return \n * }\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "canvas = " }, { "kind": "Content", "text": "\"CANVAS\"" } ], "releaseTag": "Public", "name": "canvas", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!RenderTarget.export:member", "docComment": "/**\n * The component is to be rendered for export.\n *\n * @remarks\n * ```jsx\n * function App() {\n * if (RenderTarget.current() === RenderTarget.export) {\n * return \n * }\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export = " }, { "kind": "Content", "text": "\"EXPORT\"" } ], "releaseTag": "Public", "name": "export", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!RenderTarget.preview:member", "docComment": "/**\n * The component is being rendered in the preview window.\n *\n * @remarks\n * ```jsx\n * function App() {\n * React.useEffect(() => {\n * if (RenderTarget.current() === RenderTarget.preview) {\n * // Do something in preview.\n * }\n * })\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preview = " }, { "kind": "Content", "text": "\"PREVIEW\"" } ], "releaseTag": "Public", "name": "preview", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "framer!RenderTarget.thumbnail:member", "docComment": "/**\n * The component is to be rendered as a preview thumbnail, for example in the component panel.\n *\n * @remarks\n * ```jsx\n * function App() {\n * if (RenderTarget.current() === RenderTarget.thumbnail) {\n * return \n * }\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "thumbnail = " }, { "kind": "Content", "text": "\"THUMBNAIL\"" } ], "releaseTag": "Public", "name": "thumbnail", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } } ] }, { "kind": "Namespace", "canonicalReference": "framer!RenderTarget:namespace", "docComment": "/**\n * @internalRemarks\n *\n * This is a read-only equivalent of RenderEnvironment.target that is exposed to components for context-dependent rendering\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare namespace RenderTarget " } ], "releaseTag": "Public", "name": "RenderTarget", "members": [ { "kind": "Function", "canonicalReference": "framer!RenderTarget.current:function(1)", "docComment": "/**\n * Returns the current `RenderTarget` allowing components to apply different behaviors depending on the environment.\n *\n * @remarks\n * ```jsx\n * function App() {\n * if (RenderTarget.current() === RenderTarget.thumbnail) {\n * return \n * }\n * return ...\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function current(): " }, { "kind": "Reference", "text": "RenderTarget", "canonicalReference": "framer!RenderTarget:enum" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "current" }, { "kind": "Function", "canonicalReference": "framer!RenderTarget.hasRestrictions:function(1)", "docComment": "/**\n * Returns true if the current `RenderTarget` has performance restrictions. Use this to avoid doing heavy work in these contexts because they may bail on the rendering if the component takes too long.\n *\n * @remarks\n * ```jsx\n * function App() {\n * if (RenderTarget.hasRestrictions()) {\n * return \n * }\n * return \n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function hasRestrictions(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "hasRestrictions" } ] }, { "kind": "Function", "canonicalReference": "framer!Scroll:function(1)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function Scroll(props: " }, { "kind": "Reference", "text": "ScrollProps", "canonicalReference": "framer!ScrollProps:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "JSX.Element", "canonicalReference": "@types/react!~__global.JSX.Element:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "props", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "Scroll" }, { "kind": "Interface", "canonicalReference": "framer!ScrollConfig:interface", "docComment": "/**\n * The properties for the {@link Scroll} component, which are also available within other components, like {@link Page}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ScrollConfig " } ], "releaseTag": "Public", "name": "ScrollConfig", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!ScrollConfig#contentHeight:member", "docComment": "/**\n * Height of the scrollable content.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentHeight?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "contentHeight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ScrollConfig#contentOffsetX:member", "docComment": "/**\n * Horizontal offset of the scrollable content. Set to `0` by default\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentOffsetX?: " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "contentOffsetX", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ScrollConfig#contentOffsetY:member", "docComment": "/**\n * Vertical offset of the scrollable content. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentOffsetY?: " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": " | number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "contentOffsetY", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ScrollConfig#contentWidth:member", "docComment": "/**\n * Width of the scrollable content.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "contentWidth?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "contentWidth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ScrollConfig#direction:member", "docComment": "/**\n * Controls the axis of drag-scrolling. Defaults to `\"vertical\"` for vertical scrolling.\n *\n * @remarks\n *\n * Set `\"horizontal\"` or `\"vertical\"` to only drag in a specific direction. Set `\"both\"` to drag both directions.\n * ```jsx\n * // Horizontal\n * \n *\n * // Vertical\n * \n *\n * // Locked\n * \n *\n * // Both directions\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "direction?: " }, { "kind": "Content", "text": "\"horizontal\" | \"vertical\" | \"both\"" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "direction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ScrollConfig#directionLock:member", "docComment": "/**\n * If `true`, this will lock dragging to the initial direction.\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "directionLock?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "directionLock", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ScrollConfig#dragEnabled:member", "docComment": "/**\n * Enable or disable dragging to scroll. Defaults to `true`.\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "dragEnabled?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "dragEnabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ScrollConfig#scrollAnimate:member", "docComment": "/**\n * Add a custom control for the scroll animation.\n *\n * @remarks\n * ```jsx\n * const controls = useAnimation()\n * controls.start({ y: -50 })\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "scrollAnimate?: " }, { "kind": "Reference", "text": "FrameProps", "canonicalReference": "framer!FrameProps:interface" }, { "kind": "Content", "text": "[\"animate\"]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "scrollAnimate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!ScrollConfig#wheelEnabled:member", "docComment": "/**\n * Enable or disable wheel scroll. Defaults to `true`.\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "wheelEnabled?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "wheelEnabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!ScrollEvents:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ScrollEvents " } ], "releaseTag": "Public", "name": "ScrollEvents", "members": [ { "kind": "MethodSignature", "canonicalReference": "framer!ScrollEvents#onScroll:member(1)", "docComment": "/**\n * Called periodically during scrolling.\n *\n * @remarks\n * ```jsx\n * function onScroll(info) {\n * console.log(info.offset, info.velocity)\n * }\n *\n * \n * ```\n *\n * @param info - An {@link PanInfo} object containing `x` and `y` values for:\n *\n * - `point`: Relative to the device or page. - `delta`: Distance moved since the last event. - `offset`: Offset from the original pan event. - `velocity`: Current velocity of the pointer.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onScroll?(info: " }, { "kind": "Reference", "text": "PanInfo", "canonicalReference": "framer-motion!PanInfo:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "info", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "onScroll" }, { "kind": "MethodSignature", "canonicalReference": "framer!ScrollEvents#onScrollEnd:member(1)", "docComment": "/**\n * Called when scrolling ends.\n *\n * @remarks\n * ```jsx\n * function onScrollEnd(info) {\n * console.log(info.offset, info.velocity)\n * }\n *\n * \n * ```\n *\n * @param info - An {@link PanInfo} object containing `x` and `y` values for:\n *\n * - `point`: Relative to the device or page. - `delta`: Distance moved since the last event. - `offset`: Offset from the original pan event. - `velocity`: Current velocity of the pointer.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onScrollEnd?(info: " }, { "kind": "Reference", "text": "PanInfo", "canonicalReference": "framer-motion!PanInfo:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "info", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "onScrollEnd" }, { "kind": "MethodSignature", "canonicalReference": "framer!ScrollEvents#onScrollStart:member(1)", "docComment": "/**\n * Called when scrolling starts.\n *\n * @remarks\n * ```jsx\n * function onScrollStart(info) {\n * console.log(info.offset, info.velocity)\n * }\n *\n * \n * ```\n *\n * @param info - An {@link PanInfo} object containing `x` and `y` values for:\n *\n * - `point`: Relative to the device or page. - `delta`: Distance moved since the last event. - `offset`: Offset from the original pan event. - `velocity`: Current velocity of the pointer.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "onScrollStart?(info: " }, { "kind": "Reference", "text": "PanInfo", "canonicalReference": "framer-motion!PanInfo:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "info", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "onScrollStart" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!ScrollProps:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ScrollProps extends " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "framer!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "FrameProps", "canonicalReference": "framer!FrameProps:interface" }, { "kind": "Content", "text": ">, \"onScroll\" | \"size\" | \"overflow\">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ScrollEvents", "canonicalReference": "framer!ScrollEvents:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ScrollConfig", "canonicalReference": "framer!ScrollConfig:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ScrollProps", "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 7 }, { "startIndex": 8, "endIndex": 9 }, { "startIndex": 10, "endIndex": 12 } ] }, { "kind": "Interface", "canonicalReference": "framer!SegmentedEnumControlDescription:interface", "docComment": "/**\n * @deprecated\n *\n * - Use {@link EnumControlDescription} instead, and enable displaySegmentedControl.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SegmentedEnumControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "SegmentedEnumControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!SegmentedEnumControlDescription#defaultValue:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "defaultValue?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!SegmentedEnumControlDescription#options:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "options: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "options", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!SegmentedEnumControlDescription#optionTitles:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "optionTitles?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "optionTitles", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!SegmentedEnumControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.SegmentedEnum", "canonicalReference": "framer!ControlType.SegmentedEnum:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "framer!Shadow:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Shadow " } ], "releaseTag": "Public", "name": "Shadow", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!Shadow#blur:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "blur: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "blur", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Shadow#color:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "color: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Shadow#x:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "x: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "x", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Shadow#y:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "y: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "y", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Namespace", "canonicalReference": "framer!Shadow:namespace", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare namespace Shadow " } ], "releaseTag": "Public", "name": "Shadow", "members": [ { "kind": "Function", "canonicalReference": "framer!Shadow.is:function(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "function is(shadow: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "shadow", "canonicalReference": "framer!~shadow" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "Shadow", "canonicalReference": "framer!Shadow:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 3, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "shadow", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "is" } ] }, { "kind": "Function", "canonicalReference": "framer!Size:function(1)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "declare function Size(width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Size", "canonicalReference": "framer!~Size:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "width", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "height", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "name": "Size" }, { "kind": "Interface", "canonicalReference": "framer!Size:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "interface Size " } ], "releaseTag": "Public", "name": "Size", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!Size#height:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "height: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "height", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!Size#width:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "width: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "width", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Namespace", "canonicalReference": "framer!Size:namespace", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "declare namespace Size " } ], "releaseTag": "Public", "name": "Size", "members": [ { "kind": "Variable", "canonicalReference": "framer!Size.isZero:var", "docComment": "/**\n * Checks if the size has a zero width and zero height\n *\n * @param size - size to check\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "isZero: " }, { "kind": "Content", "text": "(size: " }, { "kind": "Reference", "text": "Size", "canonicalReference": "framer!~Size:interface" }, { "kind": "Content", "text": ") => boolean" } ], "releaseTag": "Public", "name": "isZero", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Variable", "canonicalReference": "framer!Size.zero:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "zero: " }, { "kind": "Reference", "text": "Size", "canonicalReference": "framer!~Size:interface" } ], "releaseTag": "Public", "name": "zero", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ] }, { "kind": "Variable", "canonicalReference": "framer!Stack:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Stack: " }, { "kind": "Reference", "text": "React.MemoExoticComponent", "canonicalReference": "@types/react!~React.MemoExoticComponent:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "React.ForwardRefExoticComponent", "canonicalReference": "@types/react!~React.ForwardRefExoticComponent:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "StackProperties", "canonicalReference": "framer!StackProperties:interface" }, { "kind": "Content", "text": "> & " }, { "kind": "Reference", "text": "React.RefAttributes", "canonicalReference": "@types/react!~React.RefAttributes:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "HTMLDivElement", "canonicalReference": "!HTMLDivElement:interface" }, { "kind": "Content", "text": ">>>" } ], "releaseTag": "Public", "name": "Stack", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 13 } }, { "kind": "TypeAlias", "canonicalReference": "framer!StackAlignment:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type StackAlignment = " }, { "kind": "Content", "text": "\"start\" | \"center\" | \"end\"" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "StackAlignment", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "framer!StackDirection:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type StackDirection = " }, { "kind": "Content", "text": "\"horizontal\" | \"vertical\"" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "StackDirection", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "framer!StackDistribution:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type StackDistribution = " }, { "kind": "Content", "text": "\"start\" | \"center\" | \"end\" | \"space-between\" | \"space-around\" | \"space-evenly\"" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "StackDistribution", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "framer!StackProperties:interface", "docComment": "/**\n * The Stack component will automatically distribute its contents based on its properties. The Stack component takes the same props as the {@link Frame} component as well as a few additional interface defined below.\n *\n * @remarks\n * ```jsx\n * function MyComponent() {\n * return (\n * \n * \n * \n * \n * \n * )\n * }\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StackProperties extends " }, { "kind": "Reference", "text": "StackSpecificProps", "canonicalReference": "framer!StackSpecificProps:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "FrameProps", "canonicalReference": "framer!FrameProps:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "WillChangeTransformProp", "canonicalReference": "framer!WillChangeTransformProp:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "StackProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!StackProperties#children:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "children?: " }, { "kind": "Reference", "text": "React.ReactNode", "canonicalReference": "@types/react!~React.ReactNode:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StackProperties#className:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "className?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "className", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 7 } ] }, { "kind": "Interface", "canonicalReference": "framer!StackSpecificProps:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StackSpecificProps " } ], "releaseTag": "Public", "name": "StackSpecificProps", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!StackSpecificProps#alignment:member", "docComment": "/**\n * Defines the distribution of the stack contents on the alternative axis to the direction. Can be one of `\"start\"`, `\"end\",` or `\"center\"`. Set to `\"center\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "alignment: " }, { "kind": "Reference", "text": "StackAlignment", "canonicalReference": "framer!StackAlignment:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "alignment", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StackSpecificProps#direction:member", "docComment": "/**\n * Defines the flow direction of the stack contents, either `\"vertical\"` or `\"horizontal\"`. Set to `\"vertical\"` by default.\n *\n * @remarks\n * ```jsx\n * // Vertical\n * \n *\n * // Horizontal\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "direction: " }, { "kind": "Reference", "text": "StackDirection", "canonicalReference": "framer!StackDirection:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "direction", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StackSpecificProps#distribution:member", "docComment": "/**\n * Defines the distribution of the stack contents. Set to `\"space-around\"` by default, which makes the contents spread evenly across the container.\n *\n * @remarks\n *\n * - `\"start\"` — from the leading edge of the container. - `\"center\"` — centered within the container. - `\"end\"` — from the trailing edge of the container. - `\"space-between\"` — spread evenly in the container. - `\"space-around\"` — spread evenly with excess applied at the start / end. - `\"space-evenly\"` — spread with equal padding between contents.\n * ```jsx\n * // Default\n * \n *\n * // Start\n * \n *\n * // Center\n * \n *\n * // End\n * \n *\n * // Space Between\n * \n *\n * // Space Around\n * \n *\n * // Space Evenly\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "distribution: " }, { "kind": "Reference", "text": "StackDistribution", "canonicalReference": "framer!StackDistribution:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "distribution", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StackSpecificProps#gap:member", "docComment": "/**\n * The gap between items in the stack. Set to `10` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gap: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "gap", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StackSpecificProps#padding:member", "docComment": "/**\n * Padding to be applied to all sides of container. Set to `0` by default.\n *\n * @remarks\n *\n * To specify different padding for each side you can provide individual `paddingTop`, `paddingLeft`, `paddingRight` and `paddingBottom` values.\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "padding: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "padding", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StackSpecificProps#paddingBottom:member", "docComment": "/**\n * Value for the bottom padding of the container. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paddingBottom: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "paddingBottom", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StackSpecificProps#paddingLeft:member", "docComment": "/**\n * Value for the left padding of the container. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paddingLeft: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "paddingLeft", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StackSpecificProps#paddingPerSide:member", "docComment": "/**\n * Flag to tell the Stack to ignore the `padding` prop and apply values per-side.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paddingPerSide: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "paddingPerSide", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StackSpecificProps#paddingRight:member", "docComment": "/**\n * Value for the right padding of the container. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paddingRight: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "paddingRight", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StackSpecificProps#paddingTop:member", "docComment": "/**\n * Value for the top padding of the container. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "paddingTop: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "paddingTop", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!StringControlDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StringControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "StringControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!StringControlDescription#defaultValue:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "defaultValue?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StringControlDescription#displayTextArea:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "displayTextArea?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "displayTextArea", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StringControlDescription#obscured:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "obscured?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "obscured", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StringControlDescription#placeholder:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "placeholder?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "placeholder", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!StringControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.String", "canonicalReference": "framer!ControlType.String:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "framer!TextColorProperties:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TextColorProperties " } ], "releaseTag": "Public", "name": "TextColorProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!TextColorProperties#color:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "color: " }, { "kind": "Reference", "text": "Color", "canonicalReference": "framer!~Color:interface" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "framer!TransitionControlDescription:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TransitionControlDescription

extends " }, { "kind": "Reference", "text": "BaseControlDescription", "canonicalReference": "framer!BaseControlDescription:interface" }, { "kind": "Content", "text": "

" } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "P", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "TransitionControlDescription", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!TransitionControlDescription#defaultValue:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "defaultValue?: " }, { "kind": "Content", "text": "null | " }, { "kind": "Reference", "text": "Transition", "canonicalReference": "framer-motion!Transition:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "defaultValue", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "framer!TransitionControlDescription#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Reference", "text": "ControlType.Transition", "canonicalReference": "framer!ControlType.Transition:member" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Function", "canonicalReference": "framer!useIsInCurrentNavigationTarget:function(1)", "docComment": "/**\n * Used to know if a code component is a child of the current screen. This can be useful for resetting timers or interactions that need to trigger on every navigation.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function useIsInCurrentNavigationTarget(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "useIsInCurrentNavigationTarget" }, { "kind": "Function", "canonicalReference": "framer!useNavigation:function(1)", "docComment": "/**\n * @returns NavigationInterface {@link NavigationInterface}\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function useNavigation(): " }, { "kind": "Reference", "text": "NavigationInterface", "canonicalReference": "framer!NavigationInterface:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "useNavigation" }, { "kind": "Function", "canonicalReference": "framer!useVariantState:function(1)", "docComment": "/**\n * Handle stateful logic in Framer Canvas Components.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function useVariantState({ variant, variantProps, " }, { "kind": "Reference", "text": "defaultVariant", "canonicalReference": "framer!~__type#defaultVariant" }, { "kind": "Content", "text": ": externalDefaultVariant, " }, { "kind": "Reference", "text": "transitions", "canonicalReference": "framer!~__type#transitions" }, { "kind": "Content", "text": ": externalTransitions, " }, { "kind": "Reference", "text": "enabledGestures", "canonicalReference": "framer!~__type#enabledGestures" }, { "kind": "Content", "text": ": externalEnabledGestures, " }, { "kind": "Reference", "text": "cycleOrder", "canonicalReference": "framer!~__type#cycleOrder" }, { "kind": "Content", "text": ": externalCycleOrder, }: " }, { "kind": "Content", "text": "{\n defaultVariant: string;\n cycleOrder: string[];\n variant?: string;\n transitions?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": ">;\n variantProps?: " }, { "kind": "Reference", "text": "VariantProps", "canonicalReference": "framer!~VariantProps:type" }, { "kind": "Content", "text": ";\n enabledGestures?: " }, { "kind": "Reference", "text": "EnabledVariantGestures", "canonicalReference": "framer!~EnabledVariantGestures:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "VariantState", "canonicalReference": "framer!~VariantState:interface" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 21, "endIndex": 22 }, "releaseTag": "Beta", "overloadIndex": 1, "parameters": [ { "parameterName": "{ variant, variantProps, defaultVariant: externalDefaultVariant, transitions: externalTransitions, enabledGestures: externalEnabledGestures, cycleOrder: externalCycleOrder, }", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 20 } } ], "name": "useVariantState" }, { "kind": "Variable", "canonicalReference": "framer!version:var", "docComment": "/**\n * This version is automatically updated by the Makefile\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "version = \"1.2.24\"" } ], "releaseTag": "Public", "name": "version", "variableTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "kind": "Interface", "canonicalReference": "framer!VisualProperties:interface", "docComment": "/**\n * @internalremarks\n *\n * do no use separately from FrameProps\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface VisualProperties " } ], "releaseTag": "Public", "name": "VisualProperties", "members": [ { "kind": "PropertySignature", "canonicalReference": "framer!VisualProperties#backfaceVisible:member", "docComment": "/**\n * Sets whether the back face is visible when turned towards the user. Set to `true` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "backfaceVisible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "backfaceVisible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!VisualProperties#border:member", "docComment": "/**\n * Set the CSS border property, which accepts width, style and color. Set to `\"none\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "border: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "border", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!VisualProperties#borderRadius:member", "docComment": "/**\n * Set the CSS border-radius property, in pixels or percentages. Alias for `radius` Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * // Radius with pixels\n * \n *\n * // Radius with percentages\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "borderRadius: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "borderRadius", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!VisualProperties#color:member", "docComment": "/**\n * Set the color for text elements inside of a `Frame`. By default, text within Frames will be rendered in black.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "color: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "color", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!VisualProperties#opacity:member", "docComment": "/**\n * Set the opacity value, which allows you to make elements semi-transparent or entirely hidden. Useful for show-and-hide animations. Set to `1` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "opacity: " }, { "kind": "Content", "text": "number | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "opacity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!VisualProperties#overflow:member", "docComment": "/**\n * Set the CSS overflow property. Set to `\"visible\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "overflow: " }, { "kind": "Content", "text": "\"visible\" | \"hidden\"" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "overflow", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!VisualProperties#preserve3d:member", "docComment": "/**\n * Position the children of the frame in 3D space. Set to `false` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "preserve3d: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "preserve3d", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "framer!VisualProperties#radius:member", "docComment": "/**\n * Set the CSS border-radius property, in pixels or percentages. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * // Radius with pixels\n * \n *\n * // Radius with percentages\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "radius: " }, { "kind": "Content", "text": "number | string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "radius", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!VisualProperties#shadow:member", "docComment": "/**\n * Set the CSS box-shadow property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "shadow: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "MotionValue", "canonicalReference": "framer-motion!MotionValue:class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "shadow", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "framer!VisualProperties#visible:member", "docComment": "/**\n * Defines whether or not the `Frame` is visible. Unlike `opacity`, this property cannot be animated. Set to `true` by default. Maps to CSS.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "visible: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "visible", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "framer!withCSS:var", "docComment": "/**\n * Render a React component with css included in a sibling