@workday/canvas-kit-docs 10.3.30 → 10.3.31

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.
@@ -199277,7 +199277,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
199277
199277
  {
199278
199278
  "name": "Card",
199279
199279
  "symbol": "SelectCard",
199280
- "description": "`Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.\n\n**Note: The card will be the width of its corresponding `Select.Input`**.\n\n```tsx\n<Select item={options}>\n <FormField label=\"Your Label\">\n <Select.Input onChange={(event) => handleChange(event)}>\n <Select.Popper>\n <Select.Card>\n ...\n </Select.Card>\n </Select.Popper>\n </FormField>\n</Select>\n```",
199280
+ "description": "`Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.\n\n**Note: The card will be the width of its corresponding `Select.Input`**.\n\n```tsx\n<Select items={options}>\n <FormField label=\"Your Label\">\n <Select.Input onChange={(event) => handleChange(event)}>\n <Select.Popper>\n <Select.Card>\n ...\n </Select.Card>\n </Select.Popper>\n </FormField>\n</Select>\n```",
199281
199281
  "declarations": [
199282
199282
  {
199283
199283
  "name": "Card",
@@ -199289,7 +199289,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
199289
199289
  {
199290
199290
  "name": "Item",
199291
199291
  "symbol": "SelectItem",
199292
- "description": "`Select.Item` renders a {@link ComboboxMenuItem Combobox.Menu.Item} with aria role of `option`. You can optionally render a `Icon`.\n\n```tsx\n<Select item={options}>\n <FormField label=\"Your Label\">\n <Select.Input onChange={(event) => handleChange(event)}>\n <Select.Popper>\n <Select.Card>\n <Select.List>\n {(item) => <Select.Item><Select.Item.Icon icon={icon} />{item}</Select.Item>}\n </Select.List\n </Select.Card>\n </Select.Popper>\n </FormField>\n</Select>\n```",
199292
+ "description": "`Select.Item` renders a {@link ComboboxMenuItem Combobox.Menu.Item} with aria role of `option`. You can optionally render a `Icon`.\n\n```tsx\n<Select items={options}>\n <FormField label=\"Your Label\">\n <Select.Input onChange={(event) => handleChange(event)}>\n <Select.Popper>\n <Select.Card>\n <Select.List>\n {(item) => <Select.Item><Select.Item.Icon icon={icon} />{item}</Select.Item>}\n </Select.List\n </Select.Card>\n </Select.Popper>\n </FormField>\n</Select>\n```",
199293
199293
  "declarations": [
199294
199294
  {
199295
199295
  "name": "Item",
@@ -259,6 +259,9 @@ We've converted `Select` into a
259
259
  a flexible API and access to its internals via its subcomponents.
260
260
 
261
261
  ```tsx
262
+ import {Select} from '@workday/canvas-kit-react/select';
263
+ import {FormField} from '@workday/canvas-kit-react/form-field';
264
+
262
265
  // v9
263
266
  <FormField label="Pizza Size">
264
267
  <Select onChange={handleChange} value={value}>
@@ -270,6 +273,9 @@ a flexible API and access to its internals via its subcomponents.
270
273
  ```
271
274
 
272
275
  ```tsx
276
+ import {Select} from '@workday/canvas-kit-react/select';
277
+ import {FormField} from '@workday/canvas-kit-react/form-field';
278
+
273
279
  // v10
274
280
  <Select items={['Small', 'Medium', 'Large']}>
275
281
  <FormField label="Pizza Size" inputId="pizza">
@@ -287,7 +293,13 @@ a flexible API and access to its internals via its subcomponents.
287
293
  </Select>
288
294
  ```
289
295
 
290
- Unlike the
296
+ Notice that `Select` is now outside the `FormField`. This is due to the update in `Select` and how
297
+ the `FormField` in main applies attributes. Previously, `Select` was a styled native `<select>`
298
+ input and `FormField` applied attributes automatically to that input. The new `Select` is solely a
299
+ React context provider for its subcomponents. `FormField` needs `Select.Input` to be a direct child
300
+ to apply attributes correctly.
301
+
302
+ Also, unlike the
291
303
  [Select in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-select-left-label--default),
292
304
  this component does not have a border around its menu.
293
305
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workday/canvas-kit-docs",
3
- "version": "10.3.30",
3
+ "version": "10.3.31",
4
4
  "description": "Documentation components of Canvas Kit components",
5
5
  "author": "Workday, Inc. (https://www.workday.com)",
6
6
  "license": "Apache-2.0",
@@ -44,10 +44,10 @@
44
44
  "dependencies": {
45
45
  "@emotion/styled": "^11.6.0",
46
46
  "@storybook/csf": "0.0.1",
47
- "@workday/canvas-kit-labs-react": "^10.3.30",
48
- "@workday/canvas-kit-preview-react": "^10.3.30",
49
- "@workday/canvas-kit-react": "^10.3.30",
50
- "@workday/canvas-kit-styling": "^10.3.30",
47
+ "@workday/canvas-kit-labs-react": "^10.3.31",
48
+ "@workday/canvas-kit-preview-react": "^10.3.31",
49
+ "@workday/canvas-kit-react": "^10.3.31",
50
+ "@workday/canvas-kit-styling": "^10.3.31",
51
51
  "@workday/canvas-system-icons-web": "^3.0.0",
52
52
  "@workday/canvas-tokens-web": "^1.0.0",
53
53
  "markdown-to-jsx": "^6.10.3",
@@ -59,5 +59,5 @@
59
59
  "mkdirp": "^1.0.3",
60
60
  "typescript": "4.2"
61
61
  },
62
- "gitHead": "29c68b2901b35d8d4bf87fe4d8850ef26196fa49"
62
+ "gitHead": "743cbfdbea68fbdb955406a65bb7472571fb9847"
63
63
  }