@workday/canvas-kit-docs 16.1.0-0545-next.0 → 16.1.0-0569-next.0

package/dist/es6/lib/docs.js

@@ -44961,7 +44961,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "Divider",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx",
-    "description": "# Divider\nA divider to segment and visually organize content. By default, it renders a semantic `[<hr>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/hr)` element.\n\n[View Docs](https://workday.github.io/canvas-kit/?path=/docs/preview-divider--docs)\n\nThe `space` prop will equally apply top and bottom margin styles.\nIn the example below, `system.gap.xs` (0.5rem), adds `0.25rem` margin to the top and `0.25rem` to the bottom",
+    "description": "# Divider\nA divider to segment and visually organize content. By default, it renders a semantic `[<hr>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/hr)` element.\n\n[View Docs](https://workday.github.io/canvas-kit/?path=/docs/preview-divider--docs)\n\nThe `space` prop will equally apply margin styles to both ends of the `Divider`.\nIn the example below, `system.gap.xs` (0.5rem), adds `0.25rem` margin to the top and `0.25rem` to the bottom.",
     "declarations": [
       {
         "name": "Divider",
@@ -44969,7 +44969,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
       }
     ],
     "tags": {
-      "example": "```tsx\nimport { Divider } from '@workday/canvas-kit-preview-react/divider';\n\n\n<Divider space={system.gap.xs} />\n\n```"
+      "example": "```tsx\nimport { Divider } from '@workday/canvas-kit-preview-react/divider';\n\n\n<Divider space={system.gap.xs} />\n\n// vertical\n<Divider orientation=\"vertical\" />\n\n```"
     },
     "type": {
       "kind": "enhancedComponent",
@@ -44984,7 +44984,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             "kind": "primitive",
             "value": "string"
           },
-          "description": "Applies top and bottom margin evenly. It divides the provided value by two and applies half to each end.\nE.g. `space=\"2rem\"` would apply `1rem` margin to the top, and `1rem` margin to the bottom.",
+          "description": "Applies margin evenly to both ends of the `Divider`. It divides the provided value by two and applies half to each end.\nFor a `horizontal` `Divider` this is the top and bottom margin, and for a `vertical` `Divider` it is the left and right margin.\nE.g. `space=\"2rem\"` would apply `1rem` margin to each end.",
           "declarations": [
             {
               "name": "space",
@@ -45000,6 +45000,38 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
             "value": "`system.gap.md` (1rem)"
           }
         },
+        {
+          "kind": "property",
+          "name": "orientation",
+          "required": false,
+          "type": {
+            "kind": "union",
+            "value": [
+              {
+                "kind": "string",
+                "value": "horizontal"
+              },
+              {
+                "kind": "string",
+                "value": "vertical"
+              }
+            ]
+          },
+          "description": "Sets the orientation of the `Divider`.\n* `horizontal` - renders a horizontal rule to segment stacked content.\n* `vertical` - renders a vertical rule to segment content laid out in a row. The `Divider` stretches to fill\n  the height of its container, so it should be placed inside an element with a defined height (e.g. a flex or\n  grid container).",
+          "declarations": [
+            {
+              "name": "orientation",
+              "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx"
+            }
+          ],
+          "tags": {
+            "default": "'horizontal'"
+          },
+          "defaultValue": {
+            "kind": "string",
+            "value": "horizontal"
+          }
+        },
         {
           "kind": "property",
           "name": "cs",

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": "16.0.7",
-    "@workday/canvas-kit-preview-react": "16.0.7",
-    "@workday/canvas-kit-react": "16.0.7",
-    "@workday/canvas-kit-react-fonts": "^16.0.7",
-    "@workday/canvas-kit-styling": "16.0.7",
+    "@workday/canvas-kit-labs-react": "16.0.12",
+    "@workday/canvas-kit-preview-react": "16.0.12",
+    "@workday/canvas-kit-react": "16.0.12",
+    "@workday/canvas-kit-react-fonts": "^16.0.12",
+    "@workday/canvas-kit-styling": "16.0.12",
     "@workday/canvas-system-icons-web": "^5.0.3",
     "@workday/canvas-expressive-icons-web": "1.0.1",
     "@workday/canvas-tokens-web": "4.4.0-beta.11"

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

@@ -19,11 +19,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": "16.0.7",
-    "@workday/canvas-kit-preview-react": "16.0.7",
-    "@workday/canvas-kit-react": "16.0.7",
-    "@workday/canvas-kit-react-fonts": "^16.0.7",
-    "@workday/canvas-kit-styling": "16.0.7",
+    "@workday/canvas-kit-labs-react": "16.0.12",
+    "@workday/canvas-kit-preview-react": "16.0.12",
+    "@workday/canvas-kit-react": "16.0.12",
+    "@workday/canvas-kit-react-fonts": "^16.0.12",
+    "@workday/canvas-kit-styling": "16.0.12",
     "@workday/canvas-system-icons-web": "^5.0.3",
     "@workday/canvas-expressive-icons-web": "1.0.1",
     "@workday/canvas-tokens-web": "4.4.0-beta.11"

package/dist/mdx/preview-react/divider/Divider.mdx

@@ -2,6 +2,7 @@ import {ExampleCodeBlock, SymbolDoc, Specifications} from '@workday/canvas-kit-d
 
 import * as Divider from './Divider.stories.ts';
 import Basic from './examples/Basic';
+import Vertical from './examples/Vertical';
 import CustomSpace from './examples/CustomSpace';
 
 
@@ -31,6 +32,10 @@ bottom margin.
 
 <ExampleCodeBlock code={Basic} />
 
+### Vertical Example
+
+<ExampleCodeBlock code={Vertical} />
+
 ### Custom Space
 
 You might also want to apply custom space to `Divider` where the top and bottom margin are not

package/dist/mdx/preview-react/divider/examples/Basic.tsx

@@ -28,40 +28,39 @@ const maintainerList = [
   {
     id: '44883293',
     name: 'Josh Bagwell',
-    bio: 'Software Development Engineer',
+    bio: 'Master of Cocktails and Fast Cars',
   },
   {
     id: '338257',
     name: 'Nicholas Boll',
-    bio: 'Principal Software Development Engineer',
+    bio: 'Principal Potato Engineer',
   },
   {
     id: '7966550',
     name: 'Manuel Carrera',
-    bio: 'Sr. Software Development Engineer',
+    bio: 'Sr. Rock Climber and Artist',
   },
   {
     id: '146020',
     name: 'James Fan',
-    bio: 'Sr. Software Development Engineer',
+    bio: 'Sr. Television Consultant',
   },
   {
     id: '48605821',
     name: 'Raisa Primerova',
-    bio: 'Software Development Engineer',
+    bio: 'Principal Borscht Connoisseur',
   },
   {
     id: '4818182',
     name: 'Alan Smith',
-    bio: 'Principal Software Development Engineer',
+    bio: 'Principal Pizza Tosser',
   },
 ];
 
 const profileCardStyles = createStyles({
-  display: 'grid',
-  gridGap: '0.5rem',
-  gridTemplateColumns: '5rem 1fr',
-  gridTemplateRows: '1fr 1fr',
+  display: 'flex',
+  gap: '0.5rem',
+  flexDirection: 'row',
 });
 
 const profileCardAvatarStyles = createStyles({
@@ -84,6 +83,12 @@ const profileCardBodyStyles = createStyles({
   margin: 0,
 });
 
+const profileCardContentStyles = createStyles({
+  display: 'flex',
+  flexDirection: 'column',
+  gap: system.gap.xs,
+});
+
 interface ProfileCardProps {
   id: string;
   name: string;
@@ -93,12 +98,14 @@ interface ProfileCardProps {
 const ProfileCard = ({id, name, bio}: ProfileCardProps) => (
   <div className={profileCardStyles}>
     <Avatar
-      size="extraLarge"
+      size="large"
       url={`https://avatars.githubusercontent.com/u/${id}?v=4`}
       name={`${name}'s avatar`}
       className={profileCardAvatarStyles}
     />
-    <h3 className={profileCardHeadingStyles}>{name}</h3>
-    <p className={profileCardBodyStyles}>{bio}</p>
+    <div className={profileCardContentStyles}>
+      <h3 className={profileCardHeadingStyles}>{name}</h3>
+      <p className={profileCardBodyStyles}>{bio}</p>
+    </div>
   </div>
 );

package/dist/mdx/preview-react/divider/examples/Vertical.tsx

@@ -0,0 +1,50 @@
+import {Divider} from '@workday/canvas-kit-preview-react/divider';
+import {createStyles} from '@workday/canvas-kit-styling';
+import {system} from '@workday/canvas-tokens-web';
+
+const rowStyles = createStyles({
+  display: 'flex',
+  alignItems: 'center',
+  height: system.size.xxl,
+});
+
+const statStyles = createStyles({
+  display: 'flex',
+  flexDirection: 'column',
+  gap: system.gap.none,
+});
+
+const labelStyles = createStyles({
+  ...system.type.subtext.medium,
+  color: system.color.fg.default,
+  margin: 0,
+});
+
+const valueStyles = createStyles({
+  ...system.type.body.large,
+  fontWeight: system.fontWeight.bold,
+  margin: 0,
+});
+
+export default () => {
+  const lastIndex = stats.length - 1;
+  return (
+    <div className={rowStyles}>
+      {stats.map((stat, index) => (
+        <>
+          <div className={statStyles}>
+            <p className={labelStyles}>{stat.label}</p>
+            <p className={valueStyles}>{stat.value}</p>
+          </div>
+          {index !== lastIndex && <Divider orientation="vertical" space={system.gap.md} />}
+        </>
+      ))}
+    </div>
+  );
+};
+
+const stats = [
+  {label: 'Components', value: '128'},
+  {label: 'Contributors', value: '64'},
+  {label: 'Releases', value: '512'},
+];

package/dist/mdx/preview-react/status-indicator/StatusIndicator.mdx

@@ -1,4 +1,4 @@
-import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';
+import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
 
 import Basic from './examples/Basic';
 import Custom from './examples/Custom';
@@ -46,6 +46,10 @@ position of the icon may be adjusted depending on where you place it in the mark
 
 <ExampleCodeBlock code={Icon} />
 
+> **Accessibility Note**: In this example, the icon is used as a decoration and is intentionally
+> hidden from screen readers. If you're using icons to convey additional information, add
+> `role="img"` and a translated `aria-label` string to `StatusIndicator.Icon`.
+
 ### Overflow
 
 We **strongly** discourage using text in a `StatusIndicator` which will cause it to exceed its
@@ -61,14 +65,16 @@ of `StatusIndicator` via [style props](/get-started/for-developers/documentation
 Set the `variant` prop of `StatusIndicator` to adjust its background color. `variant` accepts the
 following values:
 
-- `gray`
-- `orange`
-- `blue`
-- `green`
-- `red`
+- `neutral` (default; `gray` is a deprecated alias)
+- `caution` (`orange` is a deprecated alias)
+- `info` (`blue` is a deprecated alias)
+- `positive` (`green` is a deprecated alias)
+- `critical` (`red` is a deprecated alias)
 - `transparent`
 
 The background color dictated by the `variant` will be dark or light based on the `emphasis`.
+`variant` and `emphasis` change color only—they do not change the accessible name. Put the status
+meaning in **`StatusIndicator.Label`**.
 
 <ExampleCodeBlock code={Variants} />
 
@@ -84,6 +90,113 @@ Status Indicator and its subcomponents support custom styling via the `cs` prop.
 information, check our
 ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-guides-customizing-styles--docs).
 
+## Accessibility
+
+`StatusIndicator` is a compact, **non-interactive** status label. The accessibility goal is that
+assistive technology users get the same status meaning as sighted users from
+**`StatusIndicator.Label`** text—not from color, emphasis, or a decorative icon.
+
+### Minimum Accessible Structure
+
+The following matches the [Basic Example](#basic-example): a container and a visible label. Icon is
+optional.
+
+```tsx
+import {StatusIndicator} from '@workday/canvas-kit-preview-react/status-indicator';
+
+<StatusIndicator>
+  <StatusIndicator.Label>Unpublished</StatusIndicator.Label>
+</StatusIndicator>;
+```
+
+Always include **`StatusIndicator.Label`** with concise text that names the status. Do not rely on
+**`variant`**, **`emphasis`**, or **`StatusIndicator.Icon`** as the only indicator of meaning.
+
+### Built-in Behaviors
+
+Canvas Kit applies visual layout and color through `statusIndicatorStencil` when you compose
+**`StatusIndicator`**, **`StatusIndicator.Label`**, and optionally **`StatusIndicator.Icon`**. It
+does **not** apply `role="img"` or an accessible name on the icon. **Do not duplicate them** in
+consuming code. Only add icon ARIA when the informative-icon requirement below applies.
+
+**ARIA and DOM** (_applied by subcomponents_):
+
+- **`StatusIndicator`**: renders a `div` (override with `as` if needed). Default `maxWidth` is
+  `200px`. Default `variant` is `neutral`; default `emphasis` is `low`. No ARIA role is set.
+- **`StatusIndicator.Label`**: renders a `span` with bold subtext, `white-space: nowrap`,
+  `overflow: hidden`, and `text-overflow: ellipsis`. Truncation is visual; the full text remains in
+  the accessibility tree.
+- **`StatusIndicator.Icon`**: renders `SystemIcon` at size `20`. It does **not** set `role="img"` or
+  `aria-label`. If `icon.type` is missing, the icon renders nothing.
+
+**Keyboard** (_not a control by default_):
+
+- **`StatusIndicator`** is not in the tab order. There is no built-in keyboard behavior.
+
+**Screen reader expectations** (_when built-in behaviors are used as intended_):
+
+- Assistive technology should announce the **`StatusIndicator.Label`** text as the content of the
+  indicator
+- `variant` and `emphasis` are **not** announced
+- A decorative **`StatusIndicator.Icon`** (no `role="img"`) should not add a separate accessible
+  name
+- [**OverflowTooltip**](https://workday.github.io/canvas-kit/?path=/docs/components-popups-tooltip--docs#tooltips-on-overflowing-content)
+  uses `type="muted"` and does not set `aria-label` on the target—the accessible name stays the
+  element's text content
+
+### Accessibility Requirements
+
+Required in application code for an accessible Status Indicator. Rows marked _(conditional)_ apply
+only when the situation matches—otherwise omit.
+
+**If no design spec is provided:** include a visible **`StatusIndicator.Label`**; keep the icon
+decorative (omit `role="img"` and `aria-label`); omit `tabIndex` and **`OverflowTooltip`**. Prefer
+short label text so truncation is unnecessary.
+
+| Requirement                      | How to satisfy                                                                                                                                                                                                                                         |
+| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Visible status text              | **`StatusIndicator.Label`** with translated text that names the status (for example, "Unpublished", not color alone)                                                                                                                                   |
+| Color is not the only indicator  | Use **`variant`** / **`emphasis`** only as visual reinforcement of the label. See [Failure of Success Criterion 1.4.1 due to identifying required or error fields using color differences only](https://www.w3.org/WAI/WCAG22/Techniques/failures/F81) |
+| Decorative icon _(conditional)_  | **`StatusIndicator.Icon`** with `icon={...}` and **no** `role="img"` when the icon only supports the label visually                                                                                                                                    |
+| Informative icon _(conditional)_ | On **`StatusIndicator.Icon`**, set `role="img"` and a translated `aria-label` that adds meaning **beyond** the label text                                                                                                                              |
+| Overflowed label _(conditional)_ | Avoid exceeding the `200px` max width. If truncation cannot be avoided, wrap **`StatusIndicator`** in **`OverflowTooltip`** and set `tabIndex={0}` so keyboard and mouse users can reveal the full text. See the [Overflow example](#overflow)         |
+
+**Informative icon** _(conditional)_:
+
+```tsx
+import {StatusIndicator} from '@workday/canvas-kit-preview-react/status-indicator';
+import {cloudArrowUpIcon} from '@workday/canvas-system-icons-web';
+
+<StatusIndicator>
+  <StatusIndicator.Icon role="img" aria-label="Waiting to sync" icon={cloudArrowUpIcon} />
+  <StatusIndicator.Label>Unpublished</StatusIndicator.Label>
+</StatusIndicator>;
+```
+
+**Summary for code generation:**
+
+- **REQUIRED:** visible **`StatusIndicator.Label`** whose text conveys the status
+- **CONDITIONAL:** `role="img"` + translated `aria-label` on **`StatusIndicator.Icon`**,
+  **`OverflowTooltip`** + `tabIndex={0}`
+
+### Anti-Patterns
+
+Do **not** generate code that does the following (see **Accessibility Requirements** above for what
+to supply instead):
+
+- Omit **`StatusIndicator.Label`** or use an empty label, relying on `variant`, `emphasis`, or an
+  icon for meaning
+- Set `role="img"` on a decorative **`StatusIndicator.Icon`**, or set `role="img"` without a
+  translated `aria-label`—that can expose an unnamed image to assistive technology. See **Decorative
+  icon** and **Informative icon** in **Accessibility Requirements**
+- Duplicate the label text as `aria-label` on the icon when the icon adds no extra meaning
+- Add `role="status"`, `aria-live`, or `aria-label` on **`StatusIndicator`** by default—Canvas Kit
+  does not wire these, and they change how assistive technology treats a static label. If a design
+  requires announcing asynchronous updates, see
+  [ARIA Live Regions](https://workday.github.io/canvas-kit/?path=/docs/guides-accessibility-aria-live-regions--docs)
+- Truncate label text without **`OverflowTooltip`** and `tabIndex={0}` when keyboard users must read
+  the overflow
+
 ## Component API
 
 <SymbolDoc name="StatusIndicator" fileName="/preview-react/" />

package/dist/mdx/preview-react/status-indicator/examples/Icon.tsx

@@ -12,12 +12,12 @@ export default () => {
   return (
     <Flex cs={parentContainerStyles}>
       <StatusIndicator>
-        <StatusIndicator.Icon aria-label="unpublished" icon={cloudArrowUpIcon} />
+        <StatusIndicator.Icon icon={cloudArrowUpIcon} />
         <StatusIndicator.Label>Unpublished</StatusIndicator.Label>
       </StatusIndicator>
       <StatusIndicator variant="positive">
         <StatusIndicator.Label>published</StatusIndicator.Label>
-        <StatusIndicator.Icon aria-label="published" icon={cloudArrowUpIcon} />
+        <StatusIndicator.Icon icon={cloudArrowUpIcon} />
       </StatusIndicator>
     </Flex>
   );