@workday/canvas-kit-docs 14.0.0-alpha.1230-next.0 → 14.0.0-alpha.1233-next.0

package/dist/es6/lib/docs.js

@@ -2245,7 +2245,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `SearchFormProps` is deprecated and will be removed in a future major version. Please reference our [Autocomplete example](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs#usage)."
+    },
     "type": {
       "kind": "alias",
       "name": "SearchForm"
@@ -2261,7 +2263,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `SearchFormState` is deprecated and will be removed in a future major version. Please reference our [Autocomplete example](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs#usage)."
+    },
     "type": {
       "kind": "object",
       "properties": [
@@ -2329,7 +2333,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `searchFormStencil` is deprecated and will be removed in a future major version. Please reference our [Autocomplete example](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs#usage)."
+    },
     "type": {
       "kind": "function",
       "parameters": [
@@ -3033,7 +3039,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `SearchForm` is deprecated and will be removed in a future major version. Please reference our [Autocomplete example](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs#usage)."
+    },
     "type": {
       "kind": "component",
       "props": [
@@ -3490,7 +3498,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `SearchTheme` is deprecated and will be removed in a future major version. Please our CSS tokens to theme components."
+    },
     "type": {
       "kind": "object",
       "typeParameters": [],
@@ -3533,7 +3543,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `SearchThemeAttributes` is deprecated and will be removed in a future major version. Please our CSS tokens to theme components."
+    },
     "type": {
       "kind": "object",
       "properties": [
@@ -3703,7 +3715,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `SearchThemes` is deprecated and will be removed in a future major version. Please our CSS tokens to theme components."
+    },
     "type": {
       "kind": "object",
       "properties": [],
@@ -3732,7 +3746,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `searchThemes` is deprecated and will be removed in a future major version. Please our CSS tokens to theme components."
+    },
     "type": {
       "kind": "symbol",
       "name": "SearchThemes",
@@ -69020,908 +69036,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
-  {
-    "name": "TextAreaProps",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx",
-    "description": "",
-    "declarations": [
-      {
-        "name": "TextAreaProps",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx"
-      }
-    ],
-    "tags": {
-      "deprecated": "⚠️ `TextAreaProps` in Preview has been deprecated and will be removed in a future major version. Please use [`TextArea` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-textarea--docs) instead."
-    },
-    "type": {
-      "kind": "alias",
-      "name": "TextArea"
-    }
-  },
-  {
-    "name": "TextArea",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx",
-    "description": "",
-    "declarations": [
-      {
-        "name": "TextArea",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx"
-      }
-    ],
-    "tags": {
-      "stencil": "formFieldStencil",
-      "deprecated": "⚠️ `TextArea` in Preview has been deprecated and will be removed in a future major version. Please use [`TextArea` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-textarea--docs) instead."
-    },
-    "type": {
-      "kind": "enhancedComponent",
-      "componentType": "container",
-      "displayName": "TextArea",
-      "props": [
-        {
-          "kind": "property",
-          "name": "children",
-          "required": true,
-          "type": {
-            "kind": "external",
-            "name": "ReactNode",
-            "url": "https://reactjs.org/docs/rendering-elements.html"
-          },
-          "description": "Children of the Text Input. Should contain a `<TextArea.Field>`, a `<TextArea.Label>` and an optional `<TextArea.Hint>`",
-          "declarations": [
-            {
-              "name": "children",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "orientation",
-          "required": false,
-          "type": {
-            "kind": "union",
-            "value": [
-              {
-                "kind": "string",
-                "value": "vertical"
-              },
-              {
-                "kind": "string",
-                "value": "horizontalStart"
-              },
-              {
-                "kind": "string",
-                "value": "horizontalEnd"
-              }
-            ]
-          },
-          "description": "The direction the child elements should stack. In v13, `horizontal` will be removed. Please use `horizontalStart` or `horizontalEnd` for horizontal alignment.",
-          "declarations": [
-            {
-              "name": "orientation",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/form-field/lib/FormField.tsx"
-            }
-          ],
-          "tags": {
-            "default": "vertical"
-          },
-          "defaultValue": {
-            "kind": "symbol",
-            "name": "vertical",
-            "value": "vertical"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "cs",
-          "required": false,
-          "type": {
-            "kind": "symbol",
-            "name": "CSToPropsInput",
-            "value": "CSToPropsInput"
-          },
-          "description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles } instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n   {...handleCsProp(elemProps, [\n     myStyles,\n     myModifiers({ size: 'medium' }),\n     myVars({ backgroundColor: 'red' })\n   ])}\n >\n   {children}\n </Element>\n)\n```",
-          "declarations": [
-            {
-              "name": "cs",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "grow",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "boolean"
-          },
-          "description": "True if the component should grow to its container's width. False otherwise.",
-          "declarations": [
-            {
-              "name": "grow",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "as",
-          "description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "external",
-            "name": "React.ElementType",
-            "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
-          },
-          "defaultValue": {
-            "kind": "external",
-            "name": "div",
-            "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "ref",
-          "description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "external",
-            "name": "React.Ref",
-            "url": "https://reactjs.org/docs/refs-and-the-dom.html",
-            "typeParameters": [
-              {
-                "kind": "typeParameter",
-                "name": "R",
-                "required": true,
-                "defaultValue": {
-                  "kind": "external",
-                  "name": "div",
-                  "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
-                }
-              }
-            ]
-          }
-        },
-        {
-          "kind": "property",
-          "name": "model",
-          "description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "symbol",
-            "name": "TextInputModel"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "elemPropsHook",
-          "description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "function",
-            "parameters": [
-              {
-                "kind": "parameter",
-                "description": "",
-                "tags": {},
-                "declarations": [],
-                "name": "model",
-                "type": {
-                  "kind": "symbol",
-                  "name": "TextInputModel"
-                },
-                "required": true
-              },
-              {
-                "kind": "parameter",
-                "description": "",
-                "tags": {},
-                "declarations": [],
-                "name": "elemProps",
-                "type": {
-                  "kind": "generic",
-                  "name": "TProps"
-                }
-              }
-            ],
-            "returnType": {
-              "kind": "external",
-              "name": "HTML Attributes",
-              "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
-            }
-          }
-        }
-      ],
-      "baseElement": {
-        "kind": "external",
-        "name": "div",
-        "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
-      },
-      "model": "TextInputModel",
-      "styleComponent": {
-        "kind": "symbol",
-        "name": "Flex"
-      },
-      "subComponents": [
-        {
-          "name": "Field",
-          "symbol": "TextAreaField",
-          "description": "",
-          "declarations": [
-            {
-              "name": "Field",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx"
-            },
-            {
-              "name": "TextAreaField",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextAreaField.tsx"
-            }
-          ],
-          "tags": {}
-        }
-      ]
-    }
-  },
-  {
-    "name": "TextAreaField",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextAreaField.tsx",
-    "description": "",
-    "declarations": [
-      {
-        "name": "TextAreaField",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextAreaField.tsx"
-      }
-    ],
-    "tags": {
-      "deprecated": "⚠️ `TextAreaField` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField`](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-form-field--docs) in Preview instead."
-    },
-    "type": {
-      "kind": "enhancedComponent",
-      "componentType": "subcomponent",
-      "displayName": "TextArea.Field",
-      "props": [
-        {
-          "kind": "property",
-          "name": "cs",
-          "required": false,
-          "type": {
-            "kind": "symbol",
-            "name": "CSToPropsInput",
-            "value": "CSToPropsInput"
-          },
-          "description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles } instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n   {...handleCsProp(elemProps, [\n     myStyles,\n     myModifiers({ size: 'medium' }),\n     myVars({ backgroundColor: 'red' })\n   ])}\n >\n   {children}\n </Element>\n)\n```",
-          "declarations": [
-            {
-              "name": "cs",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "children",
-          "description": "",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "external",
-            "name": "React.ReactNode",
-            "url": "https://reactjs.org/docs/rendering-elements.html"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "as",
-          "description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "external",
-            "name": "React.ElementType",
-            "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
-          },
-          "defaultValue": {
-            "kind": "external",
-            "name": "textarea",
-            "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "ref",
-          "description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "external",
-            "name": "React.Ref",
-            "url": "https://reactjs.org/docs/refs-and-the-dom.html",
-            "typeParameters": [
-              {
-                "kind": "typeParameter",
-                "name": "R",
-                "required": true,
-                "defaultValue": {
-                  "kind": "external",
-                  "name": "textarea",
-                  "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea"
-                }
-              }
-            ]
-          }
-        },
-        {
-          "kind": "property",
-          "name": "model",
-          "description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "symbol",
-            "name": "TextInputModel"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "elemPropsHook",
-          "description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "function",
-            "parameters": [
-              {
-                "kind": "parameter",
-                "description": "",
-                "tags": {},
-                "declarations": [],
-                "name": "model",
-                "type": {
-                  "kind": "symbol",
-                  "name": "TextInputModel"
-                },
-                "required": true
-              },
-              {
-                "kind": "parameter",
-                "description": "",
-                "tags": {},
-                "declarations": [],
-                "name": "elemProps",
-                "type": {
-                  "kind": "generic",
-                  "name": "TProps"
-                }
-              }
-            ],
-            "returnType": {
-              "kind": "external",
-              "name": "HTML Attributes",
-              "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
-            }
-          }
-        }
-      ],
-      "baseElement": {
-        "kind": "external",
-        "name": "textarea",
-        "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea"
-      },
-      "styleComponent": {
-        "kind": "symbol",
-        "name": "Box"
-      },
-      "model": "TextInputModel"
-    }
-  },
-  {
-    "name": "useTextInputField",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/hooks/useTextInputField.tsx",
-    "description": "Adds the necessary props to a `Field` component. Used by the TextInput.Field subcomponent.",
-    "declarations": [
-      {
-        "name": "useTextInputField",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/hooks/useTextInputField.tsx"
-      }
-    ],
-    "tags": {
-      "deprecated": "⚠️ `useTextInputField` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
-    },
-    "type": {
-      "kind": "function",
-      "name": {
-        "kind": "symbol",
-        "name": "createElemPropsHook"
-      },
-      "parameters": [
-        {
-          "kind": "parameter",
-          "name": "model",
-          "description": "",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "symbol",
-            "name": "TextInputModel"
-          },
-          "required": true
-        },
-        {
-          "kind": "parameter",
-          "name": "elemProps",
-          "description": "",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "object",
-            "properties": []
-          },
-          "required": false
-        },
-        {
-          "kind": "parameter",
-          "name": "ref",
-          "description": "",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "external",
-            "name": "React.Ref",
-            "url": "https://reactjs.org/docs/refs-and-the-dom.html"
-          },
-          "required": false
-        }
-      ],
-      "returnType": {
-        "kind": "object",
-        "properties": [
-          {
-            "kind": "property",
-            "name": "type",
-            "required": true,
-            "type": {
-              "kind": "string",
-              "value": "text"
-            },
-            "description": "",
-            "tags": {},
-            "declarations": []
-          }
-        ]
-      }
-    }
-  },
-  {
-    "name": "useTextInputModel",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/hooks/useTextInputModel.ts",
-    "description": "",
-    "declarations": [
-      {
-        "name": "useTextInputModel",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/hooks/useTextInputModel.ts"
-      }
-    ],
-    "tags": {
-      "deprecated": "⚠️ `useTextInputModel` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
-    },
-    "type": {
-      "kind": "symbol",
-      "name": "useFormFieldModel"
-    }
-  },
-  {
-    "name": "TextInputProps",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInput.tsx",
-    "description": "",
-    "declarations": [
-      {
-        "name": "TextInputProps",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInput.tsx"
-      }
-    ],
-    "tags": {
-      "deprecated": "⚠️ `TextInputProps` in Preview has been deprecated and will be removed in a future major version. Please use [`TextInput` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-text-input--docs) instead."
-    },
-    "type": {
-      "kind": "alias",
-      "name": "TextInput"
-    }
-  },
-  {
-    "name": "TextInput",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInput.tsx",
-    "description": "",
-    "declarations": [
-      {
-        "name": "TextInput",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInput.tsx"
-      }
-    ],
-    "tags": {
-      "stencil": "formFieldStencil",
-      "deprecated": "⚠️ `TextInput` in Preview has been deprecated and will be removed in a future major version. Please use [`TextInput` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-textinput--docs) instead."
-    },
-    "type": {
-      "kind": "enhancedComponent",
-      "componentType": "container",
-      "displayName": "TextInput",
-      "props": [
-        {
-          "kind": "property",
-          "name": "orientation",
-          "required": false,
-          "type": {
-            "kind": "union",
-            "value": [
-              {
-                "kind": "string",
-                "value": "vertical"
-              },
-              {
-                "kind": "string",
-                "value": "horizontalStart"
-              },
-              {
-                "kind": "string",
-                "value": "horizontalEnd"
-              }
-            ]
-          },
-          "description": "The direction the child elements should stack. In v13, `horizontal` will be removed. Please use `horizontalStart` or `horizontalEnd` for horizontal alignment.",
-          "declarations": [
-            {
-              "name": "orientation",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/form-field/lib/FormField.tsx"
-            }
-          ],
-          "tags": {
-            "default": "vertical"
-          },
-          "defaultValue": {
-            "kind": "symbol",
-            "name": "vertical",
-            "value": "vertical"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "children",
-          "required": true,
-          "type": {
-            "kind": "external",
-            "name": "ReactNode",
-            "url": "https://reactjs.org/docs/rendering-elements.html"
-          },
-          "description": "",
-          "declarations": [
-            {
-              "name": "children",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/form-field/lib/FormField.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "cs",
-          "required": false,
-          "type": {
-            "kind": "symbol",
-            "name": "CSToPropsInput",
-            "value": "CSToPropsInput"
-          },
-          "description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles } instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n   {...handleCsProp(elemProps, [\n     myStyles,\n     myModifiers({ size: 'medium' }),\n     myVars({ backgroundColor: 'red' })\n   ])}\n >\n   {children}\n </Element>\n)\n```",
-          "declarations": [
-            {
-              "name": "cs",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "grow",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "boolean"
-          },
-          "description": "True if the component should grow to its container's width. False otherwise.",
-          "declarations": [
-            {
-              "name": "grow",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "as",
-          "description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "external",
-            "name": "React.ElementType",
-            "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
-          },
-          "defaultValue": {
-            "kind": "external",
-            "name": "div",
-            "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "ref",
-          "description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "external",
-            "name": "React.Ref",
-            "url": "https://reactjs.org/docs/refs-and-the-dom.html",
-            "typeParameters": [
-              {
-                "kind": "typeParameter",
-                "name": "R",
-                "required": true,
-                "defaultValue": {
-                  "kind": "external",
-                  "name": "div",
-                  "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
-                }
-              }
-            ]
-          }
-        },
-        {
-          "kind": "property",
-          "name": "model",
-          "description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "symbol",
-            "name": "FormFieldModel"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "elemPropsHook",
-          "description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "function",
-            "parameters": [
-              {
-                "kind": "parameter",
-                "description": "",
-                "tags": {},
-                "declarations": [],
-                "name": "model",
-                "type": {
-                  "kind": "symbol",
-                  "name": "FormFieldModel"
-                },
-                "required": true
-              },
-              {
-                "kind": "parameter",
-                "description": "",
-                "tags": {},
-                "declarations": [],
-                "name": "elemProps",
-                "type": {
-                  "kind": "generic",
-                  "name": "TProps"
-                }
-              }
-            ],
-            "returnType": {
-              "kind": "external",
-              "name": "HTML Attributes",
-              "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
-            }
-          }
-        }
-      ],
-      "baseElement": {
-        "kind": "external",
-        "name": "div",
-        "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
-      },
-      "model": "FormFieldModel",
-      "styleComponent": {
-        "kind": "symbol",
-        "name": "Flex"
-      },
-      "subComponents": [
-        {
-          "name": "Field",
-          "symbol": "TextInputField",
-          "description": "",
-          "declarations": [
-            {
-              "name": "Field",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInput.tsx"
-            },
-            {
-              "name": "TextInputField",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInputField.tsx"
-            }
-          ],
-          "tags": {}
-        }
-      ]
-    }
-  },
-  {
-    "name": "TextInputField",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInputField.tsx",
-    "description": "",
-    "declarations": [
-      {
-        "name": "TextInputField",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInputField.tsx"
-      }
-    ],
-    "tags": {
-      "deprecated": "⚠️ `TextInputField` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-form-field--docs) instead."
-    },
-    "type": {
-      "kind": "enhancedComponent",
-      "componentType": "subcomponent",
-      "elemPropsHook": "useTextInputField",
-      "displayName": "TextInput.Field",
-      "props": [
-        {
-          "kind": "property",
-          "name": "cs",
-          "required": false,
-          "type": {
-            "kind": "symbol",
-            "name": "CSToPropsInput",
-            "value": "CSToPropsInput"
-          },
-          "description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles } instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n   {...handleCsProp(elemProps, [\n     myStyles,\n     myModifiers({ size: 'medium' }),\n     myVars({ backgroundColor: 'red' })\n   ])}\n >\n   {children}\n </Element>\n)\n```",
-          "declarations": [
-            {
-              "name": "cs",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "children",
-          "description": "",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "external",
-            "name": "React.ReactNode",
-            "url": "https://reactjs.org/docs/rendering-elements.html"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "as",
-          "description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "external",
-            "name": "React.ElementType",
-            "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
-          },
-          "defaultValue": {
-            "kind": "external",
-            "name": "input",
-            "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "ref",
-          "description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "external",
-            "name": "React.Ref",
-            "url": "https://reactjs.org/docs/refs-and-the-dom.html",
-            "typeParameters": [
-              {
-                "kind": "typeParameter",
-                "name": "R",
-                "required": true,
-                "defaultValue": {
-                  "kind": "external",
-                  "name": "input",
-                  "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
-                }
-              }
-            ]
-          }
-        },
-        {
-          "kind": "property",
-          "name": "model",
-          "description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "symbol",
-            "name": "TextInputModel"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "elemPropsHook",
-          "description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
-          "tags": {},
-          "declarations": [],
-          "type": {
-            "kind": "function",
-            "parameters": [
-              {
-                "kind": "parameter",
-                "description": "",
-                "tags": {},
-                "declarations": [],
-                "name": "model",
-                "type": {
-                  "kind": "symbol",
-                  "name": "TextInputModel"
-                },
-                "required": true
-              },
-              {
-                "kind": "parameter",
-                "description": "",
-                "tags": {},
-                "declarations": [],
-                "name": "elemProps",
-                "type": {
-                  "kind": "generic",
-                  "name": "TProps"
-                }
-              }
-            ],
-            "returnType": {
-              "kind": "external",
-              "name": "HTML Attributes",
-              "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
-            }
-          }
-        }
-      ],
-      "baseElement": {
-        "kind": "external",
-        "name": "input",
-        "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
-      },
-      "styleComponent": {
-        "kind": "symbol",
-        "name": "Box"
-      },
-      "model": "TextInputModel"
-    }
-  },
   {
     "name": "version",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/version.ts",
@@ -196583,7 +195697,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "useThemedRing",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts",
-    "description": "This is a way to automatically add themed colors to your input and is helpful when showing alerts, success or errors to users.\nIt supports `error`, `alert`, and `success` states. It will try and use the corresponding\n`main` colors from your `CanvasThemePalette` unless they do not meet accessibility contrast, in\nwhich case the outer ring will use the `darkest` color. This hook will also show a `focusOutline`\nring when the input is focused. Note: You should not rely on these colors alone to differentiate\nalerts, but use them in combination with icons or hint text.\n```tsx\n// Add here jsx pragma to use css\nimport {jsx} from '@emotion/react';\nimport React from 'react';\nimport {TextInput} from '@workday/canvas-kit-preview-react/text-input';\nimport {useThemedRing} from '@workday/canvas-kit-react/common';\n\nexport const MyInput = ({handleChange}) => {\n const [value, setValue] = React.useState('invalid@email');\n const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {\n   setValue(event.target.value);\n };\n\n const alertStyles = useThemedRing('alert');\n\n return (\n   <TextInput>\n    <TextInput.Label>Email</TextInput.Label>\n     <TextInput.Field css={alertStyles} onChange={handleChange} value={value} />\n     <TextInput.Hint>Please enter a valid email.</TextInput.Hint>\n   </TextInput>\n );\n};\n```",
+    "description": "This is a way to automatically add themed colors to your input and is helpful when showing alerts, success or errors to users.\nIt supports `error`, `alert`, and `success` states. It will try and use the corresponding\n`main` colors from your `CanvasThemePalette` unless they do not meet accessibility contrast, in\nwhich case the outer ring will use the `darkest` color. This hook will also show a `focusOutline`\nring when the input is focused. Note: You should not rely on these colors alone to differentiate\nalerts, but use them in combination with icons or hint text.\n```tsx\n// Add here jsx pragma to use css\nimport {jsx} from '@emotion/react';\nimport React from 'react';\nimport {FormField} from '@workday/canvas-kit-react/form-field';\nimport {TextInput} from '@workday/canvas-kit-react/text-input';\nimport {useThemedRing} from '@workday/canvas-kit-react/common';\n\nexport const MyInput = ({handleChange}) => {\n const [value, setValue] = React.useState('invalid@email');\n const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {\n   setValue(event.target.value);\n };\n\n const alertStyles = useThemedRing('alert');\n\n return (\n   <FormField>\n     <FormField.Label>Email</FormField.Label>\n     <FormField.Field css={alertStyles}>\n       <FormField.Input as={TextInput} onChange={handleChange} value={value} />\n       <FormField.Hint>Add a valid email</FormField.Hint>\n     </FormField.Field>\n   </FormField>\n );\n};\n```",
     "declarations": [
       {
         "name": "useThemedRing",