@workday/canvas-kit-docs 14.0.0-alpha.1229-next.0 → 14.0.0-alpha.1230-next.0

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.
@@ -193951,564 +193951,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
193951
193951
  ]
193952
193952
  }
193953
193953
  },
193954
- {
193955
- "name": "InputProviderProps",
193956
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx",
193957
- "description": "",
193958
- "declarations": [
193959
- {
193960
- "name": "InputProviderProps",
193961
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
193962
- }
193963
- ],
193964
- "tags": {},
193965
- "type": {
193966
- "kind": "alias",
193967
- "name": "InputProvider"
193968
- }
193969
- },
193970
- {
193971
- "name": "InputType",
193972
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx",
193973
- "description": "",
193974
- "declarations": [
193975
- {
193976
- "name": "InputType",
193977
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
193978
- }
193979
- ],
193980
- "tags": {},
193981
- "type": {
193982
- "kind": "object",
193983
- "typeParameters": [],
193984
- "properties": [
193985
- {
193986
- "kind": "property",
193987
- "name": "Initial",
193988
- "type": {
193989
- "kind": "string",
193990
- "value": "initial"
193991
- }
193992
- },
193993
- {
193994
- "kind": "property",
193995
- "name": "Keyboard",
193996
- "type": {
193997
- "kind": "string",
193998
- "value": "keyboard"
193999
- }
194000
- },
194001
- {
194002
- "kind": "property",
194003
- "name": "Mouse",
194004
- "type": {
194005
- "kind": "string",
194006
- "value": "mouse"
194007
- }
194008
- },
194009
- {
194010
- "kind": "property",
194011
- "name": "Pointer",
194012
- "type": {
194013
- "kind": "string",
194014
- "value": "pointer"
194015
- }
194016
- },
194017
- {
194018
- "kind": "property",
194019
- "name": "Touch",
194020
- "type": {
194021
- "kind": "string",
194022
- "value": "touch"
194023
- }
194024
- }
194025
- ],
194026
- "callSignatures": []
194027
- }
194028
- },
194029
- {
194030
- "name": "InputEventType",
194031
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx",
194032
- "description": "",
194033
- "declarations": [
194034
- {
194035
- "name": "InputEventType",
194036
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194037
- }
194038
- ],
194039
- "tags": {},
194040
- "type": {
194041
- "kind": "object",
194042
- "typeParameters": [],
194043
- "properties": [
194044
- {
194045
- "kind": "property",
194046
- "name": "KeyDown",
194047
- "type": {
194048
- "kind": "string",
194049
- "value": "keydown"
194050
- }
194051
- },
194052
- {
194053
- "kind": "property",
194054
- "name": "KeyUp",
194055
- "type": {
194056
- "kind": "string",
194057
- "value": "keyup"
194058
- }
194059
- },
194060
- {
194061
- "kind": "property",
194062
- "name": "MouseDown",
194063
- "type": {
194064
- "kind": "string",
194065
- "value": "mousedown"
194066
- }
194067
- },
194068
- {
194069
- "kind": "property",
194070
- "name": "MouseMove",
194071
- "type": {
194072
- "kind": "string",
194073
- "value": "mousemove"
194074
- }
194075
- },
194076
- {
194077
- "kind": "property",
194078
- "name": "Wheel",
194079
- "type": {
194080
- "kind": "string",
194081
- "value": "wheel"
194082
- }
194083
- },
194084
- {
194085
- "kind": "property",
194086
- "name": "MouseWheel",
194087
- "type": {
194088
- "kind": "string",
194089
- "value": "mousewheel"
194090
- }
194091
- },
194092
- {
194093
- "kind": "property",
194094
- "name": "PointerDown",
194095
- "type": {
194096
- "kind": "string",
194097
- "value": "pointerdown"
194098
- }
194099
- },
194100
- {
194101
- "kind": "property",
194102
- "name": "PointerMove",
194103
- "type": {
194104
- "kind": "string",
194105
- "value": "pointermove"
194106
- }
194107
- },
194108
- {
194109
- "kind": "property",
194110
- "name": "TouchStart",
194111
- "type": {
194112
- "kind": "string",
194113
- "value": "touchstart"
194114
- }
194115
- }
194116
- ],
194117
- "callSignatures": []
194118
- }
194119
- },
194120
- {
194121
- "name": "inputEventMap",
194122
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx",
194123
- "description": "",
194124
- "declarations": [
194125
- {
194126
- "name": "inputEventMap",
194127
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194128
- }
194129
- ],
194130
- "tags": {},
194131
- "type": {
194132
- "kind": "object",
194133
- "properties": [
194134
- {
194135
- "kind": "property",
194136
- "name": "__computed",
194137
- "defaultValue": {
194138
- "kind": "property",
194139
- "name": "Keyboard",
194140
- "type": {
194141
- "kind": "qualifiedName",
194142
- "left": {
194143
- "kind": "symbol",
194144
- "name": "InputType",
194145
- "value": "any"
194146
- },
194147
- "right": {
194148
- "kind": "string",
194149
- "value": "Keyboard"
194150
- }
194151
- }
194152
- },
194153
- "type": {
194154
- "kind": "symbol",
194155
- "name": "InputType",
194156
- "value": "InputType"
194157
- },
194158
- "required": true,
194159
- "description": "",
194160
- "declarations": [
194161
- {
194162
- "name": "__computed",
194163
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194164
- }
194165
- ],
194166
- "tags": {}
194167
- },
194168
- {
194169
- "kind": "property",
194170
- "name": "__computed",
194171
- "defaultValue": {
194172
- "kind": "property",
194173
- "name": "Keyboard",
194174
- "type": {
194175
- "kind": "qualifiedName",
194176
- "left": {
194177
- "kind": "symbol",
194178
- "name": "InputType",
194179
- "value": "any"
194180
- },
194181
- "right": {
194182
- "kind": "string",
194183
- "value": "Keyboard"
194184
- }
194185
- }
194186
- },
194187
- "type": {
194188
- "kind": "symbol",
194189
- "name": "InputType",
194190
- "value": "InputType"
194191
- },
194192
- "required": true,
194193
- "description": "",
194194
- "declarations": [
194195
- {
194196
- "name": "__computed",
194197
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194198
- }
194199
- ],
194200
- "tags": {}
194201
- },
194202
- {
194203
- "kind": "property",
194204
- "name": "__computed",
194205
- "defaultValue": {
194206
- "kind": "property",
194207
- "name": "Mouse",
194208
- "type": {
194209
- "kind": "qualifiedName",
194210
- "left": {
194211
- "kind": "symbol",
194212
- "name": "InputType",
194213
- "value": "any"
194214
- },
194215
- "right": {
194216
- "kind": "string",
194217
- "value": "Mouse"
194218
- }
194219
- }
194220
- },
194221
- "type": {
194222
- "kind": "symbol",
194223
- "name": "InputType",
194224
- "value": "InputType"
194225
- },
194226
- "required": true,
194227
- "description": "",
194228
- "declarations": [
194229
- {
194230
- "name": "__computed",
194231
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194232
- }
194233
- ],
194234
- "tags": {}
194235
- },
194236
- {
194237
- "kind": "property",
194238
- "name": "__computed",
194239
- "defaultValue": {
194240
- "kind": "property",
194241
- "name": "Mouse",
194242
- "type": {
194243
- "kind": "qualifiedName",
194244
- "left": {
194245
- "kind": "symbol",
194246
- "name": "InputType",
194247
- "value": "any"
194248
- },
194249
- "right": {
194250
- "kind": "string",
194251
- "value": "Mouse"
194252
- }
194253
- }
194254
- },
194255
- "type": {
194256
- "kind": "symbol",
194257
- "name": "InputType",
194258
- "value": "InputType"
194259
- },
194260
- "required": true,
194261
- "description": "",
194262
- "declarations": [
194263
- {
194264
- "name": "__computed",
194265
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194266
- }
194267
- ],
194268
- "tags": {}
194269
- },
194270
- {
194271
- "kind": "property",
194272
- "name": "__computed",
194273
- "defaultValue": {
194274
- "kind": "property",
194275
- "name": "Mouse",
194276
- "type": {
194277
- "kind": "qualifiedName",
194278
- "left": {
194279
- "kind": "symbol",
194280
- "name": "InputType",
194281
- "value": "any"
194282
- },
194283
- "right": {
194284
- "kind": "string",
194285
- "value": "Mouse"
194286
- }
194287
- }
194288
- },
194289
- "type": {
194290
- "kind": "symbol",
194291
- "name": "InputType",
194292
- "value": "InputType"
194293
- },
194294
- "required": true,
194295
- "description": "",
194296
- "declarations": [
194297
- {
194298
- "name": "__computed",
194299
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194300
- }
194301
- ],
194302
- "tags": {}
194303
- },
194304
- {
194305
- "kind": "property",
194306
- "name": "__computed",
194307
- "defaultValue": {
194308
- "kind": "property",
194309
- "name": "Mouse",
194310
- "type": {
194311
- "kind": "qualifiedName",
194312
- "left": {
194313
- "kind": "symbol",
194314
- "name": "InputType",
194315
- "value": "any"
194316
- },
194317
- "right": {
194318
- "kind": "string",
194319
- "value": "Mouse"
194320
- }
194321
- }
194322
- },
194323
- "type": {
194324
- "kind": "symbol",
194325
- "name": "InputType",
194326
- "value": "InputType"
194327
- },
194328
- "required": true,
194329
- "description": "",
194330
- "declarations": [
194331
- {
194332
- "name": "__computed",
194333
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194334
- }
194335
- ],
194336
- "tags": {}
194337
- },
194338
- {
194339
- "kind": "property",
194340
- "name": "__computed",
194341
- "defaultValue": {
194342
- "kind": "property",
194343
- "name": "Pointer",
194344
- "type": {
194345
- "kind": "qualifiedName",
194346
- "left": {
194347
- "kind": "symbol",
194348
- "name": "InputType",
194349
- "value": "any"
194350
- },
194351
- "right": {
194352
- "kind": "string",
194353
- "value": "Pointer"
194354
- }
194355
- }
194356
- },
194357
- "type": {
194358
- "kind": "symbol",
194359
- "name": "InputType",
194360
- "value": "InputType"
194361
- },
194362
- "required": true,
194363
- "description": "",
194364
- "declarations": [
194365
- {
194366
- "name": "__computed",
194367
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194368
- }
194369
- ],
194370
- "tags": {}
194371
- },
194372
- {
194373
- "kind": "property",
194374
- "name": "__computed",
194375
- "defaultValue": {
194376
- "kind": "property",
194377
- "name": "Pointer",
194378
- "type": {
194379
- "kind": "qualifiedName",
194380
- "left": {
194381
- "kind": "symbol",
194382
- "name": "InputType",
194383
- "value": "any"
194384
- },
194385
- "right": {
194386
- "kind": "string",
194387
- "value": "Pointer"
194388
- }
194389
- }
194390
- },
194391
- "type": {
194392
- "kind": "symbol",
194393
- "name": "InputType",
194394
- "value": "InputType"
194395
- },
194396
- "required": true,
194397
- "description": "",
194398
- "declarations": [
194399
- {
194400
- "name": "__computed",
194401
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194402
- }
194403
- ],
194404
- "tags": {}
194405
- },
194406
- {
194407
- "kind": "property",
194408
- "name": "__computed",
194409
- "defaultValue": {
194410
- "kind": "property",
194411
- "name": "Touch",
194412
- "type": {
194413
- "kind": "qualifiedName",
194414
- "left": {
194415
- "kind": "symbol",
194416
- "name": "InputType",
194417
- "value": "any"
194418
- },
194419
- "right": {
194420
- "kind": "string",
194421
- "value": "Touch"
194422
- }
194423
- }
194424
- },
194425
- "type": {
194426
- "kind": "symbol",
194427
- "name": "InputType",
194428
- "value": "InputType"
194429
- },
194430
- "required": true,
194431
- "description": "",
194432
- "declarations": [
194433
- {
194434
- "name": "__computed",
194435
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194436
- }
194437
- ],
194438
- "tags": {}
194439
- }
194440
- ]
194441
- }
194442
- },
194443
- {
194444
- "name": "InputProvider",
194445
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx",
194446
- "description": "This component takes heavy inspiration from what-input (https://github.com/ten1seven/what-input)",
194447
- "declarations": [
194448
- {
194449
- "name": "InputProvider",
194450
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194451
- }
194452
- ],
194453
- "tags": {},
194454
- "type": {
194455
- "kind": "component",
194456
- "props": [
194457
- {
194458
- "kind": "property",
194459
- "name": "provideIntent",
194460
- "required": false,
194461
- "type": {
194462
- "kind": "primitive",
194463
- "value": "boolean"
194464
- },
194465
- "description": "",
194466
- "declarations": [
194467
- {
194468
- "name": "provideIntent",
194469
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194470
- }
194471
- ],
194472
- "tags": {}
194473
- },
194474
- {
194475
- "kind": "property",
194476
- "name": "container",
194477
- "required": false,
194478
- "type": {
194479
- "kind": "union",
194480
- "value": [
194481
- {
194482
- "kind": "symbol",
194483
- "name": "HTMLElement",
194484
- "value": "HTMLElement"
194485
- },
194486
- {
194487
- "kind": "symbol",
194488
- "name": "React.RefObject",
194489
- "typeParameters": [
194490
- {
194491
- "kind": "symbol",
194492
- "name": "HTMLElement",
194493
- "value": "HTMLElement"
194494
- }
194495
- ],
194496
- "value": "RefObject<T>"
194497
- }
194498
- ]
194499
- },
194500
- "description": "",
194501
- "declarations": [
194502
- {
194503
- "name": "container",
194504
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
194505
- }
194506
- ],
194507
- "tags": {}
194508
- }
194509
- ]
194510
- }
194511
- },
194512
193954
  {
194513
193955
  "name": "dubLogoPrimary",
194514
193956
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts",
@@ -31,8 +31,9 @@ any questions.
31
31
  - [Tokens](#tokens)
32
32
  - [Removals](#removals)
33
33
  - [Deprecated Buttons](#deprecated-buttons)
34
+ - [Input Provider](#input-provider)
34
35
  - [Menu (preview)](#menu-preview)
35
- - [readyOnlyPillStencil and removeablePillStencil][readyOnlyPillStencil-and-removeablePillStencil]
36
+ - [readyOnlyPillStencil and removeablePillStencil](readyOnlyPillStencil-and-removeablePillStencil)
36
37
  - [Troubleshooting](#troubleshooting)
37
38
  - [Glossary](#glossary)
38
39
  - [Main](#main)
@@ -591,6 +592,28 @@ as a reminder of how far we've come and it part we're thankful for this change.
591
592
  Al though unlikely, but not impossible, if you were using `DeprecatedButton` please use our flexible
592
593
  and themable buttons like `PrimaryButton`, `ScondaryButton` or `TertiaryButton`.
593
594
 
595
+ ### Input Provider
596
+
597
+ We've removed `InputProvider` from our codebase and the `CanvasProvider`. The intent of the provider was to check the users input and apply focus styles accordingly to our components. This was needed when we still supported IE11 to ensure we could be consistent on styling based on user input events. Since dropping support and moving to `:focus-visible`, we no longer need this provider.
598
+ We now allow browser heuristics to determine when an element should receive visual focus styles. For more information, please view the [MDN docs on `:focus-visible`](https://developer.mozilla.org/en-US/docs/Web/CSS/:focus-visible).
599
+
600
+ If you are trying to apply focus styles to our components, we strongly avise to use `:focus-visible` pseudo selector.
601
+
602
+ ```tsx
603
+ import {createStyles} from '@workday/canvas-kit-styling'
604
+ import {PrimaryButton} from '@workday/canvas-kit-react/button'
605
+
606
+ const buttonStyles = createStyles({
607
+ '&:focus-visible': {
608
+ outline: '2px solid red'
609
+ }
610
+ })
611
+
612
+ <PrimaryButton cs={buttonStyles}>
613
+ Click Me
614
+ </PrimaryButton>
615
+ ```
616
+
594
617
  ### Menu (preview)
595
618
 
596
619
  **PR:** [#3353](https://github.com/Workday/canvas-kit/pull/3353)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workday/canvas-kit-docs",
3
- "version": "14.0.0-alpha.1229-next.0",
3
+ "version": "14.0.0-alpha.1230-next.0",
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.0-alpha.1229-next.0",
49
- "@workday/canvas-kit-preview-react": "^14.0.0-alpha.1229-next.0",
50
- "@workday/canvas-kit-react": "^14.0.0-alpha.1229-next.0",
51
- "@workday/canvas-kit-styling": "^14.0.0-alpha.1229-next.0",
48
+ "@workday/canvas-kit-labs-react": "^14.0.0-alpha.1230-next.0",
49
+ "@workday/canvas-kit-preview-react": "^14.0.0-alpha.1230-next.0",
50
+ "@workday/canvas-kit-react": "^14.0.0-alpha.1230-next.0",
51
+ "@workday/canvas-kit-styling": "^14.0.0-alpha.1230-next.0",
52
52
  "@workday/canvas-system-icons-web": "^3.0.35",
53
53
  "@workday/canvas-tokens-web": "3.0.0-alpha.12",
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": "9058e7f2709a2212664672616bf6c8222f3e6eba"
64
+ "gitHead": "8080313203652737f30e578bb2ef8d4225948d6b"
65
65
  }