framer-motion
Version:
An open source and production-ready motion library for React on the web
15,836 lines • 522 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.3.4",
"schemaVersion": 1002,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"docComment": "",
"name": "framer-motion",
"members": [
{
"kind": "EntryPoint",
"name": "",
"members": [
{
"kind": "Function",
"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 * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "animate"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "V"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "V"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "V"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "V"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "V"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "transition"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "V"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "PlaybackControls"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 27,
"endIndex": 28
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 12
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 15,
"endIndex": 19
}
},
{
"parameterName": "transition",
"parameterTypeTokenRange": {
"startIndex": 22,
"endIndex": 26
}
}
],
"typeParameters": [
{
"typeParameterName": "V",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "animate"
},
{
"kind": "Variable",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "AnimateLayout"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionFeature"
}
],
"releaseTag": "Public",
"name": "AnimateLayoutFeature",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "Variable",
"docComment": "/**\n * `AnimatePresence` enables the animation of components that have been removed from the tree.\n *\n * When adding/removing more than a single child, every child **must** be given a unique `key` prop.\n *\n * @library\n *\n * Any `Frame` components that have an `exit` property defined will animate out when removed from the tree.\n * ```jsx\n * import { Frame, AnimatePresence } from 'framer'\n *\n * // As items are added and removed from `items`\n * export function Items({ items }) {\n * return (\n * <AnimatePresence>\n * {items.map(item => (\n * <Frame\n * key={item.id}\n * initial={{ opacity: 0 }}\n * animate={{ opacity: 1 }}\n * exit={{ opacity: 0 }}\n * />\n * ))}\n * </AnimatePresence>\n * )\n * }\n * ```\n *\n * You can sequence exit animations throughout a tree using variants.\n *\n * @motion\n *\n * Any `motion` components that have an `exit` property defined will animate out when removed from the tree.\n * ```jsx\n * import { motion, AnimatePresence } from 'framer-motion'\n *\n * export const Items = ({ items }) => (\n * <AnimatePresence>\n * {items.map(item => (\n * <motion.div\n * key={item.id}\n * initial={{ opacity: 0 }}\n * animate={{ opacity: 1 }}\n * exit={{ opacity: 0 }}\n * />\n * ))}\n * </AnimatePresence>\n * )\n * ```\n *\n * You can sequence exit animations throughout a tree using variants.\n *\n * If a child contains multiple `motion` components with `exit` props, it will only unmount the child once all `motion` components have finished animating out. Likewise, any components using `usePresence` all need to call `safeToRemove`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "AnimatePresence"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "FunctionComponent"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "AnimatePresenceProps"
},
{
"kind": "Content",
"text": ">"
}
],
"releaseTag": "Public",
"name": "AnimatePresence",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 8
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "AnimatePresenceProps"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "AnimatePresenceProps",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * When a component is removed, there's no longer a chance to update its props. So if a component's `exit` prop is defined as a dynamic variant and you want to pass a new `custom` prop, you can do so via `AnimatePresence`. This will ensure all leaving components animate using the latest data.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "custom"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "custom",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * If set to `true`, `AnimatePresence` will only render one component at a time. The exiting component will finished its exit animation before the entering component is rendered.\n *\n * @library\n * ```jsx\n * function MyComponent({ currentItem }) {\n * return (\n * <AnimatePresence exitBeforeEnter>\n * <Frame key={currentItem} exit={{ opacity: 0 }} />\n * </AnimatePresence>\n * )\n * }\n * ```\n *\n * @motion\n * ```jsx\n * const MyComponent = ({ currentItem }) => (\n * <AnimatePresence exitBeforeEnter>\n * <motion.div key={currentItem} exit={{ opacity: 0 }} />\n * </AnimatePresence>\n * )\n * ```\n *\n * @beta\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "exitBeforeEnter"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Beta",
"name": "exitBeforeEnter",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * By passing `initial={false}`, `AnimatePresence` will disable any initial animations on children that are present when the component is first rendered.\n *\n * @library\n * ```jsx\n * <AnimatePresence initial={false}>\n * {isVisible && (\n * <Frame\n * key=\"modal\"\n * initial={{ opacity: 0 }}\n * animate={{ opacity: 1 }}\n * exit={{ opacity: 0 }}\n * />\n * )}\n * </AnimatePresence>\n * ```\n *\n * @motion\n * ```jsx\n * <AnimatePresence initial={false}>\n * {isVisible && (\n * <motion.div\n * key=\"modal\"\n * initial={{ opacity: 0 }}\n * animate={{ opacity: 1 }}\n * exit={{ opacity: 0 }}\n * />\n * )}\n * </AnimatePresence>\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "initial"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Fires when all exiting nodes have completed animating out.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onExitComplete"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "onExitComplete",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Class",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "AnimateSharedLayout"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Component"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "SharedLayoutProps"
},
{
"kind": "Content",
"text": ", {}, "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"name": "AnimateSharedLayout",
"members": [
{
"kind": "Method",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "componentDidMount"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "componentDidMount"
},
{
"kind": "Method",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "componentDidUpdate"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "componentDidUpdate"
},
{
"kind": "Property",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static "
},
{
"kind": "Reference",
"text": "contextType"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Context"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": "<any, any> | undefined>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "contextType",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 9
},
"isStatic": true
},
{
"kind": "Method",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "render"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "JSX"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Element"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "render"
},
{
"kind": "Method",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "shouldComponentUpdate"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "shouldComponentUpdate"
},
{
"kind": "Property",
"docComment": "/**\n * The methods provided to all children in the shared layout tree.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "syncContext"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "SharedLayoutSyncMethods"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "syncContext",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"isStatic": false
},
{
"kind": "Method",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "updateStacks"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "updateStacks"
}
],
"extendsTokenRange": {
"startIndex": 3,
"endIndex": 11
},
"implementsTokenRanges": []
},
{
"kind": "Function",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "animationControls"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "AnimationControls"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "animationControls"
},
{
"kind": "Interface",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "AnimationControls"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "AnimationControls",
"members": [
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "mount"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "mount"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Instantly set to a set of properties or a variant.\n * ```jsx\n * // With properties\n * controls.set({ opacity: 0 })\n *\n * // With variants\n * controls.set(\"hidden\")\n * ```\n *\n * @internalremarks\n *\n * We could perform a similar trick to `.start` where this can be called before mount and we maintain a list of of pending actions that get applied on mount. But the expectation of `set` is that it happens synchronously and this would be difficult to do before any children have even attached themselves. It's also poor practise and we should discourage render-synchronous `.start` calls rather than lean into this.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "set"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "definition"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ControlsAnimationDefinition"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "definition",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "set"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Starts an animation on all linked components.\n *\n * @remarks\n * ```jsx\n * controls.start(\"variantLabel\")\n * controls.start({\n * x: 0,\n * transition: { duration: 1 }\n * })\n * ```\n *\n * @param definition - Properties or variant label to animate to\n *\n * @param transition - Optional `transtion` to apply to a variant\n *\n * @returns - A `Promise` that resolves when all animations have completed.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "start"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "definition"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ControlsAnimationDefinition"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "transitionOverride"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Transition"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<any>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "definition",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "transitionOverride",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "start"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Stops animations on all linked components.\n * ```jsx\n * controls.stop()\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "stop"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "stop"
}
],
"extendsTokenRanges": []
},
{
"kind": "Variable",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "Animation"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionFeature"
}
],
"releaseTag": "Public",
"name": "AnimationFeature",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "AnimationProps"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "AnimationProps",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * Values to animate to, variant label(s), or `AnimationControls`.\n *\n * @library\n * ```jsx\n * // As values\n * <Frame animate={{ opacity: 1 }} />\n *\n * // As variant\n * <Frame animate=\"visible\" variants={variants} />\n *\n * // Multiple variants\n * <Frame animate={[\"visible\", \"active\"]} variants={variants} />\n *\n * // AnimationControls\n * <Frame animate={animation} />\n * ```\n *\n * @motion\n * ```jsx\n * // As values\n * <motion.div animate={{ opacity: 1 }} />\n *\n * // As variant\n * <motion.div animate=\"visible\" variants={variants} />\n *\n * // Multiple variants\n * <motion.div animate={[\"visible\", \"active\"]} variants={variants} />\n *\n * // AnimationControls\n * <motion.div animate={animation} />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "animate"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "AnimationControls"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TargetAndTransition"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "VariantLabels"
},
{
"kind": "Content",
"text": " | boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "animate",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 8
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * A target to animate to when this component is removed from the tree.\n *\n * This component **must** be the first animatable child of an `AnimatePresence` to enable this exit animation.\n *\n * This limitation exists because React doesn't allow components to defer unmounting until after an animation is complete. Once this limitation is fixed, the `AnimatePresence` component will be unnecessary.\n *\n * @library\n * ```jsx\n * import { Frame, AnimatePresence } from 'framer'\n *\n * export function MyComponent(props) {\n * return (\n * <AnimatePresence>\n * {props.isVisible && (\n * <Frame\n * initial={{ opacity: 0 }}\n * animate={{ opacity: 1 }}\n * exit={{ opacity: 0 }}\n * />\n * )}\n * </AnimatePresence>\n * )\n * }\n * ```\n *\n * @motion\n * ```jsx\n * import { AnimatePresence, motion } from 'framer-motion'\n *\n * export const MyComponent = ({ isVisible }) => {\n * return (\n * <AnimatePresence>\n * {isVisible && (\n * <motion.div\n * initial={{ opacity: 0 }}\n * animate={{ opacity: 1 }}\n * exit={{ opacity: 0 }}\n * />\n * )}\n * </AnimatePresence>\n * )\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "exit"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "TargetAndTransition"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "VariantLabels"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "exit",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Default transition. If no `transition` is defined in `animate`, it will use the transition defined here.\n *\n * @library\n * ```jsx\n * const spring = {\n * type: \"spring\",\n * damping: 10,\n * stiffness: 100\n * }\n *\n * <Frame transition={spring} animate={{ scale: 1.2 }} />\n * ```\n *\n * @motion\n * ```jsx\n * const spring = {\n * type: \"spring\",\n * damping: 10,\n * stiffness: 100\n * }\n *\n * <motion.div transition={spring} animate={{ scale: 1.2 }} />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "transition"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Transition"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "transition",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Variants allow you to define animation states and organise them by name. They allow you to control animations throughout a component tree by switching a single `animate` prop.\n *\n * Using `transition` options like `delayChildren` and `staggerChildren`, you can orchestrate when children animations play relative to their parent.\n *\n * @library\n *\n * After passing variants to one or more `Frame`'s `variants` prop, these variants can be used in place of values on the `animate`, `initial`, `whileFocus`, `whileTap` and `whileHover` props.\n * ```jsx\n * const variants = {\n * active: {\n * backgroundColor: \"#f00\"\n * },\n * inactive: {\n * backgroundColor: \"#fff\",\n * transition: { duration: 2 }\n * }\n * }\n *\n * <Frame variants={variants} animate=\"active\" />\n * ```\n *\n * @motion\n *\n * After passing variants to one or more `motion` component's `variants` prop, these variants can be used in place of values on the `animate`, `initial`, `whileFocus`, `whileTap` and `whileHover` props.\n * ```jsx\n * const variants = {\n * active: {\n * backgroundColor: \"#f00\"\n * },\n * inactive: {\n * backgroundColor: \"#fff\",\n * transition: { duration: 2 }\n * }\n * }\n *\n * <motion.div variants={variants} animate=\"active\" />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "variants"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Variants"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "variants",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * A description of a single axis using non-axis specific terms to denote the min and max value of any axis.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Axis"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Axis",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "max"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "max",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "min"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "min",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * A description of a bounding box describing each axis individually. This allows us to treate each axis generically.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "AxisBox2D"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "AxisBox2D",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "x"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Axis"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "x",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "y"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Axis"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "y",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "AxisBox3D"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "AxisBox2D"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "AxisBox3D",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "z"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Axis"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "z",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
},
{
"kind": "Interface",
"docComment": "/**\n * The transform delta that, when applied to Axis a will visually transform it to Axis b\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "AxisDelta"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "AxisDelta",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "origin"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "origin",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "originPoint"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "originPoint",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "scale"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "scale",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "translate"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "translate",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * A typically user-facing description of a bounding box using traditional t/l/r/b\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "BoundingBox2D"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "BoundingBox2D",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "bottom"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "bottom",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "left"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "left",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "right"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "right",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "top"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "top",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * A 3D bounding box\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "BoundingBox3D"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "BoundingBox2D"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "BoundingBox3D",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "back"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "back",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "front"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "front",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
},
{
"kind": "Interface",
"docComment": "/**\n * The transform delta that, when applied to Box a will visually transform it to Box b.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "BoxDelta"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "BoxDelta",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "x"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "AxisDelta"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "x",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "y"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "AxisDelta"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "y",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Function",
"docComment": "/**\n * Create a batcher to process VisualElements\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "createBatcher"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "SyncLayoutBatcher"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "createBatcher"
},
{
"kind": "Function",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "createCrossfader"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Crossfader"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "createCrossfader"
},
{
"kind": "Function",
"docComment": "/**\n * Create a DOM `motion` component with the provided string. This is primarily intended as a full alternative to `motion` for consumers who have to support environments that don't support `Proxy`.\n * ```javascript\n * import { createDomMotionComponent } from \"framer-motion\"\n *\n * const motion = {\n * div: createDomMotionComponent('div')\n * }\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "createDomMotionComponent"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Content",
"text": "keyof "
},
{
"kind": "Reference",
"text": "MotionComponents"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "MotionComponents"
},
{
"kind": "Content",
"text": "["
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "]"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 16
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 5,
"endIndex": 7
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "createDomMotionComponent"
},
{
"kind": "TypeAlias",
"docComment": "/**\n * I'd rather the return type of `custom` to be implicit but this throws incorrect relative paths in the exported types and API Extractor throws a wobbly.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "CustomDomComponent"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "ForwardRefExoticComponent"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "PropsWithoutRef"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "MotionProps"
},
{
"kind": "Content",
"text": "> & "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "RefAttributes"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "SVGElement"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "HTMLElement"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "CustomDomComponent",
"typeParameters": [
{
"typeParameterName": "Props",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 5,
"endIndex": 25
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "CustomValueType"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "CustomValueType",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "mix"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": any, "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": any) => ("
},
{
"kind": "Reference",
"text": "p"
},
{
"kind": "Content",
"text": ": number) => number | string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "mix",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 9
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "toValue"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "() => number | string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "toValue",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Class",
"docComment": "/**\n * Can manually trigger a drag gesture on one or more `drag`-enabled `motion` components.\n *\n * @library\n * ```jsx\n * const dragControls = useDragControls()\n *\n * function startDrag(event) {\n * dragControls.start(event, { snapToCursor: true })\n * }\n *\n * return (\n * <>\n * <Frame onTapStart={startDrag} />\n * <Frame drag=\"x\" dragControls={dragControls} />\n * </>\n * )\n * ```\n *\n * @motion\n * ```jsx\n * const dragControls = useDragControls()\n *\n * function startDrag(event) {\n * dragControls.start(event, { snapToCursor: true })\n * }\n *\n * return (\n * <>\n * <div onPointerDown={startDrag} />\n * <motion.div drag=\"x\" dragControls={dragControls} />\n * </>\n * )\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "DragControls"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "DragControls",
"members": [
{
"kind": "Method",
"docComment": "/**\n * Start a drag gesture on every `motion` component that has this set of drag controls passed into it via the `dragControls` prop.\n * ```jsx\n * dragControls.start(e, {\n * snapToCursor: true\n * })\n * ```\n *\n * @param event - PointerEvent\n *\n * @param options - Options\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "start"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "TouchEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "PointerEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TouchEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "PointerEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "DragControlOptions"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 26,
"endIndex": 27
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 21
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 24,
"endIndex": 25
}
}
],
"name": "start"
},
{
"kind": "Method",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "updateConstraints"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "updateConstraints"
}
],
"implementsTokenRanges": []
},
{
"kind": "Variable",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "Drag"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionFeature"
}
],
"releaseTag": "Public",
"name": "DragFeature",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "DraggableProps"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "DragHandlers"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "DraggableProps",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * Usually, dragging uses the layout project engine, and applies transforms to the underlying VisualElement. Passing MotionValues as _dragX and _dragY instead applies drag updates to these motion values. This allows you to manually control how updates from a drag gesture on an element is applied.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "_dragX"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<number>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "_dragX",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Usually, dragging uses the layout project engine, and applies transforms to the underlying VisualElement. Passing MotionValues as _dragX and _dragY instead applies drag updates to these motion values. This allows you to manually control how updates from a drag gesture on an element is applied.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "_dragY"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<number>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "_dragY",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Enable dragging for this element. Set to `false` by default. Set `true` to drag in both directions. Set `\"x\"` or `\"y\"` to only drag in a specific direction.\n *\n * @library\n * ```jsx\n * <Frame drag=\"x\" />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div drag=\"x\" />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "drag"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean | \"x\" | \"y\""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "drag",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Applies constraints on the permitted draggable area.\n *\n * It can accept an object of optional `top`, `left`, `right`, and `bottom` values, measured in pixels. This will define a distance the named edge of the draggable component.\n *\n * Alternatively, it can accept a `ref` to another component created with React's `useRef` hook. This `ref` should be passed both to the draggable component's `dragConstraints` prop, and the `ref` of the component you want to use as constraints.\n *\n * @library\n * ```jsx\n * // In pixels\n * <Frame\n * drag=\"x\"\n * dragConstraints={{ left: 0, right: 300 }}\n * />\n *\n * // As a ref to another component\n * function MyComponent() {\n * const constraintsRef = useRef(null)\n *\n * return (\n * <Frame ref={constraintsRef} width={400} height={400}>\n * <Frame drag dragConstraints={constraintsRef} />\n * </Frame>\n * )\n * }\n * ```\n *\n * @motion\n * ```jsx\n * // In pixels\n * <motion.div\n * drag=\"x\"\n * dragConstraints={{ left: 0, right: 300 }}\n * />\n *\n * // As a ref to another component\n * const MyComponent = () => {\n * const constraintsRef = useRef(null)\n *\n * return (\n * <motion.div ref={constraintsRef}>\n * <motion.div drag dragConstraints={constraintsRef} />\n * </motion.div>\n * )\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "dragConstraints"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "false | "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "BoundingBox2D"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "RefObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Element"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "dragConstraints",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 11
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Usually, dragging is initiated by pressing down on a component and moving it. For some use-cases, for instance clicking at an arbitrary point on a video scrubber, we might want to initiate dragging from a different component than the draggable one.\n *\n * By creating a `dragControls` using the `useDragControls` hook, we can pass this into the draggable component's `dragControls` prop. It exposes a `start` method that can start dragging from pointer events on other components.\n *\n * @library\n * ```jsx\n * const dragControls = useDragControls()\n *\n * function startDrag(event) {\n * dragControls.start(event, { snapToCursor: true })\n * }\n *\n * return (\n * <>\n * <Frame onTapStart={startDrag} />\n * <Frame drag=\"x\" dragControls={dragControls} />\n * </>\n * )\n * ```\n *\n * @motion\n * ```jsx\n * const dragControls = useDragControls()\n *\n * function startDrag(event) {\n * dragControls.start(event, { snapToCursor: true })\n * }\n *\n * return (\n * <>\n * <div onPointerDown={startDrag} />\n * <motion.div drag=\"x\" dragControls={dragControls} />\n * </>\n * )\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "dragControls"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "DragControls"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "dragControls",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * If `true`, this will lock dragging to the initially-detected direction. Defaults to `false`.\n *\n * @library\n * ```jsx\n * <Frame drag={true} dragDirectionLock={true} />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div drag dragDirectionLock />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "dragDirectionLock"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "dragDirectionLock",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * The degree of movement allowed outside constraints. 0 = no movement, 1 = full movement. Set to `0.5` by default.\n *\n * @library\n * ```jsx\n * <Frame\n * drag={true}\n * dragConstraints={{ left: 0, right: 300 }}\n * dragElastic={0.2}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * dragConstraints={{ left: 0, right: 300 }}\n * dragElastic={0.2}\n * />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "dragElastic"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean | number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "dragElastic",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * By default, if `drag` is defined on a component then an event listener will be attached to automatically initiate dragging when a user presses down on it.\n *\n * By setting `dragListener` to `false`, this event listener will not be created.\n *\n * @library\n * ```jsx\n * const dragControls = useDragControls()\n *\n * function startDrag(event) {\n * dragControls.start(event, { snapToCursor: true })\n * }\n *\n * return (\n * <>\n * <Frame onTapStart={startDrag} />\n * <Frame\n * drag=\"x\"\n * dragControls={dragControls}\n * dragListener={false}\n * />\n * </>\n * )\n * ```\n *\n * @motion\n * ```jsx\n * const dragControls = useDragControls()\n *\n * function startDrag(event) {\n * dragControls.start(event, { snapToCursor: true })\n * }\n *\n * return (\n * <>\n * <div onPointerDown={startDrag} />\n * <motion.div\n * drag=\"x\"\n * dragControls={dragControls}\n * dragListener={false}\n * />\n * </>\n * )\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "dragListener"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "dragListener",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Apply momentum from the pan gesture to the component when dragging finishes. Set to `true` by default.\n *\n * @library\n * ```jsx\n * <Frame\n * drag={true}\n * dragConstraints={{ left: 0, right: 300 }}\n * dragMomentum={false}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * dragConstraints={{ left: 0, right: 300 }}\n * dragMomentum={false}\n * />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "dragMomentum"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "dragMomentum",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Allows drag gesture propagation to child components. Set to `false` by default.\n *\n * @library\n * ```jsx\n * <Frame drag=\"x\" dragPropagation={true} />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div drag=\"x\" dragPropagation />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "dragPropagation"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "dragPropagation",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Allows you to change dragging inertia parameters. When releasing a draggable Frame, an animation with type `inertia` starts. The animation is based on your dragging velocity. This property allows you to customize it. See {@link https://framer.com/api/animation/#inertia | Inertia} for all properties you can use.\n *\n * @library\n * ```jsx\n * <Frame\n * drag={true}\n * dragTransition={{ bounceStiffness: 600, bounceDamping: 10 }}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * dragTransition={{ bounceStiffness: 600, bounceDamping: 10 }}\n * />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "dragTransition"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "InertiaOptions"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "dragTransition",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * If `dragConstraints` is set to a React ref, this callback will call with the measured drag constraints.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onMeasureDragConstraints"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "constraints"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BoundingBox2D"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "BoundingBox2D"
},
{
"kind": "Content",
"text": " | void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "onMeasureDragConstraints",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 9
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Properties or variant label to animate to while the drag gesture is recognised.\n * ```jsx\n * <motion.div whileDrag={{ scale: 1.2 }} />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "whileDrag"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "VariantLabels"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TargetAndTransition"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "whileDrag",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "DragHandlers"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "DragHandlers",
"members": [
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback function that fires a drag direction is determined.\n *\n * @library\n * ```jsx\n * function onDirectionLock(axis) {\n * console.log(axis)\n * }\n *\n * <Frame\n * drag\n * dragDirectionLock\n * onDirectionLock={onDirectionLock}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * dragDirectionLock\n * onDirectionLock={axis => console.log(axis)}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onDirectionLock"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "axis"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "\"x\" | \"y\""
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "axis",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "onDirectionLock"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback function that fires when the component is dragged.\n *\n * @library\n * ```jsx\n * function onDrag(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame drag onDrag={onDrag} />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * onDrag={\n * (event, info) => console.log(info.point.x, info.point.y)\n * }\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onDrag"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TouchEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "PointerEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PanInfo"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 9
}
},
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "onDrag"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback function that fires when dragging ends.\n *\n * @library\n * ```jsx\n * function onDragEnd(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame drag onDragEnd={onDragEnd} />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * onDragEnd={\n * (event, info) => console.log(info.point.x, info.point.y)\n * }\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onDragEnd"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TouchEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "PointerEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PanInfo"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 9
}
},
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "onDragEnd"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback function that fires when dragging starts.\n *\n * @library\n * ```jsx\n * function onDragStart(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame drag onDragStart={onDragStart} />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * onDragStart={\n * (event, info) => console.log(info.point.x, info.point.y)\n * }\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onDragStart"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TouchEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "PointerEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PanInfo"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 9
}
},
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "onDragStart"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback function that fires when drag momentum/bounce transition finishes.\n *\n * @library\n * ```jsx\n * function onDragTransitionEnd() {\n * console.log('drag transition has ended')\n * }\n *\n * <Frame\n * drag\n * onDragTransitionEnd={onDragTransitionEnd}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * onDragTransitionEnd={() => console.log('Drag transition complete')}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onDragTransitionEnd"
},
{
"kind": "Content",
"text": "?(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "onDragTransitionEnd"
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"docComment": "/**\n * A function that accepts a progress value between `0` and `1` and returns a new one.\n *\n * @library\n * ```jsx\n * const transition = {\n * ease: progress => progress * progress\n * }\n *\n * <Frame\n * animate={{ opacity: 0 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ opacity: 0 }}\n * transition={{\n * duration: 1,\n * ease: progress => progress * progress\n * }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "EasingFunction"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "v"
},
{
"kind": "Content",
"text": ": number) => number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "EasingFunction",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 6
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "EventInfo"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "EventInfo",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "point"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Point2D"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "point",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Variable",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "Exit"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionFeature"
}
],
"releaseTag": "Public",
"name": "ExitFeature",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "FeatureProps"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "MotionProps"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "FeatureProps",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "visualElement"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "visualElement",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "FocusHandlers"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "FocusHandlers",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * Properties or variant label to animate to while the focus gesture is recognised.\n *\n * @motion\n * ```jsx\n * <motion.input whileFocus={{ scale: 1.2 }} />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "whileFocus"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "VariantLabels"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TargetAndTransition"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "whileFocus",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "ForwardRefComponent"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Reference",
"text": "ForwardRefExoticComponent"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PropsWithoutRef"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> & "
},
{
"kind": "Reference",
"text": "RefAttributes"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ForwardRefComponent",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "P",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 7,
"endIndex": 17
}
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "GestureHandlers"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "PanHandlers"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "TapHandlers"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "HoverHandlers"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "FocusHandlers"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "GestureHandlers",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 10
}
},
{
"kind": "Variable",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "Gestures"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionFeature"
}
],
"releaseTag": "Public",
"name": "GesturesFeature",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "HoverHandlers"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "HoverHandlers",
"members": [
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback function that fires when pointer stops hovering over the component.\n *\n * @library\n * ```jsx\n * function onHoverEnd(event) {\n * console.log(\"Hover ends\")\n * }\n *\n * <Frame onHoverEnd={onHoverEnd} />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div onHoverEnd={() => console.log(\"Hover ends\")} />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onHoverEnd"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "EventInfo"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "onHoverEnd"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback function that fires when pointer starts hovering over the component.\n *\n * @library\n * ```jsx\n * function onHoverStart(event) {\n * console.log(\"Hover starts\")\n * }\n *\n * <Frame onHoverStart={onHoverStart} />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div onHoverStart={() => console.log('Hover starts')} />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onHoverStart"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "EventInfo"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "onHoverStart"
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Properties or variant label to animate to while the hover gesture is recognised.\n *\n * @library\n * ```jsx\n * <Frame whileHover={{ scale: 1.2 }} />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div whileHover={{ scale: 1.2 }} />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "whileHover"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "VariantLabels"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TargetAndTransition"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "whileHover",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "HTMLMotionProps"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TagName"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Content",
"text": "keyof "
},
{
"kind": "Reference",
"text": "ReactHTML"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Reference",
"text": "HTMLAttributesWithoutMotionProps"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "UnwrapFactoryAttributes"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ReactHTML"
},
{
"kind": "Content",
"text": "["
},
{
"kind": "Reference",
"text": "TagName"
},
{
"kind": "Content",
"text": "]>, "
},
{
"kind": "Reference",
"text": "UnwrapFactoryElement"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ReactHTML"
},
{
"kind": "Content",
"text": "["
},
{
"kind": "Reference",
"text": "TagName"
},
{
"kind": "Content",
"text": "]>> & "
},
{
"kind": "Reference",
"text": "MotionProps"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "HTMLMotionProps",
"typeParameters": [
{
"typeParameterName": "TagName",
"constraintTokenRange": {
"startIndex": 5,
"endIndex": 7
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 8,
"endIndex": 23
}
},
{
"kind": "Interface",
"docComment": "/**\n * An animation that decelerates a value based on its initial velocity, usually used to implement inertial scrolling.\n *\n * Optionally, `min` and `max` boundaries can be defined, and inertia will snap to these with a spring animation.\n *\n * This animation will automatically precalculate a target value, which can be modified with the `modifyTarget` property.\n *\n * This allows you to add snap-to-grid or similar functionality.\n *\n * Inertia is also the animation used for `dragTransition`, and can be configured via that prop.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Inertia"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Inertia",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * If `min` or `max` is set, this affects the damping of the bounce spring. If set to `0`, spring will oscillate indefinitely. Set to `10` by default.\n *\n * @library\n * ```jsx\n * const transition = {\n * min: 0,\n * max: 100,\n * bounceDamping: 8\n * }\n *\n * <Frame\n * drag\n * dragTransition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * dragTransition={{\n * min: 0,\n * max: 100,\n * bounceDamping: 8\n * }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "bounceDamping"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "bounceDamping",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * If `min` or `max` is set, this affects the stiffness of the bounce spring. Higher values will create more sudden movement. Set to `500` by default.\n *\n * @library\n * ```jsx\n * const transition = {\n * min: 0,\n * max: 100,\n * bounceStiffness: 100\n * }\n *\n * <Frame\n * drag\n * dragTransition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * dragTransition={{\n * min: 0,\n * max: 100,\n * bounceStiffness: 100\n * }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "bounceStiffness"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "bounceStiffness",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * The value to animate from. By default, this is the current state of the animating value.\n *\n * @library\n * ```jsx\n * const transition = {\n * min: 0,\n * max: 100,\n * from: 50\n * }\n *\n * <Frame\n * drag\n * dragTransition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <Frame\n * drag\n * dragTransition={{ from: 50 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number | string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "from",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Maximum constraint. If set, the value will \"bump\" against this value (or immediately snap to it, if the initial animation value exceeds this value).\n *\n * @library\n * ```jsx\n * <Frame\n * drag\n * dragTransition={{ min: 0, max: 100 }}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * dragTransition={{ min: 0, max: 100 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "max"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "max",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Minimum constraint. If set, the value will \"bump\" against this value (or immediately spring to it if the animation starts as less than this value).\n *\n * @library\n * ```jsx\n * <Frame\n * drag\n * dragTransition={{ min: 0, max: 100 }}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * dragTransition={{ min: 0, max: 100 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "min"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "min",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "MethodSignature",
"docComment": "/**\n * A function that receives the automatically-calculated target and returns a new one. Useful for snapping the target to a grid.\n *\n * @library\n * ```jsx\n * const transition = {\n * power: 0,\n * // Snap calculated target to nearest 50 pixels\n * modifyTarget: target => Math.round(target / 50) * 50\n * }\n *\n * <Frame\n * drag\n * dragTransition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * dragTransition={{\n * power: 0,\n * // Snap calculated target to nearest 50 pixels\n * modifyTarget: target => Math.round(target / 50) * 50\n * }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "modifyTarget"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "v"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "v",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "modifyTarget"
},
{
"kind": "PropertySignature",
"docComment": "/**\n * A higher power value equals a further target. Set to `0.8` by default.\n *\n * @library\n * ```jsx\n * const transition = {\n * min: 0,\n * max: 100,\n * power: 0.2\n * }\n *\n * <Frame\n * drag\n * dragTransition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * dragTransition={{ power: 0.2 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "power"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "power",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * End the animation if the distance to the animation target is below this value, and the absolute speed is below `restSpeed`. When the animation ends, the value gets snapped to the animation target. Set to `0.01` by default. Generally the default values provide smooth animation endings, only in rare cases should you need to customize these.\n *\n * @library\n * ```jsx\n * const transition = {\n * min: 0,\n * max: 100,\n * restDelta: 10\n * }\n *\n * <Frame\n * drag\n * dragTransition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * dragTransition={{ restDelta: 10 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "restDelta"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "restDelta",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Adjusting the time constant will change the duration of the deceleration, thereby affecting its feel. Set to `700` by default.\n *\n * @library\n * ```jsx\n * const transition = {\n * min: 0,\n * max: 100,\n * timeConstant: 200\n * }\n *\n * <Frame\n * drag\n * dragTransition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * drag\n * dragTransition={{ timeConstant: 200 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "timeConstant"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "timeConstant",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Set `type` to animate using the inertia animation. Set to `\"tween\"` by default. This can be used for natural deceleration, like momentum scrolling.\n *\n * @library\n * ```jsx\n * const transition = {\n * type: \"inertia\",\n * velocity: 50\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ rotate: 180 }}\n * transition={{ type: \"inertia\", velocity: 50 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "type"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "\"inertia\""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * The initial velocity of the animation. By default this is the current velocity of the component.\n *\n * @library\n * ```jsx\n * const transition = {\n * type: \"inertia\",\n * velocity: 200\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ rotate: 180 }}\n * transition={{ type: 'inertia', velocity: 200 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "velocity"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "velocity",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Function",
"docComment": "/**\n * Check whether a prop name is a valid `MotionProp` key.\n *\n * @param key - Name of the property to check\n *\n * @returns `true` is key is a valid `MotionProp`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "isValidMotionProp"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "isValidMotionProp"
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "KeyframesTarget"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "ResolvedKeyframesTarget"
},
{
"kind": "Content",
"text": " | [null, ..."
},
{
"kind": "Reference",
"text": "CustomValueType"
},
{
"kind": "Content",
"text": "[]] | "
},
{
"kind": "Reference",
"text": "CustomValueType"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "KeyframesTarget",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 9
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "LayoutProps"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "LayoutProps",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * If `true`, this component will automatically animate to its new position when its layout changes.\n * ```jsx\n * <motion.div layout />\n * ```\n *\n * This will perform a layout animation using performant transforms. Part of this technique involved animating an element's scale. This can introduce visual distortions on children, `boxShadow` and `borderRadius`.\n *\n * To correct distortion on immediate children, add `layout` to those too.\n *\n * `boxShadow` and `borderRadius` will automatically be corrected if they are already being animated on this component. Otherwise, set them directly via the `initial` prop.\n *\n * If `layout` is set to `\"position\"`, the size of the component will change instantly and only its position will animate.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "layout"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean | \"position\""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "layout",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Enable shared layout transitions between components for children of `AnimateSharedLayout`.\n *\n * When a component with a layoutId is removed from the React tree, and then added elsewhere, it will visually animate from the previous component's bounding box and its latest animated values.\n * ```jsx\n * <AnimateSharedLayout>\n * {items.map(item => (\n * <motion.li layout>\n * {item.name}\n * {item.isSelected && <motion.div layoutId=\"underline\" />}\n * </motion.li>\n * ))}\n * </AnimateSharedLayout>\n * ```\n *\n * If the previous component remains in the tree it will either get hidden immediately or, if `type=\"crossfade\"` is set on `AnimateSharedLayout`, it will crossfade to the new component.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "layoutId"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "layoutId",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "MethodSignature",
"docComment": "/**\n * A callback that will fire when a layout animation on this component completes.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onLayoutAnimationComplete"
},
{
"kind": "Content",
"text": "?(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "onLayoutAnimationComplete"
}
],
"extendsTokenRanges": []
},
{
"kind": "Variable",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "m"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "import(\"./types\")."
},
{
"kind": "Reference",
"text": "HTMLMotionComponents"
},
{
"kind": "Content",
"text": " & import(\"./types\")."
},
{
"kind": "Reference",
"text": "SVGMotionComponents"
},
{
"kind": "Content",
"text": " & {\n "
},
{
"kind": "Reference",
"text": "custom"
},
{
"kind": "Content",
"text": ": <"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "Component"
},
{
"kind": "Content",
"text": ": string | import(\"react\")."
},
{
"kind": "Reference",
"text": "ComponentClass"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": ", any> | import(\"react\")."
},
{
"kind": "Reference",
"text": "FunctionComponent"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": ">) => import(\"./motion\")."
},
{
"kind": "Reference",
"text": "CustomDomComponent"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": ">;\n}"
}
],
"releaseTag": "Public",
"name": "m",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 25
}
},
{
"kind": "Variable",
"docComment": "/**\n * HTML & SVG components, optimised for use with gestures and animation. These can be used as drop-in replacements for any HTML & SVG component, all CSS & SVG properties are supported.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "motion"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "HTMLMotionComponents"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "SVGMotionComponents"
},
{
"kind": "Content",
"text": " & {\n "
},
{
"kind": "Reference",
"text": "custom"
},
{
"kind": "Content",
"text": ": <"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "Component"
},
{
"kind": "Content",
"text": ": string | "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "ComponentClass"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": ", any> | "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "FunctionComponent"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": ">) => "
},
{
"kind": "Reference",
"text": "CustomDomComponent"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": ">;\n}"
}
],
"releaseTag": "Public",
"name": "motion",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 28
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "MotionAdvancedProps"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "MotionAdvancedProps",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * Custom data to use to resolve dynamic variants differently for each animating component.\n *\n * @library\n * ```jsx\n * const variants = {\n * visible: (custom) => ({\n * opacity: 1,\n * transition: { delay: custom * 0.2 }\n * })\n * }\n *\n * <Frame custom={0} animate=\"visible\" variants={variants} />\n * <Frame custom={1} animate=\"visible\" variants={variants} />\n * <Frame custom={2} animate=\"visible\" variants={variants} />\n * ```\n *\n * @motion\n * ```jsx\n * const variants = {\n * visible: (custom) => ({\n * opacity: 1,\n * transition: { delay: custom * 0.2 }\n * })\n * }\n *\n * <motion.div custom={0} animate=\"visible\" variants={variants} />\n * <motion.div custom={1} animate=\"visible\" variants={variants} />\n * <motion.div custom={2} animate=\"visible\" variants={variants} />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "custom"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "custom",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Set to `false` to prevent inheriting variant changes from its parent.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "inherit"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "inherit",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Function",
"docComment": "/**\n * MotionConfig can be used in combination with the `m` component to cut bundle size and dynamically load only the features you use.\n * ```jsx\n * import {\n * m as motion,\n * AnimationFeature,\n * MotionConfig\n * } from \"framer-motion\"\n *\n * export function App() {\n * return (\n * <MotionConfig features={[AnimationFeature]}>\n * <motion.div animate={{ x: 100 }} />\n * </MotionConfig>\n * )\n * }\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "MotionConfig"
},
{
"kind": "Content",
"text": "({ "
},
{
"kind": "Reference",
"text": "children"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "features"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "transition"
},
{
"kind": "Content",
"text": ", ..."
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": " }: "
},
{
"kind": "Reference",
"text": "MotionConfigProps"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Element"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 16
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "{ children, features, transition, ...props }",
"parameterTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
}
}
],
"name": "MotionConfig"
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "MotionConfigContext"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "MotionConfigContext",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * An array of features to provide to children.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "features"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionFeature"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "features",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Defines a new default transition for the entire tree.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "transition"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Transition"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "transition",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Variable",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "MotionConfigContext"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Context"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "MotionConfigContext"
},
{
"kind": "Content",
"text": ">"
}
],
"releaseTag": "Public",
"name": "MotionConfigContext",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 8
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "MotionFeature"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "MotionFeature",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getComponent"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionProps"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "ComponentType"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "FeatureProps"
},
{
"kind": "Content",
"text": "> | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "getComponent",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 13
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "key",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "shouldRender"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionProps"
},
{
"kind": "Content",
"text": ") => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "shouldRender",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * Props for `motion` components.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "MotionProps"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "AnimationProps"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "VisualElementLifecycles"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "GestureHandlers"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "DraggableProps"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "LayoutProps"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "MotionAdvancedProps"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "MotionProps",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * Properties, variant label or array of variant labels to start in.\n *\n * Set to `false` to initialise with the values in `animate` (disabling the mount animation)\n *\n * @library\n * ```jsx\n * // As values\n * <Frame initial={{ opacity: 1 }} />\n *\n * // As variant\n * <Frame initial=\"visible\" variants={variants} />\n *\n * // Multiple variants\n * <Frame initial={[\"visible\", \"active\"]} variants={variants} />\n *\n * // As false (disable mount animation)\n * <Frame initial={false} animate={{ opacity: 0 }} />\n * ```\n *\n * @motion\n * ```jsx\n * // As values\n * <motion.div initial={{ opacity: 1 }} />\n *\n * // As variant\n * <motion.div initial=\"visible\" variants={variants} />\n *\n * // Multiple variants\n * <motion.div initial={[\"visible\", \"active\"]} variants={variants} />\n *\n * // As false (disable mount animation)\n * <motion.div initial={false} animate={{ opacity: 0 }} />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "initial"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean | "
},
{
"kind": "Reference",
"text": "Target"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "VariantLabels"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "initial",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * @library\n *\n * The React DOM `style` prop, useful for setting CSS properties that aren't explicitly exposed by `Frame` props.\n * ```jsx\n * <Frame style={{ mixBlendMode: \"difference\" }} />\n * ```\n *\n * @motion\n *\n * The React DOM `style` prop, enhanced with support for `MotionValue`s and separate `transform` values.\n * ```jsx\n * export const MyComponent = () => {\n * const x = useMotionValue(0)\n *\n * return <motion.div style={{ x, opacity: 1, scale: 0.5 }} />\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "style"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "MotionStyle"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "style",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "MethodSignature",
"docComment": "/**\n * By default, Framer Motion generates a `transform` property with a sensible transform order. `transformTemplate` can be used to create a different order, or to append/preprend the automatically generated `transform` property.\n *\n * @library\n * ```jsx\n * function transformTemplate({ x, rotate }) {\n * return `rotate(${rotate}deg) translateX(${x}px)`\n * }\n *\n * <Frame x={0} rotate={180} transformTemplate={transformTemplate} />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * style={{ x: 0, rotate: 180 }}\n * transformTemplate={\n * ({ x, rotate }) => `rotate(${rotate}deg) translateX(${x}px)`\n * }\n * />\n * ```\n *\n * @param transform - The latest animated transform props.\n *\n * @param generatedTransform - The transform string as automatically generated by Framer Motion\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "transformTemplate"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "transform"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "TransformProperties"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "generatedTransform"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "transform",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "generatedTransform",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "transformTemplate"
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 4
},
{
"startIndex": 5,
"endIndex": 6
},
{
"startIndex": 7,
"endIndex": 8
},
{
"startIndex": 9,
"endIndex": 10
},
{
"startIndex": 11,
"endIndex": 12
},
{
"startIndex": 13,
"endIndex": 15
}
]
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "MotionStyle"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "MotionCSS"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "MotionTransform"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "MakeMotion"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "SVGPathProperties"
},
{
"kind": "Content",
"text": "> & "
},
{
"kind": "Reference",
"text": "MakeCustomValueType"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "CustomStyles"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "MotionStyle",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 15
}
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "MotionTransform"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "MakeMotion"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TransformProperties"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "MotionTransform",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 7
}
},
{
"kind": "Class",
"docComment": "/**\n * `MotionValue` is used to track the state and velocity of motion values.\n *\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 `MotionValue` class.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "V"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "V",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "MotionValue",
"members": [
{
"kind": "Method",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "clearListeners"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "clearListeners"
},
{
"kind": "Method",
"docComment": "/**\n * Destroy and clean up subscribers to this `MotionValue`.\n *\n * The `MotionValue` hooks like `useMotionValue` and `useTransform` automatically handle the lifecycle of the returned `MotionValue`, so this method is only necessary if you've manually created a `MotionValue` via the `motionValue` function.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "destroy"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "destroy"
},
{
"kind": "Method",
"docComment": "/**\n * Returns the latest state of `MotionValue`\n *\n * @returns - The latest state of `MotionValue`\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "get"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "V"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "get"
},
{
"kind": "Method",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "getPrevious"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "V"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getPrevious"
},
{
"kind": "Method",
"docComment": "/**\n * Returns the latest velocity of `MotionValue`\n *\n * @returns - The latest velocity of `MotionValue`. Returns `0` if the state is non-numerical.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "getVelocity"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getVelocity"
},
{
"kind": "Property",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "hasAnimated"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "hasAnimated",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"isStatic": false
},
{
"kind": "Method",
"docComment": "/**\n * Returns `true` if this value is currently animating.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "isAnimating"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "isAnimating"
},
{
"kind": "Method",
"docComment": "/**\n * Adds a function that will be notified when the `MotionValue` is updated.\n *\n * It returns a function that, when called, will cancel the subscription.\n *\n * When calling `onChange` inside a React component, it should be wrapped with the `useEffect` hook. As it returns an unsubscribe function, this should be returned from the `useEffect` function to ensure you don't add duplicate subscribers..\n *\n * @library\n * ```jsx\n * function MyComponent() {\n * const x = useMotionValue(0)\n * const y = useMotionValue(0)\n * const opacity = useMotionValue(1)\n *\n * useEffect(() => {\n * function updateOpacity() {\n * const maxXY = Math.max(x.get(), y.get())\n * const newOpacity = transform(maxXY, [0, 100], [1, 0])\n * opacity.set(newOpacity)\n * }\n *\n * const unsubscribeX = x.onChange(updateOpacity)\n * const unsubscribeY = y.onChange(updateOpacity)\n *\n * return () => {\n * unsubscribeX()\n * unsubscribeY()\n * }\n * }, [])\n *\n * return <Frame x={x} />\n * }\n * ```\n *\n * @motion\n * ```jsx\n * export const MyComponent = () => {\n * const x = useMotionValue(0)\n * const y = useMotionValue(0)\n * const opacity = useMotionValue(1)\n *\n * useEffect(() => {\n * function updateOpacity() {\n * const maxXY = Math.max(x.get(), y.get())\n * const newOpacity = transform(maxXY, [0, 100], [1, 0])\n * opacity.set(newOpacity)\n * }\n *\n * const unsubscribeX = x.onChange(updateOpacity)\n * const unsubscribeY = y.onChange(updateOpacity)\n *\n * return () => {\n * unsubscribeX()\n * unsubscribeY()\n * }\n * }, [])\n *\n * return <motion.div style={{ x }} />\n * }\n * ```\n *\n * @param subscriber - A function that receives the latest value.\n *\n * @returns A function that, when called, will cancel this subscription.\n *\n * @internalremarks\n *\n * We could look into a `useOnChange` hook if the above lifecycle management proves confusing.\n * ```jsx\n * useOnChange(x, () => {})\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onChange"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "subscription"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Subscriber"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "V"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "subscription",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 8
}
}
],
"name": "onChange"
},
{
"kind": "Method",
"docComment": "/**\n * Sets the state of the `MotionValue`.\n *\n * @remarks\n * ```jsx\n * const x = useMotionValue(0)\n * x.set(10)\n * ```\n *\n * @param latest - Latest value to set.\n *\n * @param render - Whether to notify render subscribers. Defaults to `true`\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "set"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "v"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "V"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "render"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "v",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "render",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "set"
},
{
"kind": "Method",
"docComment": "/**\n * Stop the currently active animation.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "stop"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "stop"
},
{
"kind": "Property",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "updateAndNotify"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "v"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "V"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "render"
},
{
"kind": "Content",
"text": "?: boolean) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "updateAndNotify",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 9
},
"isStatic": false
}
],
"implementsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "None"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "None",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * Set `type` to `false` for an instant transition.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "type"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "false"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * Options for orchestrating the timing of animations.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Orchestration"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Orchestration",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * Delay the animation by this duration (in seconds). Defaults to `0`.\n *\n * @remarks\n * ```javascript\n * const transition = {\n * delay: 0.2\n * }\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "delay"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "delay",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * When using variants, children animations will start after this duration (in seconds). You can add the `transition` property to both the `Frame` and the `variant` directly. Adding it to the `variant` generally offers more flexibility, as it allows you to customize the delay per visual state.\n *\n * @library\n * ```jsx\n * const container = {\n * hidden: { opacity: 0 },\n * show: {\n * opacity: 1,\n * transition: {\n * delayChildren: 0.5\n * }\n * }\n * }\n *\n * const item = {\n * hidden: { opacity: 0 },\n * show: { opacity: 1 }\n * }\n *\n * return (\n * <Frame\n * variants={container}\n * initial=\"hidden\"\n * animate=\"show\"\n * >\n * <Frame variants={item} size={50} />\n * <Frame variants={item} size={50} />\n * </Frame>\n * )\n * ```\n *\n * @motion\n * ```jsx\n * const container = {\n * hidden: { opacity: 0 },\n * show: {\n * opacity: 1,\n * transition: {\n * delayChildren: 0.5\n * }\n * }\n * }\n *\n * const item = {\n * hidden: { opacity: 0 },\n * show: { opacity: 1 }\n * }\n *\n * return (\n * <motion.ul\n * variants={container}\n * initial=\"hidden\"\n * animate=\"show\"\n * >\n * <motion.li variants={item} />\n * <motion.li variants={item} />\n * </motion.ul>\n * )\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "delayChildren"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "delayChildren",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * When using variants, animations of child components can be staggered by this duration (in seconds).\n *\n * For instance, if `staggerChildren` is `0.01`, the first child will be delayed by `0` seconds, the second by `0.01`, the third by `0.02` and so on.\n *\n * The calculated stagger delay will be added to `delayChildren`.\n *\n * @library\n * ```jsx\n * const container = {\n * hidden: { opacity: 0 },\n * show: {\n * opacity: 1,\n * transition: {\n * staggerChildren: 0.5\n * }\n * }\n * }\n *\n * const item = {\n * hidden: { opacity: 0 },\n * show: { opacity: 1 }\n * }\n *\n * return (\n * <Frame\n * variants={container}\n * initial=\"hidden\"\n * animate=\"show\"\n * >\n * <Frame variants={item} size={50} />\n * <Frame variants={item} size={50} />\n * </Frame>\n * )\n * ```\n *\n * @motion\n * ```jsx\n * const container = {\n * hidden: { opacity: 0 },\n * show: {\n * opacity: 1,\n * transition: {\n * staggerChildren: 0.5\n * }\n * }\n * }\n *\n * const item = {\n * hidden: { opacity: 0 },\n * show: { opacity: 1 }\n * }\n *\n * return (\n * <motion.ol\n * variants={container}\n * initial=\"hidden\"\n * animate=\"show\"\n * >\n * <motion.li variants={item} />\n * <motion.li variants={item} />\n * </motion.ol>\n * )\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "staggerChildren"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "staggerChildren",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * The direction in which to stagger children.\n *\n * A value of `1` staggers from the first to the last while `-1` staggers from the last to the first.\n *\n * @library\n * ```jsx\n * const container = {\n * hidden: { opacity: 0 },\n * show: {\n * opacity: 1,\n * transition: {\n * delayChildren: 0.5,\n * staggerDirection: -1\n * }\n * }\n * }\n *\n * const item = {\n * hidden: { opacity: 0 },\n * show: { opacity: 1 }\n * }\n *\n * return (\n * <Frame\n * variants={container}\n * initial=\"hidden\"\n * animate=\"show\"\n * >\n * <Frame variants={item} size={50} />\n * <Frame variants={item} size={50} />\n * </Frame>\n * )\n * ```\n *\n * @motion\n * ```jsx\n * const container = {\n * hidden: { opacity: 0 },\n * show: {\n * opacity: 1,\n * transition: {\n * delayChildren: 0.5,\n * staggerDirection: -1\n * }\n * }\n * }\n *\n * const item = {\n * hidden: { opacity: 0 },\n * show: { opacity: 1 }\n * }\n *\n * return (\n * <motion.ul\n * variants={container}\n * initial=\"hidden\"\n * animate=\"show\"\n * >\n * <motion.li variants={item} size={50} />\n * <motion.li variants={item} size={50} />\n * </motion.ul>\n * )\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "staggerDirection"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "staggerDirection",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Describes the relationship between the transition and its children. Set to `false` by default.\n *\n * @remarks\n *\n * When using variants, the transition can be scheduled in relation to its children with either `\"beforeChildren\"` to finish this transition before starting children transitions, `\"afterChildren\"` to finish children transitions before starting this transition.\n *\n * @library\n * ```jsx\n * const container = {\n * hidden: {\n * opacity: 0,\n * transition: { when: \"afterChildren\" }\n * }\n * }\n *\n * const item = {\n * hidden: {\n * opacity: 0,\n * transition: { duration: 2 }\n * }\n * }\n *\n * return (\n * <Frame variants={container} animate=\"hidden\">\n * <Frame variants={item} size={50} />\n * <Frame variants={item} size={50} />\n * </Frame>\n * )\n * ```\n *\n * @motion\n * ```jsx\n * const list = {\n * hidden: {\n * opacity: 0,\n * transition: { when: \"afterChildren\" }\n * }\n * }\n *\n * const item = {\n * hidden: {\n * opacity: 0,\n * transition: { duration: 2 }\n * }\n * }\n *\n * return (\n * <motion.ul variants={list} animate=\"hidden\">\n * <motion.li variants={item} />\n * <motion.li variants={item} />\n * </motion.ul>\n * )\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "when"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "false | \"beforeChildren\" | \"afterChildren\" | string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "when",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "PanHandlers"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "PanHandlers",
"members": [
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback function that fires when the pan gesture is recognised on this element.\n *\n * @library\n * ```jsx\n * function onPan(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame onPan={onPan} />\n * ```\n *\n * @motion\n * ```jsx\n * function onPan(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <motion.div onPan={onPan} />\n * ```\n *\n * @param event - The originating pointer event.\n *\n * @param info - A {@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",
"excerptTokens": [
{
"kind": "Reference",
"text": "onPan"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TouchEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "PointerEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PanInfo"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 9
}
},
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "onPan"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback function that fires when the pan gesture ends on this element.\n *\n * @library\n * ```jsx\n * function onPanEnd(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame onPanEnd={onPanEnd} />\n * ```\n *\n * @motion\n * ```jsx\n * function onPanEnd(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <motion.div onPanEnd={onPanEnd} />\n * ```\n *\n * @param event - The originating pointer event.\n *\n * @param info - A {@link PanInfo} object containing `x`/`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",
"excerptTokens": [
{
"kind": "Reference",
"text": "onPanEnd"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TouchEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "PointerEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PanInfo"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 9
}
},
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "onPanEnd"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback function that fires when we begin detecting a pan gesture. This is analogous to `onMouseStart` or `onTouchStart`.\n *\n * @library\n * ```jsx\n * function onPanSessionStart(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame onPanSessionStart={onPanSessionStart} />\n * ```\n *\n * @motion\n * ```jsx\n * function onPanSessionStart(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <motion.div onPanSessionStart={onPanSessionStart} />\n * ```\n *\n * @param event - The originating pointer event.\n *\n * @param info - An {@link EventInfo} object containing `x`/`y` values for:\n *\n * - `point`: Relative to the device or page.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onPanSessionStart"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TouchEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "PointerEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "EventInfo"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 9
}
},
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "onPanSessionStart"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback function that fires when the pan gesture begins on this element.\n *\n * @library\n * ```jsx\n * function onPanStart(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame onPanStart={onPanStart} />\n * ```\n *\n * @motion\n * ```jsx\n * function onPanStart(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <motion.div onPanStart={onPanStart} />\n * ```\n *\n * @param event - The originating pointer event.\n *\n * @param info - A {@link PanInfo} object containing `x`/`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",
"excerptTokens": [
{
"kind": "Reference",
"text": "onPanStart"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TouchEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "PointerEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PanInfo"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 9
}
},
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "onPanStart"
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * Passed in to pan event handlers like `onPan` the `PanInfo` object contains information about the current state of the tap gesture such as its `point`, `delta`, `offset` and `velocity`.\n *\n * @library\n * ```jsx\n * function onPan(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame onPan={onPan} />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div onPan={(event, info) => {\n * console.log(info.point.x, info.point.y)\n * }} />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "PanInfo"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "PanInfo",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * Contains `x` and `y` values for the distance moved since the last event.\n *\n * @library\n * ```jsx\n * function onPan(event, info) {\n * console.log(info.delta.x, info.delta.y)\n * }\n *\n * <Frame onPan={onPan} />\n * ```\n *\n * @motion\n * ```jsx\n * function onPan(event, info) {\n * console.log(info.delta.x, info.delta.y)\n * }\n *\n * <motion.div onPan={onPan} />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "delta"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Point2D"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "delta",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Contains `x` and `y` values for the distance moved from the first pan event.\n *\n * @library\n * ```jsx\n * function onPan(event, info) {\n * console.log(info.offset.x, info.offset.y)\n * }\n *\n * <Frame onPan={onPan} />\n * ```\n *\n * @motion\n * ```jsx\n * function onPan(event, info) {\n * console.log(info.offset.x, info.offset.y)\n * }\n *\n * <motion.div onPan={onPan} />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "offset"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Point2D"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "offset",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Contains `x` and `y` values for the current pan position relative to the device or page.\n *\n * @library\n * ```jsx\n * function onPan(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame onPan={onPan} />\n * ```\n *\n * @motion\n * ```jsx\n * function onPan(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <motion.div onPan={onPan} />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "point"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Point2D"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "point",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Contains `x` and `y` values for the current velocity of the pointer.\n *\n * @library\n * ```jsx\n * function onPan(event, info) {\n * console.log(info.velocity.x, info.velocity.y)\n * }\n *\n * <Frame onPan={onPan} />\n * ```\n *\n * @motion\n * ```jsx\n * function onPan(event, info) {\n * console.log(info.velocity.x, info.velocity.y)\n * }\n *\n * <motion.div onPan={onPan} />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "velocity"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Point2D"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "velocity",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "PassiveEffect"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "v"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "safeSetter"
},
{
"kind": "Content",
"text": ": ("
},
{
"kind": "Reference",
"text": "v"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ") => void) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "PassiveEffect",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 5,
"endIndex": 16
}
},
{
"kind": "Interface",
"docComment": "/**\n * A description of a two-dimensional point\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Point2D"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Point2D",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "x"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "x",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "y"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "y",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * A description of a three-dimensional point\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Point3D"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Point2D"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Point3D",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "z"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "z",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
},
{
"kind": "Variable",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "PresenceContext"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "import(\"react\")."
},
{
"kind": "Reference",
"text": "Context"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PresenceContextProps"
},
{
"kind": "Content",
"text": " | null>"
}
],
"releaseTag": "Public",
"name": "PresenceContext",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "RelayoutInfo"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "RelayoutInfo",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "delta"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "{\n "
},
{
"kind": "Reference",
"text": "x"
},
{
"kind": "Content",
"text": ": number;\n "
},
{
"kind": "Reference",
"text": "y"
},
{
"kind": "Content",
"text": ": number;\n "
},
{
"kind": "Reference",
"text": "width"
},
{
"kind": "Content",
"text": ": number;\n "
},
{
"kind": "Reference",
"text": "height"
},
{
"kind": "Content",
"text": ": number;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "delta",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 11
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Repeat"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Repeat",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * The number of times to repeat the transition. Set to `Infinity` for perpetual repeating.\n *\n * Without setting `repeatType`, this will loop the animation.\n *\n * @library\n * ```jsx\n * const transition = {\n * repeat: Infinity,\n * duration: 2\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ rotate: 180 }}\n * transition={{ repeat: Infinity, duration: 2 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "repeat"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "repeat",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * When repeating an animation, `repeatDelay` will set the duration of the time to wait, in seconds, between each repetition.\n *\n * @library\n * ```jsx\n * const transition = {\n * repeat: Infinity,\n * repeatDelay: 1\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ rotate: 180 }}\n * transition={{ repeat: Infinity, repeatDelay: 1 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "repeatDelay"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "repeatDelay",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * How to repeat the animation. This can be either:\n *\n * \"loop\": Repeats the animation from the start\n *\n * \"reverse\": Alternates between forward and backwards playback\n *\n * \"mirror\": Switchs `from` and `to` alternately\n *\n * @library\n * ```jsx\n * const transition = {\n * repeat: 1,\n * repeatType: \"reverse\",\n * duration: 2\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ rotate: 180 }}\n * transition={{\n * repeat: 1,\n * repeatType: \"reverse\",\n * duration: 2\n * }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "repeatType"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "\"loop\" | \"reverse\" | \"mirror\""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "repeatType",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "ResolvedKeyframesTarget"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "[null, ...number[]] | number[] | [null, ...string[]] | string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ResolvedKeyframesTarget",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "ResolvedSingleTarget"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "string | number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ResolvedSingleTarget",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "ResolvedValueTarget"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "ResolvedSingleTarget"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "ResolvedKeyframesTarget"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ResolvedValueTarget",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 6
}
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "ResolveLayoutTransition"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "RelayoutInfo"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "Transition"
},
{
"kind": "Content",
"text": " | boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ResolveLayoutTransition",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 10
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "ScrollMotionValues"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ScrollMotionValues",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "scrollX"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<number>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "scrollX",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "scrollXProgress"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<number>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "scrollXProgress",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "scrollY"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<number>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "scrollY",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "scrollYProgress"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<number>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "scrollYProgress",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "SharedLayoutAnimationConfig"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "SharedLayoutAnimationConfig",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "crossfadeOpacity"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<number>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "crossfadeOpacity",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "onComplete"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "onComplete",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "originBox"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "AxisBox2D"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "originBox",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "shouldStackAnimate"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "shouldStackAnimate",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "targetBox"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "AxisBox2D"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "targetBox",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "transition"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Transition"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "transition",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "visibilityAction"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "VisibilityAction"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "visibilityAction",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Variable",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "SharedLayoutContext"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "import(\"react\")."
},
{
"kind": "Reference",
"text": "Context"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "SyncLayoutBatcher"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "SharedLayoutSyncMethods"
},
{
"kind": "Content",
"text": ">"
}
],
"releaseTag": "Public",
"name": "SharedLayoutContext",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 9
}
},
{
"kind": "Interface",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "SharedLayoutProps"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "SharedLayoutProps",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "children"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "ReactNode"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "children",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * When combined with `AnimatePresence`, `SharedLayoutProps` can customise how to visually switch between `layoutId` components as new ones enter and leave the tree.\n *\n * - \"switch\" (default): The old `layoutId` component will be hidden instantly when a new one enters, and the new one will perform the full transition. When the newest one is removed, it will perform the full exit transition and then the old component will be shown instantly. - \"crossfade\": The root shared components will crossfade as `layoutId` children of both perform the same transition.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "type"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "\"switch\" | \"crossfade\""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * Extra API methods available to children if they're a descendant of AnimateSharedLayout\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "SharedLayoutSyncMethods"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "SyncLayoutBatcher"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "SharedLayoutSyncMethods",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "forceUpdate"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "forceUpdate",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "register"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "child"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "register",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "remove"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "child"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "remove",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "syncUpdate"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "force"
},
{
"kind": "Content",
"text": "?: boolean) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "syncUpdate",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "SingleTarget"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "ResolvedSingleTarget"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "CustomValueType"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "SingleTarget",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 6
}
},
{
"kind": "Interface",
"docComment": "/**\n * An animation that simulates spring physics for realistic motion. This is the default animation for physical values like `x`, `y`, `scale` and `rotate`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Spring"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Repeat"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Spring",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * `bounce` determines the \"bounciness\" of a spring animation.\n *\n * `0` is no bounce, and `1` is extremely bouncy.\n *\n * If `duration` is set, this defaults to `0.25`.\n *\n * Note: `bounce` and `duration` will be overridden if `stiffness`, `damping` or `mass` are set.\n *\n * @library\n * ```jsx\n * const transition = {\n * type: \"spring\",\n * bounce: 0.25\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ x: 100 }}\n * transition={{ type: \"spring\", bounce: 0.25 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "bounce"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "bounce",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Strength of opposing force. If set to 0, spring will oscillate indefinitely. Set to `10` by default.\n *\n * @library\n * ```jsx\n * const transition = {\n * type: \"spring\",\n * damping: 300\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.a\n * animate={{ rotate: 180 }}\n * transition={{ type: 'spring', damping: 300 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "damping"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "damping",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * The duration of the animation, defined in seconds. Spring animations can be a maximum of 10 seconds.\n *\n * If `bounce` is set, this defaults to `0.8`.\n *\n * Note: `duration` and `bounce` will be overridden if `stiffness`, `damping` or `mass` are set.\n *\n * @library\n * ```jsx\n * const transition = {\n * type: \"spring\",\n * duration: 0.8\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ x: 100 }}\n * transition={{ type: \"spring\", duration: 0.8 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "duration"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "duration",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * The value to animate from. By default, this is the initial state of the animating value.\n *\n * @library\n * ```jsx\n * const transition = {\n * type: \"spring\",\n * from: 90\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ rotate: 180 }}\n * transition={{ type: 'spring', from: 90 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number | string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "from",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Mass of the moving object. Higher values will result in more lethargic movement. Set to `1` by default.\n *\n * @library\n * ```jsx\n * const transition = {\n * type: \"spring\",\n * mass: 0.5\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.feTurbulence\n * animate={{ baseFrequency: 0.5 } as any}\n * transition={{ type: \"spring\", mass: 0.5 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "mass"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "mass",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * End animation if distance is below this value and speed is below `restSpeed`. When animation ends, spring gets “snapped” to. Set to `0.01` by default.\n *\n * @library\n * ```jsx\n * const transition = {\n * type: \"spring\",\n * restDelta: 0.5\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ rotate: 180 }}\n * transition={{ type: 'spring', restDelta: 0.5 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "restDelta"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "restDelta",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * End animation if absolute speed (in units per second) drops below this value and delta is smaller than `restDelta`. Set to `0.01` by default.\n *\n * @library\n * ```jsx\n * const transition = {\n * type: \"spring\",\n * restSpeed: 0.5\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ rotate: 180 }}\n * transition={{ type: 'spring', restSpeed: 0.5 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "restSpeed"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "restSpeed",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Stiffness of the spring. Higher values will create more sudden movement. Set to `100` by default.\n *\n * @library\n * ```jsx\n * const transition = {\n * type: \"spring\",\n * stiffness: 50\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.section\n * animate={{ rotate: 180 }}\n * transition={{ type: 'spring', stiffness: 50 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "stiffness"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "stiffness",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Set `type` to `\"spring\"` to animate using spring physics for natural movement. Type is set to `\"spring\"` by default.\n *\n * @library\n * ```jsx\n * const transition = {\n * type: \"spring\"\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ rotate: 180 }}\n * transition={{ type: 'spring' }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "type"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "\"spring\""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * The initial velocity of the spring. By default this is the current velocity of the component.\n *\n * @library\n * ```jsx\n * const transition = {\n * type: \"spring\",\n * velocity: 2\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ rotate: 180 }}\n * transition={{ type: 'spring', velocity: 2 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "velocity"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "velocity",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "Subscriber"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "v"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "Subscriber",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 5,
"endIndex": 10
}
},
{
"kind": "TypeAlias",
"docComment": "/**\n * Blanket-accept any SVG attribute as a `MotionValue`\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "SVGAttributesAsMotionValues"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Reference",
"text": "MakeMotion"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "SVGAttributesWithoutMotionProps"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "SVGAttributesAsMotionValues",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 5,
"endIndex": 11
}
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "SVGMotionProps"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "> extends "
},
{
"kind": "Reference",
"text": "SVGAttributesAsMotionValues"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "MotionProps"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "SVGMotionProps",
"members": [],
"extendsTokenRanges": [
{
"startIndex": 5,
"endIndex": 9
},
{
"startIndex": 10,
"endIndex": 12
}
]
},
{
"kind": "Interface",
"docComment": "/**\n * Handlers for batching sync layout lifecycles. We batches these processes to cut down on layout thrashing\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "SyncLayoutLifecycles"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "SyncLayoutLifecycles",
"members": [
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "layoutReady"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "child"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "layoutReady",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "measureLayout"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "child"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "measureLayout",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "parent"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "parent",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "TapHandlers"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "TapHandlers",
"members": [
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback when the tap gesture successfully ends on this element.\n *\n * @library\n * ```jsx\n * function onTap(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame onTap={onTap} />\n * ```\n *\n * @motion\n * ```jsx\n * function onTap(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <motion.div onTap={onTap} />\n * ```\n *\n * @param event - The originating pointer event.\n *\n * @param info - An {@link TapInfo} object containing `x` and `y` values for the `point` relative to the device or page.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onTap"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TouchEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "PointerEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "TapInfo"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 9
}
},
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "onTap"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback when the tap gesture ends outside this element.\n *\n * @library\n * ```jsx\n * function onTapCancel(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame onTapCancel={onTapCancel} />\n * ```\n *\n * @motion\n * ```jsx\n * function onTapCancel(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <motion.div onTapCancel={onTapCancel} />\n * ```\n *\n * @param event - The originating pointer event.\n *\n * @param info - An {@link TapInfo} object containing `x` and `y` values for the `point` relative to the device or page.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onTapCancel"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TouchEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "PointerEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "TapInfo"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 9
}
},
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "onTapCancel"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback when the tap gesture starts on this element.\n *\n * @library\n * ```jsx\n * function onTapStart(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame onTapStart={onTapStart} />\n * ```\n *\n * @motion\n * ```jsx\n * function onTapStart(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <motion.div onTapStart={onTapStart} />\n * ```\n *\n * @param event - The originating pointer event.\n *\n * @param info - An {@link TapInfo} object containing `x` and `y` values for the `point` relative to the device or page.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onTapStart"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "event"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MouseEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TouchEvent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "PointerEvent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "TapInfo"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "event",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 9
}
},
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "onTapStart"
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Properties or variant label to animate to while the component is pressed.\n *\n * @library\n * ```jsx\n * <Frame whileTap={{ scale: 0.8 }} />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div whileTap={{ scale: 0.8 }} />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "whileTap"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "VariantLabels"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TargetAndTransition"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "whileTap",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"docComment": "/**\n * Passed in to tap event handlers like `onTap` the `TapInfo` object contains information about the tap gesture such as it‘s location.\n *\n * @library\n * ```jsx\n * function onTap(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame onTap={onTap} />\n * ```\n *\n * @motion\n * ```jsx\n * function onTap(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <motion.div onTap={onTap} />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "TapInfo"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "TapInfo",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * Contains `x` and `y` values for the tap gesture relative to the device or page.\n *\n * @library\n * ```jsx\n * function onTapStart(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <Frame onTapStart={onTapStart} />\n * ```\n *\n * @motion\n * ```jsx\n * function onTapStart(event, info) {\n * console.log(info.point.x, info.point.y)\n * }\n *\n * <motion.div onTapStart={onTapStart} />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "point"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Point2D"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "point",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "Target"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "MakeCustomValueType"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "TargetProperties"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "Target",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 7
}
},
{
"kind": "TypeAlias",
"docComment": "/**\n * An object that specifies values to animate to. Each value may be set either as a single value, or an array of values.\n *\n * It may also option contain these properties:\n *\n * - `transition`: Specifies transitions for all or individual values. - `transitionEnd`: Specifies values to set when the animation finishes.\n * ```jsx\n * const target = {\n * x: \"0%\",\n * opacity: 0,\n * transition: { duration: 1 },\n * transitionEnd: { display: \"none\" }\n * }\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "TargetAndTransition"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "TargetWithKeyframes"
},
{
"kind": "Content",
"text": " & {\n "
},
{
"kind": "Reference",
"text": "transition"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Transition"
},
{
"kind": "Content",
"text": ";\n "
},
{
"kind": "Reference",
"text": "transitionEnd"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Target"
},
{
"kind": "Content",
"text": ";\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "TargetAndTransition",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 13
}
},
{
"kind": "Function",
"docComment": "/**\n * Transforms numbers into other values by mapping them from an input range to an output range. Returns the type of the input provided.\n *\n * @remarks\n *\n * Given an input range of `[0, 200]` and an output range of `[0, 1]`, this function will return a value between `0` and `1`. The input range must be a linear series of numbers. The output range can be any supported value type, such as numbers, colors, shadows, arrays, objects and more. Every value in the output range must be of the same type and in the same format.\n *\n * @library\n * ```jsx\n * import * as React from \"react\"\n * import { Frame, transform } from \"framer\"\n *\n * export function MyComponent() {\n * const inputRange = [0, 200]\n * const outputRange = [0, 1]\n * const output = transform(100, inputRange, outputRange)\n *\n * // Returns 0.5\n * return <Frame>{output}</Frame>\n * }\n * ```\n *\n * @motion\n * ```jsx\n * import * as React from \"react\"\n * import { transform } from \"framer-motion\"\n *\n * export function MyComponent() {\n * const inputRange = [0, 200]\n * const outputRange = [0, 1]\n * const output = transform(100, inputRange, outputRange)\n *\n * // Returns 0.5\n * return <div>{output}</div>\n * }\n * ```\n *\n * @param inputValue - A number to transform between the input and output ranges.\n *\n * @param inputRange - A linear series of numbers (either all increasing or decreasing).\n *\n * @param outputRange - A series of numbers, colors, strings, or arrays/objects of those. Must be the same length as `inputRange`.\n *\n * @param options - Clamp: Clamp values to within the given range. Defaults to `true`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "transform"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "inputValue"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "inputRange"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number[]"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "outputRange"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "TransformOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 25,
"endIndex": 26
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "inputValue",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
},
{
"parameterName": "inputRange",
"parameterTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
}
},
{
"parameterName": "outputRange",
"parameterTypeTokenRange": {
"startIndex": 15,
"endIndex": 17
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 20,
"endIndex": 24
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "transform"
},
{
"kind": "Function",
"docComment": "/**\n * @library\n *\n * For improved performance, `transform` can pre-calculate the function that will transform a value between two ranges. Returns a function.\n * ```jsx\n * import * as React from \"react\"\n * import { Frame, transform } from \"framer\"\n *\n * export function MyComponent() {\n * const inputRange = [-200, -100, 100, 200]\n * const outputRange = [0, 1, 1, 0]\n * const convertRange = transform(inputRange, outputRange)\n * const output = convertRange(-150)\n *\n * // Returns 0.5\n * return <Frame>{output}</Frame>\n * }\n *\n * ```\n *\n * @motion\n *\n * Transforms numbers into other values by mapping them from an input range to an output range.\n *\n * Given an input range of `[0, 200]` and an output range of `[0, 1]`, this function will return a value between `0` and `1`. The input range must be a linear series of numbers. The output range can be any supported value type, such as numbers, colors, shadows, arrays, objects and more. Every value in the output range must be of the same type and in the same format.\n * ```jsx\n * import * as React from \"react\"\n * import { Frame, transform } from \"framer\"\n *\n * export function MyComponent() {\n * const inputRange = [-200, -100, 100, 200]\n * const outputRange = [0, 1, 1, 0]\n * const convertRange = transform(inputRange, outputRange)\n * const output = convertRange(-150)\n *\n * // Returns 0.5\n * return <div>{output}</div>\n * }\n *\n * ```\n *\n * @param inputRange - A linear series of numbers (either all increasing or decreasing).\n *\n * @param outputRange - A series of numbers, colors or strings. Must be the same length as `inputRange`.\n *\n * @param options - Clamp: clamp values to within the given range. Defaults to `true`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "transform"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "inputRange"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number[]"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "outputRange"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "TransformOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "inputValue"
},
{
"kind": "Content",
"text": ": number) => "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 21,
"endIndex": 25
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "inputRange",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
},
{
"parameterName": "outputRange",
"parameterTypeTokenRange": {
"startIndex": 11,
"endIndex": 13
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 16,
"endIndex": 20
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "transform"
},
{
"kind": "TypeAlias",
"docComment": "/**\n * A function that accepts a two-dimensional point and returns a new one.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "TransformPoint2D"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "point"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Point2D"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "Point2D"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "TransformPoint2D",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 9
}
},
{
"kind": "TypeAlias",
"docComment": "/**\n * Transition props\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "Transition"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "Orchestration"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "Repeat"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "TransitionDefinition"
},
{
"kind": "Content",
"text": ") | ("
},
{
"kind": "Reference",
"text": "Orchestration"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "Repeat"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "TransitionMap"
},
{
"kind": "Content",
"text": ")"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "Transition",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 16
}
},
{
"kind": "Interface",
"docComment": "/**\n * An animation that animates between two or more values over a specific duration of time. This is the default animation for non-physical values like `color` and `opacity`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Tween"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Repeat"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Tween",
"members": [
{
"kind": "PropertySignature",
"docComment": "/**\n * The duration of the tween animation. Set to `0.3` by default, 0r `0.8` if animating a series of keyframes.\n *\n * @library\n * ```jsx\n * <Frame\n * animate={{ opacity: 0 }}\n * transition={{ duration: 2 }}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * const variants = {\n * visible: {\n * opacity: 1,\n * transition: { duration: 2 }\n * }\n * }\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "duration"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "duration",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * The easing function to use. Set as one of the below.\n *\n * - The name of an existing easing function. - An array of four numbers to define a cubic bezier curve. - An easing function, that accepts and returns a value `0-1`.\n *\n * If the animating value is set as an array of multiple values for a keyframes animation, `ease` can be set as an array of easing functions to set different easings between each of those values.\n *\n * @library\n * ```jsx\n * const transition = {\n * ease: [0.17, 0.67, 0.83, 0.67]\n * }\n *\n * <Frame\n * animate={{ opacity: 0 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ opacity: 0 }}\n * transition={{ ease: [0.17, 0.67, 0.83, 0.67] }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "ease"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Easing"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Easing"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ease",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * When animating keyframes, `easings` can be used to define easing functions between each keyframe. This array should be one item fewer than the number of keyframes, as these easings apply to the transitions between the keyframes.\n *\n * @library\n * ```jsx\n * const transition = {\n * easings: [\"easeIn\", \"easeOut\"]\n * }\n *\n * <Frame\n * animate={{ backgroundColor: [\"#0f0\", \"#00f\", \"#f00\"] }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ backgroundColor: [\"#0f0\", \"#00f\", \"#f00\"] }}\n * transition={{ easings: [\"easeIn\", \"easeOut\"] }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "easings"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Easing"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "easings",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * The value to animate from. By default, this is the current state of the animating value.\n *\n * @library\n * ```jsx\n * const transition = {\n * from: 90,\n * duration: 2\n * }\n *\n * <Frame\n * animate={{ rotate: 180 }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ rotate: 180 }}\n * transition={{ from: 90, duration: 2 }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number | string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "from",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * When animating keyframes, `times` can be used to determine where in the animation each keyframe is reached. Each value in `times` is a value between `0` and `1`, representing `duration`.\n *\n * There must be the same number of `times` as there are keyframes. Defaults to an array of evenly-spread durations.\n *\n * @library\n * ```jsx\n * const transition = {\n * times: [0, 0.1, 0.9, 1]\n * }\n *\n * <Frame\n * animate={{ scale: [0, 1, 0.5, 1] }}\n * transition={transition}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.div\n * animate={{ scale: [0, 1, 0.5, 1] }}\n * transition={{ times: [0, 0.1, 0.9, 1] }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "times"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "times",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Set `type` to `\"tween\"` to use a duration-based tween animation. If any non-orchestration `transition` values are set without a `type` property, this is used as the default animation.\n *\n * @library\n * ```jsx\n * <Frame\n * animate={{ opacity: 0 }}\n * transition={{ duration: 2, type: \"tween\" }}\n * />\n * ```\n *\n * @motion\n * ```jsx\n * <motion.path\n * animate={{ pathLength: 1 }}\n * transition={{ duration: 2, type: \"tween\" }}\n * />\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "type"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "\"tween\""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
},
{
"kind": "Function",
"docComment": "/**\n * Creates `AnimationControls`, which can be used to manually start, stop and sequence animations on one or more components.\n *\n * The returned `AnimationControls` should be passed to the `animate` property of the components you want to animate.\n *\n * These components can then be animated with the `start` method.\n *\n * @library\n * ```jsx\n * import * as React from 'react'\n * import { Frame, useAnimation } from 'framer'\n *\n * export function MyComponent(props) {\n * const controls = useAnimation()\n *\n * controls.start({\n * x: 100,\n * transition: { duration: 0.5 },\n * })\n *\n * return <Frame animate={controls} />\n * }\n * ```\n *\n * @motion\n * ```jsx\n * import * as React from 'react'\n * import { motion, useAnimation } from 'framer-motion'\n *\n * export function MyComponent(props) {\n * const controls = useAnimation()\n *\n * controls.start({\n * x: 100,\n * transition: { duration: 0.5 },\n * })\n *\n * return <motion.div animate={controls} />\n * }\n * ```\n *\n * @returns Animation controller with `start` and `stop` methods\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useAnimation"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "import(\"./animation-controls\")."
},
{
"kind": "Reference",
"text": "AnimationControls"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "useAnimation"
},
{
"kind": "Function",
"docComment": "/**\n * Cycles through a series of visual properties. Can be used to toggle between or cycle through animations. It works similar to `useState` in React. It is provided an initial array of possible states, and returns an array of two arguments.\n *\n * @library\n * ```jsx\n * import * as React from \"react\"\n * import { Frame, useCycle } from \"framer\"\n *\n * export function MyComponent() {\n * const [x, cycleX] = useCycle(0, 50, 100)\n *\n * return (\n * <Frame\n * animate={{ x: x }}\n * onTap={() => cycleX()}\n * />\n * )\n * }\n * ```\n *\n * @motion\n *\n * An index value can be passed to the returned `cycle` function to cycle to a specific index.\n * ```jsx\n * import * as React from \"react\"\n * import { motion, useCycle } from \"framer-motion\"\n *\n * export const MyComponent = () => {\n * const [x, cycleX] = useCycle(0, 50, 100)\n *\n * return (\n * <motion.div\n * animate={{ x: x }}\n * onTap={() => cycleX()}\n * />\n * )\n * }\n * ```\n *\n * @param items - items to cycle through\n *\n * @returns [currentState, cycleState]\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useCycle"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">(..."
},
{
"kind": "Reference",
"text": "items"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "CycleState"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "items",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "useCycle"
},
{
"kind": "Function",
"docComment": "/**\n * Returns a `MotionValue` each for `scaleX` and `scaleY` that update with the inverse of their respective parent scales.\n *\n * This is useful for undoing the distortion of content when scaling a parent component.\n *\n * By default, `useInvertedScale` will automatically fetch `scaleX` and `scaleY` from the nearest parent. By passing other `MotionValue`s in as `useInvertedScale({ scaleX, scaleY })`, it will invert the output of those instead.\n *\n * @motion\n * ```jsx\n * const MyComponent = () => {\n * const { scaleX, scaleY } = useInvertedScale()\n * return <motion.div style={{ scaleX, scaleY }} />\n * }\n * ```\n *\n * @library\n * ```jsx\n * function MyComponent() {\n * const { scaleX, scaleY } = useInvertedScale()\n * return <Frame scaleX={scaleX} scaleY={scaleY} />\n * }\n * ```\n *\n * @deprecated\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useInvertedScale"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "scale"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ScaleMotionValues"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ScaleMotionValues"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "scale",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 9
}
}
],
"name": "useDeprecatedInvertedScale"
},
{
"kind": "Function",
"docComment": "/**\n * Attaches an event listener directly to the provided DOM element.\n *\n * Bypassing React's event system can be desirable, for instance when attaching non-passive event handlers.\n * ```jsx\n * const ref = useRef(null)\n *\n * useDomEvent(ref, 'wheel', onWheel, { passive: false })\n *\n * return <div ref={ref} />\n * ```\n *\n * @param ref - React.RefObject that's been provided to the element you want to bind the listener to.\n *\n * @param eventName - Name of the event you want listen for.\n *\n * @param handler - Function to fire when receiving the event.\n *\n * @param options - Options to pass to `Event.addEventListener`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useDomEvent"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "ref"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "RefObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EventTarget"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "eventName"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "handler"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "EventListener"
},
{
"kind": "Content",
"text": " | undefined"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "AddEventListenerOptions"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 23,
"endIndex": 24
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "ref",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 9
}
},
{
"parameterName": "eventName",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
},
{
"parameterName": "handler",
"parameterTypeTokenRange": {
"startIndex": 16,
"endIndex": 18
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 21,
"endIndex": 22
}
}
],
"name": "useDomEvent"
},
{
"kind": "Function",
"docComment": "/**\n * Usually, dragging is initiated by pressing down on a `motion` component with a `drag` prop and moving it. For some use-cases, for instance clicking at an arbitrary point on a video scrubber, we might want to initiate that dragging from a different component than the draggable one.\n *\n * By creating a `dragControls` using the `useDragControls` hook, we can pass this into the draggable component's `dragControls` prop. It exposes a `start` method that can start dragging from pointer events on other components.\n *\n * @library\n * ```jsx\n * const dragControls = useDragControls()\n *\n * function startDrag(event) {\n * dragControls.start(event, { snapToCursor: true })\n * }\n *\n * return (\n * <>\n * <Frame onTapStart={startDrag} />\n * <Frame drag=\"x\" dragControls={dragControls} />\n * </>\n * )\n * ```\n *\n * @motion\n * ```jsx\n * const dragControls = useDragControls()\n *\n * function startDrag(event) {\n * dragControls.start(event, { snapToCursor: true })\n * }\n *\n * return (\n * <>\n * <div onPointerDown={startDrag} />\n * <motion.div drag=\"x\" dragControls={dragControls} />\n * </>\n * )\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useDragControls"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "DragControls"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "useDragControls"
},
{
"kind": "Function",
"docComment": "/**\n * Returns MotionValues that update when the provided element scrolls:\n *\n * - `scrollX` — Horizontal scroll distance in pixels. - `scrollY` — Vertical scroll distance in pixels. - `scrollXProgress` — Horizontal scroll progress between `0` and `1`. - `scrollYProgress` — Vertical scroll progress between `0` and `1`.\n *\n * This element must be set to `overflow: scroll` on either or both axes to report scroll offset.\n *\n * @library\n * ```jsx\n * import * as React from \"react\"\n * import {\n * Frame,\n * useElementScroll,\n * useTransform\n * } from \"framer\"\n *\n * export function MyComponent() {\n * const ref = React.useRef()\n * const { scrollYProgress } = useElementScroll(ref)\n *\n * return (\n * <Frame ref={ref}>\n * <Frame scaleX={scrollYProgress} />\n * </Frame>\n * )\n * }\n * ```\n *\n * @motion\n * ```jsx\n * export const MyComponent = () => {\n * const ref = useRef()\n * const { scrollYProgress } = useElementScroll(ref)\n *\n * return (\n * <div ref={ref}>\n * <motion.div style={{ scaleX: scrollYProgress }} />\n * </div>\n * )\n * }\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useElementScroll"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "ref"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "RefObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "HTMLElement"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ScrollMotionValues"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "ref",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 9
}
}
],
"name": "useElementScroll"
},
{
"kind": "Function",
"docComment": "/**\n * Add pan and tap gesture recognition to an element.\n *\n * @param props - Gesture event handlers\n *\n * @param ref - React `ref` containing a DOM `Element`\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useGestures"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "GestureHandlers"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "GestureHandlers"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "visualElement"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "props",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
},
{
"parameterName": "visualElement",
"parameterTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
}
}
],
"typeParameters": [
{
"typeParameterName": "GestureHandlers",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "useGestures"
},
{
"kind": "Function",
"docComment": "/**\n * Similar to `usePresence`, except `useIsPresent` simply returns whether or not the component is present. There is no `safeToRemove` function.\n * ```jsx\n * import { useIsPresent } from \"framer-motion\"\n *\n * export const Component = () => {\n * const isPresent = useIsPresent()\n *\n * useEffect(() => {\n * !isPresent && console.log(\"I've been removed!\")\n * }, [isPresent])\n *\n * return <div />\n * }\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useIsPresent"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "useIsPresent"
},
{
"kind": "Function",
"docComment": "/**\n * Combine multiple motion values into a new one using a string template literal.\n * ```jsx\n * import {\n * motion,\n * useSpring,\n * useMotionValue,\n * useMotionTemplate\n * } from \"framer-motion\"\n *\n * function Component() {\n * const shadowX = useSpring(0)\n * const shadowY = useMotionValue(0)\n * const shadow = useMotionTemplate`drop-shadow(${shadowX}px ${shadowY}px 20px rgba(0,0,0,0.3))`\n *\n * return <motion.div style={{ filter: shadow }} />\n * }\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useMotionTemplate"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "fragments"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "TemplateStringsArray"
},
{
"kind": "Content",
"text": ", ..."
},
{
"kind": "Reference",
"text": "values"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<string>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "fragments",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "values",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 11
}
}
],
"name": "useMotionTemplate"
},
{
"kind": "Function",
"docComment": "/**\n * Creates a `MotionValue` to track the state and velocity of a value.\n *\n * Usually, these are created automatically. For advanced use-cases, like use with `useTransform`, you can create `MotionValue`s externally and pass them into the animated component via the `style` prop.\n *\n * @library\n * ```jsx\n * export function MyComponent() {\n * const scale = useMotionValue(1)\n *\n * return <Frame scale={scale} />\n * }\n * ```\n *\n * @motion\n * ```jsx\n * export const MyComponent = () => {\n * const scale = useMotionValue(1)\n *\n * return <motion.div style={{ scale }} />\n * }\n * ```\n *\n * @param initial - The initial state.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useMotionValue"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "initial"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "initial",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "useMotionValue"
},
{
"kind": "Function",
"docComment": "/**\n * When a component is the child of `AnimatePresence`, it can use `usePresence` to access information about whether it's still present in the React tree.\n * ```jsx\n * import { usePresence } from \"framer-motion\"\n *\n * export const Component = () => {\n * const [isPresent, safeToRemove] = usePresence()\n *\n * useEffect(() => {\n * !isPresent && setTimeout(safeToRemove, 1000)\n * }, [isPresent])\n *\n * return <div />\n * }\n * ```\n *\n * If `isPresent` is `false`, it means that a component has been removed the tree, but `AnimatePresence` won't really remove it until `safeToRemove` has been called.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "usePresence"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "AlwaysPresent"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Present"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "NotPresent"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "usePresence"
},
{
"kind": "Function",
"docComment": "/**\n * A hook that returns `true` if we should be using reduced motion based on the current device's Reduced Motion setting.\n *\n * This can be used to implement changes to your UI based on Reduced Motion. For instance, replacing motion-sickness inducing `x`/`y` animations with `opacity`, disabling the autoplay of background videos, or turning off parallax motion.\n *\n * It will actively respond to changes and re-render your components with the latest setting.\n * ```jsx\n * export function Sidebar({ isOpen }) {\n * const shouldReduceMotion = useReducedMotion()\n * const closedX = shouldReduceMotion ? 0 : \"-100%\"\n *\n * return (\n * <motion.div animate={{\n * opacity: isOpen ? 1 : 0,\n * x: isOpen ? 0 : closedX\n * }} />\n * )\n * }\n * ```\n *\n * @return boolean\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useReducedMotion"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "boolean | null"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "useReducedMotion"
},
{
"kind": "Function",
"docComment": "/**\n * Creates a `MotionValue` that, when `set`, will use a spring animation to animate to its new state.\n *\n * It can either work as a stand-alone `MotionValue` by initialising it with a value, or as a subscriber to another `MotionValue`.\n *\n * @remarks\n * ```jsx\n * const x = useSpring(0, { stiffness: 300 })\n * const y = useSpring(x, { damping: 10 })\n * ```\n *\n * @param inputValue - `MotionValue` or number. If provided a `MotionValue`, when the input `MotionValue` changes, the created `MotionValue` will spring towards that value.\n *\n * @param springConfig - Configuration options for the spring.\n *\n * @returns `MotionValue`\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useSpring"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "source"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": " | number"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "config"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "SpringOptions"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<any>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "source",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
}
},
{
"parameterName": "config",
"parameterTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
}
}
],
"name": "useSpring"
},
{
"kind": "Function",
"docComment": "/**\n * Create a `MotionValue` that transforms the output of another `MotionValue` by mapping it from one range of values into another.\n *\n * @remarks\n *\n * Given an input range of `[-200, -100, 100, 200]` and an output range of `[0, 1, 1, 0]`, the returned `MotionValue` will:\n *\n * - When provided a value between `-200` and `-100`, will return a value between `0` and `1`. - When provided a value between `-100` and `100`, will return `1`. - When provided a value between `100` and `200`, will return a value between `1` and `0`\n *\n * The input range must be a linear series of numbers. The output range can be any value type supported by Framer Motion: numbers, colors, shadows, etc.\n *\n * Every value in the output range must be of the same type and in the same format.\n *\n * @library\n * ```jsx\n * export function MyComponent() {\n * const x = useMotionValue(0)\n * const xRange = [-200, -100, 100, 200]\n * const opacityRange = [0, 1, 1, 0]\n * const opacity = useTransform(x, xRange, opacityRange)\n *\n * return <Frame x={x} animate={{ x: 200 }} opacity={opacity} />\n * }\n * ```\n *\n * @motion\n * ```jsx\n * export const MyComponent = () => {\n * const x = useMotionValue(0)\n * const xRange = [-200, -100, 100, 200]\n * const opacityRange = [0, 1, 1, 0]\n * const opacity = useTransform(x, xRange, opacityRange)\n *\n * return (\n * <motion.div\n * animate={{ x: 200 }}\n * style={{ opacity, x }}\n * />\n * )\n * }\n * ```\n *\n * @param inputValue - `MotionValue`\n *\n * @param inputRange - A linear series of numbers (either all increasing or decreasing)\n *\n * @param outputRange - A series of numbers, colors or strings. Must be the same length as `inputRange`.\n *\n * @param options - - clamp: boolean. Clamp values to within the given range. Defaults to `true` - ease: EasingFunction[]. Easing functions to use on the interpolations between each value in the input and output ranges. If provided as an array, the array must be one item shorter than the input and output ranges, as the easings apply to the transition between each.\n *\n * @returns `MotionValue`\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useTransform"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "I"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "O"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<number>"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "inputRange"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "InputRange"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "outputRange"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "O"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "TransformOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "O"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "O"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 28,
"endIndex": 32
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 11
}
},
{
"parameterName": "inputRange",
"parameterTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
}
},
{
"parameterName": "outputRange",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 20
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 23,
"endIndex": 27
}
}
],
"typeParameters": [
{
"typeParameterName": "I",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "O",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "useTransform"
},
{
"kind": "Function",
"docComment": "/**\n * Create a `MotionValue` that transforms the output of another `MotionValue` through a function. In this example, `y` will always be double `x`.\n *\n * @library\n * ```jsx\n * import * as React from \"react\"\n * import { Frame, useMotionValue, useTransform } from \"framer\"\n *\n * export function MyComponent() {\n * const x = useMotionValue(10)\n * const y = useTransform(x, value => value * 2)\n *\n * return <Frame x={x} y={y} />\n * }\n * ```\n *\n * @motion\n * ```jsx\n * export const MyComponent = () => {\n * const x = useMotionValue(10)\n * const y = useTransform(x, value => value * 2)\n *\n * return <motion.div style={{ x, y }} />\n * }\n * ```\n *\n * @param input - A `MotionValue` that will pass its latest value through `transform` to update the returned `MotionValue`.\n *\n * @param transform - A function that accepts the latest value from `input` and returns a new value.\n *\n * @returns `MotionValue`\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useTransform"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "I"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "O"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "input"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "I"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "transformer"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "SingleTransformer"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "I"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "O"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "O"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 23,
"endIndex": 27
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "input",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 13
}
},
{
"parameterName": "transformer",
"parameterTypeTokenRange": {
"startIndex": 16,
"endIndex": 22
}
}
],
"typeParameters": [
{
"typeParameterName": "I",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "O",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "useTransform"
},
{
"kind": "Function",
"docComment": "/**\n * Pass an array of `MotionValue`s and a function to combine them. In this example, `z` will be the `x` multiplied by `y`.\n *\n * @library\n * ```jsx\n * import * as React from \"react\"\n * import { Frame, useMotionValue, useTransform } from \"framer\"\n *\n * export function MyComponent() {\n * const x = useMotionValue(0)\n * const y = useMotionValue(0)\n * const z = useTransform([x, y], [latestX, latestY] => latestX * latestY)\n *\n * return <Frame x={x} y={y} z={z} />\n * }\n * ```\n *\n * @motion\n * ```jsx\n * export const MyComponent = () => {\n * const x = useMotionValue(0)\n * const y = useMotionValue(0)\n * const z = useTransform([x, y], [latestX, latestY] => latestX * latestY)\n *\n * return <motion.div style={{ x, y, z }} />\n * }\n * ```\n *\n * @param input - An array of `MotionValue`s that will pass their latest values through `transform` to update the returned `MotionValue`.\n *\n * @param transform - A function that accepts the latest values from `input` and returns a new value.\n *\n * @returns `MotionValue`\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useTransform"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "I"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "O"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "input"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<string | number>[]"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "transformer"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MultiTransformer"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "I"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "O"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "O"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 21,
"endIndex": 25
},
"releaseTag": "Public",
"overloadIndex": 3,
"parameters": [
{
"parameterName": "input",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 11
}
},
{
"parameterName": "transformer",
"parameterTypeTokenRange": {
"startIndex": 14,
"endIndex": 20
}
}
],
"typeParameters": [
{
"typeParameterName": "I",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "O",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "useTransform"
},
{
"kind": "Function",
"docComment": "/**\n * Returns MotionValues that update when the viewport scrolls:\n *\n * - `scrollX` — Horizontal scroll distance in pixels. - `scrollY` — Vertical scroll distance in pixels. - `scrollXProgress` — Horizontal scroll progress between `0` and `1`. - `scrollYProgress` — Vertical scroll progress between `0` and `1`.\n *\n * **Warning:** Setting `body` or `html` to `height: 100%` or similar will break the `Progress` values as this breaks the browser's capability to accurately measure the page length.\n *\n * @library\n * ```jsx\n * import * as React from \"react\"\n * import {\n * Frame,\n * useViewportScroll,\n * useTransform\n * } from \"framer\"\n *\n * export function MyComponent() {\n * const { scrollYProgress } = useViewportScroll()\n * return <Frame scaleX={scrollYProgress} />\n * }\n * ```\n *\n * @motion\n * ```jsx\n * export const MyComponent = () => {\n * const { scrollYProgress } = useViewportScroll()\n * return <motion.div style={{ scaleX: scrollYProgress }} />\n * }\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "useViewportScroll"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "ScrollMotionValues"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "useViewportScroll"
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "ValueTarget"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "SingleTarget"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "KeyframesTarget"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ValueTarget",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 6
}
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "Variant"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "TargetAndTransition"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "TargetResolver"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "Variant",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 6
}
},
{
"kind": "TypeAlias",
"docComment": "/**\n * Either a string, or array of strings, that reference variants defined via the `variants` prop.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "VariantLabels"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "string | string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "VariantLabels",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"kind": "TypeAlias",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "Variants"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "{\n ["
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": string]: "
},
{
"kind": "Reference",
"text": "Variant"
},
{
"kind": "Content",
"text": ";\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "Variants",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 8
}
},
{
"kind": "Enum",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare enum "
},
{
"kind": "Reference",
"text": "VisibilityAction"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "VisibilityAction",
"members": [
{
"kind": "EnumMember",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "Hide"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "0"
}
],
"releaseTag": "Public",
"name": "Hide",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "Show"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "1"
}
],
"releaseTag": "Public",
"name": "Show",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
]
},
{
"kind": "Interface",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Instance"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "MutableState"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": "> extends "
},
{
"kind": "Reference",
"text": "LifecycleManager"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "Instance",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"typeParameterName": "MutableState",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "VisualElement",
"members": [
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "addChild"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "child"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "child",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "addChild"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "addValue"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": "<any>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 10
}
}
],
"name": "addValue"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "addVariantChild"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "child"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "undefined | (() => void)"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "child",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "addVariantChild"
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "animateMotionValue"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "typeof "
},
{
"kind": "Reference",
"text": "startAnimation"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "animateMotionValue",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "animationState"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "AnimationState"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "animationState",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "blockInitialAnimation"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "blockInitialAnimation",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "build"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "MutableState"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "build"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "clearState"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionProps"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "props",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "clearState"
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "current"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Instance"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "current",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "depth"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "depth",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "enableLayoutProjection"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "enableLayoutProjection"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "forEachValue"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "callback"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": string) => void"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "callback",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 11
}
}
],
"name": "forEachValue"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getBaseTarget"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number | string | undefined | null"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "getBaseTarget"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getClosestVariantNode"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": " | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getClosestVariantNode"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getDefaultTransition"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Transition"
},
{
"kind": "Content",
"text": " | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getDefaultTransition"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getInstance"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Instance"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getInstance"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getLatestValues"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "ResolvedValues"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getLatestValues"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getLayoutId"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "string | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getLayoutId"
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getLayoutState"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "() => "
},
{
"kind": "Reference",
"text": "LayoutState"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "getLayoutState",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getProjectionAnimationProgress"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "MotionPoint"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getProjectionAnimationProgress"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getProps"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "MotionProps"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getProps"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getStaticValue"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number | string | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "getStaticValue"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getValue"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "undefined | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "getValue"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getValue"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "defaultValue"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string | number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "defaultValue",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "getValue"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getValue"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "defaultValue"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string | number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "undefined | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 3,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "defaultValue",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "getValue"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getVariant"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "name"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Variant"
},
{
"kind": "Content",
"text": " | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "getVariant"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getVariantContext"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "startAtParent"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "undefined | {\n "
},
{
"kind": "Reference",
"text": "initial"
},
{
"kind": "Content",
"text": "?: string | string[];\n "
},
{
"kind": "Reference",
"text": "animate"
},
{
"kind": "Content",
"text": "?: string | string[];\n "
},
{
"kind": "Reference",
"text": "exit"
},
{
"kind": "Content",
"text": "?: string | string[];\n "
},
{
"kind": "Reference",
"text": "whileHover"
},
{
"kind": "Content",
"text": "?: string | string[];\n "
},
{
"kind": "Reference",
"text": "whileDrag"
},
{
"kind": "Content",
"text": "?: string | string[];\n "
},
{
"kind": "Reference",
"text": "whileFocus"
},
{
"kind": "Content",
"text": "?: string | string[];\n "
},
{
"kind": "Reference",
"text": "whileTap"
},
{
"kind": "Content",
"text": "?: string | string[];\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 21
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "startAtParent",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "getVariantContext"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "hasValue"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "hasValue"
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Layout projection - perhaps a candidate for lazy-loading or an external interface. Move into Projection?\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "isHoverEventsEnabled"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "isHoverEventsEnabled",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "isMounted"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "isMounted"
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "isPresenceRoot"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "isPresenceRoot",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "isPresent"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "isPresent",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "isStatic"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "isStatic",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "/**\n * Visibility\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "isVisible"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "isVisible",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "layoutSafeToRemove"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "layoutSafeToRemove",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "lockProjectionTarget"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "lockProjectionTarget"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "makeTargetAnimatable"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "target"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "TargetAndTransition"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "isLive"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "TargetAndTransition"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "isLive",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "makeTargetAnimatable"
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "manuallyAnimateOnMount"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "manuallyAnimateOnMount",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "measureViewportBox"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "withTransform"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "AxisBox2D"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "withTransform",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "measureViewportBox"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "notifyAnimationComplete"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "notifyAnimationComplete"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "notifyAnimationStart"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "notifyAnimationStart"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "notifyLayoutReady"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "config"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "SharedLayoutAnimationConfig"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "config",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "notifyLayoutReady"
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "path"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "path",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "pointTo"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "element"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "element",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "pointTo"
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "presence"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Presence"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "presence",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "presenceId"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "presenceId",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "prevDragCursor"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Point2D"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "prevDragCursor",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "prevViewportBox"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "AxisBox2D"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "prevViewportBox",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "projection"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "TargetProjection"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "projection",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "readValue"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string | number | undefined | null"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "readValue"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "rebaseProjectionTarget"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "force"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "sourceBox"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "AxisBox2D"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "force",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "sourceBox",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "rebaseProjectionTarget"
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "ref"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Ref"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Instance"
},
{
"kind": "Content",
"text": " | null>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ref",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
}
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "removeValue"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "removeValue"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "resetTransform"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "resetTransform"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "scheduleRender"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "scheduleRender"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "scheduleUpdateLayoutProjection"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "scheduleUpdateLayoutProjection"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "setBaseTarget"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string | number | null"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "setBaseTarget"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "setCrossfader"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "crossfader"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Crossfader"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "crossfader",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "setCrossfader"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "setProjectionTargetAxis"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "axis"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "\"x\" | \"y\""
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "min"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "max"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "axis",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "min",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
},
{
"parameterName": "max",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "setProjectionTargetAxis"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "setProps"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "MotionProps"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "props",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "setProps"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "setStaticValue"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "setStaticValue"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "setVisibility"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "visibility"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "visibility",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "setVisibility"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "snapshotViewportBox"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "snapshotViewportBox"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "sortNodePosition"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "element"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "element",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "sortNodePosition"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "startLayoutAnimation"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "axis"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "\"x\" | \"y\""
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "transition"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Transition"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<any>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "axis",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "transition",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "startLayoutAnimation"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "stopLayoutAnimation"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "stopLayoutAnimation"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "suspendHoverEvents"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "suspendHoverEvents"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "syncRender"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "syncRender"
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "treeType"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "treeType",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "unlockProjectionTarget"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "unlockProjectionTarget"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "updateLayoutMeasurement"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "updateLayoutMeasurement"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "updateLayoutProjection"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "updateLayoutProjection"
},
{
"kind": "PropertySignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "variantChildren"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Set"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "variantChildren",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
}
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "withoutTransform"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "callback"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "callback",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "withoutTransform"
}
],
"extendsTokenRanges": [
{
"startIndex": 11,
"endIndex": 13
}
]
},
{
"kind": "Variable",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "visualElement"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Instance"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "MutableState"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Options"
},
{
"kind": "Content",
"text": ">({ "
},
{
"kind": "Reference",
"text": "treeType"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "createRenderState"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "build"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "getBaseTarget"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "makeTargetAnimatable"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "measureViewportBox"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "onMount"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "render"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "renderInstance"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "readValueFromInstance"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "resetTransform"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "restoreTransform"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "removeValueFromMutableState"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "sortNodePosition"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "scrapeMotionValuesFromProps"
},
{
"kind": "Content",
"text": ", }: "
},
{
"kind": "Reference",
"text": "VisualElementConfig"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Instance"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "MutableState"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Options"
},
{
"kind": "Content",
"text": ">) => ({ "
},
{
"kind": "Reference",
"text": "parent"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "ref"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "externalRef"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "isStatic"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "presenceId"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "blockInitialAnimation"
},
{
"kind": "Content",
"text": ", }: "
},
{
"kind": "Reference",
"text": "VisualElementOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Instance"
},
{
"kind": "Content",
"text": ">, "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Options"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "VisualElement"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Instance"
},
{
"kind": "Content",
"text": ", any>"
}
],
"releaseTag": "Public",
"name": "visualElement",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 73
}
},
{
"kind": "Interface",
"docComment": "/**\n * TODO: Make more of these lifecycle events available as props\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "VisualElementLifecycles"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "VisualElementLifecycles",
"members": [
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback when animation defined in `animate` is complete.\n *\n * @library\n * ```jsx\n * function onComplete() {\n * console.log(\"Animation completed\")\n * }\n *\n * <Frame animate={{ x: 100 }} onAnimationComplete={onComplete} />\n * ```\n *\n * @motion\n * ```jsx\n * function onComplete() {\n * console.log(\"Animation completed\")\n * }\n *\n * <motion.div animate={{ x: 100 }} onAnimationComplete={onComplete} />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onAnimationComplete"
},
{
"kind": "Content",
"text": "?(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "onAnimationComplete"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback when animation defined in `animate` begins.\n *\n * @library\n * ```jsx\n * function onStart() {\n * console.log(\"Animation started\")\n * }\n *\n * <Frame animate={{ x: 100 }} onAnimationStart={onStart} />\n * ```\n *\n * @motion\n * ```jsx\n * function onStart() {\n * console.log(\"Animation started\")\n * }\n *\n * <motion.div animate={{ x: 100 }} onAnimationStart={onStart} />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onAnimationStart"
},
{
"kind": "Content",
"text": "?(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "onAnimationStart"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "onBeforeLayoutMeasure"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "box"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "AxisBox2D"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "box",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "onBeforeLayoutMeasure"
},
{
"kind": "MethodSignature",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "onLayoutMeasure"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "box"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "AxisBox2D"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "prevBox"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "AxisBox2D"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "box",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "prevBox",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "onLayoutMeasure"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * Callback with latest motion values, fired max once per frame.\n *\n * @library\n * ```jsx\n * function onUpdate(latest) {\n * console.log(latest.x, latest.opacity)\n * }\n *\n * <Frame animate={{ x: 100, opacity: 0 }} onUpdate={onUpdate} />\n * ```\n *\n * @motion\n * ```jsx\n * function onUpdate(latest) {\n * console.log(latest.x, latest.opacity)\n * }\n *\n * <motion.div animate={{ x: 100, opacity: 0 }} onUpdate={onUpdate} />\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onUpdate"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "latest"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ResolvedValues"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "latest",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "onUpdate"
},
{
"kind": "MethodSignature",
"docComment": "/**\n * A callback that fires whenever the viewport-relative bounding box updates.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onViewportBoxUpdate"
},
{
"kind": "Content",
"text": "?("
},
{
"kind": "Reference",
"text": "box"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "AxisBox2D"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "delta"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BoxDelta"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "box",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "delta",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "onViewportBoxUpdate"
}
],
"extendsTokenRanges": []
}
]
}
]
}