@workday/canvas-kit-docs 13.2.23 → 13.2.25
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
|
@@ -340930,327 +340930,19 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
340930
340930
|
}
|
|
340931
340931
|
},
|
|
340932
340932
|
{
|
|
340933
|
-
"name": "
|
|
340933
|
+
"name": "TabsMenuPopperProps",
|
|
340934
340934
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsMenuPopper.tsx",
|
|
340935
340935
|
"description": "",
|
|
340936
340936
|
"declarations": [
|
|
340937
340937
|
{
|
|
340938
|
-
"name": "
|
|
340938
|
+
"name": "TabsMenuPopperProps",
|
|
340939
340939
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsMenuPopper.tsx"
|
|
340940
340940
|
}
|
|
340941
340941
|
],
|
|
340942
340942
|
"tags": {},
|
|
340943
340943
|
"type": {
|
|
340944
|
-
"kind": "
|
|
340945
|
-
"
|
|
340946
|
-
{
|
|
340947
|
-
"kind": "property",
|
|
340948
|
-
"name": "anchorElement",
|
|
340949
|
-
"required": false,
|
|
340950
|
-
"type": {
|
|
340951
|
-
"kind": "union",
|
|
340952
|
-
"value": [
|
|
340953
|
-
{
|
|
340954
|
-
"kind": "symbol",
|
|
340955
|
-
"name": "React.RefObject",
|
|
340956
|
-
"typeParameters": [
|
|
340957
|
-
{
|
|
340958
|
-
"kind": "external",
|
|
340959
|
-
"name": "Element",
|
|
340960
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
340961
|
-
}
|
|
340962
|
-
],
|
|
340963
|
-
"value": "RefObject<T>"
|
|
340964
|
-
},
|
|
340965
|
-
{
|
|
340966
|
-
"kind": "external",
|
|
340967
|
-
"name": "Element",
|
|
340968
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
340969
|
-
},
|
|
340970
|
-
{
|
|
340971
|
-
"kind": "primitive",
|
|
340972
|
-
"value": "null"
|
|
340973
|
-
}
|
|
340974
|
-
]
|
|
340975
|
-
},
|
|
340976
|
-
"description": "The reference element used to position the Popper. Popper content will try to follow the\n`anchorElement` if it moves and will reposition itself if there is no longer room in the\nwindow.",
|
|
340977
|
-
"declarations": [
|
|
340978
|
-
{
|
|
340979
|
-
"name": "anchorElement",
|
|
340980
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
340981
|
-
}
|
|
340982
|
-
],
|
|
340983
|
-
"tags": {}
|
|
340984
|
-
},
|
|
340985
|
-
{
|
|
340986
|
-
"kind": "property",
|
|
340987
|
-
"name": "children",
|
|
340988
|
-
"required": true,
|
|
340989
|
-
"type": {
|
|
340990
|
-
"kind": "union",
|
|
340991
|
-
"value": [
|
|
340992
|
-
{
|
|
340993
|
-
"kind": "parenthesis",
|
|
340994
|
-
"value": {
|
|
340995
|
-
"kind": "function",
|
|
340996
|
-
"parameters": [
|
|
340997
|
-
{
|
|
340998
|
-
"kind": "parameter",
|
|
340999
|
-
"name": "props",
|
|
341000
|
-
"type": {
|
|
341001
|
-
"kind": "object",
|
|
341002
|
-
"properties": [
|
|
341003
|
-
{
|
|
341004
|
-
"kind": "property",
|
|
341005
|
-
"name": "placement",
|
|
341006
|
-
"required": true,
|
|
341007
|
-
"type": {
|
|
341008
|
-
"kind": "symbol",
|
|
341009
|
-
"name": "Placement",
|
|
341010
|
-
"value": "Placement"
|
|
341011
|
-
},
|
|
341012
|
-
"description": "",
|
|
341013
|
-
"declarations": [
|
|
341014
|
-
{
|
|
341015
|
-
"name": "placement",
|
|
341016
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
341017
|
-
}
|
|
341018
|
-
],
|
|
341019
|
-
"tags": {}
|
|
341020
|
-
}
|
|
341021
|
-
]
|
|
341022
|
-
},
|
|
341023
|
-
"required": true,
|
|
341024
|
-
"rest": false,
|
|
341025
|
-
"description": "",
|
|
341026
|
-
"declarations": [
|
|
341027
|
-
{
|
|
341028
|
-
"name": "props",
|
|
341029
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
341030
|
-
}
|
|
341031
|
-
],
|
|
341032
|
-
"tags": {}
|
|
341033
|
-
}
|
|
341034
|
-
],
|
|
341035
|
-
"members": [],
|
|
341036
|
-
"returnType": {
|
|
341037
|
-
"kind": "external",
|
|
341038
|
-
"name": "ReactNode",
|
|
341039
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
341040
|
-
}
|
|
341041
|
-
}
|
|
341042
|
-
},
|
|
341043
|
-
{
|
|
341044
|
-
"kind": "external",
|
|
341045
|
-
"name": "ReactNode",
|
|
341046
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
341047
|
-
}
|
|
341048
|
-
]
|
|
341049
|
-
},
|
|
341050
|
-
"description": "The content of the Popper. If a function is provided, it will be treated as a Render Prop and\npass the `placement` chosen by PopperJS. This `placement` value is useful if your popup needs\nto animate and that animation depends on the direction of the content in relation to the\n`anchorElement`.",
|
|
341051
|
-
"declarations": [
|
|
341052
|
-
{
|
|
341053
|
-
"name": "children",
|
|
341054
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
341055
|
-
}
|
|
341056
|
-
],
|
|
341057
|
-
"tags": {}
|
|
341058
|
-
},
|
|
341059
|
-
{
|
|
341060
|
-
"kind": "property",
|
|
341061
|
-
"name": "getAnchorClientRect",
|
|
341062
|
-
"required": false,
|
|
341063
|
-
"type": {
|
|
341064
|
-
"kind": "function",
|
|
341065
|
-
"parameters": [],
|
|
341066
|
-
"members": [],
|
|
341067
|
-
"returnType": {
|
|
341068
|
-
"kind": "symbol",
|
|
341069
|
-
"name": "DOMRect",
|
|
341070
|
-
"value": "DOMRect"
|
|
341071
|
-
}
|
|
341072
|
-
},
|
|
341073
|
-
"description": "When provided, this optional callback will be used to determine positioning for the Popper element\ninstead of calling `getBoundingClientRect` on the `anchorElement` prop. Use this when you need\ncomplete control over positioning. When this prop is specified, it is safe to pass `null` into the\n`anchorElement` prop. If `null` is passed into the `anchorElement` prop, an `owner` will not be\nprovided for the `PopupStack`.",
|
|
341074
|
-
"declarations": [
|
|
341075
|
-
{
|
|
341076
|
-
"name": "getAnchorClientRect",
|
|
341077
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
341078
|
-
}
|
|
341079
|
-
],
|
|
341080
|
-
"tags": {}
|
|
341081
|
-
},
|
|
341082
|
-
{
|
|
341083
|
-
"kind": "property",
|
|
341084
|
-
"name": "open",
|
|
341085
|
-
"required": false,
|
|
341086
|
-
"type": {
|
|
341087
|
-
"kind": "primitive",
|
|
341088
|
-
"value": "boolean"
|
|
341089
|
-
},
|
|
341090
|
-
"description": "Determines if `Popper` content should be rendered. The content only exists in the DOM when\n`open` is `true`",
|
|
341091
|
-
"declarations": [
|
|
341092
|
-
{
|
|
341093
|
-
"name": "open",
|
|
341094
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
341095
|
-
}
|
|
341096
|
-
],
|
|
341097
|
-
"tags": {
|
|
341098
|
-
"default": "true"
|
|
341099
|
-
}
|
|
341100
|
-
},
|
|
341101
|
-
{
|
|
341102
|
-
"kind": "property",
|
|
341103
|
-
"name": "placement",
|
|
341104
|
-
"required": false,
|
|
341105
|
-
"type": {
|
|
341106
|
-
"kind": "symbol",
|
|
341107
|
-
"name": "Placement",
|
|
341108
|
-
"value": "Placement"
|
|
341109
|
-
},
|
|
341110
|
-
"description": "The placement of the `Popper` contents relative to the `anchorElement`. Accepts `auto`, `top`,\n`right`, `bottom`, or `left`. Each placement can also be modified using any of the following\nvariations: `-start` or `-end`.",
|
|
341111
|
-
"declarations": [
|
|
341112
|
-
{
|
|
341113
|
-
"name": "placement",
|
|
341114
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
341115
|
-
}
|
|
341116
|
-
],
|
|
341117
|
-
"tags": {
|
|
341118
|
-
"default": "bottom"
|
|
341119
|
-
}
|
|
341120
|
-
},
|
|
341121
|
-
{
|
|
341122
|
-
"kind": "property",
|
|
341123
|
-
"name": "fallbackPlacements",
|
|
341124
|
-
"required": false,
|
|
341125
|
-
"type": {
|
|
341126
|
-
"kind": "array",
|
|
341127
|
-
"value": {
|
|
341128
|
-
"kind": "symbol",
|
|
341129
|
-
"name": "Placement",
|
|
341130
|
-
"value": "Placement"
|
|
341131
|
-
}
|
|
341132
|
-
},
|
|
341133
|
-
"description": "Define fallback placements by providing a list of {@link Placement} in array (in order of preference).\nThe default preference is following the order of `top`, `right`, `bottom`, and `left`. Once the initial\nand opposite placements are not available, the fallback placements will be in use. Use an empty array to\ndisable the fallback placements.",
|
|
341134
|
-
"declarations": [
|
|
341135
|
-
{
|
|
341136
|
-
"name": "fallbackPlacements",
|
|
341137
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
341138
|
-
}
|
|
341139
|
-
],
|
|
341140
|
-
"tags": {}
|
|
341141
|
-
},
|
|
341142
|
-
{
|
|
341143
|
-
"kind": "property",
|
|
341144
|
-
"name": "onPlacementChange",
|
|
341145
|
-
"required": false,
|
|
341146
|
-
"type": {
|
|
341147
|
-
"kind": "function",
|
|
341148
|
-
"parameters": [
|
|
341149
|
-
{
|
|
341150
|
-
"kind": "parameter",
|
|
341151
|
-
"name": "placement",
|
|
341152
|
-
"type": {
|
|
341153
|
-
"kind": "symbol",
|
|
341154
|
-
"name": "Placement",
|
|
341155
|
-
"value": "Placement"
|
|
341156
|
-
},
|
|
341157
|
-
"required": true,
|
|
341158
|
-
"rest": false,
|
|
341159
|
-
"description": "",
|
|
341160
|
-
"declarations": [
|
|
341161
|
-
{
|
|
341162
|
-
"name": "placement",
|
|
341163
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
341164
|
-
}
|
|
341165
|
-
],
|
|
341166
|
-
"tags": {}
|
|
341167
|
-
}
|
|
341168
|
-
],
|
|
341169
|
-
"members": [],
|
|
341170
|
-
"returnType": {
|
|
341171
|
-
"kind": "primitive",
|
|
341172
|
-
"value": "void"
|
|
341173
|
-
}
|
|
341174
|
-
},
|
|
341175
|
-
"description": "A callback function that will be called whenever PopperJS chooses a placement that is different\nfrom the provided `placement` preference. If a `placement` preference doesn't fit, PopperJS\nwill choose a new one and call this callback.",
|
|
341176
|
-
"declarations": [
|
|
341177
|
-
{
|
|
341178
|
-
"name": "onPlacementChange",
|
|
341179
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
341180
|
-
}
|
|
341181
|
-
],
|
|
341182
|
-
"tags": {}
|
|
341183
|
-
},
|
|
341184
|
-
{
|
|
341185
|
-
"kind": "property",
|
|
341186
|
-
"name": "popperOptions",
|
|
341187
|
-
"required": false,
|
|
341188
|
-
"type": {
|
|
341189
|
-
"kind": "symbol",
|
|
341190
|
-
"name": "Partial",
|
|
341191
|
-
"typeParameters": [
|
|
341192
|
-
{
|
|
341193
|
-
"kind": "external",
|
|
341194
|
-
"name": "PopperOptions",
|
|
341195
|
-
"url": "https://popper.js.org/docs/v2/constructors/#options"
|
|
341196
|
-
}
|
|
341197
|
-
],
|
|
341198
|
-
"value": "Partial<T>"
|
|
341199
|
-
},
|
|
341200
|
-
"description": "The additional options passed to the Popper's `popper.js` instance.",
|
|
341201
|
-
"declarations": [
|
|
341202
|
-
{
|
|
341203
|
-
"name": "popperOptions",
|
|
341204
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
341205
|
-
}
|
|
341206
|
-
],
|
|
341207
|
-
"tags": {}
|
|
341208
|
-
},
|
|
341209
|
-
{
|
|
341210
|
-
"kind": "property",
|
|
341211
|
-
"name": "portal",
|
|
341212
|
-
"required": false,
|
|
341213
|
-
"type": {
|
|
341214
|
-
"kind": "primitive",
|
|
341215
|
-
"value": "boolean"
|
|
341216
|
-
},
|
|
341217
|
-
"description": "If false, render the Popper within the\nDOM hierarchy of its parent. A non-portal Popper will constrained by the parent container\noverflows. If you set this to `false`, you may experience issues where you content gets cut off\nby scrollbars or `overflow: hidden`",
|
|
341218
|
-
"declarations": [
|
|
341219
|
-
{
|
|
341220
|
-
"name": "portal",
|
|
341221
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
341222
|
-
}
|
|
341223
|
-
],
|
|
341224
|
-
"tags": {
|
|
341225
|
-
"default": "true"
|
|
341226
|
-
}
|
|
341227
|
-
},
|
|
341228
|
-
{
|
|
341229
|
-
"kind": "property",
|
|
341230
|
-
"name": "popperInstanceRef",
|
|
341231
|
-
"required": false,
|
|
341232
|
-
"type": {
|
|
341233
|
-
"kind": "external",
|
|
341234
|
-
"name": "Ref",
|
|
341235
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
341236
|
-
"typeParameters": [
|
|
341237
|
-
{
|
|
341238
|
-
"kind": "symbol",
|
|
341239
|
-
"name": "Instance",
|
|
341240
|
-
"value": "Instance"
|
|
341241
|
-
}
|
|
341242
|
-
]
|
|
341243
|
-
},
|
|
341244
|
-
"description": "Reference to the PopperJS instance. Useful for making direct method calls on the popper\ninstance like `update`.",
|
|
341245
|
-
"declarations": [
|
|
341246
|
-
{
|
|
341247
|
-
"name": "popperInstanceRef",
|
|
341248
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
|
|
341249
|
-
}
|
|
341250
|
-
],
|
|
341251
|
-
"tags": {}
|
|
341252
|
-
}
|
|
341253
|
-
]
|
|
340944
|
+
"kind": "alias",
|
|
340945
|
+
"name": "TabsMenuPopper"
|
|
341254
340946
|
}
|
|
341255
340947
|
},
|
|
341256
340948
|
{
|
|
@@ -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.25",
|
|
22
|
+
"@workday/canvas-kit-preview-react": "13.2.25",
|
|
23
|
+
"@workday/canvas-kit-react": "13.2.25",
|
|
24
|
+
"@workday/canvas-kit-react-fonts": "^13.2.25",
|
|
25
|
+
"@workday/canvas-kit-styling": "13.2.25",
|
|
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.25",
|
|
22
|
+
"@workday/canvas-kit-preview-react": "13.2.25",
|
|
23
|
+
"@workday/canvas-kit-react": "13.2.25",
|
|
24
|
+
"@workday/canvas-kit-react-fonts": "^13.2.25",
|
|
25
|
+
"@workday/canvas-kit-styling": "13.2.25",
|
|
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.25",
|
|
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.25",
|
|
49
|
+
"@workday/canvas-kit-preview-react": "^13.2.25",
|
|
50
|
+
"@workday/canvas-kit-react": "^13.2.25",
|
|
51
|
+
"@workday/canvas-kit-styling": "^13.2.25",
|
|
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": "2520d74f66a44f7609e4e0c9255e573d688f5404"
|
|
65
65
|
}
|