@workday/canvas-kit-docs 9.1.19 → 9.1.22

package/dist/es6/lib/widgetUtils.js

@@ -113,7 +113,7 @@ export const SymbolDialog = ({ value }) => {
                         " "),
                     breadcrumbsList.length > 1 && (React.createElement(Breadcrumbs, { "aria-label": "Breadcrumbs" },
                         React.createElement(Breadcrumbs.List, { paddingX: "xxs" }, breadcrumbsList.map((item, index) => {
-                            return (React.createElement(React.Fragment, null, item === breadcrumbsList[breadcrumbsList.length - 1] ? (React.createElement(Breadcrumbs.CurrentItem, { key: index }, item)) : (React.createElement(Breadcrumbs.Item, { key: index },
+                            return (React.createElement(React.Fragment, null, index === breadcrumbsList.length - 1 ? (React.createElement(Breadcrumbs.CurrentItem, { key: index }, item)) : (React.createElement(Breadcrumbs.Item, { key: index },
                                 React.createElement(Breadcrumbs.Link, { onClick: e => handleBreadcrumbClick(e, index), href: '#' }, item)))));
                         })))),
                     React.createElement(Dialog.Body, null,

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/lib/widgetUtils.tsx

@@ -173,7 +173,7 @@ export const SymbolDialog = ({value}: SymbolDialogProps) => {
                   {breadcrumbsList.map((item, index) => {
                     return (
                       <>
-                        {item === breadcrumbsList[breadcrumbsList.length - 1] ? (
+                        {index === breadcrumbsList.length - 1 ? (
                           <Breadcrumbs.CurrentItem key={index}>{item}</Breadcrumbs.CurrentItem>
                         ) : (
                           <Breadcrumbs.Item key={index}>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "9.1.19",
+  "version": "9.1.22",
   "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.1.19",
-    "@workday/canvas-kit-preview-react": "^9.1.19",
-    "@workday/canvas-kit-react": "^9.1.19",
+    "@workday/canvas-kit-labs-react": "^9.1.22",
+    "@workday/canvas-kit-preview-react": "^9.1.22",
+    "@workday/canvas-kit-react": "^9.1.22",
     "@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": "215854298456c8c009e771bdab2570027f4c68d6"
+  "gitHead": "b00fd1c6dd6d3c2653d4ec7e518df12427557562"
 }