@workday/canvas-kit-docs 13.2.30 → 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.
package/dist/es6/lib/docs.js
CHANGED
|
@@ -175569,37 +175569,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
175569
175569
|
}
|
|
175570
175570
|
}
|
|
175571
175571
|
},
|
|
175572
|
-
{
|
|
175573
|
-
"name": "CompatibleCSSObject",
|
|
175574
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/focusRing.ts",
|
|
175575
|
-
"description": "",
|
|
175576
|
-
"declarations": [
|
|
175577
|
-
{
|
|
175578
|
-
"name": "CompatibleCSSObject",
|
|
175579
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/focusRing.ts"
|
|
175580
|
-
}
|
|
175581
|
-
],
|
|
175582
|
-
"tags": {},
|
|
175583
|
-
"type": {
|
|
175584
|
-
"kind": "type",
|
|
175585
|
-
"typeParameters": [],
|
|
175586
|
-
"value": {
|
|
175587
|
-
"kind": "intersection",
|
|
175588
|
-
"value": [
|
|
175589
|
-
{
|
|
175590
|
-
"kind": "symbol",
|
|
175591
|
-
"name": "CSSObject",
|
|
175592
|
-
"value": "CSSObject"
|
|
175593
|
-
},
|
|
175594
|
-
{
|
|
175595
|
-
"kind": "symbol",
|
|
175596
|
-
"name": "CSSObjectWithVars",
|
|
175597
|
-
"value": "CSSObjectWithVars"
|
|
175598
|
-
}
|
|
175599
|
-
]
|
|
175600
|
-
}
|
|
175601
|
-
}
|
|
175602
|
-
},
|
|
175603
175572
|
{
|
|
175604
175573
|
"name": "focusRing",
|
|
175605
175574
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/focusRing.ts",
|
|
@@ -175771,9 +175740,25 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
175771
175740
|
],
|
|
175772
175741
|
"members": [],
|
|
175773
175742
|
"returnType": {
|
|
175774
|
-
"kind": "
|
|
175775
|
-
"
|
|
175776
|
-
|
|
175743
|
+
"kind": "object",
|
|
175744
|
+
"properties": [
|
|
175745
|
+
{
|
|
175746
|
+
"kind": "property",
|
|
175747
|
+
"name": "boxShadow",
|
|
175748
|
+
"type": {
|
|
175749
|
+
"kind": "primitive",
|
|
175750
|
+
"value": "string"
|
|
175751
|
+
},
|
|
175752
|
+
"description": "",
|
|
175753
|
+
"declarations": [
|
|
175754
|
+
{
|
|
175755
|
+
"name": "boxShadow",
|
|
175756
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/focusRing.ts"
|
|
175757
|
+
}
|
|
175758
|
+
],
|
|
175759
|
+
"tags": {}
|
|
175760
|
+
}
|
|
175761
|
+
]
|
|
175777
175762
|
}
|
|
175778
175763
|
}
|
|
175779
175764
|
},
|
|
@@ -266206,7 +266191,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
266206
266191
|
{
|
|
266207
266192
|
"name": "useModalModel",
|
|
266208
266193
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/modal/lib/hooks/useModalModel.ts",
|
|
266209
|
-
"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```",
|
|
266210
266195
|
"declarations": [
|
|
266211
266196
|
{
|
|
266212
266197
|
"name": "useModalModel",
|
|
@@ -266344,7 +266329,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
266344
266329
|
{
|
|
266345
266330
|
"name": "ModalModel",
|
|
266346
266331
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/modal/lib/hooks/useModalModel.ts",
|
|
266347
|
-
"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```",
|
|
266348
266333
|
"declarations": [
|
|
266349
266334
|
{
|
|
266350
266335
|
"name": "useModalModel",
|
|
@@ -266688,7 +266673,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
266688
266673
|
{
|
|
266689
266674
|
"name": "ModalModelConfig",
|
|
266690
266675
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/modal/lib/hooks/useModalModel.ts",
|
|
266691
|
-
"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```",
|
|
266692
266677
|
"declarations": [
|
|
266693
266678
|
{
|
|
266694
266679
|
"name": "useModalModel",
|
|
@@ -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.
|
|
22
|
-
"@workday/canvas-kit-preview-react": "13.2.
|
|
23
|
-
"@workday/canvas-kit-react": "13.2.
|
|
24
|
-
"@workday/canvas-kit-react-fonts": "^13.2.
|
|
25
|
-
"@workday/canvas-kit-styling": "13.2.
|
|
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
|
},
|
|
@@ -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.
|
|
22
|
-
"@workday/canvas-kit-preview-react": "13.2.
|
|
23
|
-
"@workday/canvas-kit-react": "13.2.
|
|
24
|
-
"@workday/canvas-kit-react-fonts": "^13.2.
|
|
25
|
-
"@workday/canvas-kit-styling": "13.2.
|
|
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.
|
|
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.
|
|
49
|
-
"@workday/canvas-kit-preview-react": "^13.2.
|
|
50
|
-
"@workday/canvas-kit-react": "^13.2.
|
|
51
|
-
"@workday/canvas-kit-styling": "^13.2.
|
|
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": "
|
|
64
|
+
"gitHead": "c333ac191f8f3678cdc813f10fa91787b3a05fe9"
|
|
65
65
|
}
|