@workday/canvas-kit-docs 14.0.9 → 14.1.0-1282-next.0

package/dist/es6/lib/docs.js

@@ -195100,7 +195100,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/createCanvasTheme.ts"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `shiftColor` is deprecated and will be removed in a future major version. While we work on an algorithm for color shifting, you can use [oklch from or with calc](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/oklch) to calculate colors."
+    },
     "type": {
       "kind": "function",
       "parameters": [
@@ -195162,7 +195164,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/createCanvasTheme.ts"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `createCanvasTheme` is deprecated and will be removed in a future major version. Please use our CSS Branding tokens to create a theme. For more information, please use our [theming docs](https://workday.github.io/canvas-kit/?path=/docs/features-theming-overview--docs)."
+    },
     "type": {
       "kind": "function",
       "parameters": [
@@ -195322,7 +195326,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/styled.ts"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `filterOutProps` is deprecated and will be removed in a future major version. Use our `createComponent` and `handleCsProp` helpers to handle props. For more information, view our [Meriging Styles Docs](https://workday.github.io/canvas-kit/?path=/docs/styling-guides-merging-styles--docs#handlecsprop)."
+    },
     "type": {
       "kind": "function",
       "parameters": [
@@ -195444,7 +195450,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/theme.ts"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `defaultCanvasTheme` is deprecated and will be removed in a future major version. If you want to reset the theme, use `defaultBranding` and apply it to the `CanvasProvider`. For more information, view our [theming docs](https://workday.github.io/canvas-kit/?path=/docs/features-theming-overview--docs)."
+    },
     "type": {
       "kind": "symbol",
       "name": "CanvasTheme",
@@ -196277,7 +196285,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": "Use isElementRTL instead."
+      "deprecated": "⚠️ `useIsRTL` is deprecated and will be removed in a future major version. Please use `isElementRTL` instead."
     },
     "type": {
       "kind": "function",
@@ -196322,7 +196330,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
     "tags": {
       "param": "theme\n \n- 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}"
+      "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}",
+      "deprecated": "⚠️ `getTheme` is deprecated and will be removed in a future major version. Please use our [CSS tokens](https://workday.github.io/canvas-tokens/?path=/docs/docs-brand-tokens--docs) to theme components."
     },
     "type": {
       "kind": "function",
@@ -196370,7 +196379,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
     "tags": {
       "param": "theme\n \n- 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}"
+      "example": "export const ErrorMessage = () => {\n const theme = useTheme();\n return (\n   <Subtext size=\"large\" color={theme.canvas.palette.error.main}>\n );\n}",
+      "deprecated": "⚠️ `useTheme` is deprecated and will be removed in a future major version. Please use our [CSS tokens](https://workday.github.io/canvas-tokens/?path=/docs/docs-brand-tokens--docs) to theme components."
     },
     "type": {
       "kind": "function",
@@ -196415,7 +196425,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `getPaletteColorsForFocusRing` is deprecated and will be removed in a future major version. Please use the `brand.common.focusRing` CSS variable to theme focus rings. For more information, view our [CSS tokens](https://workday.github.io/canvas-tokens/?path=/docs/docs-brand-tokens--docs)."
+    },
     "type": {
       "kind": "function",
       "parameters": [
@@ -196510,7 +196522,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "`useThemedRing` is deprecated and will be removed in a future major version. Please use `brand.common.focusOutline` CSS variable instead. View our [CSS tokens](https://workday.github.io/canvas-tokens/?path=/docs/docs-brand-tokens--docs) for more information."
+    },
     "type": {
       "kind": "function",
       "parameters": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "14.0.9",
+  "version": "14.1.0-1282-next.0",
   "description": "Documentation components of Canvas Kit components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -45,10 +45,10 @@
     "@emotion/styled": "^11.6.0",
     "@stackblitz/sdk": "^1.11.0",
     "@storybook/csf": "0.0.1",
-    "@workday/canvas-kit-labs-react": "^14.0.9",
-    "@workday/canvas-kit-preview-react": "^14.0.9",
-    "@workday/canvas-kit-react": "^14.0.9",
-    "@workday/canvas-kit-styling": "^14.0.9",
+    "@workday/canvas-kit-labs-react": "^14.1.0-1282-next.0",
+    "@workday/canvas-kit-preview-react": "^14.1.0-1282-next.0",
+    "@workday/canvas-kit-react": "^14.1.0-1282-next.0",
+    "@workday/canvas-kit-styling": "^14.1.0-1282-next.0",
     "@workday/canvas-system-icons-web": "^3.0.36",
     "@workday/canvas-tokens-web": "^3.1.1",
     "markdown-to-jsx": "^7.2.0",
@@ -61,5 +61,5 @@
     "mkdirp": "^1.0.3",
     "typescript": "5.0"
   },
-  "gitHead": "63f17c093376eb1d2ad11be8f9c5340a4d9a71df"
+  "gitHead": "69e1e3b1fb6262a3db424e4b538fb6dc1afb20f2"
 }