@workday/canvas-kit-docs 13.2.22 → 13.2.24

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.
@@ -1884,6 +1884,22 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
1884
1884
  "value": "SearchThemes"
1885
1885
  }
1886
1886
  },
1887
+ {
1888
+ "name": "version",
1889
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/version.ts",
1890
+ "description": "",
1891
+ "declarations": [
1892
+ {
1893
+ "name": "version",
1894
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/version.ts"
1895
+ }
1896
+ ],
1897
+ "tags": {},
1898
+ "type": {
1899
+ "kind": "primitive",
1900
+ "value": "string"
1901
+ }
1902
+ },
1887
1903
  {
1888
1904
  "name": "PopupStackItem",
1889
1905
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/popup-stack/lib/PopupStack.ts",
@@ -63478,6 +63494,22 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63478
63494
  "model": "TextInputModel"
63479
63495
  }
63480
63496
  },
63497
+ {
63498
+ "name": "version",
63499
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/version.ts",
63500
+ "description": "",
63501
+ "declarations": [
63502
+ {
63503
+ "name": "version",
63504
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/version.ts"
63505
+ }
63506
+ ],
63507
+ "tags": {},
63508
+ "type": {
63509
+ "kind": "primitive",
63510
+ "value": "string"
63511
+ }
63512
+ },
63481
63513
  {
63482
63514
  "name": "fonts",
63483
63515
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react-fonts/lib/fonts.ts",
@@ -340898,327 +340930,19 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
340898
340930
  }
340899
340931
  },
340900
340932
  {
340901
- "name": "MenuPopperProps",
340933
+ "name": "TabsMenuPopperProps",
340902
340934
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsMenuPopper.tsx",
340903
340935
  "description": "",
340904
340936
  "declarations": [
340905
340937
  {
340906
- "name": "MenuPopperProps",
340938
+ "name": "TabsMenuPopperProps",
340907
340939
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsMenuPopper.tsx"
340908
340940
  }
340909
340941
  ],
340910
340942
  "tags": {},
340911
340943
  "type": {
340912
- "kind": "object",
340913
- "properties": [
340914
- {
340915
- "kind": "property",
340916
- "name": "anchorElement",
340917
- "required": false,
340918
- "type": {
340919
- "kind": "union",
340920
- "value": [
340921
- {
340922
- "kind": "symbol",
340923
- "name": "React.RefObject",
340924
- "typeParameters": [
340925
- {
340926
- "kind": "external",
340927
- "name": "Element",
340928
- "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
340929
- }
340930
- ],
340931
- "value": "RefObject<T>"
340932
- },
340933
- {
340934
- "kind": "external",
340935
- "name": "Element",
340936
- "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
340937
- },
340938
- {
340939
- "kind": "primitive",
340940
- "value": "null"
340941
- }
340942
- ]
340943
- },
340944
- "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.",
340945
- "declarations": [
340946
- {
340947
- "name": "anchorElement",
340948
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
340949
- }
340950
- ],
340951
- "tags": {}
340952
- },
340953
- {
340954
- "kind": "property",
340955
- "name": "children",
340956
- "required": true,
340957
- "type": {
340958
- "kind": "union",
340959
- "value": [
340960
- {
340961
- "kind": "parenthesis",
340962
- "value": {
340963
- "kind": "function",
340964
- "parameters": [
340965
- {
340966
- "kind": "parameter",
340967
- "name": "props",
340968
- "type": {
340969
- "kind": "object",
340970
- "properties": [
340971
- {
340972
- "kind": "property",
340973
- "name": "placement",
340974
- "required": true,
340975
- "type": {
340976
- "kind": "symbol",
340977
- "name": "Placement",
340978
- "value": "Placement"
340979
- },
340980
- "description": "",
340981
- "declarations": [
340982
- {
340983
- "name": "placement",
340984
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
340985
- }
340986
- ],
340987
- "tags": {}
340988
- }
340989
- ]
340990
- },
340991
- "required": true,
340992
- "rest": false,
340993
- "description": "",
340994
- "declarations": [
340995
- {
340996
- "name": "props",
340997
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
340998
- }
340999
- ],
341000
- "tags": {}
341001
- }
341002
- ],
341003
- "members": [],
341004
- "returnType": {
341005
- "kind": "external",
341006
- "name": "ReactNode",
341007
- "url": "https://reactjs.org/docs/rendering-elements.html"
341008
- }
341009
- }
341010
- },
341011
- {
341012
- "kind": "external",
341013
- "name": "ReactNode",
341014
- "url": "https://reactjs.org/docs/rendering-elements.html"
341015
- }
341016
- ]
341017
- },
341018
- "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`.",
341019
- "declarations": [
341020
- {
341021
- "name": "children",
341022
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
341023
- }
341024
- ],
341025
- "tags": {}
341026
- },
341027
- {
341028
- "kind": "property",
341029
- "name": "getAnchorClientRect",
341030
- "required": false,
341031
- "type": {
341032
- "kind": "function",
341033
- "parameters": [],
341034
- "members": [],
341035
- "returnType": {
341036
- "kind": "symbol",
341037
- "name": "DOMRect",
341038
- "value": "DOMRect"
341039
- }
341040
- },
341041
- "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`.",
341042
- "declarations": [
341043
- {
341044
- "name": "getAnchorClientRect",
341045
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
341046
- }
341047
- ],
341048
- "tags": {}
341049
- },
341050
- {
341051
- "kind": "property",
341052
- "name": "open",
341053
- "required": false,
341054
- "type": {
341055
- "kind": "primitive",
341056
- "value": "boolean"
341057
- },
341058
- "description": "Determines if `Popper` content should be rendered. The content only exists in the DOM when\n`open` is `true`",
341059
- "declarations": [
341060
- {
341061
- "name": "open",
341062
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
341063
- }
341064
- ],
341065
- "tags": {
341066
- "default": "true"
341067
- }
341068
- },
341069
- {
341070
- "kind": "property",
341071
- "name": "placement",
341072
- "required": false,
341073
- "type": {
341074
- "kind": "symbol",
341075
- "name": "Placement",
341076
- "value": "Placement"
341077
- },
341078
- "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`.",
341079
- "declarations": [
341080
- {
341081
- "name": "placement",
341082
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
341083
- }
341084
- ],
341085
- "tags": {
341086
- "default": "bottom"
341087
- }
341088
- },
341089
- {
341090
- "kind": "property",
341091
- "name": "fallbackPlacements",
341092
- "required": false,
341093
- "type": {
341094
- "kind": "array",
341095
- "value": {
341096
- "kind": "symbol",
341097
- "name": "Placement",
341098
- "value": "Placement"
341099
- }
341100
- },
341101
- "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.",
341102
- "declarations": [
341103
- {
341104
- "name": "fallbackPlacements",
341105
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
341106
- }
341107
- ],
341108
- "tags": {}
341109
- },
341110
- {
341111
- "kind": "property",
341112
- "name": "onPlacementChange",
341113
- "required": false,
341114
- "type": {
341115
- "kind": "function",
341116
- "parameters": [
341117
- {
341118
- "kind": "parameter",
341119
- "name": "placement",
341120
- "type": {
341121
- "kind": "symbol",
341122
- "name": "Placement",
341123
- "value": "Placement"
341124
- },
341125
- "required": true,
341126
- "rest": false,
341127
- "description": "",
341128
- "declarations": [
341129
- {
341130
- "name": "placement",
341131
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
341132
- }
341133
- ],
341134
- "tags": {}
341135
- }
341136
- ],
341137
- "members": [],
341138
- "returnType": {
341139
- "kind": "primitive",
341140
- "value": "void"
341141
- }
341142
- },
341143
- "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.",
341144
- "declarations": [
341145
- {
341146
- "name": "onPlacementChange",
341147
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
341148
- }
341149
- ],
341150
- "tags": {}
341151
- },
341152
- {
341153
- "kind": "property",
341154
- "name": "popperOptions",
341155
- "required": false,
341156
- "type": {
341157
- "kind": "symbol",
341158
- "name": "Partial",
341159
- "typeParameters": [
341160
- {
341161
- "kind": "external",
341162
- "name": "PopperOptions",
341163
- "url": "https://popper.js.org/docs/v2/constructors/#options"
341164
- }
341165
- ],
341166
- "value": "Partial<T>"
341167
- },
341168
- "description": "The additional options passed to the Popper's `popper.js` instance.",
341169
- "declarations": [
341170
- {
341171
- "name": "popperOptions",
341172
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
341173
- }
341174
- ],
341175
- "tags": {}
341176
- },
341177
- {
341178
- "kind": "property",
341179
- "name": "portal",
341180
- "required": false,
341181
- "type": {
341182
- "kind": "primitive",
341183
- "value": "boolean"
341184
- },
341185
- "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`",
341186
- "declarations": [
341187
- {
341188
- "name": "portal",
341189
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
341190
- }
341191
- ],
341192
- "tags": {
341193
- "default": "true"
341194
- }
341195
- },
341196
- {
341197
- "kind": "property",
341198
- "name": "popperInstanceRef",
341199
- "required": false,
341200
- "type": {
341201
- "kind": "external",
341202
- "name": "Ref",
341203
- "url": "https://reactjs.org/docs/refs-and-the-dom.html",
341204
- "typeParameters": [
341205
- {
341206
- "kind": "symbol",
341207
- "name": "Instance",
341208
- "value": "Instance"
341209
- }
341210
- ]
341211
- },
341212
- "description": "Reference to the PopperJS instance. Useful for making direct method calls on the popper\ninstance like `update`.",
341213
- "declarations": [
341214
- {
341215
- "name": "popperInstanceRef",
341216
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/Popper.tsx"
341217
- }
341218
- ],
341219
- "tags": {}
341220
- }
341221
- ]
340944
+ "kind": "alias",
340945
+ "name": "TabsMenuPopper"
341222
340946
  }
341223
340947
  },
341224
340948
  {
@@ -390822,6 +390546,22 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
390822
390546
  }
390823
390547
  }
390824
390548
  },
390549
+ {
390550
+ "name": "version",
390551
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/version.ts",
390552
+ "description": "",
390553
+ "declarations": [
390554
+ {
390555
+ "name": "version",
390556
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/version.ts"
390557
+ }
390558
+ ],
390559
+ "tags": {},
390560
+ "type": {
390561
+ "kind": "primitive",
390562
+ "value": "string"
390563
+ }
390564
+ },
390825
390565
  {
390826
390566
  "name": "createConfig",
390827
390567
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/index.ts",
@@ -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",
22
- "@workday/canvas-kit-preview-react": "13.2.22",
23
- "@workday/canvas-kit-react": "13.2.22",
24
- "@workday/canvas-kit-react-fonts": "^13.2.22",
25
- "@workday/canvas-kit-styling": "13.2.22",
21
+ "@workday/canvas-kit-labs-react": "13.2.24",
22
+ "@workday/canvas-kit-preview-react": "13.2.24",
23
+ "@workday/canvas-kit-react": "13.2.24",
24
+ "@workday/canvas-kit-react-fonts": "^13.2.24",
25
+ "@workday/canvas-kit-styling": "13.2.24",
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",
22
- "@workday/canvas-kit-preview-react": "13.2.22",
23
- "@workday/canvas-kit-react": "13.2.22",
24
- "@workday/canvas-kit-react-fonts": "^13.2.22",
25
- "@workday/canvas-kit-styling": "13.2.22",
21
+ "@workday/canvas-kit-labs-react": "13.2.24",
22
+ "@workday/canvas-kit-preview-react": "13.2.24",
23
+ "@workday/canvas-kit-react": "13.2.24",
24
+ "@workday/canvas-kit-react-fonts": "^13.2.24",
25
+ "@workday/canvas-kit-styling": "13.2.24",
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.22",
3
+ "version": "13.2.24",
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.22",
49
- "@workday/canvas-kit-preview-react": "^13.2.22",
50
- "@workday/canvas-kit-react": "^13.2.22",
51
- "@workday/canvas-kit-styling": "^13.2.22",
48
+ "@workday/canvas-kit-labs-react": "^13.2.24",
49
+ "@workday/canvas-kit-preview-react": "^13.2.24",
50
+ "@workday/canvas-kit-react": "^13.2.24",
51
+ "@workday/canvas-kit-styling": "^13.2.24",
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": "93767f5e6c2993014d350450a892ce2ccf2b99a0"
64
+ "gitHead": "8aa3aafb7182c8a8aeba65995f47edc7f20dbbb6"
65
65
  }