@workday/canvas-kit-docs 11.0.0-alpha.721-next.0 → 11.0.0-alpha.726-next.0

package/dist/es6/lib/docs.js

@@ -114006,7 +114006,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/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```",
+    "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```",
     "declarations": [
       {
         "name": "useThemedRing",
@@ -253056,6 +253056,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
+  {
+    "name": "handleInjectGlobal",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleInjectGlobal.ts",
+    "description": "",
+    "declarations": [
+      {
+        "name": "handleInjectGlobal",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleInjectGlobal.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "symbol",
+      "name": "NodeTransformer",
+      "value": "NodeTransformer"
+    }
+  },
   {
     "name": "handleKeyframes",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleKeyframes.ts",
@@ -257485,10 +257502,70 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
+  {
+    "name": "getInstance",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts",
+    "description": "Gets the current Emotion CSS instance, falling back to the one from `@emotion/css` if one wasn't\nalready created. This allows a custom cache to be created as an opt-in",
+    "declarations": [
+      {
+        "name": "getInstance",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "function",
+      "parameters": [],
+      "members": [],
+      "returnType": {
+        "kind": "symbol",
+        "name": "_createInstance"
+      }
+    }
+  },
+  {
+    "name": "createInstance",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts",
+    "description": "Creates a custom instance of Emotion CSS. If this function is never called, the instance will be\nwhat gets imported from `@emotion/css`. This function must be called before any Canvas Kit\ncomponent is imported or before any other `@workday/canvas-kit-styling` function is called. All\nthe style utility functions need an instance and will automatically create one if one isn't\nalready created.\n\nThe style utilities inject styles as soon as they are called which means an instance needs to be\ncreated before any Canvas Kit components are even imported. Your application bootstrap must\nimport a file that imports `@workday/canvas-kit-styling` and calls `createInstance` _before_ any\nother Canvas Kit components are imported.",
+    "declarations": [
+      {
+        "name": "createInstance",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "symbol",
+      "name": "_createInstance",
+      "value": "(options?: Options | undefined) => Emotion"
+    }
+  },
+  {
+    "name": "getCache",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts",
+    "description": "Returns the cache used by all style utilities",
+    "declarations": [
+      {
+        "name": "getCache",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "function",
+      "parameters": [],
+      "members": [],
+      "returnType": {
+        "kind": "symbol",
+        "name": "EmotionCache",
+        "value": "EmotionCache"
+      }
+    }
+  },
   {
     "name": "keyframes",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts",
-    "description": "",
+    "description": "Create static keyframes. Use as a drop-in replacement to `keyframes` found in `@emotion/css` or\n`@emotion/react`",
     "declarations": [
       {
         "name": "keyframes",
@@ -257592,6 +257669,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     }
   },
+  {
+    "name": "injectGlobal",
+    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts",
+    "description": "Allows injecting of global styles.",
+    "declarations": [
+      {
+        "name": "injectGlobal",
+        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
+      }
+    ],
+    "tags": {},
+    "type": {
+      "kind": "symbol",
+      "name": "EmotionCSS.injectGlobal",
+      "value": "{ (template: TemplateStringsArray, ...args: CSSInterpolation[]): void; (...args: CSSInterpolation[]): void; }"
+    }
+  },
   {
     "name": "px2rem",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/px2rem.ts",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "11.0.0-alpha.721-next.0",
+  "version": "11.0.0-alpha.726-next.0",
   "description": "Documentation components of Canvas Kit components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -44,10 +44,10 @@
   "dependencies": {
     "@emotion/styled": "^11.6.0",
     "@storybook/csf": "0.0.1",
-    "@workday/canvas-kit-labs-react": "^11.0.0-alpha.721-next.0",
-    "@workday/canvas-kit-preview-react": "^11.0.0-alpha.721-next.0",
-    "@workday/canvas-kit-react": "^11.0.0-alpha.721-next.0",
-    "@workday/canvas-kit-styling": "^11.0.0-alpha.721-next.0",
+    "@workday/canvas-kit-labs-react": "^11.0.0-alpha.726-next.0",
+    "@workday/canvas-kit-preview-react": "^11.0.0-alpha.726-next.0",
+    "@workday/canvas-kit-react": "^11.0.0-alpha.726-next.0",
+    "@workday/canvas-kit-styling": "^11.0.0-alpha.726-next.0",
     "@workday/canvas-system-icons-web": "^3.0.0",
     "@workday/canvas-tokens-web": "^1.0.2",
     "markdown-to-jsx": "^6.10.3",
@@ -59,5 +59,5 @@
     "mkdirp": "^1.0.3",
     "typescript": "4.2"
   },
-  "gitHead": "e7fad00a4763b2f506fc08d6c419b4b251c7d925"
+  "gitHead": "92313a01b7703822a67e7c7f7aff5460237f8ce7"
 }