{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.1.5",
"schemaVersion": 1000
},
"kind": "Package",
"canonicalReference": "framer",
"docComment": "",
"name": "framer",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "",
"name": "",
"members": [
{
"kind": "Function",
"canonicalReference": "(addPropertyControls:0)",
"docComment": "/**\n * Extends component with property controls\n * ```typescript\n * export const MyComponent = props => {props.header}
\n *\n * addPropertyControls(MyComponent, {\n * header: { type: ControlType.String, title: \"Header\" },\n * })\n *\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "addPropertyControls"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": " = any>("
},
{
"kind": "Reference",
"text": "component"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "ComponentType"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "propertyControls"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PropertyControls"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Props"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 21,
"endIndex": 22
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "component",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 13
}
},
{
"parameterName": "propertyControls",
"parameterTypeTokenRange": {
"startIndex": 16,
"endIndex": 20
}
}
],
"name": "addPropertyControls"
},
{
"kind": "Function",
"canonicalReference": "(Animatable:0)",
"docComment": "/**\n * Creates a Animatable object that can be animated. These objects can be passed into a {@link DeprecatedFrame} instead of a primitive like number and afterwards animated with {@link (animate:function)}.\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate(value, 100)\n * ```\n *\n * @deprecated\n *\n * Use {@link useMotionValue} instead\n *\n * @param value - Value to animate\n *\n * @returns Animatable value\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 18
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 13
}
}
],
"name": "Animatable"
},
{
"kind": "Interface",
"canonicalReference": "(Animatable:interface)",
"docComment": "/**\n * @deprecated\n *\n * Use {@link useMotionValue} instead\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> extends "
},
{
"kind": "Reference",
"text": "UpdateObserver"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"name": "Animatable",
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "(get:0)",
"docComment": "/**\n * Get the current value out of this Animatable object\n *\n * @remarks\n * ```jsx\n * const a = Animatable(0)\n * a.get() // returns 0\n * await animate(a, 42)\n * a.get() // returns 42\n * ```\n *\n * @returns Current value\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "get"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "get"
},
{
"kind": "MethodSignature",
"canonicalReference": "(set:0)",
"docComment": "/**\n * Set a new value to a animatable object\n *\n * @remarks\n *\n * The passed value can be an Animatable value too\n * ```jsx\n * const a = Animatable(0)\n * const b = Animatable(100)\n * a.set(42)\n * a.get() // returns 42\n * a.set(b)\n * a.get() // returns 100\n * ```\n *\n * @param value - New value to set to the animatable\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "set"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 10
}
}
],
"name": "set"
},
{
"kind": "MethodSignature",
"canonicalReference": "(set:1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "set"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "transaction"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "TransactionId"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 15,
"endIndex": 16
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 10
}
},
{
"parameterName": "transaction",
"parameterTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
}
}
],
"name": "set"
}
],
"extendsTokenRanges": [
{
"startIndex": 5,
"endIndex": 9
}
]
},
{
"kind": "Namespace",
"canonicalReference": "(Animatable:namespace)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Animatable",
"members": [
{
"kind": "Function",
"canonicalReference": "(getNumber:0)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "getNumber"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "value"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": " | null | undefined"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "defaultValue"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 8
}
},
{
"parameterName": "defaultValue",
"parameterTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
}
}
],
"name": "getNumber"
}
]
},
{
"kind": "Function",
"canonicalReference": "(animate:0)",
"docComment": "/**\n * Animate an {@link (Animatable:interface)} value to a new value.\n *\n * @remarks\n *\n * Recommended use is to use convenience functions from the `animate` namespace instead of passing an animator. Only use this for low-level animation tweaking.\n * ```jsx\n * const value = Animatable(0)\n * animate(value, 100)\n *\n * const value = Animatable({x: 0, y: 0})\n * animate(value, {x: 100, y: 100})\n * ```\n *\n * @deprecated\n *\n * Use the {@link MotionProps.animate} prop on {@link Frame} instead.\n *\n * @param from - The animatable value or object to start from\n *\n * @param to - Value to animate to\n *\n * @param animator - Animator class to use.\n *\n * @param options - Animation options\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "animate"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Options"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "animator"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "AnimatorClass"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Options"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Options"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Options"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 42,
"endIndex": 48
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 17
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 20,
"endIndex": 21
}
},
{
"parameterName": "animator",
"parameterTypeTokenRange": {
"startIndex": 24,
"endIndex": 30
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 33,
"endIndex": 41
}
}
],
"name": "animate"
},
{
"kind": "Namespace",
"canonicalReference": "(animate:namespace)",
"docComment": "/**\n * @deprecated\n *\n * Use the {@link MotionProps.animate} prop on {@link Frame} instead.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace "
},
{
"kind": "Reference",
"text": "animate"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "animate",
"members": [
{
"kind": "Function",
"canonicalReference": "(bezier:0)",
"docComment": "/**\n * Animate value with a bezier curve\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.bezier(value, 100, {duration: 1, curve: Bezier.EaseIn})\n *\n * animate.bezier(value, 100, {duration: 1, curve: [0.3, 0.1, 0.4, 1]})\n * ```\n *\n * @deprecated\n *\n * Use {@link MotionProps.animate} on {@link Frame} instead.\n *\n * @param from - Value to animate\n *\n * @param to - Value to animate to\n *\n * @param options - Options for the bezier curve\n *\n * - `duration` Duration of the animation - `curve` One of the `Bezier` enum values or an array with 4 control points\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "bezier"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "BezierOptions"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "BezierOptions"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 31,
"endIndex": 37
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 15
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 22,
"endIndex": 30
}
}
],
"name": "bezier"
},
{
"kind": "Function",
"canonicalReference": "(ease:0)",
"docComment": "/**\n * Animate value with a ease animation\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.ease(value, 100)\n *\n * animate.ease(value, 100, {duration: 1})\n * ```\n *\n * @deprecated\n *\n * Use {@link MotionProps.animate} on {@link Frame} instead.\n *\n * @param from - Value to animate\n *\n * @param to - Value to animate to\n *\n * @param options - The options for the animation\n *\n * - `duration` - Duration of the animation\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "ease"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "BezierOptions"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 31,
"endIndex": 37
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 15
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 22,
"endIndex": 30
}
}
],
"name": "ease"
},
{
"kind": "Function",
"canonicalReference": "(easeIn:0)",
"docComment": "/**\n * Animate value with a ease in animation\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.easeIn(value, 100)\n *\n * animate.easeIn(value, 100, {duration: 1})\n * ```\n *\n * @deprecated\n *\n * Use {@link MotionProps.animate} on {@link Frame} instead.\n *\n * @param from - Value to animate\n *\n * @param to - Value to animate to\n *\n * @param options - The options for the animation\n *\n * - `duration` - Duration of the animation\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "easeIn"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "BezierOptions"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 31,
"endIndex": 37
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 15
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 22,
"endIndex": 30
}
}
],
"name": "easeIn"
},
{
"kind": "Function",
"canonicalReference": "(easeInOut:0)",
"docComment": "/**\n * Animate value with a ease in out animation\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.easeInOut(value, 100)\n *\n * animate.easeInOut(value, 100, {duration: 1})\n * ```\n *\n * @deprecated\n *\n * Use {@link MotionProps.animate} on {@link Frame} instead.\n *\n * @param from - Value to animate\n *\n * @param to - Value to animate to\n *\n * @param options - The options for the animation\n *\n * - `duration` - Duration of the animation\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "easeInOut"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "BezierOptions"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 31,
"endIndex": 37
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 15
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 22,
"endIndex": 30
}
}
],
"name": "easeInOut"
},
{
"kind": "Function",
"canonicalReference": "(easeOut:0)",
"docComment": "/**\n * Animate value with a ease out animation\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.easeOut(value, 100)\n *\n * animate.easeOUt(value, 100, {duration: 1})\n * ```\n *\n * @deprecated\n *\n * Use {@link MotionProps.animate} on {@link Frame} instead.\n *\n * @param from - Value to animate\n *\n * @param to - Value to animate to\n *\n * @param options - The options for the animation\n *\n * - `duration` - Duration of the animation\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "easeOut"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "BezierOptions"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 31,
"endIndex": 37
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 15
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 22,
"endIndex": 30
}
}
],
"name": "easeOut"
},
{
"kind": "Function",
"canonicalReference": "(linear:0)",
"docComment": "/**\n * Animate value with a linear animation\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.linear(value, 100)\n *\n * animate.linear(value, 100, {duration: 1})\n * ```\n *\n * @deprecated\n *\n * Use {@link MotionProps.animate} on {@link Frame} instead.\n *\n * @param from - Value to animate\n *\n * @param to - Value to animate to\n *\n * @param options - The options for the animation\n *\n * - `duration` - Duration of the animation\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "linear"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EaseOptions"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "BezierOptions"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 31,
"endIndex": 37
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 15
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 22,
"endIndex": 30
}
}
],
"name": "linear"
},
{
"kind": "Function",
"canonicalReference": "(spring:0)",
"docComment": "/**\n * Animate value with a spring curve\n *\n * @remarks\n * ```jsx\n * const value = Animatable(0)\n * animate.spring(value, 100, {tension: 100, friction: 100})\n *\n * animate.spring(value, 100, {dampingRatio: 0.5, duration: 1})\n * ```\n *\n * @deprecated\n *\n * Use {@link MotionProps.animate} on {@link Frame} instead.\n *\n * @param from - Value to animate\n *\n * @param to - Value to animate to\n *\n * @param options - Options for the spring These can be either `tension`, `friction`, `velocity` and `tolerance` _or_ `dampingRatio`, `duration`, `velocity` and `mass`\n *\n * @returns Instance of {@link FramerAnimation} that can be used to control the animation\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "spring"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "SpringOptions"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "AnimationOptions"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ">>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "SpringOptions"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 31,
"endIndex": 37
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 15
}
},
{
"parameterName": "to",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 22,
"endIndex": 30
}
}
],
"name": "spring"
}
]
},
{
"kind": "Interface",
"canonicalReference": "(ArrayControlDescription:interface)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "ArrayControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": " = any> extends "
},
{
"kind": "Reference",
"text": "BaseControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"name": "ArrayControlDescription",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "defaultValue",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "defaultValue"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "any[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "defaultValue",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "maxCount",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "maxCount"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "maxCount",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "propertyControl",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "propertyControl"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "FlatControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "propertyControl",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "type",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "type"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ControlType"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Array"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "type",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
}
],
"extendsTokenRanges": [
{
"startIndex": 5,
"endIndex": 9
}
]
},
{
"kind": "Interface",
"canonicalReference": "(BackgroundProperties:interface)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "BackgroundProperties"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "BackgroundProperties",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "background",
"docComment": "/**\n * Set the background of a `Frame`. Supports color strings, color objects and images by using `src`. Set to a semi-transparent blue color by default. This will override the values set by the `image` property. To use a color and a image, use `backgroundColor` instead\n * ```jsx\n * \n * \n * \n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "background"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Background"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "background",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "backgroundColor",
"docComment": "/**\n * Set the background color of a `Frame`. Supports color strings and objects. Use this property to set a background color alongside the `image` property.\n * ```jsx\n * \n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "backgroundColor"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string | "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "backgroundColor",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "image",
"docComment": "/**\n * Sets a background image of a `Frame`. Will wrap the passed value in a `url('')` if needed.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "image"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "image",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(BaseFrameProps:interface)",
"docComment": "/**\n * @remarks\n *\n * do no use separately from FrameProps\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "BaseFrameProps"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "BaseFrameProps",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "name",
"docComment": "/**\n * Add a name to the Frame. This property does not change the behaviour of a Frame, but makes it easier to identify it in your code.\n *\n * @remarks\n *\n * The name will be rendered in the `data-framer-name` attribute of the outputted div, so the Frame is recognizable in the HTML DOM too.\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "name"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "name",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "(Color:0)",
"docComment": "/**\n * The Color function can be used to define colors, either as a string value or as an object. All colors are converted to a Color object with `r, g, b`, `h, s, l` and an `a` value. There are also various helpers on the Color function for working with, modifying and detecting colors.\n * ```jsx\n * // HEX\n * const blue = Color(\"#0099FF\")\n *\n * // RGB\n * const blue = Color(\"rgb(0, 153, 255)\")\n * const blue = Color(0, 153, 255)\n * const blue = Color({r: 0, g: 153, b: 255})\n * const blue = Color({r: 0, g: 153, b: 255, a: 1})\n *\n * // HSL\n * const blue = Color(\"hsl(204, 100, 50)\")\n * const blue = Color({h: 204, s: 100, l: 50})\n * const blue = Color({h: 204, s: 100, l: 50, a: 1})\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "declare function "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "IncomingColor"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": " | number"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "r"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "g"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "b"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 22,
"endIndex": 23
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 9
}
},
{
"parameterName": "r",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
},
{
"parameterName": "g",
"parameterTypeTokenRange": {
"startIndex": 16,
"endIndex": 17
}
},
{
"parameterName": "b",
"parameterTypeTokenRange": {
"startIndex": 20,
"endIndex": 21
}
}
],
"name": "Color"
},
{
"kind": "Interface",
"canonicalReference": "(Color:interface)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "interface "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Color",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "a",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "a"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "a",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "b",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "b"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "b",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "format",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "format"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ColorFormat"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "format",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "g",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "g"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "g",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "h",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "h"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "h",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "initialValue",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "initialValue"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "initialValue",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "isValid",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "isValid"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "isValid",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "l",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "l"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "l",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "mix",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "mix"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Mixer"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "MixerStateful"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "mix",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "r",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "r"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "r",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "roundA",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "roundA"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "roundA",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "s",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "s"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "s",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "toValue",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "toValue"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "() => string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "toValue",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Namespace",
"canonicalReference": "(Color:namespace)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "declare namespace "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Color",
"members": [
{
"kind": "Function",
"canonicalReference": "(alpha:0)",
"docComment": "/**\n * Set the alpha value, also known as opacity, of the color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * const transparent = Color.alpha(blue, 0.1)\n * ```\n *\n * @param color - The original color to modify.\n *\n * @param alpha - A number from 1 to 0. Set to 1 by default.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "alpha"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "a"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "a",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "alpha"
},
{
"kind": "Function",
"canonicalReference": "(brighten:0)",
"docComment": "/**\n * Returns a brightened color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const brightblue = Color.lighten(blue, 20)\n * ```\n *\n * @param color - The color to brighten\n *\n * @param amount - A number, from 0 to 100. Set to 10 by default.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "brighten"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "amount"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "amount",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "brighten"
},
{
"kind": "Function",
"canonicalReference": "(darken:0)",
"docComment": "/**\n * Add black and return a darkened color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const darkblue = Color.darken(blue, 20)\n * ```\n *\n * @param color - The color to darken.\n *\n * @param amount - A number, from 0 to 100. Set to 10 by default.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "darken"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "amount"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "amount",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "darken"
},
{
"kind": "Function",
"canonicalReference": "(desaturate:0)",
"docComment": "/**\n * Decrease the saturation of a color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const desaturated = Color.desaturate(blue, 100)\n * ```\n *\n * @param color - The color to modify\n *\n * @param amount - A number from 0 to 100. Set to 10 by default.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "desaturate"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "amount"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "amount",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "desaturate"
},
{
"kind": "Function",
"canonicalReference": "(difference:0)",
"docComment": "/**\n * Calculates the color difference using {@link https://en.wikipedia.org/wiki/Color_difference#Euclidean | Euclidean distance fitting human perception}. Returns a value between 0 and 765\n *\n * @param colorA - A first color.\n *\n * @param colorB - A second color.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "difference"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "colorA"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "colorB"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "colorA",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "colorB",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "difference"
},
{
"kind": "Function",
"canonicalReference": "(equal:0)",
"docComment": "/**\n * Checks whether two Color objects are equal.\n *\n * @remarks\n * ```jsx\n * Color.equal(Color(\"red\"), Color(\"red\")) // true\n * Color.equal(Color(\"red\"), Color(\"blue\")) // false\n *\n * Color.equal(Color(\"#0099FF\"), Color(\"009AFF\")) // false\n * Color.equal(Color(\"#0099FF\"), Color(\"009AFF\"), 2) // true\n * ```\n *\n * @param colorA - The first color\n *\n * @param colorB - The second color\n *\n * @param tolerance - A tolerance for the difference between rgba values. Set to 0.1 by default.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "equal"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "colorA"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "colorB"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "tolerance"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 15,
"endIndex": 16
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "colorA",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "colorB",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
},
{
"parameterName": "tolerance",
"parameterTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
}
}
],
"name": "equal"
},
{
"kind": "Function",
"canonicalReference": "(grayscale:0)",
"docComment": "/**\n * Return a fully desaturated color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const gray = Color.grayscale(blue)\n * ```\n *\n * @param color - The color to convert.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "grayscale"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "grayscale"
},
{
"kind": "Function",
"canonicalReference": "(grey:0)",
"docComment": "/**\n * Creates a greyscale color.\n *\n * @remarks\n * ```jsx\n * const gray = Color.gray(0.5)\n * ```\n *\n * @param amount - A number from 0 to 1 representing the amount of white.\n *\n * @param alphaValue - A number from 0 to 1 representing the alpha. Set to 1 by default.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "grey"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "amount"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "alphaValue"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "amount",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "alphaValue",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "grey"
},
{
"kind": "Function",
"canonicalReference": "(hueRotate:0)",
"docComment": "/**\n * Returns a new color for the rotated hue.\n *\n * @param color - The color to manipulate\n *\n * @param angle - The angle in degrees in which to rotate the hue.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "hueRotate"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "angle"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "angle",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "hueRotate"
},
{
"kind": "Function",
"canonicalReference": "(inspect:0)",
"docComment": "/**\n * Formats a Color object into a readable string for debugging.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.inspect(blue)\n * ```\n *\n * @param color - The Color object to format\n *\n * @param initialValue - A canonical hex string to be used instead of an rgba() value.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "inspect"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "initialValue"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "initialValue",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "inspect"
},
{
"kind": "Function",
"canonicalReference": "(interpolate:0)",
"docComment": "/**\n * Returns a function that can be used to transition a color from one value to another. By default this will use the RGB `mix` model. Useful for providing to animation tools.\n * ```jsx\n * const blend = Color.interpolate(Color(\"red\"), Color(\"blue\"))\n *\n * blend(0) // Initial state (red)\n * blend(0.5) // Mid state (purple)\n * blend(1) // Final state (blue)\n * ```\n *\n * @param colorA - The starting color\n *\n * @param colorB - The final color\n *\n * @param model - The model to use for the mix. One of {@link ColorMixModelType}\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "interpolate"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "colorA"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "colorB"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "model"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "ColorMixModelType"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "progress"
},
{
"kind": "Content",
"text": ": number) => "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 15,
"endIndex": 19
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "colorA",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "colorB",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
},
{
"parameterName": "model",
"parameterTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
}
}
],
"name": "interpolate"
},
{
"kind": "Function",
"canonicalReference": "(isColor:0)",
"docComment": "/**\n * Checks if the value is a valid color object or color string. Returns true or false.\n *\n * @remarks\n * ```jsx\n * Color.isColor(\"#0099FF\") // true\n * Color.isColor(Color(\"#0099FF\")) // true\n * ```\n *\n * @param color - The potential color value to validate\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "isColor"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string | "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
}
}
],
"name": "isColor"
},
{
"kind": "Function",
"canonicalReference": "(isColorObject:0)",
"docComment": "/**\n * Checks if the value is a valid Color object. Returns true or false.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.isColorObject(blue) // true\n * Color.isColorObject(\"#0099FF\") // false\n * ```\n *\n * @param color - An object representing a color.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "isColorObject"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": " is object & "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "isColorObject"
},
{
"kind": "Function",
"canonicalReference": "(isColorString:0)",
"docComment": "/**\n * Checks if the value is a valid color string. Returns true or false.\n *\n * @remarks\n * ```jsx\n * Color.isColorString(\"#0099FF\") // true\n * ```\n *\n * @param color - A string representing a color\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "isColorString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "colorString"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string | object"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "colorString",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "isColorString"
},
{
"kind": "Function",
"canonicalReference": "(lighten:0)",
"docComment": "/**\n * Add white and return a lightened color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const lightblue = Color.lighten(blue, 20)\n * ```\n *\n * @param color - The color to lighten\n *\n * @param amount - A number, from 0 to 100. Set to 10 by default.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "lighten"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "amount"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "amount",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "lighten"
},
{
"kind": "Function",
"canonicalReference": "(mix:0)",
"docComment": "/**\n * Create a function that will mix two colors together and output the result as an rgb string.\n *\n * @param colorA - The starting color\n *\n * @param colorB - The final color\n *\n * @param options - Options for the color mixer\n *\n * - `model`: The model to use for the mix. One of {@link ColorMixModelType}\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "mix"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "from"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "toColor"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", { "
},
{
"kind": "Reference",
"text": "model"
},
{
"kind": "Content",
"text": " }?: "
},
{
"kind": "Content",
"text": "{\n "
},
{
"kind": "Reference",
"text": "model"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "ColorMixModelType"
},
{
"kind": "Content",
"text": " | undefined;\n }"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "p"
},
{
"kind": "Content",
"text": ": number) => string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 19,
"endIndex": 22
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "from",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "toColor",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
},
{
"parameterName": "{ model }",
"parameterTypeTokenRange": {
"startIndex": 13,
"endIndex": 18
}
}
],
"name": "mix"
},
{
"kind": "Function",
"canonicalReference": "(mixAsColor:0)",
"docComment": "/**\n * Blend two colors together, optionally based on user input. The fraction defines the distribution between the two colors, and is set to 0.5 by default. The `limit` defines if the color can transition beyond its range.\n *\n * @remarks\n * ```jsx\n * // Mix red with yellow\n * const orange = Color.mix(\"red\", \"yellow\", 0.5)\n * ```\n *\n * ```jsx\n * Color.mix(\"red\", \"yellow\", 0.5, true, \"husl\")\n * ```\n *\n * @param colorA - A color, the first one.\n *\n * @param colorB - A color, the second one.\n *\n * @param fraction - An optional number, from 0 to 1, set to 0.5 by default.\n *\n * @param limit - An optional boolean, set to false by default.\n *\n * @param model - The model to use for the mix. One of {@link ColorMixModelType}\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "mixAsColor"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "colorA"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "colorB"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "fraction"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "limit"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "model"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "ColorMixModelType"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 23,
"endIndex": 25
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "colorA",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "colorB",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
},
{
"parameterName": "fraction",
"parameterTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
}
},
{
"parameterName": "limit",
"parameterTypeTokenRange": {
"startIndex": 17,
"endIndex": 18
}
},
{
"parameterName": "model",
"parameterTypeTokenRange": {
"startIndex": 21,
"endIndex": 22
}
}
],
"name": "mixAsColor"
},
{
"kind": "Function",
"canonicalReference": "(multiplyAlpha:0)",
"docComment": "/**\n * Change the alpha value, also know as opacity, by a multiplier.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const transparent = Color.multiplyAlpha(blue, 0.5)\n * ```\n *\n * @param color - The original color to modify.\n *\n * @param alphaValue - A number between 1 and 0, defaults to 1,\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "multiplyAlpha"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "alphaValue"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "alphaValue",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "multiplyAlpha"
},
{
"kind": "Function",
"canonicalReference": "(random:0)",
"docComment": "/**\n * Returns a Color instance with a random color value set.\n *\n * @remarks\n * ```jsx\n * const random = Color.random()\n * ```\n *\n * @param alphaValue - An optional alpha value, set to 1 by default.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "random"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "alphaValue"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "alphaValue",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "random"
},
{
"kind": "Function",
"canonicalReference": "(saturate:0)",
"docComment": "/**\n * Increase the saturation of a color.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n * const saturated = Color.saturate(blue, 100)\n * ```\n *\n * @param color - The color to modify\n *\n * @param amount - A number from 0 to 100. Set to 10 by default.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "saturate"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "amount"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "amount",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "saturate"
},
{
"kind": "Function",
"canonicalReference": "(toHex:0)",
"docComment": "/**\n * Formats a Color instance into an hexidecimal value.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHex(blue) // \"0099FF\"\n * Color.toHex(Color(\"#FFAAFF\"), true) // \"FAF\"\n * ```\n *\n * @param color - The color to format\n *\n * @param allow3Char - If true will return short hand colors if possible (defaults to false).\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHex"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "allow3Char"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "allow3Char",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "toHex"
},
{
"kind": "Function",
"canonicalReference": "(toHexString:0)",
"docComment": "/**\n * Formats a Color instance into an hexidecimal string.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHexString(blue) // \"#0099FF\"\n * Color.toHexString(Color(\"#FFAAFF\"), true) // \"#FAF\"\n * ```\n *\n * @param color - The color to format\n *\n * @param allow3Char - If true will return short hand colors if possible (defaults to false).\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHexString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "allow3Char"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "allow3Char",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "toHexString"
},
{
"kind": "Function",
"canonicalReference": "(toHsl:0)",
"docComment": "/**\n * Formats a color into an HSL object.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHsl(blue) // {h: 204, s: 1, l: 0.5, a: 1}\n * ```\n *\n * @param color - The color to format\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHsl"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ColorHSLA"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toHsl"
},
{
"kind": "Function",
"canonicalReference": "(toHslString:0)",
"docComment": "/**\n * Formats a Color instance into an HSL string.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHslString(blue) // \"hsl(204, 100%, 50%)\"\n * ```\n *\n * @param color - The color to format\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHslString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toHslString"
},
{
"kind": "Function",
"canonicalReference": "(toHsv:0)",
"docComment": "/**\n * Formats a Color instance into an HSV object.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHsv(blue) // {h: 204, s: 1, v: 1, a: 1}\"\n * ```\n *\n * @param color - The color to format\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHsv"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ColorHSVA"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toHsv"
},
{
"kind": "Function",
"canonicalReference": "(toHsvString:0)",
"docComment": "/**\n * Formats a Color instance into an HSV string.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHslString(blue) // \"hsv(204, 100%, 50%)\"\n * ```\n *\n * @param color - The color to format\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHsvString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toHsvString"
},
{
"kind": "Function",
"canonicalReference": "(toHusl:0)",
"docComment": "/**\n * Formats a Color instance into an HUSL object.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toHusl(blue) // {h: 250, s: 100, l: 50, a: 1}\n * ```\n *\n * @param color - The color to format\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHusl"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ColorHSLA"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toHusl"
},
{
"kind": "Function",
"canonicalReference": "(toName:0)",
"docComment": "/**\n * Formats a Color instance into {@link https://css-tricks.com/snippets/css/named-colors-and-hex-equivalents/ | CSS name} or returns false if unspecified.\n *\n * @remarks\n * ```jsx\n * const green = Color(\"#8FBC8F\")\n *\n * Color.toName(green) // \"darkseagreen\"\n * ```\n *\n * @param color - The color to format\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toName"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string | false"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toName"
},
{
"kind": "Function",
"canonicalReference": "(toRgb:0)",
"docComment": "/**\n * Formats a color into an RGB object.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toRgb(blue) // {r: 40, g: 175, b: 250, a: 1}\n * ```\n *\n * @param color - The color to format\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toRgb"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ColorRGBA"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toRgb"
},
{
"kind": "Function",
"canonicalReference": "(toRgbString:0)",
"docComment": "/**\n * Formats a Color instance into an RGB string.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toRgbString(blue) // \"rgb(0, 153, 255)\"\n * ```\n *\n * @param color - The color to format\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toRgbString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toRgbString"
},
{
"kind": "Function",
"canonicalReference": "(toString:0)",
"docComment": "/**\n * Formats a Color instance into an RGB string.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * Color.toString(blue) // \"rgb(0, 153, 255)\"\n * ```\n *\n * @param color - The color to format\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toString"
},
{
"kind": "Function",
"canonicalReference": "(transparent:0)",
"docComment": "/**\n * Set the alpha value, also known as opacity, of the color to zero.\n *\n * @remarks\n * ```jsx\n * const blue = Color(\"#0099FF\")\n *\n * const transparent = Color.alpha(blue)\n * ```\n *\n * @param color - The original color to modify.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "transparent"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "transparent"
}
]
},
{
"kind": "Enum",
"canonicalReference": "(ColorMixModelType:enum)",
"docComment": "/**\n * Various Color functions, such as {@link (Color:namespace).mix} and {@link (Color:namespace).interpolate}, take an optional color model that determines how two colors are mixed together.\n *\n * @remarks\n * ```javascript\n * const newColor = Color.mix(Color(\"red\"), Color(\"blue\"), {model: ColorMixModelType.HSL})\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare enum "
},
{
"kind": "Reference",
"text": "ColorMixModelType"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ColorMixModelType",
"members": [
{
"kind": "EnumMember",
"canonicalReference": "HSL",
"docComment": "/**\n * Use the {@link https://en.wikipedia.org/wiki/HSL_and_HSV | HSL} color space with an alpha value\n *\n * @remarks\n * ```javascript\n * const newColor = Color.mix(Color(\"red\"), Color(\"blue\"), {model: ColorMixModelType.HSL})\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "HSL"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"hsl\""
}
],
"releaseTag": "Public",
"name": "HSL",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "HSLA",
"docComment": "/**\n * Use the {@link https://en.wikipedia.org/wiki/HSL_and_HSV | HSL} color space with an alpha value\n *\n * @remarks\n * ```javascript\n * const newColor = Color.mix(Color(\"red\"), Color(\"blue\"), {model: ColorMixModelType.HSLA})\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "HSLA"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"hsla\""
}
],
"releaseTag": "Public",
"name": "HSLA",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "HUSL",
"docComment": "/**\n * Use the {@link http://www.hsluv.org | HSLuv} human friendly color model\n *\n * @remarks\n * ```javascript\n * const newColor = Color.mix(Color(\"red\"), Color(\"blue\"), {model: ColorMixModelType.HUSL})\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "HUSL"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"husl\""
}
],
"releaseTag": "Public",
"name": "HUSL",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "RGB",
"docComment": "/**\n * Use the {@link https://en.wikipedia.org/wiki/RGB_color_model | RGB color space} without an alpha value\n *\n * @remarks\n * ```javascript\n * const newColor = Color.mix(Color(\"red\"), Color(\"blue\"), {model: ColorMixModelType.RGB})\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "RGB"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"rgb\""
}
],
"releaseTag": "Public",
"name": "RGB",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "RGBA",
"docComment": "/**\n * Use the {@link https://en.wikipedia.org/wiki/RGB_color_model | RGB color space} color space with an alpha value\n *\n * @remarks\n * ```javascript\n * const newColor = Color.mix(Color(\"red\"), Color(\"blue\"), {model: ColorMixModelType.RGBA})\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "RGBA"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"rgba\""
}
],
"releaseTag": "Public",
"name": "RGBA",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
]
},
{
"kind": "Enum",
"canonicalReference": "(ControlType:enum)",
"docComment": "/**\n * Used by the {@link PropertyControls} and specifies the type of user interface for receiving input. Each field has a distinct set of properties though they all accept `title` and `hidden` properties.\n *\n * @remarks\n * ```javascript\n * addPropertyControls(MyComponent, {\n * text: {\n * type: ControlType.String,\n * title: \"Text\",\n * hidden: (props) => true\n * },\n * }\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare const enum "
},
{
"kind": "Reference",
"text": "ControlType"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ControlType",
"members": [
{
"kind": "EnumMember",
"canonicalReference": "Array",
"docComment": "/**\n * A property control that allows multiple values per `ControlType`, provided as an array via properties. For most control types this will be displayed as an additional section in the properties panel allowing as many fields to be provided as required.\n *\n * For a {@link ControlType.ComponentInstance} the Frame will also gain an additional outlet control on the Canvas that allows links to be created between frames.\n * ```javascript\n * addPropertyControls(MyComponent, {\n * images: {\n * type: ControlType.Array,\n * propertyControl: {\n * type: ControlType.Image\n * }\n * },\n * children: {\n * type: ControlType.Array,\n * propertyControl: {\n * type: ControlType.ComponentInstance\n * }\n * },\n * })\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "Array"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"array\""
}
],
"releaseTag": "Public",
"name": "Array",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "Boolean",
"docComment": "/**\n * A property control that displays an on / off checkbox. The associated property will be `true` or `false`, depending on the state of the checkbox. Includes an optional `defaultValue`, which is set to `true` by default. You can also customize the labels displayed in the property panel with the `enabledTitle` and `disabledTitle` properties.\n *\n * @remarks\n * ```javascript\n * addPropertyControls(MyComponent, {\n * isCentered: {\n * type: ControlType.Boolean,\n * title: \"Center\",\n * defaultValue: true,\n * enabledTitle: \"On\",\n * disabledTitle: \"Off\",\n * },\n * })\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "Boolean"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"boolean\""
}
],
"releaseTag": "Public",
"name": "Boolean",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "Color",
"docComment": "/**\n * A property control that represents a color value. It will be provided as a string via properties. This control is displayed as a color field and will provide the selected color in either HEX (`\"#fff\"`) or HSL (`hsla(203, 87%, 50%, 0.5)`) notation, depending on whether there is an alpha channel.\n *\n * @remarks\n * ```javascript\n * addPropertyControls(MyComponent, {\n * background: {\n * type: ControlType.Color,\n * defaultValue: \"#fff\",\n * },\n * })\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"color\""
}
],
"releaseTag": "Public",
"name": "Color",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "ComponentInstance",
"docComment": "/**\n * A property control that references to another components on the canvas, provided via a property. The component will have an outlet to allow linking to other Frames. Available Frames will also be displayed in a dropdown menu in the properties panel. The component reference will be provided as a property. As a convention, the name for the property is usually just `children`.\n *\n * Multiple components can be linked by combining the `ComponentInstance` type with the {@link ControlType.Array}.\n * ```javascript\n * addPropertyControls(MyComponent, {\n * children: {\n * type: ControlType.ComponentInstance,\n * },\n * })\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "ComponentInstance"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"componentinstance\""
}
],
"releaseTag": "Public",
"name": "ComponentInstance",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "Enum",
"docComment": "/**\n * A property control that represents a list of options. The selected option will be provided as a property. This control is displayed as a dropdown menu in which a user can select one of the items.\n * ```javascript\n * addPropertyControls(MyComponent, {\n * value: {\n * type: ControlType.Enum,\n * defaultValue: \"a\",\n * options: [\"a\", \"b\", \"c\"],\n * optionTitles: [\"Option A\", \"Option B\", \"Option C\"],\n * },\n * })\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "Enum"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"enum\""
}
],
"releaseTag": "Public",
"name": "Enum",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "File",
"docComment": "/**\n * A property control that represents a resource. It will be provided as an URL via properties. Displayed as an file picker that will open a native file browser. The selected file will be provided as a fully qualified URL. The `allowedFileTypes` property must be provided to specify acceptable file types.\n *\n * @remarks\n * ```javascript\n * addPropertyControls(MyComponent, {\n * asset: {\n * type: ControlType.File,\n * allowedFileTypes: [\"pdf\"],\n * },\n * })\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "File"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"file\""
}
],
"releaseTag": "Public",
"name": "File",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "FusedNumber",
"docComment": "/**\n * A property control that can be used to take a single number or four distinct numeric input fields. The typical use case for this control is for visual properties like border, padding or margin. It will display an input field to accept a single value, alongside a segmented control allowing four distinct values to be provided.\n * ```javascript\n * addPropertyControls(MyComponent, {\n * title: {\n * type: ControlType.FusedNumber,\n * defaultValue: 0,\n * toggleKey: \"isPerSide\",\n * valueKeys: [\"top\", \"left\", \"right\", \"bottom\"],\n * valueLabels: [\"T\", \"L\", \"R\", \"B\"],\n * min: 0,\n * },\n * })\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "FusedNumber"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"fusednumber\""
}
],
"releaseTag": "Public",
"name": "FusedNumber",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "Image",
"docComment": "/**\n * A property control that represents an image resource. It will be provided as an URL via properties. Displayed as an image picker with associated file picker. The chosen asset will be provided as a fully qualified URL.\n *\n * @remarks\n * ```jsx\n * addPropertyControls(MyComponent, {\n * avatar: {\n * type: ControlType.Image,\n * }\n * })\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "Image"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"image\""
}
],
"releaseTag": "Public",
"name": "Image",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "Number",
"docComment": "/**\n * A property control that accepts any numeric value. This will be provided directly as a property. Will display an input field with a range slider by default. The `displayStepper` option can be provided to include a stepper control instead.\n *\n * @remarks\n * ```javascript\n * addPropertyControls(MyComponent, {\n * offset: {\n * type: ControlType.Number,\n * defaultValue: 5,\n * min: 0,\n * max: 10,\n * unit: \"px\",\n * step: 0.1,\n * displayStepper: true,\n * },\n * })\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "Number"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"number\""
}
],
"releaseTag": "Public",
"name": "Number",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "SegmentedEnum",
"docComment": "/**\n * A property control that represents a list of option. The selected option will be provided as a property. This control is displayed as a segmented control. Otherwise, it behaves exactly the same as {@link ControlType.Enum}.\n *\n * @remarks\n * ```javascript\n * addPropertyControls(MyComponent, {\n * value: {\n * type: ControlType.SegmentedEnum,\n * defaultValue: \"a\",\n * options: [\"a\", \"b\", \"c\"],\n * optionTitles: [\"Option A\", \"Option B\", \"Option C\"],\n * },\n * })\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "SegmentedEnum"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"segmentedenum\""
}
],
"releaseTag": "Public",
"name": "SegmentedEnum",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "String",
"docComment": "/**\n * A property control that accepts plain text values. This will be provided directly as a property. Will display an input field with an optional placeholder value.\n *\n * @remarks\n * ```javascript\n * addPropertyControls(MyComponent, {\n * offset: {\n * type: ControlType.String,\n * defaultValue: \"Framer X\",\n * placeholder: \"Type something…\",\n * },\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "String"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"string\""
}
],
"releaseTag": "Public",
"name": "String",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
]
},
{
"kind": "Namespace",
"canonicalReference": "(ConvertColor:namespace)",
"docComment": "/**\n * @beta\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace "
},
{
"kind": "Reference",
"text": "ConvertColor"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Beta",
"name": "ConvertColor",
"members": [
{
"kind": "Function",
"canonicalReference": "(equals:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "equals"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "a"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": " | string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "b"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Color"
},
{
"kind": "Content",
"text": " | string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "a",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
}
},
{
"parameterName": "b",
"parameterTypeTokenRange": {
"startIndex": 10,
"endIndex": 12
}
}
],
"name": "equals"
},
{
"kind": "Function",
"canonicalReference": "(getAlpha:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "getAlpha"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "getAlpha"
},
{
"kind": "Function",
"canonicalReference": "(hsvToHSLString:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "hsvToHSLString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "hsv"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ColorHSV"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "ColorHSVA"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "hsv",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 8
}
}
],
"name": "hsvToHSLString"
},
{
"kind": "Function",
"canonicalReference": "(hsvToString:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "hsvToString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "hsv"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ColorHSV"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "ColorHSVA"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "hsv",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 8
}
}
],
"name": "hsvToString"
},
{
"kind": "Function",
"canonicalReference": "(hueRotate:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "hueRotate"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "angle"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "angle",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "hueRotate"
},
{
"kind": "Function",
"canonicalReference": "(isValid:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "isValid"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "isValid"
},
{
"kind": "Function",
"canonicalReference": "(multiplyAlpha:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "multiplyAlpha"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "alpha"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "alpha",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "multiplyAlpha"
},
{
"kind": "Function",
"canonicalReference": "(rgbaToString:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "rgbaToString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ColorRGB"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "ColorRGBA"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 8
}
}
],
"name": "rgbaToString"
},
{
"kind": "Function",
"canonicalReference": "(setAlpha:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "setAlpha"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "alpha"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "alpha",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "setAlpha"
},
{
"kind": "Function",
"canonicalReference": "(toColorPickerSquare:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toColorPickerSquare"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "h"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "h",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toColorPickerSquare"
},
{
"kind": "Function",
"canonicalReference": "(toHex:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHex"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toHex"
},
{
"kind": "Function",
"canonicalReference": "(toHexOrRgbaString:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHexOrRgbaString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "input"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "input",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toHexOrRgbaString"
},
{
"kind": "Function",
"canonicalReference": "(toHSL:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHSL"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ColorHSLA"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toHSL"
},
{
"kind": "Function",
"canonicalReference": "(toHslString:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHslString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toHslString"
},
{
"kind": "Function",
"canonicalReference": "(toHSV:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHSV"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ColorHSVA"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toHSV"
},
{
"kind": "Function",
"canonicalReference": "(toHsvString:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toHsvString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toHsvString"
},
{
"kind": "Function",
"canonicalReference": "(toRgb:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toRgb"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ColorRGBA"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toRgb"
},
{
"kind": "Function",
"canonicalReference": "(toRgbString:0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "toRgbString"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Beta",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "color",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "toRgbString"
}
]
},
{
"kind": "Interface",
"canonicalReference": "(CSSTransformProperties:interface)",
"docComment": "/**\n * @internalremarks\n *\n * do no use separately from FrameProps\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "CSSTransformProperties"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "MotionTransform"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "CSSTransformProperties",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "originX",
"docComment": "/**\n * Set the CSS transform `originX` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "originX"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "originX",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "originY",
"docComment": "/**\n * Set the CSS transform `originY` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "originY"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "originY",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "originZ",
"docComment": "/**\n * Set the CSS transform `originZ` property. Defaults to `px` units.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "originZ"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "originZ",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "perspective",
"docComment": "/**\n * Set the CSS perspective property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "perspective"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "perspective",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "rotate",
"docComment": "/**\n * Set the CSS transform `rotate` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "rotate"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "rotate",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "rotateX",
"docComment": "/**\n * Set the CSS transform `rotateX` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "rotateX"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "rotateX",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "rotateY",
"docComment": "/**\n * Set the CSS transform `rotateY` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "rotateY"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "rotateY",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "rotateZ",
"docComment": "/**\n * Set the CSS transform `rotateZ` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "rotateZ"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "rotateZ",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "scale",
"docComment": "/**\n * Set the CSS transform `scale` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "scale"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "scale",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "scaleX",
"docComment": "/**\n * Set the CSS transform `scaleX` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "scaleX"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "scaleX",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "scaleY",
"docComment": "/**\n * Set the CSS transform `scaleY` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "scaleY"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "scaleY",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "skew",
"docComment": "/**\n * Set the CSS transform `skew` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "skew"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "skew",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "skewX",
"docComment": "/**\n * Set the CSS transform `skewX` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "skewX"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "skewX",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "skewY",
"docComment": "/**\n * Set the CSS transform `skewY` property in degrees.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "skewY"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "skewY",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "x",
"docComment": "/**\n * Set the CSS transform `translateX` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "x"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "x",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "y",
"docComment": "/**\n * Set the CSS transform `translateY` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "y"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "y",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "z",
"docComment": "/**\n * Set the CSS transform `translateZ` property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "z"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "z",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
},
{
"kind": "Function",
"canonicalReference": "(Data:0)",
"docComment": "/**\n * Allows data to be shared between Frames using Code Overrides. Any changes to the `Data` instance will cause the preview to update and code overrides will re-render. In this example, we’re updating the `scale` property on `press`, setting it to `0.5`.\n * ```jsx\n * import { Data, Override } from \"framer\"\n *\n * const data = Data({\n * scale: 0.5,\n * })\n *\n * export function WhileTap(): Override {\n * return {\n * whileTap: {\n * scale: data.scale,\n * },\n * }\n * }\n *\n * ```\n *\n * @param initial - The initial value of the data to be set.\n *\n * @returns the data object for use across components.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "Data"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " extends object = object>("
},
{
"kind": "Reference",
"text": "initial"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "> | object"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "initial",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 11
}
}
],
"name": "Data"
},
{
"kind": "Namespace",
"canonicalReference": "(Data:namespace)",
"docComment": "/**\n * @internalremarks\n *\n * The release tag on this should be internal, but API extractor does not support that yet: https://github.com/Microsoft/web-build-tools/issues/972\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace "
},
{
"kind": "Reference",
"text": "Data"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Data",
"members": []
},
{
"kind": "Class",
"canonicalReference": "(DeprecatedFrame:class)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "DeprecatedFrame"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Layer"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "DeprecatedCoreFrameProps"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "DeprecatedFrameState"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"name": "DeprecatedFrame",
"members": [
{
"kind": "Method",
"canonicalReference": "(componentDidMount:instance,0)",
"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",
"canonicalReference": "(componentDidUpdate:instance,0)",
"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": "Method",
"canonicalReference": "(componentWillUnmount:instance,0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "componentWillUnmount"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "componentWillUnmount"
},
{
"kind": "Property",
"canonicalReference": "(defaultFrameSpecificProps:static)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static "
},
{
"kind": "Reference",
"text": "defaultFrameSpecificProps"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "DeprecatedFrameProperties"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "defaultFrameSpecificProps",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": true
},
{
"kind": "Property",
"canonicalReference": "(defaultProps:static)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static readonly "
},
{
"kind": "Reference",
"text": "defaultProps"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "DeprecatedCoreFrameProps"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "defaultProps",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": true
},
{
"kind": "Property",
"canonicalReference": "(element:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "element"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "HTMLDivElement"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "element",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "(getDerivedStateFromProps:static,0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static "
},
{
"kind": "Reference",
"text": "getDerivedStateFromProps"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "nextProps"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "DeprecatedCoreFrameProps"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "prevState"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "DeprecatedFrameState"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "DeprecatedFrameState"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": true,
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 16
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "nextProps",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 9
}
},
{
"parameterName": "prevState",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "getDerivedStateFromProps"
},
{
"kind": "Method",
"canonicalReference": "(getStyle:instance,0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "getStyle"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "CSSProperties"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getStyle"
},
{
"kind": "Property",
"canonicalReference": "(imageDidChange:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "imageDidChange"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "imageDidChange",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "(layoutChildren:instance,0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "layoutChildren"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "ReactElement"
},
{
"kind": "Content",
"text": " "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "ReactElement"
},
{
"kind": "Content",
"text": " "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Component"
},
{
"kind": "Content",
"text": ")> | null) | (new ("
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ": any) => "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Component"
},
{
"kind": "Content",
"text": ")>[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 24
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "layoutChildren"
},
{
"kind": "Property",
"canonicalReference": "(onPropsChange:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "protected "
},
{
"kind": "Reference",
"text": "onPropsChange"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Change"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "DeprecatedCoreFrameProps"
},
{
"kind": "Content",
"text": ">>) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "onPropsChange",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 12
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(onSizeChange:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "protected "
},
{
"kind": "Reference",
"text": "onSizeChange"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "onSizeChange",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(propsObserver:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "propsObserver"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "DeprecatedCoreFrameProps"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "propsObserver",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(propsObserverCancel:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "propsObserverCancel"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Cancel"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "propsObserverCancel",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(rect:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "rect"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "rect",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "(rect:static,0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static "
},
{
"kind": "Reference",
"text": "rect"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ConstraintProperties"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": true,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "props",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 9
}
}
],
"name": "rect"
},
{
"kind": "Method",
"canonicalReference": "(render:instance,0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "render"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "JSX"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Element"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "render"
},
{
"kind": "Property",
"canonicalReference": "(setElement:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "setElement"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "element"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "HTMLDivElement"
},
{
"kind": "Content",
"text": " | null) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "setElement",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(sizeObserver:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "sizeObserver"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Size"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "sizeObserver",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(sizeObserverCancel:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "sizeObserverCancel"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Cancel"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "sizeObserverCancel",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(state:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "state"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "DeprecatedFrameState"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "state",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(supportsConstraints:static)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static "
},
{
"kind": "Reference",
"text": "supportsConstraints"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "supportsConstraints",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": true
},
{
"kind": "Method",
"canonicalReference": "(updatedSize:static,0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static "
},
{
"kind": "Reference",
"text": "updatedSize"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "DeprecatedCoreFrameProps"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "state"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "DeprecatedFrameState"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Size"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "Size"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": true,
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 19
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "props",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 9
}
},
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "updatedSize"
}
],
"extendsTokenRange": {
"startIndex": 3,
"endIndex": 9
},
"implementsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(DeprecatedFrameProperties:interface)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "DeprecatedFrameProperties"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "ConstraintProperties"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "DeprecatedTransformProperties"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "DeprecatedVisualProperties"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "DeprecatedFrameProperties",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "backfaceVisible",
"docComment": "/**\n * Set to `true` to enable backface-visibility.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "backfaceVisible"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean | "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "backfaceVisible",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "borderColor",
"docComment": "/**\n * A border color for the Frame. Set to `\"#222\"` by default.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "borderColor"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "borderColor",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "borderStyle",
"docComment": "/**\n * A border style for the Frame. One of `\"solid\", \"dashed\", \"dotted\"` or `\"double\"`. Set to `\"solid\"` by default.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "borderStyle"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BorderStyle"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "borderStyle",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "borderWidth",
"docComment": "/**\n * A border width for the frame. Can be either a single number for all sides or an object describing each side. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "borderWidth"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<{\n "
},
{
"kind": "Reference",
"text": "top"
},
{
"kind": "Content",
"text": ": number;\n "
},
{
"kind": "Reference",
"text": "bottom"
},
{
"kind": "Content",
"text": ": number;\n "
},
{
"kind": "Reference",
"text": "left"
},
{
"kind": "Content",
"text": ": number;\n "
},
{
"kind": "Reference",
"text": "right"
},
{
"kind": "Content",
"text": ": number;\n }>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "borderWidth",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 13
}
},
{
"kind": "PropertySignature",
"canonicalReference": "className",
"docComment": "/**\n * An optional className for the Frame.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "className"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "className",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "name",
"docComment": "/**\n * An optional name for the Frame.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "name"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "name",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "perspective",
"docComment": "/**\n * Set the perspective on the z-plane.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "perspective"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number | "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "perspective",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "preserve3d",
"docComment": "/**\n * Set to `true` to preserve 3D.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "preserve3d"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean | "
},
{
"kind": "Reference",
"text": "Animatable"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "preserve3d",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "style",
"docComment": "/**\n * Additional CSSProperties to apply to the frame. Usage is exactly the same as with the standard React style prop.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "style"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "CSSProperties"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "style",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "visible",
"docComment": "/**\n * Determines whether the Frame is current visible. Set to `true` by default.\n *\n * @remarks\n * ```jsx\n * function App() {\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "visible"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "visible",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 4
},
{
"startIndex": 5,
"endIndex": 6
},
{
"startIndex": 7,
"endIndex": 9
}
]
},
{
"kind": "Interface",
"canonicalReference": "(FrameLayoutProperties:interface)",
"docComment": "/**\n * @internalremarks\n *\n * do no use separately from FrameProps\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "FrameLayoutProperties"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "FrameLayoutProperties",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "bottom",
"docComment": "/**\n * Distance from the bottom in pixels. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "bottom"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "bottom",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "center",
"docComment": "/**\n * Shortcut for centering Frames.\n *\n * @remarks\n * ```jsx\n * // Center\n * \n *\n * // Center horizontally\n * \n *\n * // Center vertically\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "center"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean | \"x\" | \"y\""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "center",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "height",
"docComment": "/**\n * Set the CSS `height` property. Set to `200` by default. Accepts all CSS value types (including pixels, percentages, keywords and more).\n *\n * @remarks\n * ```jsx\n * // Pixels\n * \n *\n * // Percentages\n * \n *\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "height"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "height",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "left",
"docComment": "/**\n * Distance from the left in pixels. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "left"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "left",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "position",
"docComment": "/**\n * Set the CSS `position` property. Set to `\"absolute\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "position"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "CSSProperties"
},
{
"kind": "Content",
"text": "[\"position\"]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "position",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
}
},
{
"kind": "PropertySignature",
"canonicalReference": "right",
"docComment": "/**\n * Distance from the right in pixels. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "right"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "right",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "size",
"docComment": "/**\n * Shortcut for setting the width and height simultaneously.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "size"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "size",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "top",
"docComment": "/**\n * Distance from the top in pixels. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "top"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "top",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "width",
"docComment": "/**\n * Set the CSS `width` property. Set to `200` by default. Accepts all CSS value types (including pixels, percentages, keywords and more).\n *\n * @remarks\n * ```jsx\n * // Pixels\n * \n *\n * // Percentages\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "width"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "width",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(FrameProps:interface)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "FrameProps"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "BackgroundProperties"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "VisualProperties"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Omit"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "MotionDivProps"
},
{
"kind": "Content",
"text": ", \"color\">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "CSSTransformProperties"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "LayerProps"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "FrameLayoutProperties"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "ConstraintConfiguration"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "BaseFrameProps"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "FrameProps",
"members": [],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 4
},
{
"startIndex": 5,
"endIndex": 6
},
{
"startIndex": 7,
"endIndex": 11
},
{
"startIndex": 12,
"endIndex": 13
},
{
"startIndex": 14,
"endIndex": 15
},
{
"startIndex": 16,
"endIndex": 17
},
{
"startIndex": 18,
"endIndex": 19
},
{
"startIndex": 20,
"endIndex": 22
}
]
},
{
"kind": "Class",
"canonicalReference": "(FramerAnimation:class)",
"docComment": "/**\n * The animation object returned by the {@link (animate:function)} functions\n *\n * @remarks\n *\n * Can be used to control a animation or wait for it to finish. You never create a FramerAnimation yourself, but store the return type from the animate function.\n * ```jsx\n * const animation = animate.ease(value, 100)\n * await animation.finished()\n * const animation = animate.spring(value, 200)\n * animation.cancel()\n * ```\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FramerAnimation` class.\n *\n * @deprecated\n *\n * Use the {@link useAnimation} hook instead\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "FramerAnimation"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Value"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "AnimatorOptions"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"name": "FramerAnimation",
"members": [
{
"kind": "Method",
"canonicalReference": "(cancel:instance,0)",
"docComment": "/**\n * Cancels the animation if it is still running.\n *\n * @remarks\n * ```jsx\n * const animation = animate.ease(value, 100, {duration: 3})\n * setTimeout(() => animation.cancel(), 500)\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "cancel"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "cancel"
},
{
"kind": "Property",
"canonicalReference": "(finished:instance)",
"docComment": "/**\n * Wait for the animation to be finished.\n *\n * @remarks\n * ```jsx\n * // async/await syntax\n * const animation = animate.ease(value, 100)\n * await animation.finished()\n * // Animation is finished\n *\n *\n * const animation = animate.ease(value, 100)\n * animation.ready().then(() => {\n * // Animation is finished\n * })\n * ```\n *\n * @returns Promise that is resolved when the animation is ready to play\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "finished"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "finished",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(ready:instance)",
"docComment": "/**\n * Wait for the animation to be ready to play.\n *\n * @remarks\n * ```jsx\n * const animation = animate.ease(value, 100)\n * animation.ready().then(() => {\n * // Animation is ready\n * })\n *\n * // async/await syntax\n * const animation = animate.ease(value, 100)\n * await animation.ready()\n * // Animation is ready\n * ```\n *\n * @returns Promise that is resolved when the animation is ready to play\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "ready"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ready",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"isStatic": false
}
],
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "(FramerEvent:class)",
"docComment": "/**\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FramerEvent` class.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "FramerEvent"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "FramerEvent",
"members": [],
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "(Page:class)",
"docComment": "/**\n * The Page component allows you to create horizontally or vertically swipeable areas. It can be imported from the Framer Library and used in code components. Add children to create pages to swipe between. These children will be stretched to the size of the page component by default, but can also be set to auto to maintain their original size.\n *\n * @remarks\n * ```jsx\n * import * as React from \"react\"\n * import { Frame, Page } from \"framer\"\n * export class Page extends React.Component {\n * render() {\n * return (\n * \n * \n * \n * )\n * }\n * }\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "Page"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Component"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PageProps"
},
{
"kind": "Content",
"text": ">, "
},
{
"kind": "Reference",
"text": "PageState"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"name": "Page",
"members": [
{
"kind": "Property",
"canonicalReference": "(state:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "state"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PageState"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "state",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(supportsConstraints:static)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static "
},
{
"kind": "Reference",
"text": "supportsConstraints"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "supportsConstraints",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": true
}
],
"extendsTokenRange": {
"startIndex": 3,
"endIndex": 13
},
"implementsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(PageEffectInfo:interface)",
"docComment": "/**\n * Information about the current effect.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "PageEffectInfo"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "PageEffectInfo",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "direction",
"docComment": "/**\n * The direction of page scrolling, `\"horizontal\"` or `\"vertical\"`\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "direction"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PageDirection"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "direction",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "gap",
"docComment": "/**\n * The gap between each page, in pixels.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "gap"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "gap",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "index",
"docComment": "/**\n * The index of the current page. The first page is `0`, the second is `1` and so on.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "index"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "index",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "normalizedOffset",
"docComment": "/**\n * The offset of this page, normalised to the page size.\n *\n * For instance, if each page is `200` pixels wide, and we're on page index `1`, the `normalizedOffset` of page index `0` will be `-1`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "normalizedOffset"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "normalizedOffset",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "offset",
"docComment": "/**\n * The offset of this page, in pixels, measured from the left-most part of the container.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "offset"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "offset",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "pageCount",
"docComment": "/**\n * The total number of pages.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "pageCount"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "pageCount",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "size",
"docComment": "/**\n * The `width` and `height` of the page.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "size"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Size"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "size",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(PageEvents:interface)",
"docComment": "/**\n * Event callbacks for the Page component, can be used to react to and co-ordinate with other components.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "PageEvents"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "PageEvents",
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "(onChangePage:0)",
"docComment": "/**\n * A callback that will be invoked when changing the page.\n *\n * @remarks\n * ```jsx\n * {\n * console.log(current, previous, page)\n * }}\n * />\n * ```\n *\n * @param currentIndex - The current page number\n *\n * @param previousIndex - The index of the previous page\n *\n * @param pageComponent - The Page component for the current page.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onChangePage"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "currentIndex"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "previousIndex"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "pageComponent"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Page"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "currentIndex",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "previousIndex",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
},
{
"parameterName": "pageComponent",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
}
],
"name": "onChangePage"
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(PageProperties:interface)",
"docComment": "/**\n * All properties that can be used with the {@link Page} component it also extends all {@link ScrollProps} properties.\n * ```jsx\n * \n * \n * \n * \n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "PageProperties"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "PageProperties",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "alignment",
"docComment": "/**\n * Alignment of the pages within the component. Either \"start\", \"center\", or \"end\". Set to `\"start\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "alignment"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PageAlignment"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "alignment",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "animateCurrentPageUpdate",
"docComment": "/**\n * Determines whether the component should animate page changes. Set to `true` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @beta\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "animateCurrentPageUpdate"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Beta",
"name": "animateCurrentPageUpdate",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "contentHeight",
"docComment": "/**\n * Height of the pages within the component. Either \"auto\" or \"stretch\" or a numeric value. Set to `\"stretch\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "contentHeight"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PageContentDimension"
},
{
"kind": "Content",
"text": " | number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "contentHeight",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "contentWidth",
"docComment": "/**\n * Width of the pages within the component. Either \"auto\" or \"stretch\" or a numeric value. Set to `\"stretch\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "contentWidth"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PageContentDimension"
},
{
"kind": "Content",
"text": " | number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "contentWidth",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "currentPage",
"docComment": "/**\n * Index of the current page. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "currentPage"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "currentPage",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "defaultEffect",
"docComment": "/**\n * Pick one of the predefined effects. Either \"none\", \"cube\", \"coverflow\", \"wheel\" or \"pile\". Set to `\"none\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "defaultEffect"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PageEffect"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "defaultEffect",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "direction",
"docComment": "/**\n * Current swipe direction. Either \"horizontal\" or \"vertical\". Set to `\"horizontal\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "direction"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PageDirection"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "direction",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "effect",
"docComment": "/**\n * Allows you to provide a custom transition effect for individual pages.\n *\n * This function is once for every page, every time the scroll offset changes. It returns a new set of styles for this page.\n *\n * @param info - A {@link PageEffectInfo} object with information about the current effect.\n *\n * @returns should return a new set of Frame properties.\n * ```jsx\n * function scaleEffect() {\n * const { normalizedOffset } = info\n * return {\n * scale: Math.max(0, 1 + Math.min(0, normalizedOffset * -1))\n * }\n * }\n *\n * return \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "effect"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "info"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "PageEffectInfo"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "PageEffectValues"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "effect",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 8
}
},
{
"kind": "PropertySignature",
"canonicalReference": "gap",
"docComment": "/**\n * A number describing the gap between the page elements. Set to `10` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "gap"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "gap",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "momentum",
"docComment": "/**\n * When enabled you can flick through multiple pages at once.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "momentum"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "momentum",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "padding",
"docComment": "/**\n * Padding to be applied to all sides. Set to `0` by default. To specify different padding for each side, provide individual `paddingTop`, `paddingLeft`, `paddingRight` and `paddingBottom` values.\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "padding"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "padding",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "paddingBottom",
"docComment": "/**\n * ```jsx\n * \n * ```\n *\n * Value for the bottom padding of the container. Set to `0` by default.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "paddingBottom"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "paddingBottom",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "paddingLeft",
"docComment": "/**\n * ```jsx\n * \n * ```\n *\n * Value for the left padding of the container. Set to `0` by default.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "paddingLeft"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "paddingLeft",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "paddingPerSide",
"docComment": "/**\n * Flag to tell the Page to ignore the `padding` prop and apply values per-side.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "paddingPerSide"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "paddingPerSide",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "paddingRight",
"docComment": "/**\n * ```jsx\n * \n * ```\n *\n * Value for the right padding of the container. Set to `0` by default.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "paddingRight"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "paddingRight",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "paddingTop",
"docComment": "/**\n * Value for the top padding of the container. Set to `0` by default.\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "paddingTop"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "paddingTop",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(PageProps:interface)",
"docComment": "/**\n * The following are the props accepted by the Page component, these are all in addition to the standard props accepted by all Frame components.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "PageProps"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "PageProperties"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Omit"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "FrameProps"
},
{
"kind": "Content",
"text": ", \"size\" | \"onScroll\">>"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "LayerProps"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PageEvents"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Omit"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ScrollProps"
},
{
"kind": "Content",
"text": ", \"direction\" | \"contentWidth\" | \"contentHeight\">> "
}
],
"releaseTag": "Public",
"name": "PageProps",
"members": [],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 4
},
{
"startIndex": 5,
"endIndex": 11
},
{
"startIndex": 12,
"endIndex": 13
},
{
"startIndex": 14,
"endIndex": 18
},
{
"startIndex": 19,
"endIndex": 25
}
]
},
{
"kind": "Function",
"canonicalReference": "(Point:0)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "declare function "
},
{
"kind": "Reference",
"text": "Point"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "x"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "y"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Point"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "x",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "y",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "Point"
},
{
"kind": "Interface",
"canonicalReference": "(Point:interface)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "interface "
},
{
"kind": "Reference",
"text": "Point"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Point",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "x",
"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",
"canonicalReference": "y",
"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": "Namespace",
"canonicalReference": "(Point:namespace)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "declare namespace "
},
{
"kind": "Reference",
"text": "Point"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Point",
"members": [
{
"kind": "Variable",
"canonicalReference": "isEqual",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "isEqual"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "a"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Point"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "b"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Point"
},
{
"kind": "Content",
"text": ") => boolean"
}
],
"releaseTag": "Public",
"name": "isEqual",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 11
}
}
]
},
{
"kind": "Function",
"canonicalReference": "(print:0)",
"docComment": "/**\n * Prints to the console.\n *\n * @param args - Arguments to print\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "print"
},
{
"kind": "Content",
"text": "(..."
},
{
"kind": "Reference",
"text": "args"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "any[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "args",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "print"
},
{
"kind": "Interface",
"canonicalReference": "(Rect:interface)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Point"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Size"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Rect",
"members": [],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 4
},
{
"startIndex": 5,
"endIndex": 7
}
]
},
{
"kind": "Namespace",
"canonicalReference": "(Rect:namespace)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Rect",
"members": [
{
"kind": "Function",
"canonicalReference": "(equals:0)",
"docComment": "/**\n * @param rect - \n *\n * @param other - \n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "equals"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "rect"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "other"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "rect",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
}
},
{
"parameterName": "other",
"parameterTypeTokenRange": {
"startIndex": 10,
"endIndex": 12
}
}
],
"name": "equals"
},
{
"kind": "Variable",
"canonicalReference": "center",
"docComment": "/**\n * @param rect - \n *\n * @beta\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "center"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "rect"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": ") => {\n "
},
{
"kind": "Reference",
"text": "x"
},
{
"kind": "Content",
"text": ": number;\n "
},
{
"kind": "Reference",
"text": "y"
},
{
"kind": "Content",
"text": ": number;\n }"
}
],
"releaseTag": "Beta",
"name": "center",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 11
}
},
{
"kind": "Variable",
"canonicalReference": "containsPoint",
"docComment": "/**\n * Checks if a rectangle contains a point\n *\n * @param rect - The rectangle to check\n *\n * @param point - The point to check\n *\n * @returns true if the provided rectangle contains the provided point\n *\n * @beta\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "containsPoint"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "rect"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "point"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Point"
},
{
"kind": "Content",
"text": ") => boolean"
}
],
"releaseTag": "Beta",
"name": "containsPoint",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 11
}
},
{
"kind": "Variable",
"canonicalReference": "containsRect",
"docComment": "/**\n * Returns wether a rect contains another rect entirely\n *\n * @param rectA - \n *\n * @param rectB - \n *\n * @returns true if rectA contains rectB\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "containsRect"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "rectA"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "rectB"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": ") => boolean"
}
],
"releaseTag": "Public",
"name": "containsRect",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 11
}
},
{
"kind": "Variable",
"canonicalReference": "isEqual",
"docComment": "/**\n * @param rectA - \n *\n * @param rectB - \n *\n * @returns if the input rectangles are equal in size and position\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "isEqual"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "rectA"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": " | null, "
},
{
"kind": "Reference",
"text": "rectB"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": " | null) => boolean"
}
],
"releaseTag": "Public",
"name": "isEqual",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 11
}
},
{
"kind": "Variable",
"canonicalReference": "maxX",
"docComment": "/**\n * @param rect - \n *\n * @beta\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "maxX"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "rect"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": ") => number"
}
],
"releaseTag": "Beta",
"name": "maxX",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
},
{
"kind": "Variable",
"canonicalReference": "maxY",
"docComment": "/**\n * @param rect - \n *\n * @beta\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "maxY"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "rect"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": ") => number"
}
],
"releaseTag": "Beta",
"name": "maxY",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
},
{
"kind": "Variable",
"canonicalReference": "minX",
"docComment": "/**\n * @param rect - \n *\n * @beta\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "minX"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "rect"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": ") => number"
}
],
"releaseTag": "Beta",
"name": "minX",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
},
{
"kind": "Variable",
"canonicalReference": "minY",
"docComment": "/**\n * @param rect - \n *\n * @beta\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "minY"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "rect"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Rect"
},
{
"kind": "Content",
"text": ") => number"
}
],
"releaseTag": "Beta",
"name": "minY",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
}
]
},
{
"kind": "Enum",
"canonicalReference": "(RenderTarget:enum)",
"docComment": "/**\n * The `RenderTarget` represents the current environment in which a component is running. This is most commonly either the editor canvas in the Framer X application or in the generated preview window.\n *\n * @remarks\n *\n * Code components can use the `RenderTarget.current()` method to check for the environment within their components and vary rendering accordingly. The most common case would be to improve performance while rendering in the Framer X canvas where components that take too long to render will be replaced with a placeholder. The `RenderTarget.hasRestrictions()` method can be used to check explicitly for this case.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare enum "
},
{
"kind": "Reference",
"text": "RenderTarget"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "RenderTarget",
"members": [
{
"kind": "EnumMember",
"canonicalReference": "canvas",
"docComment": "/**\n * The component is to be rendered for the Framer X canvas.\n *\n * @remarks\n * ```jsx\n * function App() {\n * if (RenderTarget.current() === RenderTarget.canvas) {\n * return \n * }\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "canvas"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"CANVAS\""
}
],
"releaseTag": "Public",
"name": "canvas",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "export",
"docComment": "/**\n * The component is to be rendered for export.\n *\n * @remarks\n * ```jsx\n * function App() {\n * if (RenderTarget.current() === RenderTarget.export) {\n * return \n * }\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "export"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"EXPORT\""
}
],
"releaseTag": "Public",
"name": "export",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "preview",
"docComment": "/**\n * The component is being rendered in the preview window.\n *\n * @remarks\n * ```jsx\n * function App() {\n * React.useEffect(() => {\n * if (RenderTarget.current() === RenderTarget.preview) {\n * // Do something in preview.\n * }\n * })\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "preview"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"PREVIEW\""
}
],
"releaseTag": "Public",
"name": "preview",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "EnumMember",
"canonicalReference": "thumbnail",
"docComment": "/**\n * The component is to be rendered as a preview thumbnail, for example in the component panel.\n *\n * @remarks\n * ```jsx\n * function App() {\n * if (RenderTarget.current() === RenderTarget.thumbnail) {\n * return \n * }\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "thumbnail"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "\"THUMBNAIL\""
}
],
"releaseTag": "Public",
"name": "thumbnail",
"initializerTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
]
},
{
"kind": "Namespace",
"canonicalReference": "(RenderTarget:namespace)",
"docComment": "/**\n * @internalRemarks\n *\n * This is a read-only equivalent of RenderEnvironment.target that is exposed to components for context-dependent rendering\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace "
},
{
"kind": "Reference",
"text": "RenderTarget"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "RenderTarget",
"members": [
{
"kind": "Function",
"canonicalReference": "(current:0)",
"docComment": "/**\n * Returns the current `RenderTarget` allowing components to apply different behaviors depending on the environment.\n *\n * @remarks\n * ```jsx\n * function App() {\n * if (RenderTarget.current() === RenderTarget.thumbnail) {\n * return \n * }\n * return ...\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "current"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "RenderTarget"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "current"
},
{
"kind": "Function",
"canonicalReference": "(hasRestrictions:0)",
"docComment": "/**\n * Returns true if the current `RenderTarget` has performance restrictions. Use this to avoid doing heavy work in these contexts because they may bail on the rendering if the component takes too long.\n *\n * @remarks\n * ```jsx\n * function App() {\n * if (RenderTarget.hasRestrictions()) {\n * return \n * }\n * return \n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "hasRestrictions"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "hasRestrictions"
}
]
},
{
"kind": "Function",
"canonicalReference": "(Scroll:0)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "Scroll"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ScrollProps"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Element"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "props",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "Scroll"
},
{
"kind": "Interface",
"canonicalReference": "(ScrollConfig:interface)",
"docComment": "/**\n * The properties for the {@link Scroll} component, which are also available within other components, like {@link Page}.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "ScrollConfig"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ScrollConfig",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "contentHeight",
"docComment": "/**\n * Height of the scrollable content.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "contentHeight"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "contentHeight",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "contentOffsetX",
"docComment": "/**\n * Horizontal offset of the scrollable content. Set to `0` by default\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "contentOffsetX"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": " | number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "contentOffsetX",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "contentOffsetY",
"docComment": "/**\n * Vertical offset of the scrollable content. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "contentOffsetY"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": " | number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "contentOffsetY",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "contentWidth",
"docComment": "/**\n * Width of the scrollable content.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "contentWidth"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "contentWidth",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "direction",
"docComment": "/**\n * Controls the axis of drag-scrolling. Defaults to `\"vertical\"` for vertical scrolling.\n *\n * @remarks\n *\n * Set `\"horizontal\"` or `\"vertical\"` to only drag in a specific direction. Set `\"both\"` to drag both directions.\n * ```jsx\n * // Horizontal\n * \n *\n * // Vertical\n * \n *\n * // Locked\n * \n *\n * // Both directions\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "direction"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "\"horizontal\" | \"vertical\" | \"both\""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "direction",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "directionLock",
"docComment": "/**\n * If `true`, this will lock dragging to the initial direction.\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "directionLock"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "directionLock",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "dragEnabled",
"docComment": "/**\n * Enable or disable dragging to scroll. Defaults to `true`.\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "dragEnabled"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "dragEnabled",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "scrollAnimate",
"docComment": "/**\n * Add a custom control for the scroll animation.\n *\n * @remarks\n * ```jsx\n * const controls = useAnimation()\n * controls.start({ y: -50 })\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "scrollAnimate"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "FrameProps"
},
{
"kind": "Content",
"text": "[\"animate\"]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "scrollAnimate",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "wheelEnabled",
"docComment": "/**\n * Enable or disable wheel scroll. Defaults to `true`.\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "wheelEnabled"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "wheelEnabled",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(ScrollEvents:interface)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "ScrollEvents"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ScrollEvents",
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "(onScroll:0)",
"docComment": "/**\n * Called periodically during scrolling.\n *\n * @remarks\n * ```jsx\n * function onScroll(info) {\n * console.log(info.offset, info.velocity)\n * }\n *\n * \n * ```\n *\n * @param info - An {@link PanInfo} object containing `x` and `y` values for:\n *\n * - `point`: Relative to the device or page. - `delta`: Distance moved since the last event. - `offset`: Offset from the original pan event. - `velocity`: Current velocity of the pointer.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onScroll"
},
{
"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": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "onScroll"
},
{
"kind": "MethodSignature",
"canonicalReference": "(onScrollEnd:0)",
"docComment": "/**\n * Called when scrolling ends.\n *\n * @remarks\n * ```jsx\n * function onScrollEnd(info) {\n * console.log(info.offset, info.velocity)\n * }\n *\n * \n * ```\n *\n * @param info - An {@link PanInfo} object containing `x` and `y` values for:\n *\n * - `point`: Relative to the device or page. - `delta`: Distance moved since the last event. - `offset`: Offset from the original pan event. - `velocity`: Current velocity of the pointer.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onScrollEnd"
},
{
"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": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "onScrollEnd"
},
{
"kind": "MethodSignature",
"canonicalReference": "(onScrollStart:0)",
"docComment": "/**\n * Called when scrolling starts.\n *\n * @remarks\n * ```jsx\n * function onScrollStart(info) {\n * console.log(info.offset, info.velocity)\n * }\n *\n * \n * ```\n *\n * @param info - An {@link PanInfo} object containing `x` and `y` values for:\n *\n * - `point`: Relative to the device or page. - `delta`: Distance moved since the last event. - `offset`: Offset from the original pan event. - `velocity`: Current velocity of the pointer.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "onScrollStart"
},
{
"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": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "info",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "onScrollStart"
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(ScrollProps:interface)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "ScrollProps"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Omit"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "FrameProps"
},
{
"kind": "Content",
"text": ">, \"onScroll\" | \"size\">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "ScrollEvents"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "ScrollConfig"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ScrollProps",
"members": [],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 9
},
{
"startIndex": 10,
"endIndex": 11
},
{
"startIndex": 12,
"endIndex": 14
}
]
},
{
"kind": "Function",
"canonicalReference": "(Size:0)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "declare function "
},
{
"kind": "Reference",
"text": "Size"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "width"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "height"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Size"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "width",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "height",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "Size"
},
{
"kind": "Interface",
"canonicalReference": "(Size:interface)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "interface "
},
{
"kind": "Reference",
"text": "Size"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Size",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "height",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "height"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "height",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "width",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "width"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "width",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Namespace",
"canonicalReference": "(Size:namespace)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "declare namespace "
},
{
"kind": "Reference",
"text": "Size"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Size",
"members": [
{
"kind": "Variable",
"canonicalReference": "isZero",
"docComment": "/**\n * Checks if the size has a zero width and zero height\n *\n * @param size - size to check\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "isZero"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "size"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Size"
},
{
"kind": "Content",
"text": ") => boolean"
}
],
"releaseTag": "Public",
"name": "isZero",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 7
}
},
{
"kind": "Variable",
"canonicalReference": "zero",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "zero"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Size"
}
],
"releaseTag": "Public",
"name": "zero",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
]
},
{
"kind": "Function",
"canonicalReference": "(Stack:0)",
"docComment": "/**\n * The Stack component will automatically distribute its contents based on its properties. See `StackProperties` for details on configuration.\n *\n * @remarks\n * ```jsx\n * function MyComponent() {\n * return (\n * \n * \n * \n * \n * \n * )\n * }\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "Stack"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "StackProperties"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JSX"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Element"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "props",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 9
}
}
],
"name": "Stack"
},
{
"kind": "Namespace",
"canonicalReference": "(Stack:namespace)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace "
},
{
"kind": "Reference",
"text": "Stack"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Stack",
"members": [
{
"kind": "Variable",
"canonicalReference": "displayName",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "displayName"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
}
],
"releaseTag": "Public",
"name": "displayName",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
]
},
{
"kind": "Interface",
"canonicalReference": "(StackProperties:interface)",
"docComment": "/**\n * The Stack component takes the same props as the {@link Frame} component as well as a few additional interface defined below.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "StackProperties"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "StackSpecificProps"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "FrameProps"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "WillChangeTransformProp"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "StackProperties",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "children",
"docComment": "",
"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
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 4
},
{
"startIndex": 5,
"endIndex": 6
},
{
"startIndex": 7,
"endIndex": 9
}
]
},
{
"kind": "Interface",
"canonicalReference": "(StackSpecificProps:interface)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "StackSpecificProps"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "StackSpecificProps",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "alignment",
"docComment": "/**\n * Defines the distribution of the stack contents on the alternative axis to the direction. Can be one of `\"start\"`, `\"end\",` or `\"center\"`. Set to `\"center\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "alignment"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "StackAlignment"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "alignment",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "direction",
"docComment": "/**\n * Defines the flow direction of the stack contents, either `\"vertical\"` or `\"horizontal\"`. Set to `\"vertical\"` by default.\n *\n * @remarks\n * ```jsx\n * // Vertical\n * \n *\n * // Horizontal\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "direction"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "StackDirection"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "direction",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "distribution",
"docComment": "/**\n * Defines the distribution of the stack contents. Set to `\"space-around\"` by default, which makes the contents spread evenly across the container.\n *\n * @remarks\n *\n * - `\"start\"` — from the leading edge of the container. - `\"center\"` — centered within the container. - `\"end\"` — from the trailing edge of the container. - `\"space-between\"` — spread evenly in the container. - `\"space-around\"` — spread evenly with excess applied at the start / end. - `\"space-evenly\"` — spread with equal padding between contents.\n * ```jsx\n * // Default\n * \n *\n * // Start\n * \n *\n * // Center\n * \n *\n * // End\n * \n *\n * // Space Between\n * \n *\n * // Space Around\n * \n *\n * // Space Evenly\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "distribution"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "StackDistribution"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "distribution",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "gap",
"docComment": "/**\n * The gap between items in the stack. Set to `10` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "gap"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "gap",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "padding",
"docComment": "/**\n * Padding to be applied to all sides of container. Set to `0` by default.\n *\n * @remarks\n *\n * To specify different padding for each side you can provide individual `paddingTop`, `paddingLeft`, `paddingRight` and `paddingBottom` values.\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "padding"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "padding",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "paddingBottom",
"docComment": "/**\n * Value for the bottom padding of the container. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "paddingBottom"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "paddingBottom",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "paddingLeft",
"docComment": "/**\n * Value for the left padding of the container. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "paddingLeft"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "paddingLeft",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "paddingPerSide",
"docComment": "/**\n * Flag to tell the Stack to ignore the `padding` prop and apply values per-side.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "paddingPerSide"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "paddingPerSide",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "paddingRight",
"docComment": "/**\n * Value for the right padding of the container. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "paddingRight"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "paddingRight",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "paddingTop",
"docComment": "/**\n * Value for the top padding of the container. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "paddingTop"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "paddingTop",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(VisualProperties:interface)",
"docComment": "/**\n * @internalremarks\n *\n * do no use separately from FrameProps\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "VisualProperties"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "VisualProperties",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "backfaceVisible",
"docComment": "/**\n * Sets whether the back face is visible when turned towards the user. Set to `true` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @beta\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "backfaceVisible"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Beta",
"name": "backfaceVisible",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "border",
"docComment": "/**\n * Set the CSS border property, which accepts width, style and color. Set to `\"none\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "border"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "border",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "borderRadius",
"docComment": "/**\n * Set the CSS border-radius property, in pixels or percentages. Alias for `radius` Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * // Radius with pixels\n * \n *\n * // Radius with percentages\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "borderRadius"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "borderRadius",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "color",
"docComment": "/**\n * Set the color for text elements inside of a `Frame`. By default, text within Frames will be rendered in black.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "color"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "color",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "opacity",
"docComment": "/**\n * Set the opacity value, which allows you to make elements semi-transparent or entirely hidden. Useful for show-and-hide animations. Set to `1` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "opacity"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "opacity",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "overflow",
"docComment": "/**\n * Set the CSS overflow property. Set to `\"visible\"` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "overflow"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "\"visible\" | \"hidden\""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "overflow",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "preserve3d",
"docComment": "/**\n * Position the children of the frame in 3D space. Set to `false` by default.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @beta\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "preserve3d"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Beta",
"name": "preserve3d",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "radius",
"docComment": "/**\n * Set the CSS border-radius property, in pixels or percentages. Set to `0` by default.\n *\n * @remarks\n * ```jsx\n * // Radius with pixels\n * \n *\n * // Radius with percentages\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "radius"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number | string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "radius",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "shadow",
"docComment": "/**\n * Set the CSS box-shadow property.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "shadow"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string | "
},
{
"kind": "Reference",
"text": "MotionValue"
},
{
"kind": "Content",
"text": ""
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "shadow",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
}
},
{
"kind": "PropertySignature",
"canonicalReference": "visible",
"docComment": "/**\n * Defines whether or not the `Frame` is visible. Unlike `opacity`, this property cannot be animated. Set to `true` by default. Maps to CSS.\n *\n * @remarks\n * ```jsx\n * \n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "visible"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "visible",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "AnimatableObject",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "AnimatableObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "> = {\n ["
},
{
"kind": "Reference",
"text": "K"
},
{
"kind": "Content",
"text": " in keyof "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "]: "
},
{
"kind": "Reference",
"text": "ToAnimatableOrValue"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "["
},
{
"kind": "Reference",
"text": "K"
},
{
"kind": "Content",
"text": "]>;\n};"
}
],
"releaseTag": "Public",
"name": "AnimatableObject"
},
{
"kind": "TypeAlias",
"canonicalReference": "Cancel",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "Cancel"
},
{
"kind": "Content",
"text": " = () => void;"
}
],
"releaseTag": "Public",
"name": "Cancel"
},
{
"kind": "TypeAlias",
"canonicalReference": "ControlDescription",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "ControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": " = any> = "
},
{
"kind": "Reference",
"text": "NumberControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "EnumControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "BooleanControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "StringControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "ColorControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "FusedNumberControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "SegmentedEnumControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "ImageControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "FileControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "ComponentInstanceDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "ArrayControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": ">;"
}
],
"releaseTag": "Public",
"name": "ControlDescription"
},
{
"kind": "Variable",
"canonicalReference": "DeprecatedFrameWithEvents",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "DeprecatedFrameWithEvents"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "ComponentClass"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "DeprecatedFrameWithEventsProps"
},
{
"kind": "Content",
"text": ">>"
}
],
"releaseTag": "Public",
"name": "DeprecatedFrameWithEvents",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 10
}
},
{
"kind": "TypeAlias",
"canonicalReference": "DeprecatedFrameWithEventsProps",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "DeprecatedFrameWithEventsProps"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "DeprecatedCoreFrameProps"
},
{
"kind": "Content",
"text": " & "
},
{
"kind": "Reference",
"text": "WithEventsProperties"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "DeprecatedFrameWithEventsProps"
},
{
"kind": "Variable",
"canonicalReference": "Draggable",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "Draggable"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "ComponentClass"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "DeprecatedFrameWithEventsProps"
},
{
"kind": "Content",
"text": "> & "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "DraggableProps"
},
{
"kind": "Content",
"text": ">>"
}
],
"releaseTag": "Public",
"name": "Draggable",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 16
}
},
{
"kind": "Variable",
"canonicalReference": "Frame",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "Frame"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "ForwardRefExoticComponent"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "FrameProps"
},
{
"kind": "Content",
"text": "> & "
},
{
"kind": "Reference",
"text": "React"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "RefAttributes"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "HTMLDivElement"
},
{
"kind": "Content",
"text": ">>"
}
],
"releaseTag": "Public",
"name": "Frame",
"variableTypeTokenRange": {
"startIndex": 2,
"endIndex": 16
}
},
{
"kind": "TypeAlias",
"canonicalReference": "Override",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "Override"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " extends object = "
},
{
"kind": "Reference",
"text": "FrameProps"
},
{
"kind": "Content",
"text": " & {\n ["
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": string]: any;\n}> = "
},
{
"kind": "Reference",
"text": "OverrideObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "> | "
},
{
"kind": "Reference",
"text": "OverrideFunction"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">;"
}
],
"releaseTag": "Public",
"name": "Override"
},
{
"kind": "TypeAlias",
"canonicalReference": "OverrideFunction",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "OverrideFunction"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": " extends object = any> = ("
},
{
"kind": "Reference",
"text": "props"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "P"
},
{
"kind": "Content",
"text": ">;"
}
],
"releaseTag": "Public",
"name": "OverrideFunction"
},
{
"kind": "TypeAlias",
"canonicalReference": "OverrideObject",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "OverrideObject"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " extends object = any> = "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">;"
}
],
"releaseTag": "Public",
"name": "OverrideObject"
},
{
"kind": "TypeAlias",
"canonicalReference": "PageAlignment",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "PageAlignment"
},
{
"kind": "Content",
"text": " = \"start\" | \"center\" | \"end\";"
}
],
"releaseTag": "Public",
"name": "PageAlignment"
},
{
"kind": "TypeAlias",
"canonicalReference": "PageEffect",
"docComment": "/**\n * Page effects change the behavior of the transition when swiping between pages. By default there is no page effect applied.\n *\n * @remarks\n * ```jsx\n * import * as React from \"react\"\n * import { Page, PageEffect } from \"framer\"\n *\n * export function MyComponent() {\n * return \n * }\n * ```\n *\n * `\"none\"` - No custom effect is applied. This is the default. `\"cube\"` - Each page is positioned as a 3D cube, connected to the current page. `\"coverflow\"` - Each page is positioned in 3D, behind the current page. `\"wheel\"` - Each page is gently titled in 3D, like a wheel. `\"pile\"` - Each page is stacked behind the current page.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "PageEffect"
},
{
"kind": "Content",
"text": " = \"none\" | \"cube\" | \"coverflow\" | \"wheel\" | \"pile\";"
}
],
"releaseTag": "Public",
"name": "PageEffect"
},
{
"kind": "TypeAlias",
"canonicalReference": "PropertyControls",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "PropertyControls"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ComponentProps"
},
{
"kind": "Content",
"text": " = any, "
},
{
"kind": "Reference",
"text": "ArrayTypes"
},
{
"kind": "Content",
"text": " = any> = {\n ["
},
{
"kind": "Reference",
"text": "K"
},
{
"kind": "Content",
"text": " in keyof "
},
{
"kind": "Reference",
"text": "ComponentProps"
},
{
"kind": "Content",
"text": "]?: "
},
{
"kind": "Reference",
"text": "ControlDescription"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ComponentProps"
},
{
"kind": "Content",
"text": ">>;\n};"
}
],
"releaseTag": "Public",
"name": "PropertyControls"
},
{
"kind": "Variable",
"canonicalReference": "version",
"docComment": "/**\n * This version is automatically updated by the Makefile\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "version"
},
{
"kind": "Content",
"text": " = \"1.0.10\""
}
],
"releaseTag": "Public",
"name": "version",
"variableTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
]
}
]
}