@workday/canvas-kit-docs 9.0.0-alpha.368-next.6 → 9.0.0-alpha.382-next.2

package/dist/es6/lib/docs.js

@@ -1,10 +1,10 @@
 import React from 'react';
-export var GithubUrl = React.createContext('https://github.com/Workday/canvas-kit/');
-export var GithubBranch = React.createContext('master');
-export var StorybookUrl = React.createContext(typeof location !== 'undefined' && location.pathname.indexOf('/canvas-kit/') === 0
+export const GithubUrl = React.createContext('https://github.com/Workday/canvas-kit/');
+export const GithubBranch = React.createContext('master');
+export const StorybookUrl = React.createContext(typeof location !== 'undefined' && location.pathname.indexOf('/canvas-kit/') === 0
     ? '/canvas-kit/'
     : '/');
-export var docs = (typeof window !== 'undefined' && window.__docs) ||
+export const docs = (typeof window !== 'undefined' && window.__docs) ||
     [
     
   {
@@ -958,221 +958,6 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       ]
     }
   },
-  {
-    "name": "getPaletteColors",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemedRing.ts",
-    "description": "",
-    "declarations": [
-      {
-        "name": "getPaletteColors",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemedRing.ts"
-      }
-    ],
-    "tags": {},
-    "type": {
-      "kind": "function",
-      "parameters": [
-        {
-          "kind": "parameter",
-          "name": "type",
-          "type": {
-            "kind": "type",
-            "typeParameters": [],
-            "value": {
-              "kind": "symbol",
-              "name": "Exclude",
-              "typeParameters": [
-                {
-                  "kind": "union",
-                  "value": [
-                    {
-                      "kind": "string",
-                      "value": "common"
-                    },
-                    {
-                      "kind": "string",
-                      "value": "primary"
-                    },
-                    {
-                      "kind": "string",
-                      "value": "error"
-                    },
-                    {
-                      "kind": "string",
-                      "value": "alert"
-                    },
-                    {
-                      "kind": "string",
-                      "value": "success"
-                    },
-                    {
-                      "kind": "string",
-                      "value": "neutral"
-                    }
-                  ]
-                },
-                {
-                  "kind": "string",
-                  "value": "common"
-                }
-              ],
-              "value": "Exclude<T, U>"
-            }
-          },
-          "required": true,
-          "rest": false,
-          "description": "",
-          "declarations": [
-            {
-              "name": "type",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemedRing.ts"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "parameter",
-          "name": "theme",
-          "type": {
-            "kind": "symbol",
-            "name": "EmotionCanvasTheme",
-            "value": "EmotionCanvasTheme"
-          },
-          "required": true,
-          "rest": false,
-          "description": "",
-          "declarations": [
-            {
-              "name": "theme",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemedRing.ts"
-            }
-          ],
-          "tags": {}
-        }
-      ],
-      "members": [],
-      "returnType": {
-        "kind": "object",
-        "properties": [
-          {
-            "kind": "property",
-            "name": "outer",
-            "required": false,
-            "type": {
-              "kind": "primitive",
-              "value": "string"
-            },
-            "description": "",
-            "declarations": [
-              {
-                "name": "outer",
-                "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemedRing.ts"
-              }
-            ],
-            "tags": {}
-          },
-          {
-            "kind": "property",
-            "name": "inner",
-            "required": false,
-            "type": {
-              "kind": "primitive",
-              "value": "string"
-            },
-            "description": "",
-            "declarations": [
-              {
-                "name": "inner",
-                "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemedRing.ts"
-              }
-            ],
-            "tags": {}
-          }
-        ]
-      }
-    }
-  },
-  {
-    "name": "useThemedRing",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemedRing.ts",
-    "description": "",
-    "declarations": [
-      {
-        "name": "useThemedRing",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemedRing.ts"
-      }
-    ],
-    "tags": {},
-    "type": {
-      "kind": "function",
-      "parameters": [
-        {
-          "kind": "parameter",
-          "name": "type",
-          "type": {
-            "kind": "type",
-            "typeParameters": [],
-            "value": {
-              "kind": "symbol",
-              "name": "Exclude",
-              "typeParameters": [
-                {
-                  "kind": "union",
-                  "value": [
-                    {
-                      "kind": "string",
-                      "value": "common"
-                    },
-                    {
-                      "kind": "string",
-                      "value": "primary"
-                    },
-                    {
-                      "kind": "string",
-                      "value": "error"
-                    },
-                    {
-                      "kind": "string",
-                      "value": "alert"
-                    },
-                    {
-                      "kind": "string",
-                      "value": "success"
-                    },
-                    {
-                      "kind": "string",
-                      "value": "neutral"
-                    }
-                  ]
-                },
-                {
-                  "kind": "string",
-                  "value": "common"
-                }
-              ],
-              "value": "Exclude<T, U>"
-            }
-          },
-          "required": true,
-          "rest": false,
-          "description": "",
-          "declarations": [
-            {
-              "name": "type",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemedRing.ts"
-            }
-          ],
-          "tags": {}
-        }
-      ],
-      "members": [],
-      "returnType": {
-        "kind": "symbol",
-        "name": "CSSProperties",
-        "value": "CSSProperties"
-      }
-    }
-  },
   {
     "name": "ComponentStyles",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts",
@@ -1208,7 +993,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "useThemeRTL",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts",
-    "description": "A helpful hook for supporting bidirectional styles.\n* Read below for more detail or [view the docs](https://github.com/Workday/canvas-kit/blob/master/modules/labs-react/common/README.md#useThemeRTL).",
+    "description": "",
     "declarations": [
       {
         "name": "useThemeRTL",
@@ -1216,6 +1001,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
+      "deprecated": "Now that IE11 is no longer supported, we encourage consumers to use [CSS logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Logical_Properties)\n\n\nA helpful hook for supporting bidirectional styles.\n* Read below for more detail or [view the docs](https://github.com/Workday/canvas-kit/blob/master/modules/labs-react/common/README.md#useThemeRTL).",
       "returns": "* `themeRTL` - a function to transform bidirectional styles\n* `theme` - the Canvas theme object (optional, provided for convenience)\n\n`themeRTL` allows you to support bidirectionality with a single set of styles and pass them along to a component.\nIt accepts CSS object styles and transforms CSS attributes based on the content direction set in the theme (LTR or RTL).",
       "example": "import { type } from '@workday/canvas-kit-react/tokens';\nimport { useThemeRTL } from '@workday/canvas-kit-labs-react/common';\n\nconst ErrorText: React.FC = (props) => {\n  const { themeRTL, theme } = useThemeRTL();\n  // `borderLeft` will be converted to `borderRight`\n  // when the theme direction is `RTL`.\n  // All other styles will remain unchanged.\n  const errorTextStyles = themeRTL({\n    ...type.levels.subtext.medium,\n    color: theme.canvas.palette.error.main,\n    borderLeft: `solid 2px ${theme.canvas.palette.error.main}`,\n  });\n\n  return <span css={errorTextStyles} {...props} />;\n}"
     },
@@ -17681,6 +17467,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -38220,15 +38032,15 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
                   "value": [
                     {
                       "kind": "string",
-                      "value": "common"
+                      "value": "error"
                     },
                     {
                       "kind": "string",
-                      "value": "primary"
+                      "value": "common"
                     },
                     {
                       "kind": "string",
-                      "value": "error"
+                      "value": "primary"
                     },
                     {
                       "kind": "string",
@@ -38371,15 +38183,15 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
                   "value": [
                     {
                       "kind": "string",
-                      "value": "common"
+                      "value": "error"
                     },
                     {
                       "kind": "string",
-                      "value": "primary"
+                      "value": "common"
                     },
                     {
                       "kind": "string",
-                      "value": "error"
+                      "value": "primary"
                     },
                     {
                       "kind": "string",
@@ -50024,6 +49836,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -90983,99 +90821,6 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
-  {
-    "name": "getCanvasTheme",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/getCanvasTheme.ts",
-    "description": "Use this function when you have access to `theme` in styled components.\nThis function ensures that a theme is defined via a proxy and allows access to properties on the theme object.",
-    "declarations": [
-      {
-        "name": "getCanvasTheme",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/getCanvasTheme.ts"
-      }
-    ],
-    "tags": {
-      "param": "theme Any partial or full theme object.",
-      "returns": "a theme object if it is defined, otherwise it will fall back on using defaultCanvasTheme",
-      "example": "const ResponsiveContainer = styled('div')(({theme}) => {\nconst canvas = getCanvasTheme(theme);\n return {\n   maxHeight: '100vh',\n   display: 'flex',\n   position: 'absolute',\n   left: 0,\n   top: 0,\n   justifyContent: 'center',\n   alignItems: 'center',\n   height: '100vh',\n   [canvas.breakpoints.down('s')]: {\n     alignItems: 'end',\n   },\n };\n});"
-    },
-    "type": {
-      "kind": "function",
-      "parameters": [
-        {
-          "kind": "parameter",
-          "name": "theme",
-          "defaultValue": {
-            "kind": "object",
-            "properties": []
-          },
-          "type": {
-            "kind": "primitive",
-            "value": "any"
-          },
-          "required": false,
-          "rest": false,
-          "description": "Any partial or full theme object.",
-          "declarations": [
-            {
-              "name": "theme",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/getCanvasTheme.ts"
-            }
-          ],
-          "tags": {
-            "param": "theme Any partial or full theme object."
-          }
-        }
-      ],
-      "members": [],
-      "returnType": {
-        "kind": "symbol",
-        "name": "CanvasTheme",
-        "value": "CanvasTheme"
-      }
-    }
-  },
-  {
-    "name": "useCanvasTheme",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/getCanvasTheme.ts",
-    "description": "",
-    "declarations": [
-      {
-        "name": "useCanvasTheme",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/getCanvasTheme.ts"
-      }
-    ],
-    "tags": {},
-    "type": {
-      "kind": "function",
-      "parameters": [
-        {
-          "kind": "parameter",
-          "name": "themeOverride",
-          "type": {
-            "kind": "symbol",
-            "name": "Theme",
-            "value": "Theme"
-          },
-          "required": false,
-          "rest": false,
-          "description": "",
-          "declarations": [
-            {
-              "name": "themeOverride",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/getCanvasTheme.ts"
-            }
-          ],
-          "tags": {}
-        }
-      ],
-      "members": [],
-      "returnType": {
-        "kind": "symbol",
-        "name": "CanvasTheme",
-        "value": "CanvasTheme"
-      }
-    }
-  },
   {
     "name": "RecursivePartial",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/getObjectProxy.ts",
@@ -92074,10 +91819,58 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
+  {
+    "name": "getTheme",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useTheme.ts",
+    "description": "Function to get the correct theme object for `styled` and class components\nor to be used outside component.",
+    "declarations": [
+      {
+        "name": "getTheme",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useTheme.ts"
+      }
+    ],
+    "tags": {
+      "param": "theme - The theme object with the Canvas Kit theme.\nIt should be namespaced within this variable under the `canvas` key.\nValue of `canvas` property is any partial or full theme object to overwtite default theme.",
+      "returns": "An object containing updated or default Canvas Kit theme under `canvas` key.\n\nThe passed partial theme object will be merged with the default Canvas theme\n(using memoized createCanvasTheme()) to establish any missing fields that have\nnot been defined by the consumer's theme object.\n\nIf theme is not passed, the function will try to retrieve it from the window object.\nIf window theme is not found, it will return the default Canvas theme.",
+      "example": "import {getTheme} from '@workday/canvas-kit-react/common';\n\nconst theme = getTheme();\nconst {up, down} = theme.canvas.breakpoints;\nconst small = down('m'); // Returns '@media (max-width: 768px)'\nconst medium = up('m'); // Returns '@media (min-width: 768px)'\n\nconst styles = {\n [small]: {\n   margin: space.m\n },\n [medium]: {\n   margin: space.l\n }\n}"
+    },
+    "type": {
+      "kind": "function",
+      "parameters": [
+        {
+          "kind": "parameter",
+          "name": "theme",
+          "type": {
+            "kind": "symbol",
+            "name": "PartialEmotionCanvasTheme",
+            "value": "PartialEmotionCanvasTheme"
+          },
+          "required": false,
+          "rest": false,
+          "description": "- The theme object with the Canvas Kit theme.\nIt should be namespaced within this variable under the `canvas` key.\nValue of `canvas` property is any partial or full theme object to overwtite default theme.",
+          "declarations": [
+            {
+              "name": "theme",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useTheme.ts"
+            }
+          ],
+          "tags": {
+            "param": "theme - The theme object with the Canvas Kit theme.\nIt should be namespaced within this variable under the `canvas` key.\nValue of `canvas` property is any partial or full theme object to overwtite default theme."
+          }
+        }
+      ],
+      "members": [],
+      "returnType": {
+        "kind": "symbol",
+        "name": "EmotionCanvasTheme",
+        "value": "EmotionCanvasTheme"
+      }
+    }
+  },
   {
     "name": "useTheme",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useTheme.ts",
-    "description": "Hook function to get the correct theme object.",
+    "description": "Hook function to get the correct theme object for functional components.",
     "declarations": [
       {
         "name": "useTheme",
@@ -92085,7 +91878,9 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "param": "theme - The theme object returned from the emotion ThemeContext\n(through ThemeProvider). The Canvas Kit theme is namespaced within this variable under the `canvas` key.\n\nNOTE: If you are using a class component, you MUST pass the theme.\nIf not passed, the function will try to pull the theme from ThemeContext.\nIf that does not work, it will try to retrieve it from the window object.\nAs a last resort, it will return the default Canvas theme.\n\nThe resulting theme will be merged with the default Canvas theme\n(using memoized createCanvasTheme()) to establish any missing fields that have\nnot been defined by the consumer's theme object.\n\nProviding the default theme here is currently a work around for when no\nThemeProvider or context exists.\nTracked on https://github.com/emotion-js/emotion/issues/1193."
+      "param": "theme - The theme object with the Canvas Kit theme.\nIt should be namespaced within this variable under the `canvas` key.\nValue of `canvas` property is any partial or full theme object to overwtite default theme.",
+      "returns": "An object containing updated or default Canvas Kit theme under `canvas` key.\n\nNOTE: If theme is not passed, the function will try to pull the theme from ThemeContext.\nIf that does not work, it will try to retrieve it from the window object.\nAs a last resort, it will return the default Canvas theme.\n\nThe resulting theme will be merged with the default Canvas theme\n(using memoized createCanvasTheme()) to establish any missing fields that have\nnot been defined by the consumer's theme object.\n\nProviding the default theme here is currently a work around for when no\nThemeProvider or context exists.\nTracked on https://github.com/emotion-js/emotion/issues/1193.",
+      "example": "export const ErrorMessage = () => {\n const theme = useTheme();\n return (\n   <Subtext size=\"large\" color={theme.canvas.palette.error.main}>\n );\n}"
     },
     "type": {
       "kind": "function",
@@ -92100,7 +91895,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           },
           "required": false,
           "rest": false,
-          "description": "- The theme object returned from the emotion ThemeContext\n(through ThemeProvider). The Canvas Kit theme is namespaced within this variable under the `canvas` key.\n\nNOTE: If you are using a class component, you MUST pass the theme.\nIf not passed, the function will try to pull the theme from ThemeContext.\nIf that does not work, it will try to retrieve it from the window object.\nAs a last resort, it will return the default Canvas theme.\n\nThe resulting theme will be merged with the default Canvas theme\n(using memoized createCanvasTheme()) to establish any missing fields that have\nnot been defined by the consumer's theme object.\n\nProviding the default theme here is currently a work around for when no\nThemeProvider or context exists.\nTracked on https://github.com/emotion-js/emotion/issues/1193.",
+          "description": "- The theme object with the Canvas Kit theme.\nIt should be namespaced within this variable under the `canvas` key.\nValue of `canvas` property is any partial or full theme object to overwtite default theme.",
           "declarations": [
             {
               "name": "theme",
@@ -92108,7 +91903,7 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
             }
           ],
           "tags": {
-            "param": "theme - The theme object returned from the emotion ThemeContext\n(through ThemeProvider). The Canvas Kit theme is namespaced within this variable under the `canvas` key.\n\nNOTE: If you are using a class component, you MUST pass the theme.\nIf not passed, the function will try to pull the theme from ThemeContext.\nIf that does not work, it will try to retrieve it from the window object.\nAs a last resort, it will return the default Canvas theme.\n\nThe resulting theme will be merged with the default Canvas theme\n(using memoized createCanvasTheme()) to establish any missing fields that have\nnot been defined by the consumer's theme object.\n\nProviding the default theme here is currently a work around for when no\nThemeProvider or context exists.\nTracked on https://github.com/emotion-js/emotion/issues/1193."
+            "param": "theme - The theme object with the Canvas Kit theme.\nIt should be namespaced within this variable under the `canvas` key.\nValue of `canvas` property is any partial or full theme object to overwtite default theme."
           }
         }
       ],
@@ -92120,6 +91915,221 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
+  {
+    "name": "getPaletteColorsForFocusRing",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts",
+    "description": "",
+    "declarations": [
+      {
+        "name": "getPaletteColorsForFocusRing",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "function",
+      "parameters": [
+        {
+          "kind": "parameter",
+          "name": "type",
+          "type": {
+            "kind": "type",
+            "typeParameters": [],
+            "value": {
+              "kind": "symbol",
+              "name": "Exclude",
+              "typeParameters": [
+                {
+                  "kind": "union",
+                  "value": [
+                    {
+                      "kind": "string",
+                      "value": "error"
+                    },
+                    {
+                      "kind": "string",
+                      "value": "common"
+                    },
+                    {
+                      "kind": "string",
+                      "value": "primary"
+                    },
+                    {
+                      "kind": "string",
+                      "value": "alert"
+                    },
+                    {
+                      "kind": "string",
+                      "value": "success"
+                    },
+                    {
+                      "kind": "string",
+                      "value": "neutral"
+                    }
+                  ]
+                },
+                {
+                  "kind": "string",
+                  "value": "common"
+                }
+              ],
+              "value": "Exclude<T, U>"
+            }
+          },
+          "required": true,
+          "rest": false,
+          "description": "",
+          "declarations": [
+            {
+              "name": "type",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts"
+            }
+          ],
+          "tags": {}
+        },
+        {
+          "kind": "parameter",
+          "name": "theme",
+          "type": {
+            "kind": "symbol",
+            "name": "EmotionCanvasTheme",
+            "value": "EmotionCanvasTheme"
+          },
+          "required": true,
+          "rest": false,
+          "description": "",
+          "declarations": [
+            {
+              "name": "theme",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts"
+            }
+          ],
+          "tags": {}
+        }
+      ],
+      "members": [],
+      "returnType": {
+        "kind": "object",
+        "properties": [
+          {
+            "kind": "property",
+            "name": "outer",
+            "required": false,
+            "type": {
+              "kind": "primitive",
+              "value": "string"
+            },
+            "description": "",
+            "declarations": [
+              {
+                "name": "outer",
+                "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts"
+              }
+            ],
+            "tags": {}
+          },
+          {
+            "kind": "property",
+            "name": "inner",
+            "required": false,
+            "type": {
+              "kind": "primitive",
+              "value": "string"
+            },
+            "description": "",
+            "declarations": [
+              {
+                "name": "inner",
+                "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts"
+              }
+            ],
+            "tags": {}
+          }
+        ]
+      }
+    }
+  },
+  {
+    "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/core';\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```",
+    "declarations": [
+      {
+        "name": "useThemedRing",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "function",
+      "parameters": [
+        {
+          "kind": "parameter",
+          "name": "type",
+          "type": {
+            "kind": "type",
+            "typeParameters": [],
+            "value": {
+              "kind": "symbol",
+              "name": "Exclude",
+              "typeParameters": [
+                {
+                  "kind": "union",
+                  "value": [
+                    {
+                      "kind": "string",
+                      "value": "error"
+                    },
+                    {
+                      "kind": "string",
+                      "value": "common"
+                    },
+                    {
+                      "kind": "string",
+                      "value": "primary"
+                    },
+                    {
+                      "kind": "string",
+                      "value": "alert"
+                    },
+                    {
+                      "kind": "string",
+                      "value": "success"
+                    },
+                    {
+                      "kind": "string",
+                      "value": "neutral"
+                    }
+                  ]
+                },
+                {
+                  "kind": "string",
+                  "value": "common"
+                }
+              ],
+              "value": "Exclude<T, U>"
+            }
+          },
+          "required": true,
+          "rest": false,
+          "description": "",
+          "declarations": [
+            {
+              "name": "type",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts"
+            }
+          ],
+          "tags": {}
+        }
+      ],
+      "members": [],
+      "returnType": {
+        "kind": "symbol",
+        "name": "CSSProperties",
+        "value": "CSSProperties"
+      }
+    }
+  },
   {
     "name": "GrowthBehavior",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts",
@@ -92614,6 +92624,70 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
+  {
+    "name": "getColor",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/colorUtils.ts",
+    "description": "The function takes in a color string or an enum value of CanvasColor and returns its hex value color.",
+    "declarations": [
+      {
+        "name": "getColor",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/colorUtils.ts"
+      }
+    ],
+    "tags": {
+      "param": "value a string or an enum value of CanvasColor",
+      "returns": "the hex value color"
+    },
+    "type": {
+      "kind": "function",
+      "parameters": [
+        {
+          "kind": "parameter",
+          "name": "value",
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "symbol",
+                "name": "CanvasColor",
+                "value": "\"cinnamon600\" | \"cinnamon500\" | \"cinnamon400\" | \"cinnamon300\" | \"cinnamon200\" | \"cinnamon100\" | \"peach600\" | \"peach500\" | \"peach400\" | \"peach300\" | \"peach200\" | \"peach100\" | ... 149 more ... | \"blackPepper100\""
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "required": false,
+          "rest": false,
+          "description": "a string or an enum value of CanvasColor",
+          "declarations": [
+            {
+              "name": "value",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/colorUtils.ts"
+            }
+          ],
+          "tags": {
+            "param": "value a string or an enum value of CanvasColor"
+          }
+        }
+      ],
+      "members": [],
+      "returnType": {
+        "kind": "union",
+        "value": [
+          {
+            "kind": "primitive",
+            "value": "string"
+          },
+          {
+            "kind": "primitive",
+            "value": "undefined"
+          }
+        ]
+      }
+    }
+  },
   {
     "name": "expandHex",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/colorUtils.ts",
@@ -99504,8 +99578,11 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
                 "kind": "parameter",
                 "name": "args",
                 "type": {
-                  "kind": "primitive",
-                  "value": "any"
+                  "kind": "array",
+                  "value": {
+                    "kind": "primitive",
+                    "value": "any"
+                  }
                 },
                 "required": true,
                 "rest": true,
@@ -106883,8 +106960,8 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           "name": "color",
           "required": false,
           "type": {
-            "kind": "primitive",
-            "value": "string"
+            "kind": "symbol",
+            "name": "CanvasColorTokens"
           },
           "description": "The fill color of the AccentIcon.",
           "declarations": [
@@ -107039,8 +107116,8 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           "name": "color",
           "required": false,
           "type": {
-            "kind": "primitive",
-            "value": "string"
+            "kind": "symbol",
+            "name": "CanvasColorTokens"
           },
           "description": "The fill color of the AccentIcon.",
           "declarations": [
@@ -108887,8 +108964,8 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           "name": "background",
           "required": false,
           "type": {
-            "kind": "primitive",
-            "value": "string"
+            "kind": "symbol",
+            "name": "CanvasColorTokens"
           },
           "description": "The background color of the SystemIconCircle from `@workday/canvas-colors-web`.",
           "declarations": [
@@ -109142,65 +109219,6 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
-  {
-    "name": "getColor",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/utils.ts",
-    "description": "",
-    "declarations": [
-      {
-        "name": "getColor",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/utils.ts"
-      }
-    ],
-    "tags": {},
-    "type": {
-      "kind": "function",
-      "parameters": [
-        {
-          "kind": "parameter",
-          "name": "value",
-          "type": {
-            "kind": "union",
-            "value": [
-              {
-                "kind": "symbol",
-                "name": "CanvasColor",
-                "value": "\"cinnamon600\" | \"cinnamon500\" | \"cinnamon400\" | \"cinnamon300\" | \"cinnamon200\" | \"cinnamon100\" | \"peach600\" | \"peach500\" | \"peach400\" | \"peach300\" | \"peach200\" | \"peach100\" | ... 149 more ... | \"blackPepper100\""
-              },
-              {
-                "kind": "primitive",
-                "value": "string"
-              }
-            ]
-          },
-          "required": false,
-          "rest": false,
-          "description": "",
-          "declarations": [
-            {
-              "name": "value",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/icon/lib/utils.ts"
-            }
-          ],
-          "tags": {}
-        }
-      ],
-      "members": [],
-      "returnType": {
-        "kind": "union",
-        "value": [
-          {
-            "kind": "primitive",
-            "value": "string"
-          },
-          {
-            "kind": "primitive",
-            "value": "undefined"
-          }
-        ]
-      }
-    }
-  },
   {
     "name": "BoxProps",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx",
@@ -111726,6 +111744,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -116012,6 +116056,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -120721,6 +120791,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -128103,6 +128199,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -146526,6 +146648,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -152992,6 +153140,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -158072,6 +158246,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -173244,6 +173444,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -179244,6 +179470,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -192523,6 +192775,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -197192,6 +197470,32 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
           ],
           "tags": {}
         },
+        {
+          "kind": "property",
+          "name": "inset",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "primitive",
+                "value": "number"
+              },
+              {
+                "kind": "primitive",
+                "value": "string"
+              }
+            ]
+          },
+          "description": "- sets [CSS inset property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset)",
+          "declarations": [
+            {
+              "name": "inset",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/position.ts"
+            }
+          ],
+          "tags": {}
+        },
         {
           "kind": "property",
           "name": "insetInlineStart",
@@ -213874,26 +214178,26 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
 
     ];
 export function getDoc(name, fileName) {
-    return docs.find(function (d) {
+    return docs.find(d => {
         return d.name === name && (fileName ? d.fileName.includes(fileName) : true);
     });
 }
-var subscriptions = [];
+const subscriptions = [];
 export function subscribe(listener) {
     subscriptions.push(listener);
-    return function () {
-        var index = subscriptions.findIndex(function (s) { return s === listener; });
+    return () => {
+        const index = subscriptions.findIndex(s => s === listener);
         if (index > 0) {
             subscriptions.splice(index, 1);
         }
     };
 }
 export function updateDocs(updatedDocs) {
-    updatedDocs.forEach(function (doc) {
-        var foundIndex = docs.findIndex(function (d) { return d.fileName === doc.fileName && d.name === doc.name; });
+    updatedDocs.forEach(doc => {
+        const foundIndex = docs.findIndex(d => d.fileName === doc.fileName && d.name === doc.name);
         if (foundIndex !== -1) {
             // we need to replace the doc with updates
-            subscriptions.forEach(function (s) {
+            subscriptions.forEach(s => {
                 if (s.name === doc.name && s.fileName ? s.fileName === doc.fileName : true) {
                     s.callback(doc);
                 }