@workday/canvas-kit-docs 16.0.10 → 16.0.12

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.10",
-    "@workday/canvas-kit-preview-react": "16.0.10",
-    "@workday/canvas-kit-react": "16.0.10",
-    "@workday/canvas-kit-react-fonts": "^16.0.10",
-    "@workday/canvas-kit-styling": "16.0.10",
+    "@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.10",
-    "@workday/canvas-kit-preview-react": "16.0.10",
-    "@workday/canvas-kit-react": "16.0.10",
-    "@workday/canvas-kit-react-fonts": "^16.0.10",
-    "@workday/canvas-kit-styling": "16.0.10",
+    "@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/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>
   );

package/dist/mdx/react/dialog/Dialog.mdx

@@ -1,7 +1,8 @@
 import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
+import Alt from './examples/Alt';
 import Basic from './examples/Basic';
 import Focus from './examples/Focus';
-import Alt from './examples/Alt';
+
 
 # Canvas Kit Dialog
 
@@ -18,16 +19,17 @@ yarn add @workday/canvas-kit-react
 
 ### Basic Example
 
-Unlike Modal, Dialog **does not** render the rest of the page inert while it is active. Dialog
-should be used in situations where the task does not require immediate attention.
+The following example shows a typical Dialog with heading, close control, and form content.
 
 <ExampleCodeBlock code={Basic} />
 
 ### Focus Redirect
 
-Dialog **does not** trap keyboard focus like the Modal component does. Instead, it allows focus to
-move freely in and out of the dialog, supporting more flexible navigation. The following example
-shows how Dialog manages focus in and out of the component.
+Dialog **does not** trap keyboard focus like the Modal component does. The default `useDialogModel`
+composes `useFocusRedirect`: <kbd>Tab</kbd> / <kbd>Shift</kbd>+<kbd>Tab</kbd> at the last or first
+focusable element inside the dialog closes it and moves focus to the next or previous focusable
+element on the page. Dialog is non-modal and is **not** a focus trap; it does **not** change screen
+reader reading order. The following example shows how Dialog manages focus at those edges.
 
 <ExampleCodeBlock code={Focus} />
 
@@ -36,53 +38,238 @@ shows how Dialog manages focus in and out of the component.
 
 ### Alt Example
 
-The `alt` variant is designed for use on alternative page backgrounds (`system.color.bg.alt.default`). Use this variant to maintain proper visual hierarchy when placing components on colored backgrounds. While the default variant should be used on `system.color.bg.default` backgrounds, the `alt` variant ensures the component remains visually elevated on `system.color.bg.alt.default` backgrounds.
+The `alt` variant is designed for use on alternative page backgrounds
+(`system.color.bg.alt.default`). Use this variant to maintain proper visual hierarchy when placing
+components on colored backgrounds. While the default variant should be used on
+`system.color.bg.default` backgrounds, the `alt` variant ensures the component remains visually
+elevated on `system.color.bg.alt.default` backgrounds.
 
 <ExampleCodeBlock code={Alt} />
 
 ## Accessibility
 
-`Dialog` composes the popup stack with `useInitialFocus`, `useReturnFocus`, `useCloseOnEscape`,
-`useCloseOnOutsideClick`, and `useFocusRedirect`. The card container includes an ARIA
-**`role="dialog"`** that is **non-modal**: the rest of the page stays available. The card also
-includes an **`aria-labelledby`** attribute referencing the `id` on `Dialog.Heading`, so the dialog
-has an accessible name that matches the visible heading.
-
-The Dialog component includes a `<div>` element (sibling to the `Dialog.Target`) with `aria-owns`
-pointing to the `Dialog.Card`. This remaps the hierarchy of the accessibility tree to improve
-sequential reading order in supported browsers. For more information, see
-[Guides > Accessibility > Inline Popups](https://workday.github.io/canvas-kit/?path=/docs/guides-accessibility-inline-popups--docs).
-
-[Dialog Pattern | APG | WAI | W3C](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/)
-
-- Prefer **`Dialog.Heading`** so the dialog is properly labelled; avoid leaving a dialog without an
-  accessible name.
-- Ensure icon-only controls such as **`Dialog.CloseIcon`** include an accessible name. Prefer the
-  `Tooltip` component to provide a visible label, or a translated `aria-label` string is acceptable.
-
-### Navigation
-
-- **Enter** / **Space**: Open the dialog (standard button behavior on the trigger). When it opens,
-  focus moves to the **first focusable element** inside the dialog in DOM order—often the close
-  control—or to the element referenced by **`initialFocusRef`** on the dialog model when set.
-- **Tab** / **Shift + Tab**: Move through focusable elements inside the dialog; leaving the first or
-  last focusable element **closes** the dialog and moves focus to the next or previous focusable
-  element on the page (non-modal focus redirect behavior).
-- **Escape**: Closes the dialog and returns focus to the `Dialog.Target` (or configured return
-  target).
-
-### Screen Reader Experience
-
-- **When the dialog opens:** Screen readers should announce the name and role of the first focused
-  control (often the close button), the dialog's name (`Dialog.Heading`) and role.
-- **Reading order:** The dialog contents should be read in the same order as it appears on screen
-  for browsers and screen readers that support `aria-owns`. Results vary, so always test with your
-  supported browsers and screen reader combinations.
-- **Expanded or collapsed state:** The `Dialog.Target` does not include an expanded or collapsed
-  state by default, but it can be added if the interaction design isn't using an initial focus for
-  the Dialog. See
-  [Guides > Accessibility > Inline Popups](https://workday.github.io/canvas-kit/?path=/docs/guides-accessibility-inline-popups--docs)
-  for more information.
+Ensure users of assistive technology can discover, name, and operate a **non-modal** dialog: the
+rest of the page stays available (no inert background), the dialog has an accessible name that
+matches its visible heading, keyboard users can open and dismiss it predictably, and screen reader
+reading order is improved where `aria-owns` is supported (see
+[Guides > Accessibility > Inline Popups](https://workday.github.io/canvas-kit/?path=/docs/guides-accessibility-inline-popups--docs)).
+For blocking tasks, use
+[**Modal**](https://workday.github.io/canvas-kit/?path=/docs/components-popups-modal--docs) instead.
+Prefer **Dialog** for the standard non-modal dialog; use
+[**Popup**](https://workday.github.io/canvas-kit/?path=/docs/components-popups-popup--docs) with
+composed hooks when you need a custom popup stack or behavior (for example omitting
+**`useInitialFocus`**). The W3C
+[Dialog (Modal) Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/) applies to
+[**Modal**](https://workday.github.io/canvas-kit/?path=/docs/components-popups-modal--docs); Dialog
+is intentionally non-modal.
+
+### Minimum Accessible Structure
+
+The following matches the [Basic Example](#basic-example) layout: **`Dialog.CloseIcon`** before
+**`Dialog.Heading`** so open focus lands on the dismiss control first; primary actions use
+**`Dialog.CloseButton`** (which closes the dialog on activate).
+
+```tsx
+import {PrimaryButton} from '@workday/canvas-kit-react/button';
+import {Dialog} from '@workday/canvas-kit-react/dialog';
+import {FormField} from '@workday/canvas-kit-react/form-field';
+import {TextInput} from '@workday/canvas-kit-react/text-input';
+
+<Dialog>
+  <Dialog.Target as={PrimaryButton}>Open</Dialog.Target>
+  <Dialog.Popper>
+    <Dialog.Card>
+      <Dialog.CloseIcon aria-label="Close" />
+      <Dialog.Heading>Title</Dialog.Heading>
+      <Dialog.Body>
+        <FormField>
+          <FormField.Label>Email</FormField.Label>
+          <FormField.Input as={TextInput} />
+        </FormField>
+      </Dialog.Body>
+      <Dialog.ButtonGroup>
+        <Dialog.CloseButton>Cancel</Dialog.CloseButton>
+        <Dialog.CloseButton as={PrimaryButton}>Submit</Dialog.CloseButton>
+      </Dialog.ButtonGroup>
+    </Dialog.Card>
+  </Dialog.Popper>
+</Dialog>;
+```
+
+Include a dismiss control: **`Dialog.CloseButton`** with visible text (for example "Cancel" or
+"Close"), and/or **`Dialog.CloseIcon`** when the design uses an icon-only dismiss (requires
+**`aria-label`** or **`Tooltip`**). Use **`Dialog.CloseButton`** for actions that should also close
+the dialog (for example "Submit").
+
+### Built-in Behaviors
+
+Canvas Kit applies these automatically via `useDialogModel` and Dialog subcomponents. **Do not
+duplicate them** in consuming code.
+
+**Popup behaviors** (_composed on the default model_):
+
+- `useInitialFocus` — moves focus into the dialog when it opens (default: first focusable element in
+  DOM order; optional override via `initialFocusRef` on the model)
+- `useReturnFocus` — returns focus to `Dialog.Target` (or configured return target) when it closes
+- `useCloseOnEscape` — <kbd>Escape</kbd> closes the dialog
+- `useCloseOnOutsideClick` — pointer interaction outside closes the dialog
+- `useFocusRedirect` — <kbd>Tab</kbd> / <kbd>Shift</kbd>+<kbd>Tab</kbd> at the first or last
+  focusable element inside the dialog closes it and moves focus to the next or previous focusable
+  element on the page (non-modal; **not** a focus trap; does **not** change screen reader reading
+  order)
+
+**ARIA and DOM** (_applied by hooks/subcomponents_):
+
+- `Dialog.Card`: `role="dialog"`, `aria-labelledby` referencing the heading `id` (non-modal; page
+  content is not hidden with `aria-hidden`)
+- `Dialog.Popper`: sibling wrapper rendered when open with `aria-owns` pointing at `Dialog.Card` to
+  remap the accessibility tree for sequential reading order in supported browsers
+- `Dialog.Heading`: `id` wired to `Dialog.Card`'s `aria-labelledby`
+- `Dialog.CloseIcon` / `Dialog.CloseButton`: `onClick` that calls `model.events.hide()`
+- `Dialog.Target`: `ref` and `onClick` to open and to receive return focus
+
+**Keyboard** (_trigger is `Dialog.Target`, default `SecondaryButton`_):
+
+- <kbd>Enter</kbd> / <kbd>Space</kbd> on the trigger opens the dialog (standard button behavior)
+- On open and close, focus is managed by **`useInitialFocus`** and **`useReturnFocus`** (application
+  overrides: see **Focus management** in Accessibility Requirements)
+- <kbd>Tab</kbd> / <kbd>Shift</kbd>+<kbd>Tab</kbd> move focus forward and backward through
+  interactive elements inside the dialog (standard sequential focus behavior)
+- <kbd>Escape</kbd> closes the dialog and returns focus per `useReturnFocus`
+
+**Screen reader expectations** (_when built-in behaviors are used as intended_):
+
+- On open, assistive technology should announce the first focused control (often a dismiss control),
+  the dialog name (`Dialog.Heading`), and `dialog` role
+- Background page content remains available to assistive technology—Dialog does **not** apply
+  **`aria-hidden`** to siblings or render the rest of the page inert (unlike
+  [**Modal**](https://workday.github.io/canvas-kit/?path=/docs/components-popups-modal--docs))
+- Reading order may follow on-screen order where `aria-owns` is honored; support varies by browser
+  and screen reader
+
+### Accessibility Requirements
+
+Required in application code for an accessible Dialog. Hoist **`useDialogModel`** when you need to
+configure focus targets. Rows marked _(conditional)_ apply only when the situation matches—otherwise
+omit.
+
+**If no design spec is provided:** use default focus behavior; omit **`initialFocusRef`**,
+**`returnFocusRef`**, **`aria-describedby`**, **`aria-expanded`**, and **`aria-haspopup`**.
+
+**Focus management — defaults and developer prompts:** Canvas Kit handles open and close focus
+automatically. **State the default to the developer first.** Only set **`initialFocusRef`** or
+**`returnFocusRef`** after the developer (or an explicit design spec) chooses a non-default target.
+**Do not generate focus refs by default.**
+
+| When              | Default behavior                                                                                                                                                                            | Ask the developer before overriding                                                                                                                                                                        |
+| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Dialog **opens**  | **`useInitialFocus`** moves focus to the **first focusable element** in DOM order inside the dialog (often **`Dialog.CloseIcon`** or **`Dialog.CloseButton`**). Omit **`initialFocusRef`**. | _Which element should receive focus when the dialog opens?_ (Only when the default first focusable element is wrong for the design.) Attach **`initialFocusRef`** to that element on **`useDialogModel`**. |
+| Dialog **closes** | **`useReturnFocus`** moves focus to **`Dialog.Target`**. Omit **`returnFocusRef`**.                                                                                                         | _Which element should receive focus when the dialog closes?_ (Only when return focus should land somewhere other than **`Dialog.Target`**.)                                                                |
+
+If close **removes the trigger from the DOM**, **`returnFocusRef`** alone is not enough—move focus
+after the UI updates (for example with **`useLayoutEffect`**). See
+[Modal > Return Focus](https://workday.github.io/canvas-kit/?path=/docs/components-popups-modal--docs#return-focus).
+
+**Custom targets** _(conditional)_: Apply when using a custom **`as`** component on
+**`Dialog.Target`**. **`Dialog.Target`** adds **`onClick`** and **`ref`**. Custom targets must
+forward both to a **keyboard-focusable** element (prefer a native **`<button>`** or
+**`as={SecondaryButton}`** / another Canvas Kit button). Wrap the component in
+**`React.forwardRef`** when it does not forward refs by default (required if the dialog can open
+programmatically before the user clicks the target).
+
+| Requirement                                                   | How to satisfy                                                                                                                                                                                                                                                                                                                                                             |
+| ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Accessible dialog name                                        | Use **`Dialog.Heading`** so `aria-labelledby` on `Dialog.Card` references a visible title. Do not omit the heading: **`Dialog.Card` always sets `aria-labelledby`**, and an `aria-label` fallback is unreliable when that ID does not exist.                                                                                                                                |
+| Dismiss control                                               | Provide a way to close the dialog: **`Dialog.CloseButton`** with visible text (no extra **`aria-label`** needed), and/or **`Dialog.CloseIcon`** for icon-only dismiss (requires **`Tooltip`** or translated **`aria-label`**).                                                                                                                                             |
+| Keyboard-operable trigger                                     | See **Custom targets** above.                                                                                                                                                                                                                                                                                                                                              |
+| Supplementary copy when overriding open focus _(conditional)_ | When **`initialFocusRef`** places open focus **below** **`Dialog.Heading`**, assign a unique `id` to supplementary text and pass **`aria-describedby`** on **`Dialog.Card`**. See **Open focus below the heading** below and [Popup > Initial Focus](https://workday.github.io/canvas-kit/?path=/docs/components-popups-popup--docs#initial-focus) (button-focus variant). |
+| Open/closed state on the trigger _(conditional)_              | See **Wiring aria-expanded** below. **Default:** omit **`aria-expanded`** and **`aria-haspopup`**.                                                                                                                                                                                                                                                                         |
+
+**Open focus below the heading** _(conditional; see supplementary copy row above)_:
+
+When open focus moves past the heading (for example into a form field), wire **`aria-describedby`**
+so assistive technology still announces the supplementary copy. For focusing a primary action
+instead of an input, see
+[Popup > Initial Focus](https://workday.github.io/canvas-kit/?path=/docs/components-popups-popup--docs#initial-focus).
+
+```tsx
+import React from 'react';
+
+import {useUniqueId} from '@workday/canvas-kit-react/common';
+import {Dialog, useDialogModel} from '@workday/canvas-kit-react/dialog';
+import {FormField} from '@workday/canvas-kit-react/form-field';
+import {TextInput} from '@workday/canvas-kit-react/text-input';
+
+const Example = () => {
+  const descriptionId = useUniqueId();
+  const inputRef = React.useRef<HTMLInputElement>(null);
+  const model = useDialogModel({initialFocusRef: inputRef});
+
+  return (
+    <Dialog model={model}>
+      <Dialog.Target>Open</Dialog.Target>
+      <Dialog.Popper>
+        <Dialog.Card aria-describedby={descriptionId}>
+          <Dialog.CloseIcon aria-label="Close" />
+          <Dialog.Heading>Title</Dialog.Heading>
+          <Dialog.Body>
+            <p id={descriptionId}>Enter your email to continue.</p>
+            <FormField>
+              <FormField.Label>Email</FormField.Label>
+              <FormField.Input as={TextInput} ref={inputRef} />
+            </FormField>
+          </Dialog.Body>
+          <Dialog.CloseButton>Cancel</Dialog.CloseButton>
+        </Dialog.Card>
+      </Dialog.Popper>
+    </Dialog>
+  );
+};
+```
+
+**Summary for code generation:**
+
+- **REQUIRED:** accessible name, dismiss control, keyboard-operable trigger
+- **CONDITIONAL:** **`initialFocusRef`**, **`returnFocusRef`**, **`aria-describedby`**,
+  **`aria-expanded`** / **`aria-haspopup`**, **`forwardRef`** on custom **`Dialog.Target`**
+
+**Wiring aria-expanded** _(conditional)_:
+
+The **`aria-expanded`** pattern is **uncommon** for Dialog—omit **`aria-expanded`** and
+**`aria-haspopup`** unless a review deliberately keeps open focus on the trigger (for example
+**`initialFocusRef`** on the trigger per design spec). When required, on **`Dialog.Target`** set
+**`aria-expanded={model.state.visibility !== 'hidden'}`** and **`aria-haspopup="dialog"`**. See
+**Focus management** and the open/closed-state row above. If the design should not move focus into
+the dialog on open, use
+[**Popup**](https://workday.github.io/canvas-kit/?path=/docs/components-popups-popup--docs) with
+composed hooks instead of overriding Dialog defaults.
+
+### Anti-Patterns
+
+Do **not** generate code that does the following (see **Accessibility Requirements** above for what
+to supply instead):
+
+- Manually set `role="dialog"`, `aria-labelledby`, `aria-owns`, or dialog `id` on **`Dialog.Card`**,
+  **`Dialog.Popper`**, or **`Dialog.Heading`** — Canvas Kit hooks wire these
+- Omit **`Dialog.Popper`**, render **`Dialog.Card`** outside it, or add a custom portal/restructure
+  instead of **`Dialog` → `Dialog.Popper` → `Dialog.Card`**
+- Use **`open`** / **`onClose`** props on **`Dialog`** — Dialog has no controlled visibility props;
+  use **`useDialogModel`** and **`model.events.show()`** / **`model.events.hide()`**
+- Add **`useFocusTrap`**, **`aria-modal="true"`**, or **`aria-hidden`** on page siblings expecting
+  modal behavior — Dialog is intentionally non-modal
+- Use **Modal** when the task is non-critical or the rest of the page must stay operable
+- Set **`initialFocusRef`** or **`returnFocusRef`** by default — state the default focus behavior
+  first and ask the developer before overriding (see **Focus management** in Accessibility
+  Requirements)
+- Add **`aria-expanded`** / **`aria-haspopup`** on the default Dialog path, or bind
+  **`aria-expanded`** to a static value (see **Wiring aria-expanded** in Accessibility Requirements)
+- Use a custom **`Dialog.Target`** **`as`** component that does not forward **`ref`** to a focusable
+  element — use **`React.forwardRef`** or a Canvas Kit button component instead
+- Rely on **`returnFocusRef`** alone when close **removes the trigger from the DOM** (see
+  [Modal > Return Focus](https://workday.github.io/canvas-kit/?path=/docs/components-popups-modal--docs#return-focus))
+- Nest multiple **`Dialog`** instances without deliberate initial focus and return-focus planning
+- Assume **`useFocusRedirect`** fixes screen reader reading order, or that **`aria-owns`** remapping
+  works in all browser and screen reader combinations — test your supported combinations
 
 ## Component API