@workday/canvas-kit-docs 13.2.31 → 13.2.32

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
@@ -266191,7 +266191,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
266191
266191
  {
266192
266192
  "name": "useModalModel",
266193
266193
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/modal/lib/hooks/useModalModel.ts",
266194
- "description": "",
266194
+ "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```",
266195
266195
  "declarations": [
266196
266196
  {
266197
266197
  "name": "useModalModel",
@@ -266329,7 +266329,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
266329
266329
  {
266330
266330
  "name": "ModalModel",
266331
266331
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/modal/lib/hooks/useModalModel.ts",
266332
- "description": "",
266332
+ "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```",
266333
266333
  "declarations": [
266334
266334
  {
266335
266335
  "name": "useModalModel",
@@ -266673,7 +266673,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
266673
266673
  {
266674
266674
  "name": "ModalModelConfig",
266675
266675
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/modal/lib/hooks/useModalModel.ts",
266676
- "description": "",
266676
+ "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```",
266677
266677
  "declarations": [
266678
266678
  {
266679
266679
  "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": "13.2.31",
22
- "@workday/canvas-kit-preview-react": "13.2.31",
23
- "@workday/canvas-kit-react": "13.2.31",
24
- "@workday/canvas-kit-react-fonts": "^13.2.31",
25
- "@workday/canvas-kit-styling": "13.2.31",
21
+ "@workday/canvas-kit-labs-react": "13.2.32",
22
+ "@workday/canvas-kit-preview-react": "13.2.32",
23
+ "@workday/canvas-kit-react": "13.2.32",
24
+ "@workday/canvas-kit-react-fonts": "^13.2.32",
25
+ "@workday/canvas-kit-styling": "13.2.32",
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": "13.2.31",
22
- "@workday/canvas-kit-preview-react": "13.2.31",
23
- "@workday/canvas-kit-react": "13.2.31",
24
- "@workday/canvas-kit-react-fonts": "^13.2.31",
25
- "@workday/canvas-kit-styling": "13.2.31",
21
+ "@workday/canvas-kit-labs-react": "13.2.32",
22
+ "@workday/canvas-kit-preview-react": "13.2.32",
23
+ "@workday/canvas-kit-react": "13.2.32",
24
+ "@workday/canvas-kit-react-fonts": "^13.2.32",
25
+ "@workday/canvas-kit-styling": "13.2.32",
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": "13.2.31",
3
+ "version": "13.2.32",
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": "^13.2.31",
49
- "@workday/canvas-kit-preview-react": "^13.2.31",
50
- "@workday/canvas-kit-react": "^13.2.31",
51
- "@workday/canvas-kit-styling": "^13.2.31",
48
+ "@workday/canvas-kit-labs-react": "^13.2.32",
49
+ "@workday/canvas-kit-preview-react": "^13.2.32",
50
+ "@workday/canvas-kit-react": "^13.2.32",
51
+ "@workday/canvas-kit-styling": "^13.2.32",
52
52
  "@workday/canvas-system-icons-web": "^3.0.35",
53
53
  "@workday/canvas-tokens-web": "^2.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": "7ed50ae3f05aa9c49247b663a451ea65f1b682a2"
64
+ "gitHead": "c333ac191f8f3678cdc813f10fa91787b3a05fe9"
65
65
  }