@workday/canvas-kit-docs 9.2.0-526-next.0 → 9.2.0-528-next.0

package/dist/es6/lib/docs.js

@@ -993,7 +993,7 @@ export const 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": "",
+    "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).",
     "declarations": [
       {
         "name": "useThemeRTL",
@@ -1001,9 +1001,9 @@ export const 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}"
+      "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}",
+      "deprecated": "⚠️ `useThemeRTL` has been deprecated and will be removed in a future major version. 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)."
     },
     "type": {
       "kind": "function",
@@ -7155,14 +7155,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "DeprecatedMenuProps",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
-    "description": "### Deprecated Menu\n\nAs of Canvas Kit v8, Menu is being deprecated.\nIt will be removed in v10. Please see the\n[upgrade guide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page)\nfor more information.",
+    "description": "",
     "declarations": [
       {
         "name": "DeprecatedMenuProps",
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `DeprecatedMenuProps` has been deprecated and will be removed in a future major version. Please use [Menu in Main](https://workday.github.io/canvas-kit/?path=/docs/components-popups-menu--basic) instead."
+    },
     "type": {
       "kind": "alias",
       "name": "DeprecatedMenu"
@@ -7171,14 +7173,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "DeprecatedMenuState",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
-    "description": "### Deprecated Menu State\n\nAs of Canvas Kit v8, Menu is being deprecated.\nIt will be removed in v10. Please see the\n[upgrade guide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page)\nfor more information.",
+    "description": "",
     "declarations": [
       {
         "name": "DeprecatedMenuState",
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `DeprecatedMenuState` has been deprecated and will be removed in a future major version. Please use [Menu in Main](https://workday.github.io/canvas-kit/?path=/docs/components-popups-menu--basic) instead."
+    },
     "type": {
       "kind": "object",
       "properties": [
@@ -7205,7 +7209,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "DeprecatedMenu",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
-    "description": "As of Canvas Kit v8, Menu is being deprecated.\nIt will be removed in v10. Please see the [upgrade\nguide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page) for\nmore information.\n\n`DeprecatedMenu` renders a styled `<ul role=\"menu\">` element within a {@link Card} and follows\nthe [Active Menu\npattern](https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/examples/menu-button-actions-active-descendant/)\nusing `aria-activedescendant`.\n\nUndocumented props are spread to the underlying `<ul>` element.",
+    "description": "`DeprecatedMenu` renders a styled `<ul role=\"menu\">` element within a {@link Card} and follows\nthe [Active Menu\npattern](https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/examples/menu-button-actions-active-descendant/)\nusing `aria-activedescendant`.\n\nUndocumented props are spread to the underlying `<ul>` element.",
     "declarations": [
       {
         "name": "DeprecatedMenu",
@@ -7213,7 +7217,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": ""
+      "deprecated": "⚠️ Deprecated Menu has been deprecated and will be removed in a future major version. Please use [Menu in Main](https://workday.github.io/canvas-kit/?path=/docs/components-popups-menu--basic) instead."
     },
     "type": {
       "kind": "component",
@@ -7430,14 +7434,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "DeprecatedMenuItemProps",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx",
-    "description": "### Deprecated Menu Item Props\n\nAs of Canvas Kit v8, Menu is being deprecated.\nIt will be removed in v10. Please see the\n[upgrade guide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page)\nfor more information.",
+    "description": "",
     "declarations": [
       {
         "name": "DeprecatedMenuItemProps",
         "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
       }
     ],
-    "tags": {},
+    "tags": {
+      "deprecated": "⚠️ `DeprecatedMenuItemProps` has been deprecated and will be removed in a future major version. Please use [Menu in Main](https://workday.github.io/canvas-kit/?path=/docs/components-popups-menu--basic) instead."
+    },
     "type": {
       "kind": "alias",
       "name": "DeprecatedMenuItem"
@@ -7446,7 +7452,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "DeprecatedMenuItem",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx",
-    "description": "`DeprecatedMenuItem` renders an `<li>` element with the correct attributes to ensure it is\naccessible. If you choose to implement your own custom menu items, be sure to use semantic `<li>`\nelements with the following attributes:\n\n- `role=\"menuitem\"`\n- `tabindex={-1}`\n- `id`s following this pattern: `${MenuId}-${index}`\n\nAs of Canvas Kit v8, Menu is being deprecated.\nIt will be removed in v10. Please see the [upgrade\nguide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page) for\nmore information.\n\nUndocumented props are spread to the underlying `<li>` element.",
+    "description": "`DeprecatedMenuItem` renders an `<li>` element with the correct attributes to ensure it is\naccessible. If you choose to implement your own custom menu items, be sure to use semantic `<li>`\nelements with the following attributes:\n\n- `role=\"menuitem\"`\n- `tabindex={-1}`\n- `id`s following this pattern: `${MenuId}-${index}`\n\nUndocumented props are spread to the underlying `<li>` element.",
     "declarations": [
       {
         "name": "DeprecatedMenuItem",
@@ -7454,7 +7460,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": ""
+      "deprecated": "⚠️ `DeprecatedMenuItem` has been deprecated and will be removed in a future major version. Please use [Menu in Main](https://workday.github.io/canvas-kit/?path=/docs/components-popups-menu--basic) instead."
     },
     "type": {
       "kind": "component",
@@ -31771,7 +31777,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": "Please use `useFormFieldModel` instead"
+      "deprecated": "⚠️ `useTextInputModel` is deprecated and will be removed in a future major version. Please use `useFormFieldModel` instead."
     },
     "type": {
       "kind": "symbol",
@@ -111825,7 +111831,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
                     }
                   ],
                   "tags": {
-                    "deprecated": "You no longer need to use displayName. A `displayName` will be automatically added if it belongs to a container"
+                    "deprecated": "⚠️ `displayName` has been deprecated and will be removed in a future major version. You no longer need to use `displayName`. A `displayName` will be automatically added if it belongs to a container."
                   }
                 },
                 {
@@ -112778,7 +112784,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": "use `createSubModelElemPropsHook` instead"
+      "deprecated": "⚠️ `subModelHook` has been deprecated and will be removed in a future major version. Please use `createSubModelElemPropsHook` instead."
     },
     "type": {
       "kind": "function",
@@ -115356,7 +115362,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": "The returned model is now inferred from `createModelHook`"
+      "deprecated": "⚠️ `Model` has been deprecated and will be removed in a future major version. The returned model is now inferred from `createModelHook`."
     },
     "type": {
       "kind": "object",
@@ -115463,7 +115469,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
     ],
     "tags": {
       "example": "type ModelConfig = {\n  // additional config your model requires goes here\n  id?: string\n} & Partial<ToModelConfig<State, Events, typeof eventMap>>",
-      "deprecated": "`createModelHook` now infers the config type"
+      "deprecated": "⚠️ `ToModelConfig` has been deprecated and will be removed in a future major version. Please use `createModelHook` instead since it infers the config type."
     },
     "type": {
       "kind": "type",
@@ -115662,7 +115668,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
     ],
     "tags": {
       "example": "type Events = {\n  open(data: { eventData: string }): void\n}\n\nconst eventMap = createEventMap<Events>()({\n  guards: {\n    shouldOpen: 'open'\n  },\n  callbacks: {\n    onOpen: 'open'\n  }\n})",
-      "deprecated": "`createModelHook` uses Template Literal Types to create event map types"
+      "deprecated": "⚠️ `createEventMap` has been deprecated and will be removed in a future major version. Please use `createModelHook` instead. It uses Template Literal Types to create event map types."
     },
     "type": {
       "kind": "function",
@@ -115914,7 +115920,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
     "tags": {
       "param": "eventMap\nstate\nconfig\nevents",
       "example": "const useDiscloseModel = (config: ModelConfig = {}): DiscloseModel => {\n  const events = useEventMap(eventMap, state, config, {\n    open() {\n      // do something\n    }\n  }\n})",
-      "deprecated": "Use `createModelHook` instead"
+      "deprecated": "⚠️ `useEventMap` has been deprecated and will be removed in a future major version. Please use `createModelHook` instead."
     },
     "type": {
       "kind": "function",
@@ -118036,7 +118042,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": "TODO: Remove in major release"
+      "deprecated": "⚠️ `uniqueId` has been deprecated and will be removed in a future major version. Please use `useUniqueId` instead."
     },
     "type": {
       "kind": "symbol",
@@ -188815,7 +188821,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "StatusIndicatorType",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
-    "description": "### ⚠️ Status Indicator has been deprecated and will be removed in v11 ⚠️\n- Please consider using [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in preview",
+    "description": "",
     "declarations": [
       {
         "name": "StatusIndicatorType",
@@ -188823,7 +188829,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": ""
+      "deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead."
     },
     "type": {
       "kind": "object",
@@ -188884,7 +188890,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "StatusIndicatorEmphasis",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
-    "description": "### ⚠️ Status Indicator has been deprecated and will be removed in v11 ⚠️\n- Please consider using [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in preview",
+    "description": "",
     "declarations": [
       {
         "name": "StatusIndicatorEmphasis",
@@ -188892,7 +188898,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": ""
+      "deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead."
     },
     "type": {
       "kind": "object",
@@ -188921,7 +188927,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "StatusIndicatorGenericStyle",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
-    "description": "### ⚠️ Status Indicator has been deprecated and will be removed in v11 ⚠️\n- Please consider using [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in preview",
+    "description": "",
     "declarations": [
       {
         "name": "StatusIndicatorGenericStyle",
@@ -188929,7 +188935,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": ""
+      "deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead."
     },
     "type": {
       "kind": "object",
@@ -189017,7 +189023,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "statusIndicatorStyles",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
-    "description": "### ⚠️ Status Indicator has been deprecated and will be removed in v11 ⚠️\n- Please consider using [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in preview",
+    "description": "",
     "declarations": [
       {
         "name": "statusIndicatorStyles",
@@ -189025,7 +189031,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": ""
+      "deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead."
     },
     "type": {
       "kind": "symbol",
@@ -189036,7 +189042,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "StatusIndicatorProps",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
-    "description": "### ⚠️ Status Indicator has been deprecated and will be removed in v11 ⚠️\n- Please consider using [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in preview",
+    "description": "",
     "declarations": [
       {
         "name": "StatusIndicatorProps",
@@ -189044,7 +189050,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": ""
+      "deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead."
     },
     "type": {
       "kind": "alias",
@@ -189054,7 +189060,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "StatusIndicator",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
-    "description": "### ⚠️ Status Indicator has been deprecated and will be removed in v11 ⚠️\n- Please consider using [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in preview",
+    "description": "",
     "declarations": [
       {
         "name": "StatusIndicator",
@@ -189062,7 +189068,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "deprecated": ""
+      "deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead."
     },
     "type": {
       "kind": "component",
@@ -189946,7 +189952,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             }
           ],
           "tags": {
-            "deprecated": "Use `Tabs.Menu.Popper` instead"
+            "deprecated": "⚠️ `MenuPopper` has been deprecated and will be removed in a future major version. Please use `Tabs.Menu.Popper` instead."
           }
         },
         {

package/dist/mdx/MAINTAINING.mdx

@@ -27,6 +27,7 @@ Kit!
   - [Canary Releases](#canary-releases)
 - [Codemods](#codemods)
   - [Add a New Codemod](#add-a-new-codemod)
+- [Deprecations](#deprecations)
 
 ## Branches
 
@@ -270,12 +271,13 @@ last release tag. So for example, a V8 canary would look something like this:
 ## Codemods
 
 We use codemods to reduce friction for consumers as they make changes and do upgrades. Codemods are
-accompany major version releases since v5, and can also be released in minor releases if users want to apply some changes sooner.
+accompany major version releases since v5, and can also be released in minor releases if users want
+to apply some changes sooner.
 
 ### Add a New Codemod
 
-Adding a new codemod is pretty straightforward, but this guide will make sure you don't miss any steps
-along the way.
+Adding a new codemod is pretty straightforward, but this guide will make sure you don't miss any
+steps along the way.
 
 First, you need to add a new command to the root CLI. For this example, we'll pretend you're adding
 a new v10 codemod.
@@ -379,4 +381,81 @@ describe('Example Codemod', () => {
 });
 ```
 
-And that's it! You're done. Stage your changes, commit, and push up a PR.
+And that's it! You're done. Stage your changes, commit, and push up a PR.
+
+## Deprecations
+
+We add the [@deprecated](https://jsdoc.app/tags-deprecated.html) JSDoc tag to code we plan to remove
+in a future major release. This signals consumers to migrate to a more stable alternative before the
+deprecated code is removed.
+
+Add the `@deprecated` tag to the JSDoc comment directly above all exported declarations you wish to
+deprecate. Create a new JSDoc comment if one doesn't already exist.
+
+```tsx
+/**
+ * ...existing JSDoc comment, if present...
+ *
+ * @deprecated ⚠️ ${Deprecated Name} has been deprecated and will be removed in a future major release. ${Provide a migration strategy}
+ */
+export...
+```
+
+The provided migration strategy can take on any form as long as it gives the consumer a path forward
+once the deprecated code is removed.
+
+For example, we'll deprecate a component in our Main package before replacing it with an updated
+version of the component in our Preview or Labs packages. Note the inclusion of package names
+(Main/Preview/Labs) for disambiguation as well as the optional Storybook link to the updated
+component.
+
+```tsx
+/**
+ * @deprecated ⚠️ Status Indicator in Main has been deprecated and will be removed in a future major release. Please use [Status Indicator in Preview](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) instead.
+ */
+export class StatusIndicator...
+```
+
+Here's an example of a deprecated utility function.
+
+```tsx
+/**
+ * @deprecated ⚠️ `subModelHook` has been deprecated and will be removed in a future major release. Please use `createSubModelElemPropsHook` instead.
+ */
+export const subModelHook...
+```
+
+You may share the same `@deprecation` note for multiple deprecations related to the same component.
+
+```tsx
+/**
+ * @deprecated ⚠️ Status Indicator in Main has been deprecated and will be removed in a future major release. Please use [Status Indicator in Preview](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) instead.
+ */
+export enum StatusIndicatorType...
+
+/**
+ * @deprecated ⚠️ Status Indicator in Main has been deprecated and will be removed in a future major release. Please use [Status Indicator in Preview](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) instead.
+ */
+export interface StatusIndicatorProps...
+
+/**
+ * @deprecated ⚠️ Status Indicator in Main has been deprecated and will be removed in a future major release. Please use [Status Indicator in Preview](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) instead.
+ */
+export class StatusIndicator...
+```
+
+Finally, be sure to notify users of the deprecation in the corresponding
+[Upgrade Guide](https://github.com/Workday/canvas-kit/tree/master/modules/docs/mdx) MDX.
+
+```md
+## Deprecations
+
+...
+
+### ${Deprecated Name}
+
+**PR:** [#${PR number where the deprecation took place}](https://github.com/Workday/canvas-kit/pull/${PR number})
+
+We've deprecated ${Deprecated Name} ${Optional: Include package name to disambiguate (e.g., "from Labs")} ${Provide a
+migration strategy}
+```

package/dist/mdx/react/common/examples/CreateComponent.tsx

@@ -6,7 +6,7 @@ import {colors} from '@workday/canvas-kit-react/tokens';
 
 // Extend Heading Props and omitting size since we've added a default
 interface CardHeadingProps extends Omit<ExtractProps<typeof Heading>, 'size'> {}
-export const CardHeading = createComponent('h2')({
+export default createComponent('h2')({
   displayName: 'CardHeading',
   Component: ({children, ...elemProps}: CardHeadingProps, ref, Element) => {
     return (
@@ -19,7 +19,7 @@ export const CardHeading = createComponent('h2')({
 
 // Extend Box Props for customization
 interface CardProps extends BoxProps {}
-export const Card = createComponent('div')({
+export default createComponent('div')({
   displayName: 'Card',
   subComponents: {
     Heading: CardHeading,
@@ -33,7 +33,7 @@ export const Card = createComponent('div')({
   },
 });
 
-export const CreateComponent = () => {
+export default () => {
   return (
     <Card depth={2} border={`1px solid ${colors.soap400}`} padding="s" as="section">
       <Card.Heading>Card Heading</Card.Heading>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "9.2.0-526-next.0",
+  "version": "9.2.0-528-next.0",
   "description": "Documentation components of Canvas Kit components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -44,9 +44,9 @@
   "dependencies": {
     "@emotion/styled": "^11.6.0",
     "@storybook/csf": "0.0.1",
-    "@workday/canvas-kit-labs-react": "^9.2.0-526-next.0",
-    "@workday/canvas-kit-preview-react": "^9.2.0-526-next.0",
-    "@workday/canvas-kit-react": "^9.2.0-526-next.0",
+    "@workday/canvas-kit-labs-react": "^9.2.0-528-next.0",
+    "@workday/canvas-kit-preview-react": "^9.2.0-528-next.0",
+    "@workday/canvas-kit-react": "^9.2.0-528-next.0",
     "@workday/canvas-system-icons-web": "^3.0.0",
     "markdown-to-jsx": "^6.10.3",
     "ts-node": "^10.9.1"
@@ -57,5 +57,5 @@
     "mkdirp": "^1.0.3",
     "typescript": "4.2"
   },
-  "gitHead": "9faea8962499ab9229f6050bfcedf8da179bb20b"
+  "gitHead": "32899ba334066e6b0f021de22fd0ae933108462c"
 }