@workday/canvas-kit-docs 14.0.0-alpha.1251-next.0 → 14.0.0-alpha.1252-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.
@@ -193551,9 +193551,204 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
193551
193551
  ],
193552
193552
  "members": [],
193553
193553
  "returnType": {
193554
- "kind": "symbol",
193555
- "name": "CompatibleCSSObject",
193556
- "value": "CompatibleCSSObject"
193554
+ "kind": "union",
193555
+ "value": [
193556
+ {
193557
+ "kind": "object",
193558
+ "properties": [
193559
+ {
193560
+ "kind": "property",
193561
+ "name": "borderColor",
193562
+ "required": false,
193563
+ "type": {
193564
+ "kind": "primitive",
193565
+ "value": "undefined"
193566
+ },
193567
+ "description": "",
193568
+ "tags": {},
193569
+ "declarations": []
193570
+ },
193571
+ {
193572
+ "kind": "property",
193573
+ "name": "transition",
193574
+ "required": false,
193575
+ "type": {
193576
+ "kind": "primitive",
193577
+ "value": "undefined"
193578
+ },
193579
+ "description": "",
193580
+ "tags": {},
193581
+ "declarations": []
193582
+ },
193583
+ {
193584
+ "kind": "property",
193585
+ "name": "boxShadow",
193586
+ "required": false,
193587
+ "type": {
193588
+ "kind": "primitive",
193589
+ "value": "undefined"
193590
+ },
193591
+ "description": "",
193592
+ "tags": {},
193593
+ "declarations": []
193594
+ },
193595
+ {
193596
+ "kind": "property",
193597
+ "name": "&:hover, &:disabled, &.hover, &.disabled",
193598
+ "required": false,
193599
+ "type": {
193600
+ "kind": "primitive",
193601
+ "value": "undefined"
193602
+ },
193603
+ "description": "",
193604
+ "tags": {},
193605
+ "declarations": []
193606
+ },
193607
+ {
193608
+ "kind": "property",
193609
+ "name": "&:focus-visible:not([disabled]), &.focus:not([disabled])",
193610
+ "required": false,
193611
+ "type": {
193612
+ "kind": "primitive",
193613
+ "value": "undefined"
193614
+ },
193615
+ "description": "",
193616
+ "tags": {},
193617
+ "declarations": []
193618
+ }
193619
+ ]
193620
+ },
193621
+ {
193622
+ "kind": "object",
193623
+ "properties": [
193624
+ {
193625
+ "kind": "property",
193626
+ "name": "borderColor",
193627
+ "required": true,
193628
+ "type": {
193629
+ "kind": "union",
193630
+ "value": [
193631
+ {
193632
+ "kind": "primitive",
193633
+ "value": "string"
193634
+ },
193635
+ {
193636
+ "kind": "primitive",
193637
+ "value": "undefined"
193638
+ }
193639
+ ]
193640
+ },
193641
+ "description": "",
193642
+ "tags": {},
193643
+ "declarations": []
193644
+ },
193645
+ {
193646
+ "kind": "property",
193647
+ "name": "transition",
193648
+ "required": true,
193649
+ "type": {
193650
+ "kind": "primitive",
193651
+ "value": "string"
193652
+ },
193653
+ "description": "",
193654
+ "tags": {},
193655
+ "declarations": []
193656
+ },
193657
+ {
193658
+ "kind": "property",
193659
+ "name": "boxShadow",
193660
+ "required": true,
193661
+ "type": {
193662
+ "kind": "primitive",
193663
+ "value": "string"
193664
+ },
193665
+ "description": "",
193666
+ "tags": {},
193667
+ "declarations": []
193668
+ },
193669
+ {
193670
+ "kind": "property",
193671
+ "name": "&:hover, &:disabled, &.hover, &.disabled",
193672
+ "required": true,
193673
+ "type": {
193674
+ "kind": "object",
193675
+ "properties": [
193676
+ {
193677
+ "kind": "property",
193678
+ "name": "borderColor",
193679
+ "required": true,
193680
+ "type": {
193681
+ "kind": "union",
193682
+ "value": [
193683
+ {
193684
+ "kind": "primitive",
193685
+ "value": "string"
193686
+ },
193687
+ {
193688
+ "kind": "primitive",
193689
+ "value": "undefined"
193690
+ }
193691
+ ]
193692
+ },
193693
+ "description": "",
193694
+ "tags": {},
193695
+ "declarations": []
193696
+ }
193697
+ ]
193698
+ },
193699
+ "description": "",
193700
+ "tags": {},
193701
+ "declarations": []
193702
+ },
193703
+ {
193704
+ "kind": "property",
193705
+ "name": "&:focus-visible:not([disabled]), &.focus:not([disabled])",
193706
+ "required": true,
193707
+ "type": {
193708
+ "kind": "object",
193709
+ "properties": [
193710
+ {
193711
+ "kind": "property",
193712
+ "name": "borderColor",
193713
+ "required": true,
193714
+ "type": {
193715
+ "kind": "union",
193716
+ "value": [
193717
+ {
193718
+ "kind": "primitive",
193719
+ "value": "string"
193720
+ },
193721
+ {
193722
+ "kind": "primitive",
193723
+ "value": "undefined"
193724
+ }
193725
+ ]
193726
+ },
193727
+ "description": "",
193728
+ "tags": {},
193729
+ "declarations": []
193730
+ },
193731
+ {
193732
+ "kind": "property",
193733
+ "name": "boxShadow",
193734
+ "required": true,
193735
+ "type": {
193736
+ "kind": "primitive",
193737
+ "value": "string"
193738
+ },
193739
+ "description": "",
193740
+ "tags": {},
193741
+ "declarations": []
193742
+ }
193743
+ ]
193744
+ },
193745
+ "description": "",
193746
+ "tags": {},
193747
+ "declarations": []
193748
+ }
193749
+ ]
193750
+ }
193751
+ ]
193557
193752
  }
193558
193753
  }
193559
193754
  },
@@ -193706,24 +193901,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
193706
193901
  }
193707
193902
  ],
193708
193903
  "tags": {}
193709
- },
193710
- {
193711
- "kind": "parameter",
193712
- "name": "theme",
193713
- "type": {
193714
- "kind": "primitive",
193715
- "value": "any"
193716
- },
193717
- "required": false,
193718
- "rest": false,
193719
- "description": "",
193720
- "declarations": [
193721
- {
193722
- "name": "theme",
193723
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/focusRing.ts"
193724
- }
193725
- ],
193726
- "tags": {}
193727
193904
  }
193728
193905
  ],
193729
193906
  "members": [],
@@ -4,6 +4,13 @@ This guide contains an overview of the changes in Canvas Kit v14. Please
4
4
  [reach out](https://github.com/Workday/canvas-kit/issues/new?labels=bug&template=bug.md) if you have
5
5
  any questions.
6
6
 
7
+ ## Why You Should Upgrade
8
+
9
+ v14.0 Introduces Workday's new brand direction which includes a new color palette and with it, some
10
+ styling updates to our components.
11
+
12
+ > **Note:** v14.0 requires an upgrade to the `@workday/canvas-tokens-web` package to `@v3.0.0`.
13
+
7
14
  ## Table of contents
8
15
 
9
16
  - [Codemod](#codemod)
@@ -13,13 +20,13 @@ any questions.
13
20
  - [Theming](#theming)
14
21
  - [Canvas Provider](#canvas-provider-)
15
22
  - [Component Updates](#component-updates)
16
- - [Avatar in Preview](#avatar-in-preview)
17
- - [Branding Changes](#branding-changes)
23
+ - [Avatar Preview](#avatar-preview)
24
+ - [Branding Changes](#branding-changes-)
18
25
  - [Buttons](#buttons)
19
- - [Card](#card)
26
+ - [Card](#card-)
20
27
  - [Count Badge](#count-badge)
21
28
  - [Expandable](#expandable)
22
- - [Hyperlink & ExternalHyperlink](#hyperlink-and-externalhyperlink)
29
+ - [Hyperlink and ExternalHyperlink](#hyperlink-and-external-hyperlink)
23
30
  - [Loading Dots](#loading-dots)
24
31
  - [Pill](#pill)
25
32
  - [SearchForm](#search-form)
@@ -36,7 +43,7 @@ any questions.
36
43
  - [Deprecated Buttons](#deprecated-buttons)
37
44
  - [Input Provider](#input-provider)
38
45
  - [Menu (preview)](#menu-preview)
39
- - [readyOnlyPillStencil and removeablePillStencil](readyOnlyPillStencil-and-removeablePillStencil)
46
+ - [readyOnlyPillStencil and removeablePillStencil](#readyOnlyPillStencil-and-removeablePillStencil)
40
47
  - [Text Area](#text-area)
41
48
  - [Text Input](#text-input)
42
49
  - [Troubleshooting](#troubleshooting)
@@ -275,7 +282,7 @@ specificity.
275
282
 
276
283
  ## Component Updates
277
284
 
278
- ### Avatar in Preview
285
+ ### Avatar (Preview)
279
286
 
280
287
  **PR:** [#3430](https://github.com/Workday/canvas-kit/pull/3430)
281
288
 
@@ -329,13 +336,16 @@ import { Avatar } from '@workday/canvas-kit-preview-react/avatar';
329
336
  ### Branding Changes 💅
330
337
 
331
338
  Several components have been refactored to reflect our new brand direction. Most of these changes
332
- revolve around the use of our new brand colors.
339
+ revolve around the use of our new brand colors. For a better guide on what has changed in our v3.0.0
340
+ tokens, please view the Tokens v3.0.0
341
+ [Upgrade Guide](https://workday.github.io/canvas-tokens/?path=/docs/guides-upgrade-guides-v3-overview--docs).
342
+
343
+ > **Note:** If you want a visual diff of the changes, please view the [Visual Changes](https://workday.github.io/canvas-kit/?path=/docs/guides-upgrade-guides-v14-0-visual-changes--docs) guide.
333
344
 
334
345
  The following components have been updated:
335
346
 
336
- - `Breadcrumbs`
337
- - [#3270](https://github.com/Workday/canvas-kit/pull/3270)
338
- - [#3447](https://github.com/Workday/canvas-kit/pull/3447)
347
+ - `Breadcrumbs` [#3270](https://github.com/Workday/canvas-kit/pull/3270),
348
+ [#3447](https://github.com/Workday/canvas-kit/pull/3447)
339
349
  - `Buttons` [#3394](https://github.com/Workday/canvas-kit/pull/3394)
340
350
  - `ColorPicker` (Main) [#3307](https://github.com/Workday/canvas-kit/pull/3307)
341
351
  - `ColorPicker` (preview) [#3307](https://github.com/Workday/canvas-kit/pull/3307)
@@ -357,6 +367,14 @@ The `TertiaryButton` component no longer supports the `isThemable` prop. To cust
357
367
  of `TertiaryButton`, use the `cs` prop for custom styles or the `colors` prop for palette-based
358
368
  color overrides.
359
369
 
370
+ **After in v14**
371
+
372
+ ```tsx
373
+ <TertiaryButton cs={{[buttonStencil.vars.background: 'red']}}>
374
+ Click Me
375
+ </TertiaryButton>
376
+ ```
377
+
360
378
  The shape of `TertiaryButton` has changed to have rounded corners, aligning with other buttons and
361
379
  our new brand direction.
362
380
 
@@ -372,10 +390,10 @@ visual hierarchy and more flexible styling options. The following changes have b
372
390
 
373
391
  #### Default Card No Longer Has Shadow
374
392
 
375
- The default `Card` variant no longer includes a shadow, creating a cleaner, flatter appearance that
376
- aligns with our new brand's emphasis on simplicity and clarity. This is a **visual breaking change**
377
- that may affect your application's visual hierarchy. If your design requires shadow you can added
378
- through `cs` prop.
393
+ The default `Card` variant no longer includes a box shadow, creating a cleaner, flatter appearance
394
+ that aligns with our new brand's emphasis on simplicity and clarity. This is a **visual breaking
395
+ change** that may affect your application's visual hierarchy. If your design requires a shadow you
396
+ can add it through `cs` prop.
379
397
 
380
398
  **Before in v13**
381
399
 
@@ -386,13 +404,15 @@ through `cs` prop.
386
404
  </Card>
387
405
  ```
388
406
 
389
- **After in v14**
407
+ **After in v14** Only do this if you need a shadow. Otherwise, adhere to the default styling.
390
408
 
391
409
  ```tsx
410
+ import {system} from '@workday/canvas-tokens-web';
411
+
392
412
  <Card cs={{boxShadow: system.depth[1]}}>
393
413
  <Card.Heading>Card Title</Card.Heading>
394
414
  <Card.Body>Card content with shadow</Card.Body>
395
- </Card>
415
+ </Card>;
396
416
  ```
397
417
 
398
418
  #### New Card Variants
@@ -407,7 +427,7 @@ We've added two new variants to provide more styling flexibility:
407
427
  The `variant` prop is optional - if no variant is specified, the card will use the default styling.
408
428
 
409
429
  ```tsx
410
- // Default card (no variant prop needed)
430
+ // Default card (no variant prop needed) with a border and no box shadow
411
431
  <Card>
412
432
  <Card.Heading>Default Card</Card.Heading>
413
433
  <Card.Body>Default styling with borders, no shadow</Card.Body>
@@ -428,11 +448,11 @@ The `variant` prop is optional - if no variant is specified, the card will use t
428
448
 
429
449
  #### Gap Instead of Margins
430
450
 
431
- We've replaced the individual margins on `Card.Heading` and `Card.Body` with a `gap` prop on the
432
- card container. The card now uses `display: flex` with `flex-direction: column` by default, and the
433
- `gap` prop provides consistent spacing between all direct children. This provides more consistent
434
- spacing and better control over the layout. This is a **visual breaking change** that may affect the
435
- spacing between card elements.
451
+ We've replaced the individual margins on `Card.Heading` and `Card.Body` with `gap`. The card now
452
+ uses `display: flex` with `flex-direction: column` by default, and the `gap` prop provides
453
+ consistent spacing between all direct children. This provides more consistent spacing and better
454
+ control over the layout. This is a **visual breaking change** that may affect the spacing between
455
+ card elements.
436
456
 
437
457
  **Before in v13**
438
458
 
@@ -465,7 +485,7 @@ emphasis for the badge.
465
485
 
466
486
  ```tsx
467
487
  <CountBadge /> // Default count badge with high emphasis
468
- <CountBadge variant="inverse" /> // Inverse default count badge
488
+ <CountBadge variant="inverse" /> // Inverse default count badge to use on dark backgrounds
469
489
  // new
470
490
  <CountBadge emphasis="low" /> // Default count badge with low emphasis
471
491
  <CountBadge variant="inverse" emphasis="low" /> // Inverse count badge with low emphasis
@@ -485,8 +505,6 @@ emphasis for the badge.
485
505
 
486
506
  > 🤖 The codemod will handle the change of `altText` to `name` on `Expandable.Avatar`.
487
507
 
488
- These changes are only **visual** and should not affect the functionality of the component.
489
-
490
508
  ### Hyperlink and External Hyperlink
491
509
 
492
510
  **PR:** [#3390](https://github.com/Workday/canvas-kit/pull/3390)
@@ -494,7 +512,7 @@ These changes are only **visual** and should not affect the functionality of the
494
512
  - `Hyperlink` and `ExternalHyperlink` now have a `standalone` and `standaloneInverse` variant. This
495
513
  removes the underline text decoration for use outside the context of body text.
496
514
 
497
- **HyperLink and ExternalHyperlink in v14**
515
+ **In v14**
498
516
 
499
517
  ```tsx
500
518
  <Hyperlink variant="standalone" href="#hyperlink">Hyperlink</Hyperlink>
@@ -510,16 +528,19 @@ These changes are only **visual** and should not affect the functionality of the
510
528
 
511
529
  **PR:** [#3393](https://github.com/Workday/canvas-kit/pull/3393)
512
530
 
513
- - We've updated the colors to match brand refresh. The default color changes from
531
+ - We've updated the colors to match our brand refresh. The default color changes from
514
532
  `system.color.bg.alt.strong` to `system.color.bg.muted.strong`.
515
533
  - `LoadingDots` now has a `inverse` variant. Use this variant when the Loading Dots are on a dark
516
534
  background or image.
517
535
 
536
+ **After in v14**
537
+
518
538
  ```tsx
539
+ // Use inverse variant when the Loading Dots are on a dark background or image
519
540
  <LoadingDots variant="inverse" />
520
541
  ```
521
542
 
522
- ### Pill
543
+ ### Pill (Preview)
523
544
 
524
545
  **PRs:** [#3430](https://github.com/Workday/canvas-kit/pull/3430),
525
546
  [#3446](https://github.com/Workday/canvas-kit/pull/3446)
@@ -0,0 +1,44 @@
1
+ import {Graphic} from '@workday/canvas-kit-react/icon';
2
+
3
+ import avatarImage from './images/v14-avatar.png';
4
+ import breadcrumbsImage from './images/v14-breadcrumbs.png';
5
+ import cardImage from './images/v14-card.png';
6
+ import checkboxImage from './images/v14-checkbox.png';
7
+ import countBadgeImage from './images/v14-count-badge.png';
8
+ import expandableImage from './images/v14-expandable.png';
9
+ import infoHighlightImage from './images/v14-info-highlight.png';
10
+ import loadingDotsImage from './images/v14-loading-dots.png';
11
+ import pillImage from './images/v14-pill.png';
12
+ import primaryButtonImage from './images/v14-primary-button.png';
13
+ import radioImage from './images/v14-radio.png';
14
+ import secondaryButtonImage from './images/v14-secondary-button.png';
15
+ import selectImage from './images/v14-select.png';
16
+ import statusIndicatorImage from './images/v14-status-indicator-preview.png';
17
+ import tabsImage from './images/v14-tabs.png';
18
+ import tertiaryButtonImage from './images/v14-tertiary-button.png';
19
+ import textAreaImage from './images/v14-text-area.png';
20
+ import textInputImage from './images/v14-text-input.png';
21
+
22
+
23
+ # Canvas Kit 14.0 Visual Changes
24
+
25
+ This guide contains an overview of the changes in Canvas Kit v14. If you have any issues, feel free to report them [here](https://github.com/Workday/canvas-kit/issues). For a mode detailed overview of the changes in v14, please view our [v14 Upgrade Guide](https://workday.github.io/canvas-kit/?path=/docs/guides-upgrade-guides-v14-0-overview--docs).
26
+
27
+ <Graphic src={{url: avatarImage}} />
28
+ <Graphic src={{url: breadcrumbsImage}} />
29
+ <Graphic src={{url: cardImage}} />
30
+ <Graphic src={{url: checkboxImage}} />
31
+ <Graphic src={{url: countBadgeImage}} />
32
+ <Graphic src={{url: expandableImage}} />
33
+ <Graphic src={{url: infoHighlightImage}} />
34
+ <Graphic src={{url: loadingDotsImage}} />
35
+ <Graphic src={{url: pillImage}} />
36
+ <Graphic src={{url: primaryButtonImage}} />
37
+ <Graphic src={{url: radioImage}} />
38
+ <Graphic src={{url: secondaryButtonImage}} />
39
+ <Graphic src={{url: selectImage}} />
40
+ <Graphic src={{url: statusIndicatorImage}} />
41
+ <Graphic src={{url: tabsImage}} />
42
+ <Graphic src={{url: tertiaryButtonImage}} />
43
+ <Graphic src={{url: textAreaImage}} />
44
+ <Graphic src={{url: textInputImage}} />
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workday/canvas-kit-docs",
3
- "version": "14.0.0-alpha.1251-next.0",
3
+ "version": "14.0.0-alpha.1252-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.1251-next.0",
49
- "@workday/canvas-kit-preview-react": "^14.0.0-alpha.1251-next.0",
50
- "@workday/canvas-kit-react": "^14.0.0-alpha.1251-next.0",
51
- "@workday/canvas-kit-styling": "^14.0.0-alpha.1251-next.0",
48
+ "@workday/canvas-kit-labs-react": "^14.0.0-alpha.1252-next.0",
49
+ "@workday/canvas-kit-preview-react": "^14.0.0-alpha.1252-next.0",
50
+ "@workday/canvas-kit-react": "^14.0.0-alpha.1252-next.0",
51
+ "@workday/canvas-kit-styling": "^14.0.0-alpha.1252-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": "74f6a6aa07c8b1689b37208aed829b22b162acf0"
64
+ "gitHead": "80e4dc6c529068c00bce5b14c625ea69a6ee63c2"
65
65
  }