@workday/canvas-kit-docs 14.0.0-alpha.1148-next.0 → 14.0.0-alpha.1151-next.0

package/dist/es6/lib/docs.js

@@ -8708,556 +8708,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       "value": "CanvasSystemIcon"
     }
   },
-  {
-    "name": "DeprecatedMenuProps",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
-    "description": "",
-    "declarations": [
-      {
-        "name": "DeprecatedMenuProps",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
-      }
-    ],
-    "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"
-    }
-  },
-  {
-    "name": "DeprecatedMenuState",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
-    "description": "",
-    "declarations": [
-      {
-        "name": "DeprecatedMenuState",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
-      }
-    ],
-    "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": [
-        {
-          "kind": "property",
-          "name": "selectedItemIndex",
-          "required": true,
-          "type": {
-            "kind": "primitive",
-            "value": "number"
-          },
-          "description": "",
-          "declarations": [
-            {
-              "name": "selectedItemIndex",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
-            }
-          ],
-          "tags": {}
-        }
-      ]
-    }
-  },
-  {
-    "name": "DeprecatedMenu",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
-    "description": "`DeprecatedMenu` renders a styled `<ul role=\"menu\">` element within a {@link Card} and follows\nthe [Active Menu\npattern](https://www.w3.org/TR/wai-aria-practices/examples/menu-button/menu-button-actions-active-descendant.html)\nusing `aria-activedescendant`.\n\nUndocumented props are spread to the underlying `<ul>` element.",
-    "declarations": [
-      {
-        "name": "DeprecatedMenu",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
-      }
-    ],
-    "tags": {
-      "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",
-      "props": [
-        {
-          "kind": "property",
-          "name": "children",
-          "required": false,
-          "type": {
-            "kind": "union",
-            "value": [
-              {
-                "kind": "external",
-                "name": "ReactElement",
-                "url": "https://reactjs.org/docs/rendering-elements.html",
-                "typeParameters": [
-                  {
-                    "kind": "symbol",
-                    "name": "DeprecatedMenuItemProps",
-                    "value": "DeprecatedMenuItemProps"
-                  }
-                ]
-              },
-              {
-                "kind": "array",
-                "value": {
-                  "kind": "external",
-                  "name": "ReactElement",
-                  "url": "https://reactjs.org/docs/rendering-elements.html",
-                  "typeParameters": [
-                    {
-                      "kind": "symbol",
-                      "name": "DeprecatedMenuItemProps",
-                      "value": "DeprecatedMenuItemProps"
-                    }
-                  ]
-                }
-              }
-            ]
-          },
-          "description": "The DeprecatedMenuItem children of the DeprecatedMenu (must be at least one). Also accepts other components which share the same interface as `DeprecatedMenuItem`.",
-          "declarations": [
-            {
-              "name": "children",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "isOpen",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "boolean"
-          },
-          "description": "If true, set the DeprecatedMenu to the open state. Useful for showing and hiding the DeprecatedMenu from a parent component such as a menu button.",
-          "declarations": [
-            {
-              "name": "isOpen",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
-            }
-          ],
-          "tags": {
-            "default": "true"
-          },
-          "defaultValue": {
-            "kind": "boolean",
-            "value": true
-          }
-        },
-        {
-          "kind": "property",
-          "name": "width",
-          "required": false,
-          "type": {
-            "kind": "union",
-            "value": [
-              {
-                "kind": "primitive",
-                "value": "number"
-              },
-              {
-                "kind": "primitive",
-                "value": "string"
-              }
-            ]
-          },
-          "description": "The width of the DeprecatedMenu. If no value is provided, the DeprecatedMenu will collapse around its content.",
-          "declarations": [
-            {
-              "name": "width",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "onSelect",
-          "required": false,
-          "type": {
-            "kind": "function",
-            "parameters": [],
-            "members": [],
-            "returnType": {
-              "kind": "primitive",
-              "value": "void"
-            }
-          },
-          "description": "The function called when a menu item is selected.",
-          "declarations": [
-            {
-              "name": "onSelect",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "onClose",
-          "required": false,
-          "type": {
-            "kind": "function",
-            "parameters": [],
-            "members": [],
-            "returnType": {
-              "kind": "primitive",
-              "value": "void"
-            }
-          },
-          "description": "The function called when the DeprecatedMenu should close. This is called after a menu item is selected or if the escape shortcut key is used. This will not fire if the menu item sets `shouldClose` to false.",
-          "declarations": [
-            {
-              "name": "onClose",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "initialSelectedItem",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "number"
-          },
-          "description": "The zero-based index of the menu item which should initially receive focus.",
-          "declarations": [
-            {
-              "name": "initialSelectedItem",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "id",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "string"
-          },
-          "description": "The unique id of the DeprecatedMenu used for ARIA and HTML `id` attributes.",
-          "declarations": [
-            {
-              "name": "id",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "aria-labelledby",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "string"
-          },
-          "description": "The HTML `id` of the element that labels the DeprecatedMenu. Often used with menu buttons.",
-          "declarations": [
-            {
-              "name": "aria-labelledby",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "grow",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "boolean"
-          },
-          "description": "True if the component should grow to its container's width. False otherwise.",
-          "declarations": [
-            {
-              "name": "grow",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
-            }
-          ],
-          "tags": {}
-        }
-      ]
-    }
-  },
-  {
-    "name": "DeprecatedMenuItemProps",
-    "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx",
-    "description": "",
-    "declarations": [
-      {
-        "name": "DeprecatedMenuItemProps",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-      }
-    ],
-    "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"
-    }
-  },
-  {
-    "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\nUndocumented props are spread to the underlying `<li>` element.",
-    "declarations": [
-      {
-        "name": "DeprecatedMenuItem",
-        "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-      }
-    ],
-    "tags": {
-      "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",
-      "props": [
-        {
-          "kind": "property",
-          "name": "onClick",
-          "required": false,
-          "type": {
-            "kind": "function",
-            "parameters": [
-              {
-                "kind": "parameter",
-                "name": "event",
-                "type": {
-                  "kind": "symbol",
-                  "name": "React.MouseEvent",
-                  "value": "MouseEvent<T, E>"
-                },
-                "required": true,
-                "rest": false,
-                "description": "",
-                "declarations": [
-                  {
-                    "name": "event",
-                    "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-                  }
-                ],
-                "tags": {}
-              }
-            ],
-            "members": [],
-            "returnType": {
-              "kind": "primitive",
-              "value": "void"
-            }
-          },
-          "description": "The function called when the DeprecatedMenuItem is clicked. If the item is a child of the DeprecatedMenu component, this callback will be decorated with the onSelect and onClose DeprecatedMenu callbacks. This callback will not fire if the item is disabled (see below).",
-          "declarations": [
-            {
-              "name": "onClick",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "id",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "string"
-          },
-          "description": "The unique id for the DeprecatedMenuItem used for ARIA attributes. If the item is a child of the `DeprecatedMenu` component, this property will be generated and overridden.",
-          "declarations": [
-            {
-              "name": "id",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "icon",
-          "required": false,
-          "type": {
-            "kind": "symbol",
-            "name": "CanvasSystemIcon",
-            "value": "CanvasSystemIcon"
-          },
-          "description": "The icon of the DeprecatedMenuItem. This icon is displayed before what you supplied for the children.",
-          "declarations": [
-            {
-              "name": "icon",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "secondaryIcon",
-          "required": false,
-          "type": {
-            "kind": "symbol",
-            "name": "CanvasSystemIcon",
-            "value": "CanvasSystemIcon"
-          },
-          "description": "The secondary icon of the DeprecatedMenuItem. This icon is displayed after what you supplied for the children.",
-          "declarations": [
-            {
-              "name": "secondaryIcon",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-            }
-          ],
-          "tags": {}
-        },
-        {
-          "kind": "property",
-          "name": "hasDivider",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "boolean"
-          },
-          "description": "If true, render a top border on the DeprecatedMenuItem.",
-          "declarations": [
-            {
-              "name": "hasDivider",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-            }
-          ],
-          "tags": {
-            "default": "false"
-          },
-          "defaultValue": {
-            "kind": "boolean",
-            "value": false
-          }
-        },
-        {
-          "kind": "property",
-          "name": "isHeader",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "boolean"
-          },
-          "description": "If true, render a header to group data, this menu item will not be intractable.",
-          "declarations": [
-            {
-              "name": "isHeader",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-            }
-          ],
-          "tags": {
-            "default": "false"
-          },
-          "defaultValue": {
-            "kind": "boolean",
-            "value": false
-          }
-        },
-        {
-          "kind": "property",
-          "name": "isDisabled",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "boolean"
-          },
-          "description": "If true, set the DeprecatedMenuItem to the disabled state so it is not clickable.",
-          "declarations": [
-            {
-              "name": "isDisabled",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-            }
-          ],
-          "tags": {
-            "default": "false"
-          },
-          "defaultValue": {
-            "kind": "boolean",
-            "value": false
-          }
-        },
-        {
-          "kind": "property",
-          "name": "isFocused",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "boolean"
-          },
-          "description": "If true, set the DeprecatedMenuItem to be the currently selected item. If the item is a child of the DeprecatedMenu component, this property will be generated and overridden.",
-          "declarations": [
-            {
-              "name": "isFocused",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-            }
-          ],
-          "tags": {
-            "default": "false"
-          },
-          "defaultValue": {
-            "kind": "boolean",
-            "value": false
-          }
-        },
-        {
-          "kind": "property",
-          "name": "role",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "string"
-          },
-          "description": "The role of the DeprecatedMenuItem. Use this to override the role of the item (e.g. you can use this element as an option in a Combobox).",
-          "declarations": [
-            {
-              "name": "role",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-            }
-          ],
-          "tags": {
-            "default": "menuItem"
-          },
-          "defaultValue": {
-            "kind": "symbol",
-            "name": "menuItem",
-            "value": "menuItem"
-          }
-        },
-        {
-          "kind": "property",
-          "name": "shouldClose",
-          "required": false,
-          "type": {
-            "kind": "primitive",
-            "value": "boolean"
-          },
-          "description": "If true, allow the onClose DeprecatedMenu callback to be fired after the DeprecatedMenuItem has been clicked.",
-          "declarations": [
-            {
-              "name": "shouldClose",
-              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
-            }
-          ],
-          "tags": {
-            "default": "true"
-          },
-          "defaultValue": {
-            "kind": "boolean",
-            "value": true
-          }
-        }
-      ]
-    }
-  },
   {
     "name": "MultiSelectProps",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/multi-select/lib/MultiSelect.tsx",

package/dist/es6/lib/stackblitzFiles/packageJSONFile.js

@@ -18,11 +18,11 @@ export const packageJSONFile = `{
     "@emotion/react": "11.11.4",
     "@types/react": "18.2.60",
     "@types/react-dom": "18.2.19",
-    "@workday/canvas-kit-labs-react": "13.1.4",
-    "@workday/canvas-kit-preview-react": "13.1.4",
-    "@workday/canvas-kit-react": "13.1.4",
-    "@workday/canvas-kit-react-fonts": "^13.1.4",
-    "@workday/canvas-kit-styling": "13.1.4",
+    "@workday/canvas-kit-labs-react": "13.1.5",
+    "@workday/canvas-kit-preview-react": "13.1.5",
+    "@workday/canvas-kit-react": "13.1.5",
+    "@workday/canvas-kit-react-fonts": "^13.1.5",
+    "@workday/canvas-kit-styling": "13.1.5",
     "@workday/canvas-system-icons-web": "3.0.22",
     "@workday/canvas-tokens-web": "2.0.0"
   },

package/dist/es6/lib/stackblitzFiles/packageJSONFile.ts

@@ -18,11 +18,11 @@ export const packageJSONFile = `{
     "@emotion/react": "11.11.4",
     "@types/react": "18.2.60",
     "@types/react-dom": "18.2.19",
-    "@workday/canvas-kit-labs-react": "13.1.4",
-    "@workday/canvas-kit-preview-react": "13.1.4",
-    "@workday/canvas-kit-react": "13.1.4",
-    "@workday/canvas-kit-react-fonts": "^13.1.4",
-    "@workday/canvas-kit-styling": "13.1.4",
+    "@workday/canvas-kit-labs-react": "13.1.5",
+    "@workday/canvas-kit-preview-react": "13.1.5",
+    "@workday/canvas-kit-react": "13.1.5",
+    "@workday/canvas-kit-react-fonts": "^13.1.5",
+    "@workday/canvas-kit-styling": "13.1.5",
     "@workday/canvas-system-icons-web": "3.0.22",
     "@workday/canvas-tokens-web": "2.0.0"
   },

package/dist/mdx/14.0-UPGRADE-GUIDE.mdx

@@ -9,9 +9,11 @@ any questions.
 - [Codemod](#codemod)
   - [Instructions](#instructions)
 - [Component Updates](#component-updates)
-  - [Styling API and CSS Tokens](#styling-api-and-css-tokens)
+  - [Styling Changes](#styling-changes)
   - [Card](#card)
   - [SearchForm](#search-form)
+- [Removals](#removals)
+  - [Menu (preview)](#menu-preview)
 - [Troubleshooting](#troubleshooting)
 - [Glossary](#glossary)
   - [Main](#main)
@@ -81,7 +83,7 @@ yarn remove @workday/canvas-kit-codemod
 
 ## Component Updates
 
-### Styling API and Canvas Tokens 💅
+### Styling Changes 💅
 
 Several components have been refactored to use our Canvas tokens and styling API. The React
 interface has not changed, but Canvas Tokens are now used for dynamic properties.
@@ -243,6 +245,21 @@ const customTheme = {
   This **should not** affect the way you use the type unless you're passing a `number` of `0`, `1`
   or `2` to the `searchTheme` prop.
 
+## Removals
+
+Removals are deletions from our codebase and you can no longer consume this component. We've either
+promoted or replaced a component or utility.
+
+### Menu (preview)
+
+**PR:** [#3353](https://github.com/Workday/canvas-kit/pull/3353)
+
+We've removed `Menu` from `@workday/canvas-kit-preview-react` package. Please use
+[Menu](https://workday.github.io/canvas-kit/?path=/docs/components-popups-menu--docs) from
+`@workday/canvas-kit-react` instead.
+
+---
+
 ## Troubleshooting
 
 - When upgrading to the latest major version of Canvas Kit, all related Canvas Kit packages should

package/dist/mdx/react/card/card.mdx

@@ -32,17 +32,16 @@ yarn add @workday/canvas-kit-react
 ### Borderless Example
 
 The `borderless` variant removes the border from the Card, creating a cleaner appearance while
-maintaining the same internal spacing and structure.
-Use this variant when placing cards on colored backgrounds where you want the
-  card to blend seamlessly without borders or shadows.
+maintaining the same internal spacing and structure. Use this variant when placing cards on colored
+backgrounds where you want the card to blend seamlessly without borders or shadows.
 
 <ExampleCodeBlock code={Borderless} />
 
 ### Filled Example
 
 The `filled` variant adds a background color to the Card, creating a more prominent appearance while
-maintaining the same internal spacing and structure. Use this variant when you need a card with a grayish background to create visual
-  separation from the page background.
+maintaining the same internal spacing and structure. Use this variant when you need a card with a
+grayish background to create visual separation from the page background.
 
 <ExampleCodeBlock code={Filled} />