@workday/canvas-kit-docs 14.0.3 → 14.0.4

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.
Files changed (4) hide show
  1. package/dist/es6/lib/docs.js +3 -3
  2. package/dist/es6/lib/stackblitzFiles/packageJSONFile.js +5 -5
  3. package/dist/es6/lib/stackblitzFiles/packageJSONFile.ts +5 -5
  4. package/package.json +6 -6
package/dist/es6/lib/docs.js CHANGED
@@ -285321,7 +285321,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
285321
285321
  {
285322
285322
  "name": "useModalModel",
285323
285323
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/modal/lib/hooks/useModalModel.ts",
285324
- "description": "",
285324
+ "description": "This model hook uses {@link usePopupModel} and pre-configures behaviors that are required for an\naccessible modal. `useModalModel` should be used in most cases, but if you require custom\nbehaviors, you can use `usePopupModel` directly. Be sure to add proper popup behaviors to ensure\nthe modal is accessible.\n\nThe following behaviors are added to the `PopupModel`:\n- {@link useInitialFocus}\n- {@link useReturnFocus}\n- {@link useCloseOnOverlayClick}\n- {@link useCloseOnEscape}\n- {@link useFocusTrap}\n- {@link useAssistiveHideSiblings}\n- {@link useDisableBodyScroll}\n\nYou can pass the Modal model config either directly to the `Modal` component or to the\n`useModalModel` hook, but not both. A `model` prop always takes precedence over the config passed\nto the `useModalModel` hook. If no `model` is passed to a `Modal` component, a `ModalModel` will\nbe created for you. Creating your own model hoists the modal's state to the level of your\ncomponent and allows you to access the model's state and events.\n\n```tsx\nconst model = useModalModel(config);\n\n<Modal model={model}>\n // ...\n</Modal>\n```",
285325
285325
  "declarations": [
285326
285326
  {
285327
285327
  "name": "useModalModel",
@@ -285459,7 +285459,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
285459
285459
  {
285460
285460
  "name": "ModalModel",
285461
285461
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/modal/lib/hooks/useModalModel.ts",
285462
- "description": "",
285462
+ "description": "This model hook uses {@link usePopupModel} and pre-configures behaviors that are required for an\naccessible modal. `useModalModel` should be used in most cases, but if you require custom\nbehaviors, you can use `usePopupModel` directly. Be sure to add proper popup behaviors to ensure\nthe modal is accessible.\n\nThe following behaviors are added to the `PopupModel`:\n- {@link useInitialFocus}\n- {@link useReturnFocus}\n- {@link useCloseOnOverlayClick}\n- {@link useCloseOnEscape}\n- {@link useFocusTrap}\n- {@link useAssistiveHideSiblings}\n- {@link useDisableBodyScroll}\n\nYou can pass the Modal model config either directly to the `Modal` component or to the\n`useModalModel` hook, but not both. A `model` prop always takes precedence over the config passed\nto the `useModalModel` hook. If no `model` is passed to a `Modal` component, a `ModalModel` will\nbe created for you. Creating your own model hoists the modal's state to the level of your\ncomponent and allows you to access the model's state and events.\n\n```tsx\nconst model = useModalModel(config);\n\n<Modal model={model}>\n // ...\n</Modal>\n```",
285463
285463
  "declarations": [
285464
285464
  {
285465
285465
  "name": "useModalModel",
@@ -285803,7 +285803,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
285803
285803
  {
285804
285804
  "name": "ModalModelConfig",
285805
285805
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/modal/lib/hooks/useModalModel.ts",
285806
- "description": "",
285806
+ "description": "This model hook uses {@link usePopupModel} and pre-configures behaviors that are required for an\naccessible modal. `useModalModel` should be used in most cases, but if you require custom\nbehaviors, you can use `usePopupModel` directly. Be sure to add proper popup behaviors to ensure\nthe modal is accessible.\n\nThe following behaviors are added to the `PopupModel`:\n- {@link useInitialFocus}\n- {@link useReturnFocus}\n- {@link useCloseOnOverlayClick}\n- {@link useCloseOnEscape}\n- {@link useFocusTrap}\n- {@link useAssistiveHideSiblings}\n- {@link useDisableBodyScroll}\n\nYou can pass the Modal model config either directly to the `Modal` component or to the\n`useModalModel` hook, but not both. A `model` prop always takes precedence over the config passed\nto the `useModalModel` hook. If no `model` is passed to a `Modal` component, a `ModalModel` will\nbe created for you. Creating your own model hoists the modal's state to the level of your\ncomponent and allows you to access the model's state and events.\n\n```tsx\nconst model = useModalModel(config);\n\n<Modal model={model}>\n // ...\n</Modal>\n```",
285807
285807
  "declarations": [
285808
285808
  {
285809
285809
  "name": "useModalModel",
package/dist/es6/lib/stackblitzFiles/packageJSONFile.js CHANGED
@@ -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": "14.0.3",
22
- "@workday/canvas-kit-preview-react": "14.0.3",
23
- "@workday/canvas-kit-react": "14.0.3",
24
- "@workday/canvas-kit-react-fonts": "^14.0.3",
25
- "@workday/canvas-kit-styling": "14.0.3",
21
+ "@workday/canvas-kit-labs-react": "14.0.4",
22
+ "@workday/canvas-kit-preview-react": "14.0.4",
23
+ "@workday/canvas-kit-react": "14.0.4",
24
+ "@workday/canvas-kit-react-fonts": "^14.0.4",
25
+ "@workday/canvas-kit-styling": "14.0.4",
26
26
  "@workday/canvas-system-icons-web": "3.0.22",
27
27
  "@workday/canvas-tokens-web": "2.0.0"
28
28
  },
package/dist/es6/lib/stackblitzFiles/packageJSONFile.ts CHANGED
@@ -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": "14.0.3",
22
- "@workday/canvas-kit-preview-react": "14.0.3",
23
- "@workday/canvas-kit-react": "14.0.3",
24
- "@workday/canvas-kit-react-fonts": "^14.0.3",
25
- "@workday/canvas-kit-styling": "14.0.3",
21
+ "@workday/canvas-kit-labs-react": "14.0.4",
22
+ "@workday/canvas-kit-preview-react": "14.0.4",
23
+ "@workday/canvas-kit-react": "14.0.4",
24
+ "@workday/canvas-kit-react-fonts": "^14.0.4",
25
+ "@workday/canvas-kit-styling": "14.0.4",
26
26
  "@workday/canvas-system-icons-web": "3.0.22",
27
27
  "@workday/canvas-tokens-web": "2.0.0"
28
28
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workday/canvas-kit-docs",
3
- "version": "14.0.3",
3
+ "version": "14.0.4",
4
4
  "description": "Documentation components of Canvas Kit components",
5
5
  "author": "Workday, Inc. (https://www.workday.com)",
6
6
  "license": "Apache-2.0",
@@ -45,10 +45,10 @@
45
45
  "@emotion/styled": "^11.6.0",
46
46
  "@stackblitz/sdk": "^1.11.0",
47
47
  "@storybook/csf": "0.0.1",
48
- "@workday/canvas-kit-labs-react": "^14.0.3",
49
- "@workday/canvas-kit-preview-react": "^14.0.3",
50
- "@workday/canvas-kit-react": "^14.0.3",
51
- "@workday/canvas-kit-styling": "^14.0.3",
48
+ "@workday/canvas-kit-labs-react": "^14.0.4",
49
+ "@workday/canvas-kit-preview-react": "^14.0.4",
50
+ "@workday/canvas-kit-react": "^14.0.4",
51
+ "@workday/canvas-kit-styling": "^14.0.4",
52
52
  "@workday/canvas-system-icons-web": "^3.0.36",
53
53
  "@workday/canvas-tokens-web": "^3.1.1",
54
54
  "markdown-to-jsx": "^7.2.0",
@@ -61,5 +61,5 @@
61
61
  "mkdirp": "^1.0.3",
62
62
  "typescript": "5.0"
63
63
  },
64
- "gitHead": "241a81d0e3d2ef4db433277fcdb453df5700be4d"
64
+ "gitHead": "b105d648b00e47c816c9ce6aafc801bc42e0806a"
65
65
  }