@workday/canvas-kit-docs 11.0.0-alpha.657-next.0 → 11.0.0-alpha.664-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.
Files changed (87) hide show
  1. package/dist/es6/lib/docs.js +818 -324
  2. package/dist/mdx/preview-react/form-field/FormField.mdx +18 -0
  3. package/dist/mdx/preview-react/form-field/examples/AllFields.tsx +12 -12
  4. package/dist/mdx/preview-react/form-field/examples/Grow.tsx +21 -0
  5. package/dist/mdx/preview-react/form-field/examples/ThemedErrors.tsx +36 -0
  6. package/dist/mdx/preview-react/loading-sparkles/LoadingSparkles.mdx +15 -2
  7. package/dist/mdx/preview-react/loading-sparkles/examples/Basic.tsx +59 -1
  8. package/dist/mdx/preview-react/menu/Menu.mdx +10 -1
  9. package/dist/mdx/preview-react/radio/Radio.mdx +2 -5
  10. package/dist/mdx/preview-react/radio/examples/Basic.tsx +11 -4
  11. package/dist/mdx/preview-react/radio/examples/Custom.tsx +11 -4
  12. package/dist/mdx/preview-react/radio/examples/Disabled.tsx +5 -4
  13. package/dist/mdx/preview-react/radio/examples/Error.tsx +1 -1
  14. package/dist/mdx/preview-react/radio/examples/Inverse.tsx +7 -10
  15. package/dist/mdx/preview-react/radio/examples/LabelPosition.tsx +5 -8
  16. package/dist/mdx/preview-react/radio/examples/NoValue.tsx +5 -8
  17. package/dist/mdx/preview-react/radio/examples/RefForwarding.tsx +5 -4
  18. package/dist/mdx/preview-react/radio/examples/Required.tsx +7 -10
  19. package/dist/mdx/preview-react/radio/examples/StandaloneRadio.tsx +7 -4
  20. package/dist/mdx/preview-react/text-area/TextArea.mdx +9 -0
  21. package/dist/mdx/preview-react/text-input/TextInput.mdx +12 -2
  22. package/dist/mdx/react/checkbox/Checkbox.mdx +16 -6
  23. package/dist/mdx/react/checkbox/examples/Alert.tsx +11 -7
  24. package/dist/mdx/react/checkbox/examples/Error.tsx +11 -7
  25. package/dist/mdx/react/checkbox/examples/LabelPosition.tsx +9 -3
  26. package/dist/mdx/react/checkbox/examples/Required.tsx +9 -3
  27. package/dist/mdx/react/color-picker/color-input/ColorInput.mdx +16 -6
  28. package/dist/mdx/react/color-picker/color-input/examples/Alert.tsx +5 -8
  29. package/dist/mdx/react/color-picker/color-input/examples/Basic.tsx +4 -3
  30. package/dist/mdx/react/color-picker/color-input/examples/Checked.tsx +4 -3
  31. package/dist/mdx/react/color-picker/color-input/examples/Disabled.tsx +4 -3
  32. package/dist/mdx/react/color-picker/color-input/examples/Error.tsx +5 -8
  33. package/dist/mdx/react/color-picker/color-input/examples/Grow.tsx +4 -3
  34. package/dist/mdx/react/color-picker/color-input/examples/LabelPosition.tsx +4 -3
  35. package/dist/mdx/react/color-picker/color-input/examples/RefForwarding.tsx +4 -3
  36. package/dist/mdx/react/color-picker/color-input/examples/Required.tsx +4 -3
  37. package/dist/mdx/react/color-picker/color-input/examples/ValidColorChange.tsx +5 -3
  38. package/dist/mdx/react/color-picker/color-preview/ColorPreview.mdx +16 -6
  39. package/dist/mdx/react/color-picker/color-preview/examples/LabelPosition.tsx +4 -3
  40. package/dist/mdx/react/color-picker/color-preview/examples/RefForwarding.tsx +4 -3
  41. package/dist/mdx/react/common/examples/ResponsiveStyles.tsx +4 -3
  42. package/dist/mdx/react/dialog/examples/Basic.tsx +4 -3
  43. package/dist/mdx/react/dialog/examples/Focus.tsx +4 -3
  44. package/dist/mdx/react/form-field/FormField.mdx +9 -0
  45. package/dist/mdx/react/modal/examples/CustomFocus.tsx +9 -3
  46. package/dist/mdx/react/modal/examples/FormModal.tsx +7 -5
  47. package/dist/mdx/react/modal/examples/ReturnFocus.tsx +6 -4
  48. package/dist/mdx/react/radio/Radio.mdx +19 -8
  49. package/dist/mdx/react/radio/examples/Alert.tsx +6 -10
  50. package/dist/mdx/react/radio/examples/Basic.tsx +5 -4
  51. package/dist/mdx/react/radio/examples/Disabled.tsx +5 -4
  52. package/dist/mdx/react/radio/examples/Error.tsx +6 -10
  53. package/dist/mdx/react/radio/examples/LabelPosition.tsx +5 -8
  54. package/dist/mdx/react/radio/examples/NoValue.tsx +5 -4
  55. package/dist/mdx/react/radio/examples/RefForwarding.tsx +5 -4
  56. package/dist/mdx/react/radio/examples/Required.tsx +5 -4
  57. package/dist/mdx/react/select/Select.mdx +16 -7
  58. package/dist/mdx/react/select/examples/Alert.tsx +5 -7
  59. package/dist/mdx/react/select/examples/Basic.tsx +4 -3
  60. package/dist/mdx/react/select/examples/Complex.tsx +4 -3
  61. package/dist/mdx/react/select/examples/Disabled.tsx +4 -3
  62. package/dist/mdx/react/select/examples/DisabledOption.tsx +4 -3
  63. package/dist/mdx/react/select/examples/Error.tsx +5 -7
  64. package/dist/mdx/react/select/examples/Grow.tsx +4 -3
  65. package/dist/mdx/react/select/examples/HoistedModel.tsx +4 -3
  66. package/dist/mdx/react/select/examples/LabelPosition.tsx +4 -3
  67. package/dist/mdx/react/select/examples/MenuHeight.tsx +4 -3
  68. package/dist/mdx/react/select/examples/RefForwarding.tsx +8 -7
  69. package/dist/mdx/react/select/examples/Required.tsx +7 -6
  70. package/dist/mdx/react/select/examples/WithIcons.tsx +11 -6
  71. package/dist/mdx/react/skeleton/examples/Simulation.tsx +7 -5
  72. package/dist/mdx/react/status-indicator/StatusIndicator.mdx +10 -0
  73. package/dist/mdx/react/switch/Switch.mdx +16 -7
  74. package/dist/mdx/react/table/Table.mdx +7 -0
  75. package/dist/mdx/react/text-area/TextArea.mdx +18 -11
  76. package/dist/mdx/react/text-area/examples/Alert.tsx +5 -8
  77. package/dist/mdx/react/text-area/examples/Basic.tsx +4 -3
  78. package/dist/mdx/react/text-area/examples/Disabled.tsx +4 -3
  79. package/dist/mdx/react/text-area/examples/Error.tsx +5 -8
  80. package/dist/mdx/react/text-area/examples/Grow.tsx +4 -3
  81. package/dist/mdx/react/text-area/examples/LabelPosition.tsx +4 -3
  82. package/dist/mdx/react/text-area/examples/Placeholder.tsx +9 -3
  83. package/dist/mdx/react/text-area/examples/RefForwarding.tsx +4 -3
  84. package/dist/mdx/react/text-area/examples/Required.tsx +4 -3
  85. package/dist/mdx/react/text-area/examples/ResizeConstraints.tsx +9 -3
  86. package/dist/mdx/react/text-input/TextInput.mdx +16 -7
  87. package/package.json +6 -6
@@ -5690,7 +5690,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
5690
5690
  {
5691
5691
  "name": "FormField",
5692
5692
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormField.tsx",
5693
- "description": "Use `FormField` to wrap input components to make them accessible. You can customize the field\nby passing in `TextInput`, `Select`, `RadioGroup` and other form elements to `FormField.Input`.\n\n```tsx\n<FormField>\n <FormField.Label>First Name</FormField.Label>\n <FormField.Input as={TextInput} value={value} onChange={(e) => console.log(e)} />\n </FormField>\n```",
5693
+ "description": "Use `FormField` to wrap input components to make them accessible. You can customize the field\nby passing in `TextInput`, `Select`, `RadioGroup` and other form elements to `FormField.Input` through the `as` prop.\n\n```tsx\n<FormField>\n <FormField.Label>First Name</FormField.Label>\n <FormField.Input as={TextInput} value={value} onChange={(e) => console.log(e)} />\n </FormField>\n```",
5694
5694
  "declarations": [
5695
5695
  {
5696
5696
  "name": "FormField",
@@ -5739,6 +5739,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
5739
5739
  ],
5740
5740
  "tags": {}
5741
5741
  },
5742
+ {
5743
+ "kind": "property",
5744
+ "name": "grow",
5745
+ "required": false,
5746
+ "type": {
5747
+ "kind": "primitive",
5748
+ "value": "boolean"
5749
+ },
5750
+ "description": "True if the component should grow to its container's width. False otherwise.",
5751
+ "declarations": [
5752
+ {
5753
+ "name": "grow",
5754
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
5755
+ }
5756
+ ],
5757
+ "tags": {}
5758
+ },
5742
5759
  {
5743
5760
  "kind": "property",
5744
5761
  "name": "as",
@@ -5846,7 +5863,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
5846
5863
  {
5847
5864
  "name": "Input",
5848
5865
  "symbol": "FormFieldInput",
5849
- "description": "`FormField.Input` will render any `inputs` passed to it including `TextInput`, `Select`, `Switch`, `TextArea`, `RadioGroup` or any custom input.\n`FromField.Input` will be associated with `FormField.Label` and `FormField.Hint` by a generated `id`. You can customize this `id` by passing `id` to `FormField`.\n\n```tsx\n <FormField id='my-unique-id'>\n <FormField.Label>My Label Text</FormField.Label>\n <FormField.Input as={TextInput} onChange={(e) => console.log(e)} />\n <FormField>\n```",
5866
+ "description": "`FormField.Input` will render any `inputs` passed to it via the `as` prop, including `TextInput`, `Select`, `Switch`, `TextArea`, `RadioGroup` or any custom input.\n`FromField.Input` will be associated with `FormField.Label` and `FormField.Hint` by a generated `id`. You can customize this `id` by passing `id` to `FormField`.\n\n**Note: If you pass in a custom input that is *not* as Canvas Kit input, you will have to handle the `error` prop, validation and styling. For a custom approach, reference our Custom storybook example.**\n\n```tsx\n <FormField id='my-unique-id'>\n <FormField.Label>My Label Text</FormField.Label>\n <FormField.Input as={TextInput} onChange={(e) => console.log(e)} />\n <FormField>\n```",
5850
5867
  "declarations": [
5851
5868
  {
5852
5869
  "name": "Input",
@@ -6448,72 +6465,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
6448
6465
  ],
6449
6466
  "tags": {}
6450
6467
  },
6451
- {
6452
- "kind": "property",
6453
- "name": "typeLevel",
6454
- "required": false,
6455
- "type": {
6456
- "kind": "union",
6457
- "value": [
6458
- {
6459
- "kind": "string",
6460
- "value": "body.medium"
6461
- },
6462
- {
6463
- "kind": "string",
6464
- "value": "body.large"
6465
- },
6466
- {
6467
- "kind": "string",
6468
- "value": "body.small"
6469
- },
6470
- {
6471
- "kind": "string",
6472
- "value": "title.medium"
6473
- },
6474
- {
6475
- "kind": "string",
6476
- "value": "title.large"
6477
- },
6478
- {
6479
- "kind": "string",
6480
- "value": "title.small"
6481
- },
6482
- {
6483
- "kind": "string",
6484
- "value": "subtext.medium"
6485
- },
6486
- {
6487
- "kind": "string",
6488
- "value": "subtext.large"
6489
- },
6490
- {
6491
- "kind": "string",
6492
- "value": "subtext.small"
6493
- },
6494
- {
6495
- "kind": "string",
6496
- "value": "heading.medium"
6497
- },
6498
- {
6499
- "kind": "string",
6500
- "value": "heading.large"
6501
- },
6502
- {
6503
- "kind": "string",
6504
- "value": "heading.small"
6505
- }
6506
- ]
6507
- },
6508
- "description": "",
6509
- "declarations": [
6510
- {
6511
- "name": "typeLevel",
6512
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
6513
- }
6514
- ],
6515
- "tags": {}
6516
- },
6517
6468
  {
6518
6469
  "kind": "property",
6519
6470
  "name": "disabled",
@@ -6522,11 +6473,11 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
6522
6473
  "kind": "primitive",
6523
6474
  "value": "boolean"
6524
6475
  },
6525
- "description": "Disabled state as a boolean\n\n```tsx\n<LabelText disabled={true}>Error text</LabelText>\n```",
6476
+ "description": "Will style the text as disabled",
6526
6477
  "declarations": [
6527
6478
  {
6528
6479
  "name": "disabled",
6529
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
6480
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx"
6530
6481
  }
6531
6482
  ],
6532
6483
  "tags": {}
@@ -6552,29 +6503,11 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
6552
6503
  }
6553
6504
  ]
6554
6505
  },
6555
- "description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<LabelText variant=\"error\">Error text</LabelText>\n```",
6506
+ "description": "Changes the color of the text",
6556
6507
  "declarations": [
6557
6508
  {
6558
6509
  "name": "variant",
6559
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
6560
- }
6561
- ],
6562
- "tags": {}
6563
- },
6564
- {
6565
- "kind": "property",
6566
- "name": "cs",
6567
- "required": false,
6568
- "type": {
6569
- "kind": "symbol",
6570
- "name": "CSToPropsInput",
6571
- "value": "CSToPropsInput"
6572
- },
6573
- "description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles} instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n {...handleCsProp(elemProps, [\n myStyles,\n myModifiers({ size: 'medium' }),\n myVars({ backgroundColor: 'red' })\n ])}\n >\n {children}\n </Element>\n)\n```",
6574
- "declarations": [
6575
- {
6576
- "name": "cs",
6577
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
6510
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/FormFieldLabel.tsx"
6578
6511
  }
6579
6512
  ],
6580
6513
  "tags": {}
@@ -6591,8 +6524,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
6591
6524
  "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
6592
6525
  },
6593
6526
  "defaultValue": {
6594
- "kind": "symbol",
6595
- "name": "LabelText"
6527
+ "kind": "external",
6528
+ "name": "label",
6529
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label"
6596
6530
  }
6597
6531
  },
6598
6532
  {
@@ -6611,8 +6545,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
6611
6545
  "name": "R",
6612
6546
  "required": true,
6613
6547
  "defaultValue": {
6614
- "kind": "symbol",
6615
- "name": "LabelText"
6548
+ "kind": "external",
6549
+ "name": "label",
6550
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label"
6616
6551
  }
6617
6552
  }
6618
6553
  ]
@@ -6671,12 +6606,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
6671
6606
  }
6672
6607
  ],
6673
6608
  "baseElement": {
6674
- "kind": "symbol",
6675
- "name": "LabelText"
6676
- },
6677
- "styleComponent": {
6678
- "kind": "symbol",
6679
- "name": "Box"
6609
+ "kind": "external",
6610
+ "name": "label",
6611
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label"
6680
6612
  },
6681
6613
  "model": "FormFieldModel"
6682
6614
  }
@@ -31531,27 +31463,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
31531
31463
  },
31532
31464
  {
31533
31465
  "kind": "string",
31534
- "value": "subtext.medium"
31466
+ "value": "heading.medium"
31535
31467
  },
31536
31468
  {
31537
31469
  "kind": "string",
31538
- "value": "subtext.large"
31470
+ "value": "heading.large"
31539
31471
  },
31540
31472
  {
31541
31473
  "kind": "string",
31542
- "value": "subtext.small"
31474
+ "value": "heading.small"
31543
31475
  },
31544
31476
  {
31545
31477
  "kind": "string",
31546
- "value": "heading.medium"
31478
+ "value": "subtext.medium"
31547
31479
  },
31548
31480
  {
31549
31481
  "kind": "string",
31550
- "value": "heading.large"
31482
+ "value": "subtext.large"
31551
31483
  },
31552
31484
  {
31553
31485
  "kind": "string",
31554
- "value": "heading.small"
31486
+ "value": "subtext.small"
31555
31487
  }
31556
31488
  ]
31557
31489
  },
@@ -32652,7 +32584,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
32652
32584
  }
32653
32585
  ],
32654
32586
  "tags": {
32655
- "deprecated": "⚠️ `TextAreaProps` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
32587
+ "deprecated": "⚠️ `TextAreaProps` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
32656
32588
  },
32657
32589
  "type": {
32658
32590
  "kind": "alias",
@@ -32670,7 +32602,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
32670
32602
  }
32671
32603
  ],
32672
32604
  "tags": {
32673
- "deprecated": "⚠️ `TextArea` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
32605
+ "deprecated": "⚠️ `TextArea` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
32674
32606
  },
32675
32607
  "type": {
32676
32608
  "kind": "enhancedComponent",
@@ -32715,175 +32647,21 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
32715
32647
  },
32716
32648
  {
32717
32649
  "kind": "property",
32718
- "name": "as",
32719
- "description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
32720
- "tags": {},
32721
- "declarations": [],
32722
- "type": {
32723
- "kind": "external",
32724
- "name": "React.ElementType",
32725
- "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
32726
- },
32727
- "defaultValue": {
32728
- "kind": "external",
32729
- "name": "div",
32730
- "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
32731
- }
32732
- },
32733
- {
32734
- "kind": "property",
32735
- "name": "ref",
32736
- "description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
32737
- "tags": {},
32738
- "declarations": [],
32739
- "type": {
32740
- "kind": "external",
32741
- "name": "React.Ref",
32742
- "url": "https://reactjs.org/docs/refs-and-the-dom.html",
32743
- "typeParameters": [
32744
- {
32745
- "kind": "typeParameter",
32746
- "name": "R",
32747
- "required": true,
32748
- "defaultValue": {
32749
- "kind": "external",
32750
- "name": "div",
32751
- "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
32752
- }
32753
- }
32754
- ]
32755
- }
32756
- },
32757
- {
32758
- "kind": "property",
32759
- "name": "model",
32760
- "description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
32761
- "tags": {},
32762
- "declarations": [],
32763
- "type": {
32764
- "kind": "symbol",
32765
- "name": "TextInputModel"
32766
- }
32767
- },
32768
- {
32769
- "kind": "property",
32770
- "name": "elemPropsHook",
32771
- "description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
32772
- "tags": {},
32773
- "declarations": [],
32774
- "type": {
32775
- "kind": "function",
32776
- "parameters": [
32777
- {
32778
- "kind": "parameter",
32779
- "description": "",
32780
- "tags": {},
32781
- "declarations": [],
32782
- "name": "model",
32783
- "type": {
32784
- "kind": "symbol",
32785
- "name": "TextInputModel"
32786
- },
32787
- "required": true
32788
- },
32789
- {
32790
- "kind": "parameter",
32791
- "description": "",
32792
- "tags": {},
32793
- "declarations": [],
32794
- "name": "elemProps",
32795
- "type": {
32796
- "kind": "generic",
32797
- "name": "TProps"
32798
- }
32799
- }
32800
- ],
32801
- "returnType": {
32802
- "kind": "external",
32803
- "name": "HTML Attributes",
32804
- "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
32805
- }
32806
- }
32807
- }
32808
- ],
32809
- "baseElement": {
32810
- "kind": "external",
32811
- "name": "div",
32812
- "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
32813
- },
32814
- "model": "TextInputModel",
32815
- "styleComponent": {
32816
- "kind": "symbol",
32817
- "name": "Flex"
32818
- },
32819
- "subComponents": [
32820
- {
32821
- "name": "Field",
32822
- "symbol": "TextAreaField",
32823
- "description": "",
32824
- "declarations": [
32825
- {
32826
- "name": "Field",
32827
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx"
32828
- },
32829
- {
32830
- "name": "TextAreaField",
32831
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextAreaField.tsx"
32832
- }
32833
- ],
32834
- "tags": {}
32835
- }
32836
- ]
32837
- }
32838
- },
32839
- {
32840
- "name": "TextAreaField",
32841
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextAreaField.tsx",
32842
- "description": "",
32843
- "declarations": [
32844
- {
32845
- "name": "TextAreaField",
32846
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextAreaField.tsx"
32847
- }
32848
- ],
32849
- "tags": {
32850
- "deprecated": "⚠️ `TextAreaField` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
32851
- },
32852
- "type": {
32853
- "kind": "enhancedComponent",
32854
- "componentType": "subcomponent",
32855
- "displayName": "TextArea.Field",
32856
- "props": [
32857
- {
32858
- "kind": "property",
32859
- "name": "cs",
32650
+ "name": "grow",
32860
32651
  "required": false,
32861
32652
  "type": {
32862
- "kind": "symbol",
32863
- "name": "CSToPropsInput",
32864
- "value": "CSToPropsInput"
32653
+ "kind": "primitive",
32654
+ "value": "boolean"
32865
32655
  },
32866
- "description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles} instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n {...handleCsProp(elemProps, [\n myStyles,\n myModifiers({ size: 'medium' }),\n myVars({ backgroundColor: 'red' })\n ])}\n >\n {children}\n </Element>\n)\n```",
32656
+ "description": "True if the component should grow to its container's width. False otherwise.",
32867
32657
  "declarations": [
32868
32658
  {
32869
- "name": "cs",
32870
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
32659
+ "name": "grow",
32660
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
32871
32661
  }
32872
32662
  ],
32873
32663
  "tags": {}
32874
32664
  },
32875
- {
32876
- "kind": "property",
32877
- "name": "children",
32878
- "description": "",
32879
- "tags": {},
32880
- "declarations": [],
32881
- "type": {
32882
- "kind": "external",
32883
- "name": "React.ReactNode",
32884
- "url": "https://reactjs.org/docs/rendering-elements.html"
32885
- }
32886
- },
32887
32665
  {
32888
32666
  "kind": "property",
32889
32667
  "name": "as",
@@ -32897,8 +32675,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
32897
32675
  },
32898
32676
  "defaultValue": {
32899
32677
  "kind": "external",
32900
- "name": "textarea",
32901
- "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea"
32678
+ "name": "div",
32679
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
32902
32680
  }
32903
32681
  },
32904
32682
  {
@@ -32918,8 +32696,179 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
32918
32696
  "required": true,
32919
32697
  "defaultValue": {
32920
32698
  "kind": "external",
32921
- "name": "textarea",
32922
- "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea"
32699
+ "name": "div",
32700
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
32701
+ }
32702
+ }
32703
+ ]
32704
+ }
32705
+ },
32706
+ {
32707
+ "kind": "property",
32708
+ "name": "model",
32709
+ "description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
32710
+ "tags": {},
32711
+ "declarations": [],
32712
+ "type": {
32713
+ "kind": "symbol",
32714
+ "name": "TextInputModel"
32715
+ }
32716
+ },
32717
+ {
32718
+ "kind": "property",
32719
+ "name": "elemPropsHook",
32720
+ "description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
32721
+ "tags": {},
32722
+ "declarations": [],
32723
+ "type": {
32724
+ "kind": "function",
32725
+ "parameters": [
32726
+ {
32727
+ "kind": "parameter",
32728
+ "description": "",
32729
+ "tags": {},
32730
+ "declarations": [],
32731
+ "name": "model",
32732
+ "type": {
32733
+ "kind": "symbol",
32734
+ "name": "TextInputModel"
32735
+ },
32736
+ "required": true
32737
+ },
32738
+ {
32739
+ "kind": "parameter",
32740
+ "description": "",
32741
+ "tags": {},
32742
+ "declarations": [],
32743
+ "name": "elemProps",
32744
+ "type": {
32745
+ "kind": "generic",
32746
+ "name": "TProps"
32747
+ }
32748
+ }
32749
+ ],
32750
+ "returnType": {
32751
+ "kind": "external",
32752
+ "name": "HTML Attributes",
32753
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
32754
+ }
32755
+ }
32756
+ }
32757
+ ],
32758
+ "baseElement": {
32759
+ "kind": "external",
32760
+ "name": "div",
32761
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
32762
+ },
32763
+ "model": "TextInputModel",
32764
+ "styleComponent": {
32765
+ "kind": "symbol",
32766
+ "name": "Flex"
32767
+ },
32768
+ "subComponents": [
32769
+ {
32770
+ "name": "Field",
32771
+ "symbol": "TextAreaField",
32772
+ "description": "",
32773
+ "declarations": [
32774
+ {
32775
+ "name": "Field",
32776
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx"
32777
+ },
32778
+ {
32779
+ "name": "TextAreaField",
32780
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextAreaField.tsx"
32781
+ }
32782
+ ],
32783
+ "tags": {}
32784
+ }
32785
+ ]
32786
+ }
32787
+ },
32788
+ {
32789
+ "name": "TextAreaField",
32790
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextAreaField.tsx",
32791
+ "description": "",
32792
+ "declarations": [
32793
+ {
32794
+ "name": "TextAreaField",
32795
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextAreaField.tsx"
32796
+ }
32797
+ ],
32798
+ "tags": {
32799
+ "deprecated": "⚠️ `TextAreaField` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
32800
+ },
32801
+ "type": {
32802
+ "kind": "enhancedComponent",
32803
+ "componentType": "subcomponent",
32804
+ "displayName": "TextArea.Field",
32805
+ "props": [
32806
+ {
32807
+ "kind": "property",
32808
+ "name": "cs",
32809
+ "required": false,
32810
+ "type": {
32811
+ "kind": "symbol",
32812
+ "name": "CSToPropsInput",
32813
+ "value": "CSToPropsInput"
32814
+ },
32815
+ "description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles} instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n {...handleCsProp(elemProps, [\n myStyles,\n myModifiers({ size: 'medium' }),\n myVars({ backgroundColor: 'red' })\n ])}\n >\n {children}\n </Element>\n)\n```",
32816
+ "declarations": [
32817
+ {
32818
+ "name": "cs",
32819
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
32820
+ }
32821
+ ],
32822
+ "tags": {}
32823
+ },
32824
+ {
32825
+ "kind": "property",
32826
+ "name": "children",
32827
+ "description": "",
32828
+ "tags": {},
32829
+ "declarations": [],
32830
+ "type": {
32831
+ "kind": "external",
32832
+ "name": "React.ReactNode",
32833
+ "url": "https://reactjs.org/docs/rendering-elements.html"
32834
+ }
32835
+ },
32836
+ {
32837
+ "kind": "property",
32838
+ "name": "as",
32839
+ "description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
32840
+ "tags": {},
32841
+ "declarations": [],
32842
+ "type": {
32843
+ "kind": "external",
32844
+ "name": "React.ElementType",
32845
+ "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
32846
+ },
32847
+ "defaultValue": {
32848
+ "kind": "external",
32849
+ "name": "textarea",
32850
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea"
32851
+ }
32852
+ },
32853
+ {
32854
+ "kind": "property",
32855
+ "name": "ref",
32856
+ "description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
32857
+ "tags": {},
32858
+ "declarations": [],
32859
+ "type": {
32860
+ "kind": "external",
32861
+ "name": "React.Ref",
32862
+ "url": "https://reactjs.org/docs/refs-and-the-dom.html",
32863
+ "typeParameters": [
32864
+ {
32865
+ "kind": "typeParameter",
32866
+ "name": "R",
32867
+ "required": true,
32868
+ "defaultValue": {
32869
+ "kind": "external",
32870
+ "name": "textarea",
32871
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea"
32923
32872
  }
32924
32873
  }
32925
32874
  ]
@@ -33000,7 +32949,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
33000
32949
  }
33001
32950
  ],
33002
32951
  "tags": {
33003
- "deprecated": "⚠️ `useTextInputField` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
32952
+ "deprecated": "⚠️ `useTextInputField` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
33004
32953
  },
33005
32954
  "type": {
33006
32955
  "kind": "function",
@@ -33077,7 +33026,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
33077
33026
  }
33078
33027
  ],
33079
33028
  "tags": {
33080
- "deprecated": "⚠️ `useTextInputModel` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
33029
+ "deprecated": "⚠️ `useTextInputModel` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
33081
33030
  },
33082
33031
  "type": {
33083
33032
  "kind": "symbol",
@@ -33095,7 +33044,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
33095
33044
  }
33096
33045
  ],
33097
33046
  "tags": {
33098
- "deprecated": "⚠️ `TextInputProps` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
33047
+ "deprecated": "⚠️ `TextInputProps` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
33099
33048
  },
33100
33049
  "type": {
33101
33050
  "kind": "alias",
@@ -33113,7 +33062,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
33113
33062
  }
33114
33063
  ],
33115
33064
  "tags": {
33116
- "deprecated": "⚠️ `TextInput` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
33065
+ "deprecated": "⚠️ `TextInput` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
33117
33066
  },
33118
33067
  "type": {
33119
33068
  "kind": "enhancedComponent",
@@ -33156,6 +33105,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
33156
33105
  ],
33157
33106
  "tags": {}
33158
33107
  },
33108
+ {
33109
+ "kind": "property",
33110
+ "name": "grow",
33111
+ "required": false,
33112
+ "type": {
33113
+ "kind": "primitive",
33114
+ "value": "boolean"
33115
+ },
33116
+ "description": "True if the component should grow to its container's width. False otherwise.",
33117
+ "declarations": [
33118
+ {
33119
+ "name": "grow",
33120
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
33121
+ }
33122
+ ],
33123
+ "tags": {}
33124
+ },
33159
33125
  {
33160
33126
  "kind": "property",
33161
33127
  "name": "as",
@@ -33290,7 +33256,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
33290
33256
  }
33291
33257
  ],
33292
33258
  "tags": {
33293
- "deprecated": "⚠️ `TextInputField` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
33259
+ "deprecated": "⚠️ `TextInputField` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
33294
33260
  },
33295
33261
  "type": {
33296
33262
  "kind": "enhancedComponent",
@@ -44266,27 +44232,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
44266
44232
  },
44267
44233
  {
44268
44234
  "kind": "string",
44269
- "value": "subtext.medium"
44235
+ "value": "heading.medium"
44270
44236
  },
44271
44237
  {
44272
44238
  "kind": "string",
44273
- "value": "subtext.large"
44239
+ "value": "heading.large"
44274
44240
  },
44275
44241
  {
44276
44242
  "kind": "string",
44277
- "value": "subtext.small"
44243
+ "value": "heading.small"
44278
44244
  },
44279
44245
  {
44280
44246
  "kind": "string",
44281
- "value": "heading.medium"
44247
+ "value": "subtext.medium"
44282
44248
  },
44283
44249
  {
44284
44250
  "kind": "string",
44285
- "value": "heading.large"
44251
+ "value": "subtext.large"
44286
44252
  },
44287
44253
  {
44288
44254
  "kind": "string",
44289
- "value": "heading.small"
44255
+ "value": "subtext.small"
44290
44256
  }
44291
44257
  ]
44292
44258
  },
@@ -109497,6 +109463,551 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109497
109463
  }
109498
109464
  }
109499
109465
  },
109466
+ {
109467
+ "name": "accessibleHide",
109468
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx",
109469
+ "description": "A utility to visually hide content, while still making accessible to screen readers\nSee https://a11y-101.com/development/skip-link",
109470
+ "declarations": [
109471
+ {
109472
+ "name": "accessibleHide",
109473
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx"
109474
+ }
109475
+ ],
109476
+ "tags": {},
109477
+ "type": {
109478
+ "kind": "object",
109479
+ "properties": [
109480
+ {
109481
+ "kind": "property",
109482
+ "name": "clip",
109483
+ "defaultValue": {
109484
+ "kind": "string",
109485
+ "value": "rect(1px, 1px, 1px, 1px)"
109486
+ },
109487
+ "type": {
109488
+ "kind": "string",
109489
+ "value": "rect(1px, 1px, 1px, 1px)"
109490
+ },
109491
+ "required": true,
109492
+ "description": "",
109493
+ "declarations": [
109494
+ {
109495
+ "name": "clip",
109496
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx"
109497
+ }
109498
+ ],
109499
+ "tags": {}
109500
+ },
109501
+ {
109502
+ "kind": "property",
109503
+ "name": "clipPath",
109504
+ "defaultValue": {
109505
+ "kind": "string",
109506
+ "value": "polygon(0px 0px, 0px 0px, 0px 0px, 0px 0px)"
109507
+ },
109508
+ "type": {
109509
+ "kind": "string",
109510
+ "value": "polygon(0px 0px, 0px 0px, 0px 0px, 0px 0px)"
109511
+ },
109512
+ "required": true,
109513
+ "description": "",
109514
+ "declarations": [
109515
+ {
109516
+ "name": "clipPath",
109517
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx"
109518
+ }
109519
+ ],
109520
+ "tags": {}
109521
+ },
109522
+ {
109523
+ "kind": "property",
109524
+ "name": "position",
109525
+ "defaultValue": {
109526
+ "kind": "string",
109527
+ "value": "absolute"
109528
+ },
109529
+ "type": {
109530
+ "kind": "string",
109531
+ "value": "absolute"
109532
+ },
109533
+ "required": true,
109534
+ "description": "",
109535
+ "declarations": [
109536
+ {
109537
+ "name": "position",
109538
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx"
109539
+ }
109540
+ ],
109541
+ "tags": {}
109542
+ },
109543
+ {
109544
+ "kind": "property",
109545
+ "name": "overflow",
109546
+ "defaultValue": {
109547
+ "kind": "string",
109548
+ "value": "hidden"
109549
+ },
109550
+ "type": {
109551
+ "kind": "string",
109552
+ "value": "hidden"
109553
+ },
109554
+ "required": true,
109555
+ "description": "",
109556
+ "declarations": [
109557
+ {
109558
+ "name": "overflow",
109559
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx"
109560
+ }
109561
+ ],
109562
+ "tags": {}
109563
+ },
109564
+ {
109565
+ "kind": "property",
109566
+ "name": "whiteSpace",
109567
+ "defaultValue": {
109568
+ "kind": "string",
109569
+ "value": "nowrap"
109570
+ },
109571
+ "type": {
109572
+ "kind": "string",
109573
+ "value": "nowrap"
109574
+ },
109575
+ "required": true,
109576
+ "description": "",
109577
+ "declarations": [
109578
+ {
109579
+ "name": "whiteSpace",
109580
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx"
109581
+ }
109582
+ ],
109583
+ "tags": {}
109584
+ },
109585
+ {
109586
+ "kind": "property",
109587
+ "name": "height",
109588
+ "defaultValue": {
109589
+ "kind": "string",
109590
+ "value": "1px"
109591
+ },
109592
+ "type": {
109593
+ "kind": "string",
109594
+ "value": "1px"
109595
+ },
109596
+ "required": true,
109597
+ "description": "",
109598
+ "declarations": [
109599
+ {
109600
+ "name": "height",
109601
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx"
109602
+ }
109603
+ ],
109604
+ "tags": {}
109605
+ },
109606
+ {
109607
+ "kind": "property",
109608
+ "name": "width",
109609
+ "defaultValue": {
109610
+ "kind": "string",
109611
+ "value": "1px"
109612
+ },
109613
+ "type": {
109614
+ "kind": "string",
109615
+ "value": "1px"
109616
+ },
109617
+ "required": true,
109618
+ "description": "",
109619
+ "declarations": [
109620
+ {
109621
+ "name": "width",
109622
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx"
109623
+ }
109624
+ ],
109625
+ "tags": {}
109626
+ },
109627
+ {
109628
+ "kind": "property",
109629
+ "name": "margin",
109630
+ "defaultValue": {
109631
+ "kind": "string",
109632
+ "value": "-1px"
109633
+ },
109634
+ "type": {
109635
+ "kind": "string",
109636
+ "value": "-1px"
109637
+ },
109638
+ "required": true,
109639
+ "description": "",
109640
+ "declarations": [
109641
+ {
109642
+ "name": "margin",
109643
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx"
109644
+ }
109645
+ ],
109646
+ "tags": {}
109647
+ },
109648
+ {
109649
+ "kind": "property",
109650
+ "name": "padding",
109651
+ "defaultValue": {
109652
+ "kind": "number",
109653
+ "value": 0
109654
+ },
109655
+ "type": {
109656
+ "kind": "number",
109657
+ "value": 0
109658
+ },
109659
+ "required": true,
109660
+ "description": "",
109661
+ "declarations": [
109662
+ {
109663
+ "name": "padding",
109664
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx"
109665
+ }
109666
+ ],
109667
+ "tags": {}
109668
+ },
109669
+ {
109670
+ "kind": "property",
109671
+ "name": "border",
109672
+ "defaultValue": {
109673
+ "kind": "number",
109674
+ "value": 0
109675
+ },
109676
+ "type": {
109677
+ "kind": "number",
109678
+ "value": 0
109679
+ },
109680
+ "required": true,
109681
+ "description": "",
109682
+ "declarations": [
109683
+ {
109684
+ "name": "border",
109685
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx"
109686
+ }
109687
+ ],
109688
+ "tags": {}
109689
+ }
109690
+ ]
109691
+ }
109692
+ },
109693
+ {
109694
+ "name": "AccessibleHide",
109695
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx",
109696
+ "description": "A convenient component wrapper to visually hide content, while still making it accessible to screen readers",
109697
+ "declarations": [
109698
+ {
109699
+ "name": "AccessibleHide",
109700
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AccessibleHide.tsx"
109701
+ }
109702
+ ],
109703
+ "tags": {},
109704
+ "type": {
109705
+ "kind": "enhancedComponent",
109706
+ "componentType": "regular",
109707
+ "displayName": "AccessibleHide",
109708
+ "props": [
109709
+ {
109710
+ "kind": "property",
109711
+ "name": "cs",
109712
+ "required": false,
109713
+ "type": {
109714
+ "kind": "symbol",
109715
+ "name": "CSToPropsInput",
109716
+ "value": "CSToPropsInput"
109717
+ },
109718
+ "description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles} instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n {...handleCsProp(elemProps, [\n myStyles,\n myModifiers({ size: 'medium' }),\n myVars({ backgroundColor: 'red' })\n ])}\n >\n {children}\n </Element>\n)\n```",
109719
+ "declarations": [
109720
+ {
109721
+ "name": "cs",
109722
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
109723
+ }
109724
+ ],
109725
+ "tags": {}
109726
+ },
109727
+ {
109728
+ "kind": "property",
109729
+ "name": "children",
109730
+ "description": "",
109731
+ "tags": {},
109732
+ "declarations": [],
109733
+ "type": {
109734
+ "kind": "external",
109735
+ "name": "React.ReactNode",
109736
+ "url": "https://reactjs.org/docs/rendering-elements.html"
109737
+ }
109738
+ },
109739
+ {
109740
+ "kind": "property",
109741
+ "name": "as",
109742
+ "description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
109743
+ "tags": {},
109744
+ "declarations": [],
109745
+ "type": {
109746
+ "kind": "external",
109747
+ "name": "React.ElementType",
109748
+ "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
109749
+ },
109750
+ "defaultValue": {
109751
+ "kind": "external",
109752
+ "name": "div",
109753
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
109754
+ }
109755
+ },
109756
+ {
109757
+ "kind": "property",
109758
+ "name": "ref",
109759
+ "description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
109760
+ "tags": {},
109761
+ "declarations": [],
109762
+ "type": {
109763
+ "kind": "external",
109764
+ "name": "React.Ref",
109765
+ "url": "https://reactjs.org/docs/refs-and-the-dom.html",
109766
+ "typeParameters": [
109767
+ {
109768
+ "kind": "typeParameter",
109769
+ "name": "R",
109770
+ "required": true,
109771
+ "defaultValue": {
109772
+ "kind": "external",
109773
+ "name": "div",
109774
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
109775
+ }
109776
+ }
109777
+ ]
109778
+ }
109779
+ }
109780
+ ],
109781
+ "baseElement": {
109782
+ "kind": "external",
109783
+ "name": "div",
109784
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
109785
+ }
109786
+ }
109787
+ },
109788
+ {
109789
+ "name": "AriaLiveRegionProps",
109790
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AriaLiveRegion.tsx",
109791
+ "description": "",
109792
+ "declarations": [
109793
+ {
109794
+ "name": "AriaLiveRegionProps",
109795
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AriaLiveRegion.tsx"
109796
+ }
109797
+ ],
109798
+ "tags": {},
109799
+ "type": {
109800
+ "kind": "alias",
109801
+ "name": "AriaLiveRegion"
109802
+ }
109803
+ },
109804
+ {
109805
+ "name": "AriaLiveRegion",
109806
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AriaLiveRegion.tsx",
109807
+ "description": "A convenient wrapper for creating an [aria-live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions)",
109808
+ "declarations": [
109809
+ {
109810
+ "name": "AriaLiveRegion",
109811
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AriaLiveRegion.tsx"
109812
+ }
109813
+ ],
109814
+ "tags": {},
109815
+ "type": {
109816
+ "kind": "enhancedComponent",
109817
+ "componentType": "regular",
109818
+ "displayName": "AriaLiveRegion",
109819
+ "props": [
109820
+ {
109821
+ "kind": "property",
109822
+ "name": "aria-atomic",
109823
+ "required": false,
109824
+ "type": {
109825
+ "kind": "union",
109826
+ "value": [
109827
+ {
109828
+ "kind": "boolean",
109829
+ "value": true
109830
+ },
109831
+ {
109832
+ "kind": "boolean",
109833
+ "value": false
109834
+ },
109835
+ {
109836
+ "kind": "string",
109837
+ "value": "true"
109838
+ },
109839
+ {
109840
+ "kind": "string",
109841
+ "value": "false"
109842
+ }
109843
+ ]
109844
+ },
109845
+ "description": "set the [aria-atomic](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-atomic) attribute",
109846
+ "declarations": [
109847
+ {
109848
+ "name": "aria-atomic",
109849
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AriaLiveRegion.tsx"
109850
+ }
109851
+ ],
109852
+ "tags": {
109853
+ "default": "true"
109854
+ },
109855
+ "defaultValue": {
109856
+ "kind": "boolean",
109857
+ "value": true
109858
+ }
109859
+ },
109860
+ {
109861
+ "kind": "property",
109862
+ "name": "aria-live",
109863
+ "required": false,
109864
+ "type": {
109865
+ "kind": "union",
109866
+ "value": [
109867
+ {
109868
+ "kind": "string",
109869
+ "value": "polite"
109870
+ },
109871
+ {
109872
+ "kind": "string",
109873
+ "value": "assertive"
109874
+ },
109875
+ {
109876
+ "kind": "string",
109877
+ "value": "off"
109878
+ }
109879
+ ]
109880
+ },
109881
+ "description": "set the [aria-live](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-live) attribute",
109882
+ "declarations": [
109883
+ {
109884
+ "name": "aria-live",
109885
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AriaLiveRegion.tsx"
109886
+ }
109887
+ ],
109888
+ "tags": {
109889
+ "default": "'polite'"
109890
+ },
109891
+ "defaultValue": {
109892
+ "kind": "string",
109893
+ "value": "polite"
109894
+ }
109895
+ },
109896
+ {
109897
+ "kind": "property",
109898
+ "name": "role",
109899
+ "required": false,
109900
+ "type": {
109901
+ "kind": "union",
109902
+ "value": [
109903
+ {
109904
+ "kind": "string",
109905
+ "value": "status"
109906
+ },
109907
+ {
109908
+ "kind": "string",
109909
+ "value": "alert"
109910
+ },
109911
+ {
109912
+ "kind": "string",
109913
+ "value": "log"
109914
+ }
109915
+ ]
109916
+ },
109917
+ "description": "set the live region's [aria role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role)",
109918
+ "declarations": [
109919
+ {
109920
+ "name": "role",
109921
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/AriaLiveRegion.tsx"
109922
+ }
109923
+ ],
109924
+ "tags": {
109925
+ "default": "'status'"
109926
+ },
109927
+ "defaultValue": {
109928
+ "kind": "string",
109929
+ "value": "status"
109930
+ }
109931
+ },
109932
+ {
109933
+ "kind": "property",
109934
+ "name": "cs",
109935
+ "required": false,
109936
+ "type": {
109937
+ "kind": "symbol",
109938
+ "name": "CSToPropsInput",
109939
+ "value": "CSToPropsInput"
109940
+ },
109941
+ "description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles} instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n {...handleCsProp(elemProps, [\n myStyles,\n myModifiers({ size: 'medium' }),\n myVars({ backgroundColor: 'red' })\n ])}\n >\n {children}\n </Element>\n)\n```",
109942
+ "declarations": [
109943
+ {
109944
+ "name": "cs",
109945
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
109946
+ }
109947
+ ],
109948
+ "tags": {}
109949
+ },
109950
+ {
109951
+ "kind": "property",
109952
+ "name": "children",
109953
+ "description": "",
109954
+ "tags": {},
109955
+ "declarations": [],
109956
+ "type": {
109957
+ "kind": "external",
109958
+ "name": "React.ReactNode",
109959
+ "url": "https://reactjs.org/docs/rendering-elements.html"
109960
+ }
109961
+ },
109962
+ {
109963
+ "kind": "property",
109964
+ "name": "as",
109965
+ "description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
109966
+ "tags": {},
109967
+ "declarations": [],
109968
+ "type": {
109969
+ "kind": "external",
109970
+ "name": "React.ElementType",
109971
+ "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
109972
+ },
109973
+ "defaultValue": {
109974
+ "kind": "external",
109975
+ "name": "div",
109976
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
109977
+ }
109978
+ },
109979
+ {
109980
+ "kind": "property",
109981
+ "name": "ref",
109982
+ "description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
109983
+ "tags": {},
109984
+ "declarations": [],
109985
+ "type": {
109986
+ "kind": "external",
109987
+ "name": "React.Ref",
109988
+ "url": "https://reactjs.org/docs/refs-and-the-dom.html",
109989
+ "typeParameters": [
109990
+ {
109991
+ "kind": "typeParameter",
109992
+ "name": "R",
109993
+ "required": true,
109994
+ "defaultValue": {
109995
+ "kind": "external",
109996
+ "name": "div",
109997
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
109998
+ }
109999
+ }
110000
+ ]
110001
+ }
110002
+ }
110003
+ ],
110004
+ "baseElement": {
110005
+ "kind": "external",
110006
+ "name": "div",
110007
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
110008
+ }
110009
+ }
110010
+ },
109500
110011
  {
109501
110012
  "name": "CanvasProviderProps",
109502
110013
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/CanvasProvider.tsx",
@@ -110665,23 +111176,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
110665
111176
  }
110666
111177
  }
110667
111178
  },
110668
- {
110669
- "name": "accessibleHide",
110670
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/accessibleHide.ts",
110671
- "description": "A utility to visually hide content, while still making accessible to screenreaders\nSee https://a11y-101.com/development/skip-link",
110672
- "declarations": [
110673
- {
110674
- "name": "accessibleHide",
110675
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/accessibleHide.ts"
110676
- }
110677
- ],
110678
- "tags": {},
110679
- "type": {
110680
- "kind": "symbol",
110681
- "name": "CSSProperties",
110682
- "value": "CSSProperties"
110683
- }
110684
- },
110685
111179
  {
110686
111180
  "name": "getErrorColors",
110687
111181
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/errorRing.ts",
@@ -124618,7 +125112,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
124618
125112
  }
124619
125113
  ],
124620
125114
  "tags": {
124621
- "deprecated": "⚠️ `FormFieldProps` in Main has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
125115
+ "deprecated": "⚠️ `FormFieldProps` in Main has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
124622
125116
  },
124623
125117
  "type": {
124624
125118
  "kind": "alias",
@@ -124671,7 +125165,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
124671
125165
  }
124672
125166
  ],
124673
125167
  "tags": {
124674
- "deprecated": "⚠️ `FormField` in Main has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
125168
+ "deprecated": "⚠️ `FormField` in Main has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
124675
125169
  },
124676
125170
  "type": {
124677
125171
  "kind": "component",
@@ -124950,7 +125444,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
124950
125444
  }
124951
125445
  ],
124952
125446
  "tags": {
124953
- "deprecated": "⚠️ `HintProps` in Main has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
125447
+ "deprecated": "⚠️ `HintProps` in Main has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
124954
125448
  },
124955
125449
  "type": {
124956
125450
  "kind": "object",
@@ -125043,7 +125537,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
125043
125537
  }
125044
125538
  ],
125045
125539
  "tags": {
125046
- "deprecated": "⚠️ `LabelProps` in Main has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
125540
+ "deprecated": "⚠️ `LabelProps` in Main has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
125047
125541
  },
125048
125542
  "type": {
125049
125543
  "kind": "object",
@@ -125175,7 +125669,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
125175
125669
  }
125176
125670
  ],
125177
125671
  "tags": {
125178
- "deprecated": "⚠️ `FormFieldLabelPosition` in Main has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
125672
+ "deprecated": "⚠️ `FormFieldLabelPosition` in Main has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
125179
125673
  },
125180
125674
  "type": {
125181
125675
  "kind": "object",
@@ -125220,7 +125714,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
125220
125714
  }
125221
125715
  ],
125222
125716
  "tags": {
125223
- "deprecated": "⚠️ `FormFieldLabelPositionBehavior` in Main has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--custom) instead."
125717
+ "deprecated": "⚠️ `FormFieldLabelPositionBehavior` in Main has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
125224
125718
  },
125225
125719
  "type": {
125226
125720
  "kind": "object",
@@ -223678,27 +224172,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
223678
224172
  },
223679
224173
  {
223680
224174
  "kind": "string",
223681
- "value": "subtext.medium"
224175
+ "value": "heading.medium"
223682
224176
  },
223683
224177
  {
223684
224178
  "kind": "string",
223685
- "value": "subtext.large"
224179
+ "value": "heading.large"
223686
224180
  },
223687
224181
  {
223688
224182
  "kind": "string",
223689
- "value": "subtext.small"
224183
+ "value": "heading.small"
223690
224184
  },
223691
224185
  {
223692
224186
  "kind": "string",
223693
- "value": "heading.medium"
224187
+ "value": "subtext.medium"
223694
224188
  },
223695
224189
  {
223696
224190
  "kind": "string",
223697
- "value": "heading.large"
224191
+ "value": "subtext.large"
223698
224192
  },
223699
224193
  {
223700
224194
  "kind": "string",
223701
- "value": "heading.small"
224195
+ "value": "subtext.small"
223702
224196
  }
223703
224197
  ]
223704
224198
  },
@@ -228285,27 +228779,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
228285
228779
  },
228286
228780
  {
228287
228781
  "kind": "string",
228288
- "value": "subtext.medium"
228782
+ "value": "heading.medium"
228289
228783
  },
228290
228784
  {
228291
228785
  "kind": "string",
228292
- "value": "subtext.large"
228786
+ "value": "heading.large"
228293
228787
  },
228294
228788
  {
228295
228789
  "kind": "string",
228296
- "value": "subtext.small"
228790
+ "value": "heading.small"
228297
228791
  },
228298
228792
  {
228299
228793
  "kind": "string",
228300
- "value": "heading.medium"
228794
+ "value": "subtext.medium"
228301
228795
  },
228302
228796
  {
228303
228797
  "kind": "string",
228304
- "value": "heading.large"
228798
+ "value": "subtext.large"
228305
228799
  },
228306
228800
  {
228307
228801
  "kind": "string",
228308
- "value": "heading.small"
228802
+ "value": "subtext.small"
228309
228803
  }
228310
228804
  ]
228311
228805
  },
@@ -228519,27 +229013,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
228519
229013
  },
228520
229014
  {
228521
229015
  "kind": "string",
228522
- "value": "subtext.medium"
229016
+ "value": "heading.medium"
228523
229017
  },
228524
229018
  {
228525
229019
  "kind": "string",
228526
- "value": "subtext.large"
229020
+ "value": "heading.large"
228527
229021
  },
228528
229022
  {
228529
229023
  "kind": "string",
228530
- "value": "subtext.small"
229024
+ "value": "heading.small"
228531
229025
  },
228532
229026
  {
228533
229027
  "kind": "string",
228534
- "value": "heading.medium"
229028
+ "value": "subtext.medium"
228535
229029
  },
228536
229030
  {
228537
229031
  "kind": "string",
228538
- "value": "heading.large"
229032
+ "value": "subtext.large"
228539
229033
  },
228540
229034
  {
228541
229035
  "kind": "string",
228542
- "value": "heading.small"
229036
+ "value": "subtext.small"
228543
229037
  }
228544
229038
  ]
228545
229039
  },