@workday/canvas-kit-docs 16.0.13 → 16.1.0-0564-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -44961,7 +44961,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
44961
44961
  {
44962
44962
  "name": "Divider",
44963
44963
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx",
44964
- "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",
44964
+ "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.",
44965
44965
  "declarations": [
44966
44966
  {
44967
44967
  "name": "Divider",
@@ -44969,7 +44969,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
44969
44969
  }
44970
44970
  ],
44971
44971
  "tags": {
44972
- "example": "```tsx\nimport { Divider } from '@workday/canvas-kit-preview-react/divider';\n\n\n<Divider space={system.gap.xs} />\n\n```"
44972
+ "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```"
44973
44973
  },
44974
44974
  "type": {
44975
44975
  "kind": "enhancedComponent",
@@ -44984,7 +44984,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
44984
44984
  "kind": "primitive",
44985
44985
  "value": "string"
44986
44986
  },
44987
- "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.",
44987
+ "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.",
44988
44988
  "declarations": [
44989
44989
  {
44990
44990
  "name": "space",
@@ -45000,6 +45000,38 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
45000
45000
  "value": "`system.gap.md` (1rem)"
45001
45001
  }
45002
45002
  },
45003
+ {
45004
+ "kind": "property",
45005
+ "name": "orientation",
45006
+ "required": false,
45007
+ "type": {
45008
+ "kind": "union",
45009
+ "value": [
45010
+ {
45011
+ "kind": "string",
45012
+ "value": "horizontal"
45013
+ },
45014
+ {
45015
+ "kind": "string",
45016
+ "value": "vertical"
45017
+ }
45018
+ ]
45019
+ },
45020
+ "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).",
45021
+ "declarations": [
45022
+ {
45023
+ "name": "orientation",
45024
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx"
45025
+ }
45026
+ ],
45027
+ "tags": {
45028
+ "default": "'horizontal'"
45029
+ },
45030
+ "defaultValue": {
45031
+ "kind": "string",
45032
+ "value": "horizontal"
45033
+ }
45034
+ },
45003
45035
  {
45004
45036
  "kind": "property",
45005
45037
  "name": "cs",
@@ -228019,22 +228051,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
228019
228051
  "properties": []
228020
228052
  }
228021
228053
  },
228022
- {
228023
- "name": "CanvasThemeAttributeContext",
228024
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/CanvasProvider.tsx",
228025
- "description": "Context for providing the `data-theme` value to popup containers.\n\nToken stylesheets scope their variables to an attribute selector (e.g. Sana's\n`[data-theme=\"sana-canvas\"]` block defines ~300 variables — palette, shape, depth, type).\nPortaled popups render under `document.body`, outside the `CanvasProvider` wrapper, so they\nnever inherit a nested `data-theme` and none of those variables resolve. Forwarding the\nattribute itself lets the popup container match the same selector, so the whole theme applies\nthrough normal cascade — rather than trying to mirror every variable as an inline style.",
228026
- "declarations": [
228027
- {
228028
- "name": "CanvasThemeAttributeContext",
228029
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/CanvasProvider.tsx"
228030
- }
228031
- ],
228032
- "tags": {},
228033
- "type": {
228034
- "kind": "object",
228035
- "properties": []
228036
- }
228037
- },
228038
228054
  {
228039
228055
  "name": "CanvasProviderProps",
228040
228056
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/CanvasProvider.tsx",
@@ -230883,7 +230899,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
230883
230899
  {
230884
230900
  "kind": "symbol",
230885
230901
  "name": "CanvasBrandRamp",
230886
- "value": "Partial<Record<\"25\" | \"50\" | \"100\" | \"200\" | \"300\" | \"400\" | \"500\" | \"600\" | \"700\" | \"800\" | \"900\" | \"950\" | \"975\" | \"A25\" | \"A50\" | \"A100\" | \"A200\" | \"A300\", string>>"
230902
+ "value": "Partial<Record<\"25\" | \"50\" | \"100\" | \"200\" | \"300\" | \"400\" | \"500\" | \"600\" | \"700\" | \"800\" | \"900\" | \"950\" | \"975\" | \"A25\" | \"A50\" | \"A100\" | \"A200\", string>>"
230887
230903
  },
230888
230904
  {
230889
230905
  "kind": "symbol",
@@ -232796,7 +232812,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
232796
232812
  {
232797
232813
  "name": "sanaCanvasNumericalTheme",
232798
232814
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/sanaTheme.ts",
232799
- "description": "Sana Canvas brand tokens for scoped `CanvasProvider` / popup forwarding.\nValues are `var()` references to Sana brand variables — not merged from `defaultCanvasTheme`.\n\nMirrors only what Sana's stylesheet itself defines: the `neutral` ramp, the `A300` step of\n`primary`/`critical`/`caution`/`positive` (the one step Sana redefines for those families — a\nstronger alpha wash on the matching hue), and the four `system.color.brand.*` tokens Sana\noverrides. Every other key is intentionally omitted — Sana does not define a distinct value\nfor it, so writing it here would only reference the very variable being written (a `var()`\ncycle that resolves to invalid, leaking the classic-theme fallback color instead of Sana's).\n\n`action.*` and `selected.*` are deliberately **not** set. Sana's stylesheet does not define\n`--cnvs-brand-action-*` or `--cnvs-sys-color-brand-fg-selected`/`-surface-selected`; those are\nderived downstream from the root theme. Forcing them here would pin values the root is meant\nto own.\n\nRamp values must reference `base.*` (the underlying palette), never `brand.*` of the same\nname — CanvasProvider writes each entry onto the identically-named `--cnvs-brand-*` CSS\nvariable, so referencing `brand.*` here would create that same self-reference cycle. The\n`system.color.brand.*` overrides are the exception: they target *different* CSS variables\n(`--cnvs-sys-color-brand-*`) than the `brand.*` values they reference, so no cycle.\n\nNote this preset only covers brand tokens. The rest of Sana (shape, depth, type, non-brand\nsystem colors) comes from the stylesheet's `[data-theme=\"sana-canvas\"]` block — pass\n`data-theme` to `CanvasProvider` alongside this preset and it is forwarded to portaled popups\nso the full theme applies there too.",
232815
+ "description": "Sana Canvas brand tokens for scoped `CanvasProvider` / popup forwarding.\nValues are `var()` references to Sana brand variables — not merged from `defaultCanvasTheme`.",
232800
232816
  "declarations": [
232801
232817
  {
232802
232818
  "name": "sanaCanvasNumericalTheme",
@@ -232813,7 +232829,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
232813
232829
  {
232814
232830
  "name": "sanaCanvasProviderTheme",
232815
232831
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/sanaTheme.ts",
232816
- "description": "Pass to root `CanvasProvider` to forward Sana brand CSS variables onto popup containers\n(menus, selects, modals, tooltips).\n\n**When to use it**\n- **Required** when you cannot set `data-theme=\"sana-canvas\"` on `<html>` (embedded apps,\n microfrontends, third-party shells). Popups portal to `document.body` and will not inherit\n a nested `data-theme` — this preset copies Sana brand vars onto the popup stack container.\n- Also useful in tests without global Sana CSS, or custom popup hosts outside normal cascade.\n\n**When you can skip it**\n- Prefer setting `data-theme=\"sana-canvas\"` on `<html>` with Sana CSS imported. Popups then\n inherit brand variables from the document and no `theme` prop is needed.\n\nPass `data-theme=\"sana-canvas\"` alongside it. That attribute is forwarded to popup stack\ncontainers, so the rest of Sana (shape, depth, type, non-brand system colors) applies to\nportaled content through the stylesheet's own `[data-theme=\"sana-canvas\"]` block — this preset\ncovers brand tokens, the attribute covers everything else.\n\n`action.*` and selected-state tokens are not set by this preset — Sana does not define them,\nand they resolve from the root theme.",
232832
+ "description": "Pass to root `CanvasProvider` to forward Sana brand CSS variables onto popup containers\n(menus, selects, modals, tooltips).\n\n**When to use it**\n- **Required** when you cannot set `data-theme=\"sana-canvas\"` on `<html>` (embedded apps,\n microfrontends, third-party shells). Popups portal to `document.body` and will not inherit\n a nested `data-theme` — this preset copies Sana brand vars onto the popup stack container.\n- Also useful in tests without global Sana CSS, or custom popup hosts outside normal cascade.\n\n**When you can skip it**\n- Prefer setting `data-theme=\"sana-canvas\"` on `<html>` with Sana CSS imported. Popups then\n inherit brand variables from the document and no `theme` prop is needed.",
232817
232833
  "declarations": [
232818
232834
  {
232819
232835
  "name": "sanaCanvasProviderTheme",
@@ -232821,7 +232837,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
232821
232837
  }
232822
232838
  ],
232823
232839
  "tags": {
232824
- "example": "```tsx\n// Preferred — control <html>\nimport '@workday/canvas-tokens-web/css/sana/_variables.css';\n// <html data-theme=\"sana-canvas\">\n<CanvasProvider><App /></CanvasProvider>\n\n// No access to <html> — pass both for full parity, including portaled popups\n<CanvasProvider theme={sanaCanvasProviderTheme} data-theme=\"sana-canvas\">\n <App />\n</CanvasProvider>\n```"
232840
+ "example": "```tsx\n// Preferred — control <html>\nimport '@workday/canvas-tokens-web/css/sana/_variables.css';\n// <html data-theme=\"sana-canvas\">\n<CanvasProvider><App /></CanvasProvider>\n\n// No access to <html> — required for popup parity\n<CanvasProvider theme={sanaCanvasProviderTheme}><App /></CanvasProvider>\n```"
232825
232841
  },
232826
232842
  "type": {
232827
232843
  "kind": "symbol",
@@ -233890,10 +233906,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
233890
233906
  {
233891
233907
  "kind": "string",
233892
233908
  "value": "A200"
233893
- },
233894
- {
233895
- "kind": "string",
233896
- "value": "A300"
233897
233909
  }
233898
233910
  ]
233899
233911
  },
@@ -233911,7 +233923,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
233911
233923
  {
233912
233924
  "name": "CanvasNeutralBrandRamp",
233913
233925
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts",
233914
- "description": "Neutral brand ramp — includes Sana-only steps (`150` / `850` / `A150` / `A850`), plus the\nextended alpha steps (`A400`–`A975`) that only the neutral family exposes.",
233926
+ "description": "Neutral brand ramp — includes Sana-only steps (`150` / `850` / `A150`) that are not\nexported for primary/critical/caution/positive families.",
233915
233927
  "declarations": [
233916
233928
  {
233917
233929
  "name": "CanvasNeutralBrandRamp",
@@ -233928,7 +233940,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
233928
233940
  {
233929
233941
  "kind": "symbol",
233930
233942
  "name": "CanvasBrandRamp",
233931
- "value": "Partial<Record<\"25\" | \"50\" | \"100\" | \"200\" | \"300\" | \"400\" | \"500\" | \"600\" | \"700\" | \"800\" | \"900\" | \"950\" | \"975\" | \"A25\" | \"A50\" | \"A100\" | \"A200\" | \"A300\", string>>"
233943
+ "value": "Partial<Record<\"25\" | \"50\" | \"100\" | \"200\" | \"300\" | \"400\" | \"500\" | \"600\" | \"700\" | \"800\" | \"900\" | \"950\" | \"975\" | \"A25\" | \"A50\" | \"A100\" | \"A200\", string>>"
233932
233944
  },
233933
233945
  {
233934
233946
  "kind": "symbol",
@@ -233953,42 +233965,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
233953
233965
  {
233954
233966
  "kind": "string",
233955
233967
  "value": "A150"
233956
- },
233957
- {
233958
- "kind": "string",
233959
- "value": "A400"
233960
- },
233961
- {
233962
- "kind": "string",
233963
- "value": "A500"
233964
- },
233965
- {
233966
- "kind": "string",
233967
- "value": "A600"
233968
- },
233969
- {
233970
- "kind": "string",
233971
- "value": "A700"
233972
- },
233973
- {
233974
- "kind": "string",
233975
- "value": "A800"
233976
- },
233977
- {
233978
- "kind": "string",
233979
- "value": "A850"
233980
- },
233981
- {
233982
- "kind": "string",
233983
- "value": "A900"
233984
- },
233985
- {
233986
- "kind": "string",
233987
- "value": "A950"
233988
- },
233989
- {
233990
- "kind": "string",
233991
- "value": "A975"
233992
233968
  }
233993
233969
  ]
233994
233970
  },
@@ -234136,7 +234112,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
234136
234112
  "type": {
234137
234113
  "kind": "symbol",
234138
234114
  "name": "CanvasBrandRamp",
234139
- "value": "Partial<Record<\"25\" | \"50\" | \"100\" | \"200\" | \"300\" | \"400\" | \"500\" | \"600\" | \"700\" | \"800\" | \"900\" | \"950\" | \"975\" | \"A25\" | \"A50\" | \"A100\" | \"A200\" | \"A300\", string>>"
234115
+ "value": "Partial<Record<\"25\" | \"50\" | \"100\" | \"200\" | \"300\" | \"400\" | \"500\" | \"600\" | \"700\" | \"800\" | \"900\" | \"950\" | \"975\" | \"A25\" | \"A50\" | \"A100\" | \"A200\", string>>"
234140
234116
  },
234141
234117
  "description": "Primary brand ramp (`--cnvs-brand-primary-*`).\n\n**Shortcut (brand scope only):** when `'600'` is the only key under `primary`,\nalso sets:\n- `PrimaryButton` — `brand.action.base`, `accent.primary`, `accent.action`\n- Selected `Menu.Item` — `system.color.brand.fg.selected`, `surface.selected`\n\nDoes **not** set focus rings — use {@link CanvasNumericalBrandTheme.focus }\nor legacy `canvas.palette.common.focusOutline`.\n\n| Key | CSS variable | Typical consumers |\n|-----|--------------|-------------------|\n| `'600'` | `--cnvs-brand-primary-600` | PrimaryButton, brand links, accent.primary |\n| `'700'` | `--cnvs-brand-primary-700` | Strong primary fg, selected text |\n| `'500'` | `--cnvs-brand-primary-500` | Mid primary ramp only (not focus) |\n| `'A50'` | `--cnvs-brand-primary-A50` | Selected/hover surfaces |",
234142
234118
  "declarations": [
@@ -234172,7 +234148,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
234172
234148
  "type": {
234173
234149
  "kind": "symbol",
234174
234150
  "name": "CanvasBrandRamp",
234175
- "value": "Partial<Record<\"25\" | \"50\" | \"100\" | \"200\" | \"300\" | \"400\" | \"500\" | \"600\" | \"700\" | \"800\" | \"900\" | \"950\" | \"975\" | \"A25\" | \"A50\" | \"A100\" | \"A200\" | \"A300\", string>>"
234151
+ "value": "Partial<Record<\"25\" | \"50\" | \"100\" | \"200\" | \"300\" | \"400\" | \"500\" | \"600\" | \"700\" | \"800\" | \"900\" | \"950\" | \"975\" | \"A25\" | \"A50\" | \"A100\" | \"A200\", string>>"
234176
234152
  },
234177
234153
  "description": "Critical/error ramp (`--cnvs-brand-critical-*`).\n\n| Key | Typical consumers |\n|-----|-------------------|\n| `'600'` | TextInput error, DeleteButton, critical fg |\n| `'500'` | Critical focus ring, error border |\n| `'A25'` / `'A50'` | Error surface tints |",
234178
234154
  "declarations": [
@@ -234190,7 +234166,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
234190
234166
  "type": {
234191
234167
  "kind": "symbol",
234192
234168
  "name": "CanvasBrandRamp",
234193
- "value": "Partial<Record<\"25\" | \"50\" | \"100\" | \"200\" | \"300\" | \"400\" | \"500\" | \"600\" | \"700\" | \"800\" | \"900\" | \"950\" | \"975\" | \"A25\" | \"A50\" | \"A100\" | \"A200\" | \"A300\", string>>"
234169
+ "value": "Partial<Record<\"25\" | \"50\" | \"100\" | \"200\" | \"300\" | \"400\" | \"500\" | \"600\" | \"700\" | \"800\" | \"900\" | \"950\" | \"975\" | \"A25\" | \"A50\" | \"A100\" | \"A200\", string>>"
234194
234170
  },
234195
234171
  "description": "Caution/warning ramp (`--cnvs-brand-caution-*`).\n\n| Key | Typical consumers |\n|-----|-------------------|\n| `'400'` | Caution accent, TextInput caution |\n| `'500'` | Caution focus outer, caution border |\n| `'A25'` / `'A50'` | Caution surface tints |",
234196
234172
  "declarations": [
@@ -234208,7 +234184,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
234208
234184
  "type": {
234209
234185
  "kind": "symbol",
234210
234186
  "name": "CanvasBrandRamp",
234211
- "value": "Partial<Record<\"25\" | \"50\" | \"100\" | \"200\" | \"300\" | \"400\" | \"500\" | \"600\" | \"700\" | \"800\" | \"900\" | \"950\" | \"975\" | \"A25\" | \"A50\" | \"A100\" | \"A200\" | \"A300\", string>>"
234187
+ "value": "Partial<Record<\"25\" | \"50\" | \"100\" | \"200\" | \"300\" | \"400\" | \"500\" | \"600\" | \"700\" | \"800\" | \"900\" | \"950\" | \"975\" | \"A25\" | \"A50\" | \"A100\" | \"A200\", string>>"
234212
234188
  },
234213
234189
  "description": "Positive/success ramp (`--cnvs-brand-positive-*`).\n\n| Key | Typical consumers |\n|-----|-------------------|\n| `'600'` | Checkbox/Radio checked, success fg |\n| `'A25'` / `'A50'` | Success surface tints |",
234214
234190
  "declarations": [
@@ -18,11 +18,11 @@ export const packageJSONFile = `{
18
18
  "@emotion/react": "11.11.4",
19
19
  "@types/react": "18.2.60",
20
20
  "@types/react-dom": "18.2.19",
21
- "@workday/canvas-kit-labs-react": "16.0.13",
22
- "@workday/canvas-kit-preview-react": "16.0.13",
23
- "@workday/canvas-kit-react": "16.0.13",
24
- "@workday/canvas-kit-react-fonts": "^16.0.13",
25
- "@workday/canvas-kit-styling": "16.0.13",
21
+ "@workday/canvas-kit-labs-react": "16.0.11",
22
+ "@workday/canvas-kit-preview-react": "16.0.11",
23
+ "@workday/canvas-kit-react": "16.0.11",
24
+ "@workday/canvas-kit-react-fonts": "^16.0.11",
25
+ "@workday/canvas-kit-styling": "16.0.11",
26
26
  "@workday/canvas-system-icons-web": "^5.0.3",
27
27
  "@workday/canvas-expressive-icons-web": "1.0.1",
28
28
  "@workday/canvas-tokens-web": "4.4.0-beta.11"
@@ -19,11 +19,11 @@ export const packageJSONFile = `{
19
19
  "@emotion/react": "11.11.4",
20
20
  "@types/react": "18.2.60",
21
21
  "@types/react-dom": "18.2.19",
22
- "@workday/canvas-kit-labs-react": "16.0.13",
23
- "@workday/canvas-kit-preview-react": "16.0.13",
24
- "@workday/canvas-kit-react": "16.0.13",
25
- "@workday/canvas-kit-react-fonts": "^16.0.13",
26
- "@workday/canvas-kit-styling": "16.0.13",
22
+ "@workday/canvas-kit-labs-react": "16.0.11",
23
+ "@workday/canvas-kit-preview-react": "16.0.11",
24
+ "@workday/canvas-kit-react": "16.0.11",
25
+ "@workday/canvas-kit-react-fonts": "^16.0.11",
26
+ "@workday/canvas-kit-styling": "16.0.11",
27
27
  "@workday/canvas-system-icons-web": "^5.0.3",
28
28
  "@workday/canvas-expressive-icons-web": "1.0.1",
29
29
  "@workday/canvas-tokens-web": "4.4.0-beta.11"
@@ -70,21 +70,6 @@ parent component's DOM hierarchy, and only inherit theme from `<html>`, or from
70
70
  > `[data-theme="sana-canvas"]` overrides, so removing the attribute is how you get classic Canvas —
71
71
  > there's nothing to undo it with.
72
72
 
73
- **Scoped / no document-root control:** if you cannot set `data-theme` on `<html>` (embedded apps,
74
- microfrontends, third-party shells), pass both `data-theme="sana-canvas"` and
75
- `sanaCanvasProviderTheme` to `CanvasProvider`. The preset supplies Sana's brand variables, and
76
- Canvas Kit forwards the `data-theme` attribute onto the popup stack container — so portaled
77
- menus, modals, and dialogs match the same `[data-theme="sana-canvas"]` selector and pick up the
78
- rest of the theme (shape, depth, type, non-brand system colors) through normal cascade:
79
-
80
- ```tsx
81
- import {CanvasProvider, sanaCanvasProviderTheme} from '@workday/canvas-kit-react/common';
82
-
83
- <CanvasProvider theme={sanaCanvasProviderTheme} data-theme="sana-canvas">
84
- <App />
85
- </CanvasProvider>
86
- ```
87
-
88
73
  ### What Changes When You Opt In
89
74
 
90
75
  Things that change are primary brand consumers and Sana's neutral color scale
@@ -2,6 +2,7 @@ import {ExampleCodeBlock, SymbolDoc, Specifications} from '@workday/canvas-kit-d
2
2
 
3
3
  import * as Divider from './Divider.stories.ts';
4
4
  import Basic from './examples/Basic';
5
+ import Vertical from './examples/Vertical';
5
6
  import CustomSpace from './examples/CustomSpace';
6
7
 
7
8
 
@@ -31,6 +32,10 @@ bottom margin.
31
32
 
32
33
  <ExampleCodeBlock code={Basic} />
33
34
 
35
+ ### Vertical Example
36
+
37
+ <ExampleCodeBlock code={Vertical} />
38
+
34
39
  ### Custom Space
35
40
 
36
41
  You might also want to apply custom space to `Divider` where the top and bottom margin are not
@@ -28,40 +28,39 @@ const maintainerList = [
28
28
  {
29
29
  id: '44883293',
30
30
  name: 'Josh Bagwell',
31
- bio: 'Software Development Engineer',
31
+ bio: 'Master of Cocktails and Fast Cars',
32
32
  },
33
33
  {
34
34
  id: '338257',
35
35
  name: 'Nicholas Boll',
36
- bio: 'Principal Software Development Engineer',
36
+ bio: 'Principal Potato Engineer',
37
37
  },
38
38
  {
39
39
  id: '7966550',
40
40
  name: 'Manuel Carrera',
41
- bio: 'Sr. Software Development Engineer',
41
+ bio: 'Sr. Rock Climber and Artist',
42
42
  },
43
43
  {
44
44
  id: '146020',
45
45
  name: 'James Fan',
46
- bio: 'Sr. Software Development Engineer',
46
+ bio: 'Sr. Television Consultant',
47
47
  },
48
48
  {
49
49
  id: '48605821',
50
50
  name: 'Raisa Primerova',
51
- bio: 'Software Development Engineer',
51
+ bio: 'Principal Borscht Connoisseur',
52
52
  },
53
53
  {
54
54
  id: '4818182',
55
55
  name: 'Alan Smith',
56
- bio: 'Principal Software Development Engineer',
56
+ bio: 'Principal Pizza Tosser',
57
57
  },
58
58
  ];
59
59
 
60
60
  const profileCardStyles = createStyles({
61
- display: 'grid',
62
- gridGap: '0.5rem',
63
- gridTemplateColumns: '5rem 1fr',
64
- gridTemplateRows: '1fr 1fr',
61
+ display: 'flex',
62
+ gap: '0.5rem',
63
+ flexDirection: 'row',
65
64
  });
66
65
 
67
66
  const profileCardAvatarStyles = createStyles({
@@ -84,6 +83,12 @@ const profileCardBodyStyles = createStyles({
84
83
  margin: 0,
85
84
  });
86
85
 
86
+ const profileCardContentStyles = createStyles({
87
+ display: 'flex',
88
+ flexDirection: 'column',
89
+ gap: system.gap.xs,
90
+ });
91
+
87
92
  interface ProfileCardProps {
88
93
  id: string;
89
94
  name: string;
@@ -93,12 +98,14 @@ interface ProfileCardProps {
93
98
  const ProfileCard = ({id, name, bio}: ProfileCardProps) => (
94
99
  <div className={profileCardStyles}>
95
100
  <Avatar
96
- size="extraLarge"
101
+ size="large"
97
102
  url={`https://avatars.githubusercontent.com/u/${id}?v=4`}
98
103
  name={`${name}'s avatar`}
99
104
  className={profileCardAvatarStyles}
100
105
  />
101
- <h3 className={profileCardHeadingStyles}>{name}</h3>
102
- <p className={profileCardBodyStyles}>{bio}</p>
106
+ <div className={profileCardContentStyles}>
107
+ <h3 className={profileCardHeadingStyles}>{name}</h3>
108
+ <p className={profileCardBodyStyles}>{bio}</p>
109
+ </div>
103
110
  </div>
104
111
  );
@@ -0,0 +1,50 @@
1
+ import {Divider} from '@workday/canvas-kit-preview-react/divider';
2
+ import {createStyles} from '@workday/canvas-kit-styling';
3
+ import {system} from '@workday/canvas-tokens-web';
4
+
5
+ const rowStyles = createStyles({
6
+ display: 'flex',
7
+ alignItems: 'center',
8
+ height: system.size.xxl,
9
+ });
10
+
11
+ const statStyles = createStyles({
12
+ display: 'flex',
13
+ flexDirection: 'column',
14
+ gap: system.gap.none,
15
+ });
16
+
17
+ const labelStyles = createStyles({
18
+ ...system.type.subtext.medium,
19
+ color: system.color.fg.default,
20
+ margin: 0,
21
+ });
22
+
23
+ const valueStyles = createStyles({
24
+ ...system.type.body.large,
25
+ fontWeight: system.fontWeight.bold,
26
+ margin: 0,
27
+ });
28
+
29
+ export default () => {
30
+ const lastIndex = stats.length - 1;
31
+ return (
32
+ <div className={rowStyles}>
33
+ {stats.map((stat, index) => (
34
+ <>
35
+ <div className={statStyles}>
36
+ <p className={labelStyles}>{stat.label}</p>
37
+ <p className={valueStyles}>{stat.value}</p>
38
+ </div>
39
+ {index !== lastIndex && <Divider orientation="vertical" space={system.gap.md} />}
40
+ </>
41
+ ))}
42
+ </div>
43
+ );
44
+ };
45
+
46
+ const stats = [
47
+ {label: 'Components', value: '128'},
48
+ {label: 'Contributors', value: '64'},
49
+ {label: 'Releases', value: '512'},
50
+ ];
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';
2
2
 
3
3
  import Basic from './examples/Basic';
4
4
  import Custom from './examples/Custom';
@@ -46,10 +46,6 @@ position of the icon may be adjusted depending on where you place it in the mark
46
46
 
47
47
  <ExampleCodeBlock code={Icon} />
48
48
 
49
- > **Accessibility Note**: In this example, the icon is used as a decoration and is intentionally
50
- > hidden from screen readers. If you're using icons to convey additional information, add
51
- > `role="img"` and a translated `aria-label` string to `StatusIndicator.Icon`.
52
-
53
49
  ### Overflow
54
50
 
55
51
  We **strongly** discourage using text in a `StatusIndicator` which will cause it to exceed its
@@ -65,16 +61,14 @@ of `StatusIndicator` via [style props](/get-started/for-developers/documentation
65
61
  Set the `variant` prop of `StatusIndicator` to adjust its background color. `variant` accepts the
66
62
  following values:
67
63
 
68
- - `neutral` (default; `gray` is a deprecated alias)
69
- - `caution` (`orange` is a deprecated alias)
70
- - `info` (`blue` is a deprecated alias)
71
- - `positive` (`green` is a deprecated alias)
72
- - `critical` (`red` is a deprecated alias)
64
+ - `gray`
65
+ - `orange`
66
+ - `blue`
67
+ - `green`
68
+ - `red`
73
69
  - `transparent`
74
70
 
75
71
  The background color dictated by the `variant` will be dark or light based on the `emphasis`.
76
- `variant` and `emphasis` change color only—they do not change the accessible name. Put the status
77
- meaning in **`StatusIndicator.Label`**.
78
72
 
79
73
  <ExampleCodeBlock code={Variants} />
80
74
 
@@ -90,113 +84,6 @@ Status Indicator and its subcomponents support custom styling via the `cs` prop.
90
84
  information, check our
91
85
  ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-guides-customizing-styles--docs).
92
86
 
93
- ## Accessibility
94
-
95
- `StatusIndicator` is a compact, **non-interactive** status label. The accessibility goal is that
96
- assistive technology users get the same status meaning as sighted users from
97
- **`StatusIndicator.Label`** text—not from color, emphasis, or a decorative icon.
98
-
99
- ### Minimum Accessible Structure
100
-
101
- The following matches the [Basic Example](#basic-example): a container and a visible label. Icon is
102
- optional.
103
-
104
- ```tsx
105
- import {StatusIndicator} from '@workday/canvas-kit-preview-react/status-indicator';
106
-
107
- <StatusIndicator>
108
- <StatusIndicator.Label>Unpublished</StatusIndicator.Label>
109
- </StatusIndicator>;
110
- ```
111
-
112
- Always include **`StatusIndicator.Label`** with concise text that names the status. Do not rely on
113
- **`variant`**, **`emphasis`**, or **`StatusIndicator.Icon`** as the only indicator of meaning.
114
-
115
- ### Built-in Behaviors
116
-
117
- Canvas Kit applies visual layout and color through `statusIndicatorStencil` when you compose
118
- **`StatusIndicator`**, **`StatusIndicator.Label`**, and optionally **`StatusIndicator.Icon`**. It
119
- does **not** apply `role="img"` or an accessible name on the icon. **Do not duplicate them** in
120
- consuming code. Only add icon ARIA when the informative-icon requirement below applies.
121
-
122
- **ARIA and DOM** (_applied by subcomponents_):
123
-
124
- - **`StatusIndicator`**: renders a `div` (override with `as` if needed). Default `maxWidth` is
125
- `200px`. Default `variant` is `neutral`; default `emphasis` is `low`. No ARIA role is set.
126
- - **`StatusIndicator.Label`**: renders a `span` with bold subtext, `white-space: nowrap`,
127
- `overflow: hidden`, and `text-overflow: ellipsis`. Truncation is visual; the full text remains in
128
- the accessibility tree.
129
- - **`StatusIndicator.Icon`**: renders `SystemIcon` at size `20`. It does **not** set `role="img"` or
130
- `aria-label`. If `icon.type` is missing, the icon renders nothing.
131
-
132
- **Keyboard** (_not a control by default_):
133
-
134
- - **`StatusIndicator`** is not in the tab order. There is no built-in keyboard behavior.
135
-
136
- **Screen reader expectations** (_when built-in behaviors are used as intended_):
137
-
138
- - Assistive technology should announce the **`StatusIndicator.Label`** text as the content of the
139
- indicator
140
- - `variant` and `emphasis` are **not** announced
141
- - A decorative **`StatusIndicator.Icon`** (no `role="img"`) should not add a separate accessible
142
- name
143
- - [**OverflowTooltip**](https://workday.github.io/canvas-kit/?path=/docs/components-popups-tooltip--docs#tooltips-on-overflowing-content)
144
- uses `type="muted"` and does not set `aria-label` on the target—the accessible name stays the
145
- element's text content
146
-
147
- ### Accessibility Requirements
148
-
149
- Required in application code for an accessible Status Indicator. Rows marked _(conditional)_ apply
150
- only when the situation matches—otherwise omit.
151
-
152
- **If no design spec is provided:** include a visible **`StatusIndicator.Label`**; keep the icon
153
- decorative (omit `role="img"` and `aria-label`); omit `tabIndex` and **`OverflowTooltip`**. Prefer
154
- short label text so truncation is unnecessary.
155
-
156
- | Requirement | How to satisfy |
157
- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
158
- | Visible status text | **`StatusIndicator.Label`** with translated text that names the status (for example, "Unpublished", not color alone) |
159
- | 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) |
160
- | Decorative icon _(conditional)_ | **`StatusIndicator.Icon`** with `icon={...}` and **no** `role="img"` when the icon only supports the label visually |
161
- | Informative icon _(conditional)_ | On **`StatusIndicator.Icon`**, set `role="img"` and a translated `aria-label` that adds meaning **beyond** the label text |
162
- | 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) |
163
-
164
- **Informative icon** _(conditional)_:
165
-
166
- ```tsx
167
- import {StatusIndicator} from '@workday/canvas-kit-preview-react/status-indicator';
168
- import {cloudArrowUpIcon} from '@workday/canvas-system-icons-web';
169
-
170
- <StatusIndicator>
171
- <StatusIndicator.Icon role="img" aria-label="Waiting to sync" icon={cloudArrowUpIcon} />
172
- <StatusIndicator.Label>Unpublished</StatusIndicator.Label>
173
- </StatusIndicator>;
174
- ```
175
-
176
- **Summary for code generation:**
177
-
178
- - **REQUIRED:** visible **`StatusIndicator.Label`** whose text conveys the status
179
- - **CONDITIONAL:** `role="img"` + translated `aria-label` on **`StatusIndicator.Icon`**,
180
- **`OverflowTooltip`** + `tabIndex={0}`
181
-
182
- ### Anti-Patterns
183
-
184
- Do **not** generate code that does the following (see **Accessibility Requirements** above for what
185
- to supply instead):
186
-
187
- - Omit **`StatusIndicator.Label`** or use an empty label, relying on `variant`, `emphasis`, or an
188
- icon for meaning
189
- - Set `role="img"` on a decorative **`StatusIndicator.Icon`**, or set `role="img"` without a
190
- translated `aria-label`—that can expose an unnamed image to assistive technology. See **Decorative
191
- icon** and **Informative icon** in **Accessibility Requirements**
192
- - Duplicate the label text as `aria-label` on the icon when the icon adds no extra meaning
193
- - Add `role="status"`, `aria-live`, or `aria-label` on **`StatusIndicator`** by default—Canvas Kit
194
- does not wire these, and they change how assistive technology treats a static label. If a design
195
- requires announcing asynchronous updates, see
196
- [ARIA Live Regions](https://workday.github.io/canvas-kit/?path=/docs/guides-accessibility-aria-live-regions--docs)
197
- - Truncate label text without **`OverflowTooltip`** and `tabIndex={0}` when keyboard users must read
198
- the overflow
199
-
200
87
  ## Component API
201
88
 
202
89
  <SymbolDoc name="StatusIndicator" fileName="/preview-react/" />
@@ -12,12 +12,12 @@ export default () => {
12
12
  return (
13
13
  <Flex cs={parentContainerStyles}>
14
14
  <StatusIndicator>
15
- <StatusIndicator.Icon icon={cloudArrowUpIcon} />
15
+ <StatusIndicator.Icon aria-label="unpublished" icon={cloudArrowUpIcon} />
16
16
  <StatusIndicator.Label>Unpublished</StatusIndicator.Label>
17
17
  </StatusIndicator>
18
18
  <StatusIndicator variant="positive">
19
19
  <StatusIndicator.Label>published</StatusIndicator.Label>
20
- <StatusIndicator.Icon icon={cloudArrowUpIcon} />
20
+ <StatusIndicator.Icon aria-label="published" icon={cloudArrowUpIcon} />
21
21
  </StatusIndicator>
22
22
  </Flex>
23
23
  );
@@ -116,11 +116,9 @@ import {CanvasProvider} from '@workday/canvas-kit-react/common';
116
116
  ```
117
117
 
118
118
  **Scoped / no document-root control:** if you cannot set `data-theme` on `<html>` (embedded apps,
119
- microfrontends, third-party shells), pass both `data-theme="sana-canvas"` and
120
- `sanaCanvasProviderTheme` to `CanvasProvider`. The preset supplies Sana's brand variables, and
121
- Canvas Kit forwards the `data-theme` attribute onto the popup stack container — so portaled
122
- menus, modals, and dialogs match the same `[data-theme="sana-canvas"]` selector and pick up the
123
- rest of the theme (shape, depth, type, non-brand system colors) through normal cascade:
119
+ microfrontends, third-party shells), a nested `data-theme` alone does **not** reach portaled
120
+ popups. Pass both `data-theme="sana-canvas"` (for in-tree UI) and `sanaCanvasProviderTheme` (so
121
+ Canvas Kit forwards Sana brand variables onto the popup stack container):
124
122
 
125
123
  ```tsx
126
124
  import {CanvasProvider, sanaCanvasProviderTheme} from '@workday/canvas-kit-react/common';
@@ -1,11 +1,9 @@
1
1
  import React from 'react';
2
2
 
3
- import {PrimaryButton} from '@workday/canvas-kit-react/button';
3
+ import {PrimaryButton, SecondaryButton} from '@workday/canvas-kit-react/button';
4
4
  import {CanvasProvider, sanaCanvasProviderTheme} from '@workday/canvas-kit-react/common';
5
- import {FormField} from '@workday/canvas-kit-react/form-field';
6
5
  import {Menu} from '@workday/canvas-kit-react/menu';
7
6
  import {Popup, useCloseOnOutsideClick, usePopupModel} from '@workday/canvas-kit-react/popup';
8
- import {TextInput} from '@workday/canvas-kit-react/text-input';
9
7
 
10
8
  /**
11
9
  * Scoped Sana setup for popup parity: `data-theme` themes the in-tree UI, and
@@ -18,25 +16,17 @@ export default () => {
18
16
  return (
19
17
  <CanvasProvider theme={sanaCanvasProviderTheme} data-theme="sana-canvas">
20
18
  <Popup model={myModel}>
21
- <Popup.Target as={PrimaryButton}>Open Menu</Popup.Target>
19
+ <Popup.Target as={SecondaryButton}>Open Menu</Popup.Target>
22
20
  <Popup.Popper>
23
21
  <Popup.Card>
24
22
  <Popup.Body>
25
- <Menu initialSelectedIds={['selected']}>
26
- <Menu.List role="listbox">
27
- <Menu.Option data-id="selected">Option 1</Menu.Option>
28
- <Menu.Option>Option 2</Menu.Option>
29
- <Menu.Option>Option 3</Menu.Option>
30
- </Menu.List>
23
+ <Menu>
24
+ <Menu.Item>Option 1</Menu.Item>
25
+ <Menu.Item>Option 2</Menu.Item>
26
+ <Menu.Item>Option 3</Menu.Item>
31
27
  </Menu>
32
28
  <PrimaryButton>Hello World</PrimaryButton>
33
29
  </Popup.Body>
34
- <FormField>
35
- <FormField.Label>Example text input</FormField.Label>
36
- <FormField.Field>
37
- <FormField.Input as={TextInput} />
38
- </FormField.Field>
39
- </FormField>
40
30
  </Popup.Card>
41
31
  </Popup.Popper>
42
32
  </Popup>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workday/canvas-kit-docs",
3
- "version": "16.0.13",
3
+ "version": "16.1.0-0564-next.0",
4
4
  "description": "Documentation components of Canvas Kit components",
5
5
  "author": "Workday, Inc. (https://www.workday.com)",
6
6
  "license": "Apache-2.0",
@@ -47,10 +47,10 @@
47
47
  "@stackblitz/sdk": "^1.11.0",
48
48
  "@storybook/csf": "0.0.1",
49
49
  "@workday/canvas-expressive-icons-web": "1.0.2",
50
- "@workday/canvas-kit-labs-react": "^16.0.13",
51
- "@workday/canvas-kit-preview-react": "^16.0.13",
52
- "@workday/canvas-kit-react": "^16.0.13",
53
- "@workday/canvas-kit-styling": "^16.0.13",
50
+ "@workday/canvas-kit-labs-react": "^16.1.0-0564-next.0",
51
+ "@workday/canvas-kit-preview-react": "^16.1.0-0564-next.0",
52
+ "@workday/canvas-kit-react": "^16.1.0-0564-next.0",
53
+ "@workday/canvas-kit-styling": "^16.1.0-0564-next.0",
54
54
  "@workday/canvas-system-icons-web": "^5.0.3",
55
55
  "@workday/canvas-tokens-web": "^4.4.0",
56
56
  "markdown-to-jsx": "^7.2.0",
@@ -63,5 +63,5 @@
63
63
  "mkdirp": "^1.0.3",
64
64
  "typescript": "5.0"
65
65
  },
66
- "gitHead": "e9dd2a5816799426ed59d7b4a3c8b6b56300aa68"
66
+ "gitHead": "1066b7766b37f856c8744b337753d2901da4ad36"
67
67
  }