@workday/canvas-kit-preview-react 9.0.0-alpha.336-next.6 → 9.0.0-alpha.344-next.3

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 (154) hide show
  1. package/dist/commonjs/form-field/lib/FormField.d.ts +2 -2
  2. package/dist/commonjs/form-field/lib/FormFieldHint.d.ts +1 -1
  3. package/dist/commonjs/form-field/lib/FormFieldInput.d.ts +1 -1
  4. package/dist/commonjs/form-field/lib/hooks/useFormFieldHint.d.ts +1 -1
  5. package/dist/commonjs/form-field/lib/hooks/useFormFieldInput.d.ts +1 -1
  6. package/dist/commonjs/form-field/lib/hooks/useFormFieldLabel.d.ts +1 -1
  7. package/dist/commonjs/form-field/lib/hooks/useFormFieldModel.d.ts +2 -12
  8. package/dist/commonjs/form-field/lib/hooks/useFormFieldModel.d.ts.map +1 -1
  9. package/dist/commonjs/form-field/lib/hooks/useFormFieldModel.js +1 -3
  10. package/dist/commonjs/menu/lib/Menu.d.ts +12 -5
  11. package/dist/commonjs/menu/lib/Menu.d.ts.map +1 -1
  12. package/dist/commonjs/menu/lib/Menu.js +14 -5
  13. package/dist/commonjs/menu/lib/MenuItem.d.ts +15 -5
  14. package/dist/commonjs/menu/lib/MenuItem.d.ts.map +1 -1
  15. package/dist/commonjs/menu/lib/MenuItem.js +18 -6
  16. package/dist/commonjs/pill/lib/Pill.d.ts +103 -5
  17. package/dist/commonjs/pill/lib/Pill.d.ts.map +1 -1
  18. package/dist/commonjs/pill/lib/Pill.js +101 -2
  19. package/dist/commonjs/segmented-control/index.d.ts +2 -0
  20. package/dist/commonjs/segmented-control/index.d.ts.map +1 -1
  21. package/dist/commonjs/segmented-control/index.js +4 -0
  22. package/dist/commonjs/segmented-control/lib/SegmentedControl.d.ts +74 -38
  23. package/dist/commonjs/segmented-control/lib/SegmentedControl.d.ts.map +1 -1
  24. package/dist/commonjs/segmented-control/lib/SegmentedControl.js +36 -0
  25. package/dist/commonjs/segmented-control/lib/SegmentedControlItem.d.ts +1 -1
  26. package/dist/commonjs/segmented-control/lib/SegmentedControlList.d.ts +64 -1
  27. package/dist/commonjs/segmented-control/lib/SegmentedControlList.d.ts.map +1 -1
  28. package/dist/commonjs/segmented-control/lib/SegmentedControlList.js +3 -3
  29. package/dist/commonjs/segmented-control/lib/hooks/useSegmentedControlItem.d.ts +2 -2
  30. package/dist/commonjs/segmented-control/lib/hooks/useSegmentedControlModel.d.ts +39 -39
  31. package/dist/commonjs/segmented-control/lib/hooks/useSegmentedControlModel.js +2 -1
  32. package/dist/commonjs/select/lib/Select.js +2 -0
  33. package/dist/commonjs/side-panel/lib/SidePanel.d.ts +13 -26
  34. package/dist/commonjs/side-panel/lib/SidePanel.d.ts.map +1 -1
  35. package/dist/commonjs/side-panel/lib/SidePanel.js +73 -96
  36. package/dist/commonjs/side-panel/lib/SidePanelToggleButton.d.ts +17 -0
  37. package/dist/commonjs/side-panel/lib/SidePanelToggleButton.d.ts.map +1 -0
  38. package/dist/commonjs/side-panel/lib/SidePanelToggleButton.js +88 -0
  39. package/dist/commonjs/side-panel/lib/hooks.d.ts +20 -0
  40. package/dist/commonjs/side-panel/lib/hooks.d.ts.map +1 -1
  41. package/dist/commonjs/side-panel/lib/hooks.js +20 -1
  42. package/dist/commonjs/status-indicator/index.d.ts +2 -0
  43. package/dist/commonjs/status-indicator/index.d.ts.map +1 -1
  44. package/dist/commonjs/status-indicator/index.js +4 -0
  45. package/dist/commonjs/status-indicator/lib/StatusIndicator.d.ts +28 -2
  46. package/dist/commonjs/status-indicator/lib/StatusIndicator.d.ts.map +1 -1
  47. package/dist/commonjs/status-indicator/lib/StatusIndicator.js +27 -1
  48. package/dist/commonjs/status-indicator/lib/StatusIndicatorIcon.d.ts +13 -0
  49. package/dist/commonjs/status-indicator/lib/StatusIndicatorIcon.d.ts.map +1 -1
  50. package/dist/commonjs/status-indicator/lib/StatusIndicatorIcon.js +3 -3
  51. package/dist/commonjs/text-area/lib/TextArea.d.ts +1 -1
  52. package/dist/commonjs/text-area/lib/TextArea.d.ts.map +1 -1
  53. package/dist/commonjs/text-area/lib/TextArea.js +1 -2
  54. package/dist/commonjs/text-input/lib/TextInput.d.ts +2 -2
  55. package/dist/commonjs/text-input/lib/TextInput.d.ts.map +1 -1
  56. package/dist/commonjs/text-input/lib/TextInput.js +1 -2
  57. package/dist/commonjs/text-input/lib/TextInputField.js +1 -1
  58. package/dist/commonjs/text-input/lib/hooks/useTextInputField.d.ts +1 -1
  59. package/dist/commonjs/text-input/lib/hooks/useTextInputModel.d.ts +1 -0
  60. package/dist/commonjs/text-input/lib/hooks/useTextInputModel.d.ts.map +1 -1
  61. package/dist/commonjs/text-input/lib/hooks/useTextInputModel.js +1 -0
  62. package/dist/es6/form-field/lib/FormField.d.ts +2 -2
  63. package/dist/es6/form-field/lib/FormFieldHint.d.ts +1 -1
  64. package/dist/es6/form-field/lib/FormFieldInput.d.ts +1 -1
  65. package/dist/es6/form-field/lib/hooks/useFormFieldHint.d.ts +1 -1
  66. package/dist/es6/form-field/lib/hooks/useFormFieldInput.d.ts +1 -1
  67. package/dist/es6/form-field/lib/hooks/useFormFieldLabel.d.ts +1 -1
  68. package/dist/es6/form-field/lib/hooks/useFormFieldModel.d.ts +2 -12
  69. package/dist/es6/form-field/lib/hooks/useFormFieldModel.d.ts.map +1 -1
  70. package/dist/es6/form-field/lib/hooks/useFormFieldModel.js +1 -3
  71. package/dist/es6/menu/lib/Menu.d.ts +12 -5
  72. package/dist/es6/menu/lib/Menu.d.ts.map +1 -1
  73. package/dist/es6/menu/lib/Menu.js +14 -5
  74. package/dist/es6/menu/lib/MenuItem.d.ts +15 -5
  75. package/dist/es6/menu/lib/MenuItem.d.ts.map +1 -1
  76. package/dist/es6/menu/lib/MenuItem.js +18 -6
  77. package/dist/es6/pill/lib/Pill.d.ts +103 -5
  78. package/dist/es6/pill/lib/Pill.d.ts.map +1 -1
  79. package/dist/es6/pill/lib/Pill.js +101 -2
  80. package/dist/es6/segmented-control/index.d.ts +2 -0
  81. package/dist/es6/segmented-control/index.d.ts.map +1 -1
  82. package/dist/es6/segmented-control/index.js +2 -0
  83. package/dist/es6/segmented-control/lib/SegmentedControl.d.ts +74 -38
  84. package/dist/es6/segmented-control/lib/SegmentedControl.d.ts.map +1 -1
  85. package/dist/es6/segmented-control/lib/SegmentedControl.js +36 -0
  86. package/dist/es6/segmented-control/lib/SegmentedControlItem.d.ts +1 -1
  87. package/dist/es6/segmented-control/lib/SegmentedControlList.d.ts +64 -1
  88. package/dist/es6/segmented-control/lib/SegmentedControlList.d.ts.map +1 -1
  89. package/dist/es6/segmented-control/lib/SegmentedControlList.js +1 -1
  90. package/dist/es6/segmented-control/lib/hooks/useSegmentedControlItem.d.ts +2 -2
  91. package/dist/es6/segmented-control/lib/hooks/useSegmentedControlModel.d.ts +39 -39
  92. package/dist/es6/segmented-control/lib/hooks/useSegmentedControlModel.js +2 -1
  93. package/dist/es6/select/lib/Select.js +2 -0
  94. package/dist/es6/side-panel/lib/SidePanel.d.ts +13 -26
  95. package/dist/es6/side-panel/lib/SidePanel.d.ts.map +1 -1
  96. package/dist/es6/side-panel/lib/SidePanel.js +75 -97
  97. package/dist/es6/side-panel/lib/SidePanelToggleButton.d.ts +17 -0
  98. package/dist/es6/side-panel/lib/SidePanelToggleButton.d.ts.map +1 -0
  99. package/dist/es6/side-panel/lib/SidePanelToggleButton.js +66 -0
  100. package/dist/es6/side-panel/lib/hooks.d.ts +20 -0
  101. package/dist/es6/side-panel/lib/hooks.d.ts.map +1 -1
  102. package/dist/es6/side-panel/lib/hooks.js +19 -0
  103. package/dist/es6/status-indicator/index.d.ts +2 -0
  104. package/dist/es6/status-indicator/index.d.ts.map +1 -1
  105. package/dist/es6/status-indicator/index.js +2 -0
  106. package/dist/es6/status-indicator/lib/StatusIndicator.d.ts +28 -2
  107. package/dist/es6/status-indicator/lib/StatusIndicator.d.ts.map +1 -1
  108. package/dist/es6/status-indicator/lib/StatusIndicator.js +27 -1
  109. package/dist/es6/status-indicator/lib/StatusIndicatorIcon.d.ts +13 -0
  110. package/dist/es6/status-indicator/lib/StatusIndicatorIcon.d.ts.map +1 -1
  111. package/dist/es6/status-indicator/lib/StatusIndicatorIcon.js +1 -1
  112. package/dist/es6/text-area/lib/TextArea.d.ts +1 -1
  113. package/dist/es6/text-area/lib/TextArea.d.ts.map +1 -1
  114. package/dist/es6/text-area/lib/TextArea.js +2 -3
  115. package/dist/es6/text-input/lib/TextInput.d.ts +2 -2
  116. package/dist/es6/text-input/lib/TextInput.d.ts.map +1 -1
  117. package/dist/es6/text-input/lib/TextInput.js +2 -3
  118. package/dist/es6/text-input/lib/TextInputField.js +3 -3
  119. package/dist/es6/text-input/lib/hooks/useTextInputField.d.ts +1 -1
  120. package/dist/es6/text-input/lib/hooks/useTextInputModel.d.ts +1 -0
  121. package/dist/es6/text-input/lib/hooks/useTextInputModel.d.ts.map +1 -1
  122. package/dist/es6/text-input/lib/hooks/useTextInputModel.js +1 -0
  123. package/form-field/lib/hooks/useFormFieldModel.tsx +1 -3
  124. package/menu/lib/Menu.tsx +12 -5
  125. package/menu/lib/MenuItem.tsx +15 -5
  126. package/package.json +4 -4
  127. package/pill/lib/Pill.tsx +101 -2
  128. package/segmented-control/index.ts +2 -0
  129. package/segmented-control/lib/SegmentedControl.tsx +36 -0
  130. package/segmented-control/lib/SegmentedControlList.tsx +1 -1
  131. package/side-panel/lib/SidePanel.tsx +119 -169
  132. package/side-panel/lib/SidePanelToggleButton.tsx +78 -0
  133. package/side-panel/lib/hooks.ts +20 -0
  134. package/status-indicator/index.ts +2 -0
  135. package/status-indicator/lib/StatusIndicator.tsx +27 -1
  136. package/status-indicator/lib/StatusIndicatorIcon.tsx +1 -1
  137. package/text-area/lib/TextArea.tsx +6 -3
  138. package/text-input/lib/TextInput.tsx +6 -3
  139. package/text-input/lib/TextInputField.tsx +3 -3
  140. package/text-input/lib/hooks/useTextInputModel.ts +1 -0
  141. package/dist/commonjs/text-area/lib/hooks/index.d.ts +0 -2
  142. package/dist/commonjs/text-area/lib/hooks/index.d.ts.map +0 -1
  143. package/dist/commonjs/text-area/lib/hooks/index.js +0 -13
  144. package/dist/commonjs/text-area/lib/hooks/useTextAreaModel.d.ts +0 -28
  145. package/dist/commonjs/text-area/lib/hooks/useTextAreaModel.d.ts.map +0 -1
  146. package/dist/commonjs/text-area/lib/hooks/useTextAreaModel.js +0 -5
  147. package/dist/es6/text-area/lib/hooks/index.d.ts +0 -2
  148. package/dist/es6/text-area/lib/hooks/index.d.ts.map +0 -1
  149. package/dist/es6/text-area/lib/hooks/index.js +0 -1
  150. package/dist/es6/text-area/lib/hooks/useTextAreaModel.d.ts +0 -28
  151. package/dist/es6/text-area/lib/hooks/useTextAreaModel.d.ts.map +0 -1
  152. package/dist/es6/text-area/lib/hooks/useTextAreaModel.js +0 -2
  153. package/text-area/lib/hooks/index.ts +0 -1
  154. package/text-area/lib/hooks/useTextAreaModel.ts +0 -3
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SidePanelToggleButton.d.ts","sourceRoot":"","sources":["../../../../side-panel/lib/SidePanelToggleButton.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAkB,YAAY,EAAW,MAAM,kCAAkC,CAAC;AAEzF,OAAO,EAAC,cAAc,EAAC,MAAM,kCAAkC,CAAC;AAMhE,MAAM,WAAW,0BAA2B,SAAQ,YAAY,CAAC,OAAO,cAAc,EAAE,KAAK,CAAC;IAC5F;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,eAAO,MAAM,qBAAqB,mGAoDhC,CAAC"}
@@ -0,0 +1,66 @@
1
+ var __assign = (this && this.__assign) || function () {
2
+ __assign = Object.assign || function(t) {
3
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
4
+ s = arguments[i];
5
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
6
+ t[p] = s[p];
7
+ }
8
+ return t;
9
+ };
10
+ return __assign.apply(this, arguments);
11
+ };
12
+ var __rest = (this && this.__rest) || function (s, e) {
13
+ var t = {};
14
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
15
+ t[p] = s[p];
16
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
17
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
18
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
19
+ t[p[i]] = s[p[i]];
20
+ }
21
+ return t;
22
+ };
23
+ /** @jsxRuntime classic */
24
+ /** @jsx jsx */
25
+ import * as React from 'react';
26
+ import { createComponent, useIsRTL } from '@workday/canvas-kit-react/common';
27
+ import { css, jsx } from '@emotion/react';
28
+ import { TertiaryButton } from '@workday/canvas-kit-react/button';
29
+ import { space } from '@workday/canvas-kit-react/tokens';
30
+ import { transformationImportIcon } from '@workday/canvas-system-icons-web';
31
+ import { Tooltip } from '@workday/canvas-kit-react/tooltip';
32
+ import { SidePanelContext } from './hooks';
33
+ /**
34
+ * A toggle button styled specifically for the side panel container.
35
+ */
36
+ export var SidePanelToggleButton = createComponent('button')({
37
+ displayName: 'SidePanel.ToggleButton',
38
+ Component: function (_a) {
39
+ var _b = _a.variant, variant = _b === void 0 ? undefined : _b, _c = _a.icon, icon = _c === void 0 ? transformationImportIcon : _c, _d = _a.tooltipTextExpand, tooltipTextExpand = _d === void 0 ? 'Expand' : _d, _e = _a.tooltipTextCollapse, tooltipTextCollapse = _e === void 0 ? 'Collapse' : _e, elemProps = __rest(_a, ["variant", "icon", "tooltipTextExpand", "tooltipTextCollapse"]);
40
+ var context = React.useContext(SidePanelContext);
41
+ var useRTLOrigin = function () {
42
+ var isRTL = useIsRTL();
43
+ // if the direction is set to RTl, flip the origin
44
+ if (isRTL) {
45
+ return context.origin === 'left' ? 'right' : 'left';
46
+ }
47
+ // Otherwise, default to returning the origin
48
+ return context.origin;
49
+ };
50
+ var rtlOrigin = useRTLOrigin();
51
+ // Note: Depending on the collapsed width, the button could "jump" to it's final position.
52
+ var buttonStyle = css({
53
+ position: 'absolute',
54
+ top: space.m,
55
+ width: space.l,
56
+ right: context.state === 'collapsed' ? 0 : rtlOrigin === 'left' ? space.s : undefined,
57
+ left: context.state === 'collapsed' ? 0 : rtlOrigin === 'right' ? space.s : undefined,
58
+ margin: context.state === 'collapsed' ? 'auto' : 0,
59
+ transform: context.state === 'collapsed' || context.state === 'collapsing'
60
+ ? "scaleX(" + (rtlOrigin === 'left' ? '1' : '-1') + ")"
61
+ : "scaleX(" + (rtlOrigin === 'left' ? '-1' : '1') + ")",
62
+ });
63
+ return (jsx(Tooltip, { title: context.state === 'collapsed' ? tooltipTextExpand : tooltipTextCollapse, type: "muted" },
64
+ jsx(TertiaryButton, __assign({ type: "button", css: buttonStyle, icon: icon, variant: variant }, elemProps))));
65
+ },
66
+ });
@@ -1,3 +1,8 @@
1
+ import * as React from 'react';
2
+ export declare const SidePanelContext: React.Context<{
3
+ state: string;
4
+ origin: string;
5
+ }>;
1
6
  /**
2
7
  * The optional config options for the `useSidePanel` hook
3
8
  */
@@ -70,6 +75,21 @@ export interface ControlProps {
70
75
  */
71
76
  onClick: () => void;
72
77
  }
78
+ /**
79
+ *
80
+ * This hook manages the state and `aria-` attributes for the SidePanel. It takes an optional
81
+ * configuration object:
82
+ *
83
+ * ```tsx
84
+ * import {useSidePanel} from '@workday/canvas-kit-preview-react/side-panel';
85
+ *
86
+ * const {expanded, setExpanded, panelProps, labelProps, controlProps} = useSidePanel({
87
+ * initialExpanded: false,
88
+ * panelId: 'custom-panel-id',
89
+ * labelId: 'custom-label-id',
90
+ * });
91
+ * ```
92
+ */
73
93
  export declare const useSidePanel: (config?: UseSidePanelProps | undefined) => {
74
94
  expanded: boolean;
75
95
  setExpanded: (newExpandedState: boolean) => void;
@@ -1 +1 @@
1
- {"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../../side-panel/lib/hooks.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,eAAO,MAAM,YAAY;;oCA2BsB,OAAO;;;;CA8BrD,CAAC"}
1
+ {"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../../side-panel/lib/hooks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,eAAO,MAAM,gBAAgB;;;EAG3B,CAAC;AAGH;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,YAAY;;oCA2BsB,OAAO;;;;CA8BrD,CAAC"}
@@ -1,5 +1,24 @@
1
1
  import * as React from 'react';
2
+ export var SidePanelContext = React.createContext({
3
+ state: 'expanded',
4
+ origin: 'left',
5
+ });
2
6
  import { useUniqueId } from '@workday/canvas-kit-react/common';
7
+ /**
8
+ *
9
+ * This hook manages the state and `aria-` attributes for the SidePanel. It takes an optional
10
+ * configuration object:
11
+ *
12
+ * ```tsx
13
+ * import {useSidePanel} from '@workday/canvas-kit-preview-react/side-panel';
14
+ *
15
+ * const {expanded, setExpanded, panelProps, labelProps, controlProps} = useSidePanel({
16
+ * initialExpanded: false,
17
+ * panelId: 'custom-panel-id',
18
+ * labelId: 'custom-label-id',
19
+ * });
20
+ * ```
21
+ */
3
22
  export var useSidePanel = function (config) {
4
23
  var _a = React.useState(false), touched = _a[0], setTouched = _a[1];
5
24
  var configParams = config
@@ -1,2 +1,4 @@
1
1
  export * from './lib/StatusIndicator';
2
+ export * from './lib/hooks/useStatusIndicatorModel';
3
+ export { useStatusIndicatorIcon } from './lib/StatusIndicatorIcon';
2
4
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../status-indicator/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../status-indicator/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,qCAAqC,CAAC;AACpD,OAAO,EAAC,sBAAsB,EAAC,MAAM,2BAA2B,CAAC"}
@@ -1 +1,3 @@
1
1
  export * from './lib/StatusIndicator';
2
+ export * from './lib/hooks/useStatusIndicatorModel';
3
+ export { useStatusIndicatorIcon } from './lib/StatusIndicatorIcon';
@@ -13,13 +13,23 @@ export declare const useStatusIndicator: <P extends {}, R>(model: {
13
13
  variant: import("./hooks").StatusIndicatorVariant;
14
14
  };
15
15
  events: {};
16
- }, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | React.RefObject<R> | null | undefined) => {
16
+ }, elemProps?: P | undefined, ref?: React.Ref<R> | undefined) => {
17
17
  opacity: string | undefined;
18
18
  color: string;
19
19
  background: string;
20
20
  } & P & (R extends HTMLOrSVGElement ? {
21
21
  ref: React.Ref<R>;
22
22
  } : {});
23
+ /**
24
+ * `StatusIndicator` is a container component which renders an {@link Flex} under the hood to
25
+ * apply spacing evenly between its children. It has a default maximum width of `200px`.
26
+ *
27
+ * ```tsx
28
+ * <StatusIndicator emphasis="low" variant="blue">
29
+ * {Child components}
30
+ * </StatusIndicator>
31
+ * ```
32
+ */
23
33
  export declare const StatusIndicator: import("@workday/canvas-kit-react/common").ElementComponentM<"div", StatusIndicatorProps & Partial<{
24
34
  emphasis: import("./hooks").StatusIndicatorEmphasis;
25
35
  variant: import("./hooks").StatusIndicatorVariant;
@@ -30,6 +40,23 @@ export declare const StatusIndicator: import("@workday/canvas-kit-react/common")
30
40
  };
31
41
  events: {};
32
42
  }> & {
43
+ /**
44
+ * `StatusIndicator.Label` renders {@link Text} under the hood. It will apply an ellipsis if its
45
+ * contents exceed the component's maximum width.
46
+ *
47
+ * ```tsx
48
+ * <StatusIndicator.Label>{The text to be rendered}</StatusIndicator.Label>
49
+ * ```
50
+ */
51
+ Label: import("@workday/canvas-kit-react/common").ElementComponent<"span", import("./StatusIndicatorLabel").StatusIndicatorLabelProps>;
52
+ /**
53
+ * `StatusIndicator.Icon` renders {@link SystemIcon} under the hood. It's used as a decorative
54
+ * element to visually support the {@link StatusIndicatorLabel StatusIndicator.Label} text.
55
+ *
56
+ * ```tsx
57
+ * <StatusIndicator.Icon icon={uploadCloudIcon} />
58
+ * ```
59
+ */
33
60
  Icon: import("@workday/canvas-kit-react/common").ElementComponentM<"span", import("./StatusIndicatorIcon").StatusIndicatorIconProps, {
34
61
  state: {
35
62
  emphasis: import("./hooks").StatusIndicatorEmphasis;
@@ -37,6 +64,5 @@ export declare const StatusIndicator: import("@workday/canvas-kit-react/common")
37
64
  };
38
65
  events: {};
39
66
  }>;
40
- Label: import("@workday/canvas-kit-react/common").ElementComponent<"span", import("./StatusIndicatorLabel").StatusIndicatorLabelProps>;
41
67
  };
42
68
  //# sourceMappingURL=StatusIndicator.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"StatusIndicator.d.ts","sourceRoot":"","sources":["../../../../status-indicator/lib/StatusIndicator.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAC,YAAY,EAAuC,MAAM,kCAAkC,CAAC;AACpG,OAAO,EAAC,IAAI,EAAC,MAAM,kCAAkC,CAAC;AAKtD,MAAM,WAAW,oBAAqB,SAAQ,YAAY,CAAC,OAAO,IAAI,EAAE,KAAK,CAAC;IAC5E;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;;OAO7B,CAAC;AAEH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;CAwB1B,CAAC"}
1
+ {"version":3,"file":"StatusIndicator.d.ts","sourceRoot":"","sources":["../../../../status-indicator/lib/StatusIndicator.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAC,YAAY,EAAuC,MAAM,kCAAkC,CAAC;AACpG,OAAO,EAAC,IAAI,EAAC,MAAM,kCAAkC,CAAC;AAKtD,MAAM,WAAW,oBAAqB,SAAQ,YAAY,CAAC,OAAO,IAAI,EAAE,KAAK,CAAC;IAC5E;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;;OAO7B,CAAC;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;IAKxB;;;;;;;OAOG;;IAEH;;;;;;;OAOG;;;;;;;;CAmBL,CAAC"}
@@ -35,13 +35,39 @@ export var useStatusIndicator = createElemPropsHook(useStatusIndicatorModel)(fun
35
35
  background: colors.background,
36
36
  };
37
37
  });
38
+ /**
39
+ * `StatusIndicator` is a container component which renders an {@link Flex} under the hood to
40
+ * apply spacing evenly between its children. It has a default maximum width of `200px`.
41
+ *
42
+ * ```tsx
43
+ * <StatusIndicator emphasis="low" variant="blue">
44
+ * {Child components}
45
+ * </StatusIndicator>
46
+ * ```
47
+ */
38
48
  export var StatusIndicator = createContainer('div')({
39
49
  displayName: 'StatusIndicator',
40
50
  modelHook: useStatusIndicatorModel,
41
51
  elemPropsHook: useStatusIndicator,
42
52
  subComponents: {
43
- Icon: StatusIndicatorIcon,
53
+ /**
54
+ * `StatusIndicator.Label` renders {@link Text} under the hood. It will apply an ellipsis if its
55
+ * contents exceed the component's maximum width.
56
+ *
57
+ * ```tsx
58
+ * <StatusIndicator.Label>{The text to be rendered}</StatusIndicator.Label>
59
+ * ```
60
+ */
44
61
  Label: StatusIndicatorLabel,
62
+ /**
63
+ * `StatusIndicator.Icon` renders {@link SystemIcon} under the hood. It's used as a decorative
64
+ * element to visually support the {@link StatusIndicatorLabel StatusIndicator.Label} text.
65
+ *
66
+ * ```tsx
67
+ * <StatusIndicator.Icon icon={uploadCloudIcon} />
68
+ * ```
69
+ */
70
+ Icon: StatusIndicatorIcon,
45
71
  },
46
72
  })(function (_a, Element, model) {
47
73
  var children = _a.children, elemProps = __rest(_a, ["children"]);
@@ -1,3 +1,4 @@
1
+ import React from 'react';
1
2
  import { SystemIconProps } from '@workday/canvas-kit-react/icon';
2
3
  export interface StatusIndicatorIconProps extends SystemIconProps {
3
4
  }
@@ -63,6 +64,18 @@ export declare const statusIndicatorColors: {
63
64
  };
64
65
  };
65
66
  };
67
+ export declare const useStatusIndicatorIcon: <P extends {}, R>(model: {
68
+ state: {
69
+ emphasis: import("./hooks").StatusIndicatorEmphasis;
70
+ variant: import("./hooks").StatusIndicatorVariant;
71
+ };
72
+ events: {};
73
+ }, elemProps?: P | undefined, ref?: React.Ref<R> | undefined) => {
74
+ color: string;
75
+ colorHover: string;
76
+ } & P & (R extends HTMLOrSVGElement ? {
77
+ ref: React.Ref<R>;
78
+ } : {});
66
79
  export declare const StatusIndicatorIcon: import("@workday/canvas-kit-react/common").ElementComponentM<"span", StatusIndicatorIconProps, {
67
80
  state: {
68
81
  emphasis: import("./hooks").StatusIndicatorEmphasis;
@@ -1 +1 @@
1
- {"version":3,"file":"StatusIndicatorIcon.d.ts","sourceRoot":"","sources":["../../../../status-indicator/lib/StatusIndicatorIcon.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAa,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAG3E,MAAM,WAAW,wBAAyB,SAAQ,eAAe;CAAG;AAIpE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6DjC,CAAC;AAUF,eAAO,MAAM,mBAAmB;;;;;;EAK9B,CAAC"}
1
+ {"version":3,"file":"StatusIndicatorIcon.d.ts","sourceRoot":"","sources":["../../../../status-indicator/lib/StatusIndicatorIcon.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,OAAO,EAAa,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAG3E,MAAM,WAAW,wBAAyB,SAAQ,eAAe;CAAG;AAIpE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6DjC,CAAC;AAEF,eAAO,MAAM,sBAAsB;;;;;;;;;;;OAMjC,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;EAK9B,CAAC"}
@@ -76,7 +76,7 @@ export var statusIndicatorColors = {
76
76
  },
77
77
  },
78
78
  };
79
- var useStatusIndicatorIcon = createElemPropsHook(useStatusIndicatorModel)(function (_a) {
79
+ export var useStatusIndicatorIcon = createElemPropsHook(useStatusIndicatorModel)(function (_a) {
80
80
  var state = _a.state;
81
81
  var colors = statusIndicatorColors[state.variant][state.emphasis];
82
82
  return {
@@ -42,7 +42,7 @@ export declare const TextArea: import("@workday/canvas-kit-react/common").Elemen
42
42
  };
43
43
  events: {};
44
44
  }>;
45
- Hint: import("@workday/canvas-kit-react/common").ElementComponentM<"p", Pick<import("@workday/canvas-kit-react/text").TypeLevelProps, "top" | "left" | "right" | "bottom" | "fill" | "children" | "color" | "resize" | "width" | "height" | "alignSelf" | "appearance" | "backgroundAttachment" | "backgroundColor" | "backgroundImage" | "backgroundRepeat" | "backgroundSize" | "borderBottomColor" | "borderBottomLeftRadius" | "borderBottomRightRadius" | "borderBottomStyle" | "borderBottomWidth" | "borderCollapse" | "borderInlineEndColor" | "borderInlineEndStyle" | "borderInlineEndWidth" | "borderInlineStartColor" | "borderInlineStartStyle" | "borderInlineStartWidth" | "borderLeftColor" | "borderLeftStyle" | "borderLeftWidth" | "borderRightColor" | "borderRightStyle" | "borderRightWidth" | "borderSpacing" | "borderTopColor" | "borderTopLeftRadius" | "borderTopRightRadius" | "borderTopStyle" | "borderTopWidth" | "boxShadow" | "boxSizing" | "content" | "cursor" | "display" | "flexBasis" | "flexGrow" | "flexShrink" | "float" | "fontFamily" | "fontSize" | "fontStyle" | "fontWeight" | "gridColumnEnd" | "gridColumnStart" | "gridRowEnd" | "gridRowStart" | "insetInlineEnd" | "insetInlineStart" | "justifySelf" | "letterSpacing" | "lineHeight" | "marginBottom" | "marginInlineEnd" | "marginInlineStart" | "marginLeft" | "marginRight" | "marginTop" | "maxHeight" | "maxWidth" | "minHeight" | "minWidth" | "objectFit" | "objectPosition" | "opacity" | "order" | "outlineOffset" | "overflowWrap" | "overflowX" | "overflowY" | "paddingBottom" | "paddingInlineEnd" | "paddingInlineStart" | "paddingLeft" | "paddingRight" | "paddingTop" | "pointerEvents" | "position" | "textAlign" | "textOverflow" | "textShadow" | "textTransform" | "transform" | "userSelect" | "verticalAlign" | "visibility" | "whiteSpace" | "wordBreak" | "zIndex" | "animation" | "background" | "backgroundPosition" | "border" | "borderBottom" | "borderColor" | "borderInlineEnd" | "borderInlineStart" | "borderLeft" | "borderRadius" | "borderRight" | "borderStyle" | "borderTop" | "borderWidth" | "flex" | "gridArea" | "gridColumn" | "gridRow" | "listStyle" | "margin" | "outline" | "overflow" | "padding" | "placeSelf" | "textDecoration" | "transition" | "stroke" | "depth" | "marginX" | "marginY" | "paddingX" | "paddingY" | "variant">, {
45
+ Hint: import("@workday/canvas-kit-react/common").ElementComponentM<"p", Omit<import("@workday/canvas-kit-react/text").TypeLevelProps, "size">, {
46
46
  state: {
47
47
  id: string;
48
48
  hasError: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"TextArea.d.ts","sourceRoot":"","sources":["../../../../text-area/lib/TextArea.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAkB,YAAY,EAAC,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAC,SAAS,EAA0B,MAAM,8CAA8C,CAAC;AAMhG,MAAM,WAAW,aAAc,SAAQ,YAAY,CAAC,OAAO,SAAS,EAAE,KAAK,CAAC;IAC1E;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgBnB,CAAC"}
1
+ {"version":3,"file":"TextArea.d.ts","sourceRoot":"","sources":["../../../../text-area/lib/TextArea.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAkB,YAAY,EAAC,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EACL,SAAS,EAGV,MAAM,8CAA8C,CAAC;AAKtD,MAAM,WAAW,aAAc,SAAQ,YAAY,CAAC,OAAO,SAAS,EAAE,KAAK,CAAC;IAC1E;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgBnB,CAAC"}
@@ -22,13 +22,12 @@ var __rest = (this && this.__rest) || function (s, e) {
22
22
  };
23
23
  import React from 'react';
24
24
  import { createContainer } from '@workday/canvas-kit-react/common';
25
- import { FormField, useFormFieldOrientation } from '@workday/canvas-kit-preview-react/form-field';
25
+ import { FormField, useFormFieldModel, useFormFieldOrientation, } from '@workday/canvas-kit-preview-react/form-field';
26
26
  import { Flex } from '@workday/canvas-kit-react/layout';
27
- import { useTextAreaModel } from './hooks';
28
27
  import { TextAreaField } from './TextAreaField';
29
28
  export var TextArea = createContainer('div')({
30
29
  displayName: 'TextArea',
31
- modelHook: useTextAreaModel,
30
+ modelHook: useFormFieldModel,
32
31
  subComponents: {
33
32
  Field: TextAreaField,
34
33
  Label: FormField.Label,
@@ -7,7 +7,7 @@ export interface TextInputProps extends ExtractProps<typeof FormField, never> {
7
7
  */
8
8
  children: React.ReactNode;
9
9
  }
10
- export declare const TextInput: import("@workday/canvas-kit-react/common").ElementComponentM<"div", import("../../form-field").FormFieldProps & Partial<{
10
+ export declare const TextInput: import("@workday/canvas-kit-react/common").ElementComponentM<"div", import("@workday/canvas-kit-preview-react/form-field").FormFieldProps & Partial<{
11
11
  hasError: boolean;
12
12
  id: string;
13
13
  isRequired: boolean;
@@ -49,7 +49,7 @@ export declare const TextInput: import("@workday/canvas-kit-react/common").Eleme
49
49
  };
50
50
  events: {};
51
51
  }>;
52
- Hint: import("@workday/canvas-kit-react/common").ElementComponentM<"p", Pick<import("@workday/canvas-kit-react/text").TypeLevelProps, "top" | "left" | "right" | "bottom" | "fill" | "children" | "color" | "resize" | "width" | "height" | "alignSelf" | "appearance" | "backgroundAttachment" | "backgroundColor" | "backgroundImage" | "backgroundRepeat" | "backgroundSize" | "borderBottomColor" | "borderBottomLeftRadius" | "borderBottomRightRadius" | "borderBottomStyle" | "borderBottomWidth" | "borderCollapse" | "borderInlineEndColor" | "borderInlineEndStyle" | "borderInlineEndWidth" | "borderInlineStartColor" | "borderInlineStartStyle" | "borderInlineStartWidth" | "borderLeftColor" | "borderLeftStyle" | "borderLeftWidth" | "borderRightColor" | "borderRightStyle" | "borderRightWidth" | "borderSpacing" | "borderTopColor" | "borderTopLeftRadius" | "borderTopRightRadius" | "borderTopStyle" | "borderTopWidth" | "boxShadow" | "boxSizing" | "content" | "cursor" | "display" | "flexBasis" | "flexGrow" | "flexShrink" | "float" | "fontFamily" | "fontSize" | "fontStyle" | "fontWeight" | "gridColumnEnd" | "gridColumnStart" | "gridRowEnd" | "gridRowStart" | "insetInlineEnd" | "insetInlineStart" | "justifySelf" | "letterSpacing" | "lineHeight" | "marginBottom" | "marginInlineEnd" | "marginInlineStart" | "marginLeft" | "marginRight" | "marginTop" | "maxHeight" | "maxWidth" | "minHeight" | "minWidth" | "objectFit" | "objectPosition" | "opacity" | "order" | "outlineOffset" | "overflowWrap" | "overflowX" | "overflowY" | "paddingBottom" | "paddingInlineEnd" | "paddingInlineStart" | "paddingLeft" | "paddingRight" | "paddingTop" | "pointerEvents" | "position" | "textAlign" | "textOverflow" | "textShadow" | "textTransform" | "transform" | "userSelect" | "verticalAlign" | "visibility" | "whiteSpace" | "wordBreak" | "zIndex" | "animation" | "background" | "backgroundPosition" | "border" | "borderBottom" | "borderColor" | "borderInlineEnd" | "borderInlineStart" | "borderLeft" | "borderRadius" | "borderRight" | "borderStyle" | "borderTop" | "borderWidth" | "flex" | "gridArea" | "gridColumn" | "gridRow" | "listStyle" | "margin" | "outline" | "overflow" | "padding" | "placeSelf" | "textDecoration" | "transition" | "stroke" | "depth" | "marginX" | "marginY" | "paddingX" | "paddingY" | "variant">, {
52
+ Hint: import("@workday/canvas-kit-react/common").ElementComponentM<"p", Omit<import("@workday/canvas-kit-react/text").TypeLevelProps, "size">, {
53
53
  state: {
54
54
  id: string;
55
55
  hasError: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"TextInput.d.ts","sourceRoot":"","sources":["../../../../text-input/lib/TextInput.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAkB,YAAY,EAAC,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAC,SAAS,EAA0B,MAAM,8CAA8C,CAAC;AAMhG,MAAM,WAAW,cAAe,SAAQ,YAAY,CAAC,OAAO,SAAS,EAAE,KAAK,CAAC;IAC3E;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgBpB,CAAC"}
1
+ {"version":3,"file":"TextInput.d.ts","sourceRoot":"","sources":["../../../../text-input/lib/TextInput.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAkB,YAAY,EAAC,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EACL,SAAS,EAGV,MAAM,8CAA8C,CAAC;AAKtD,MAAM,WAAW,cAAe,SAAQ,YAAY,CAAC,OAAO,SAAS,EAAE,KAAK,CAAC;IAC3E;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgBpB,CAAC"}
@@ -22,13 +22,12 @@ var __rest = (this && this.__rest) || function (s, e) {
22
22
  };
23
23
  import React from 'react';
24
24
  import { createContainer } from '@workday/canvas-kit-react/common';
25
- import { FormField, useFormFieldOrientation } from '@workday/canvas-kit-preview-react/form-field';
25
+ import { FormField, useFormFieldModel, useFormFieldOrientation, } from '@workday/canvas-kit-preview-react/form-field';
26
26
  import { Flex } from '@workday/canvas-kit-react/layout';
27
- import { useTextInputModel } from './hooks';
28
27
  import { TextInputField } from './TextInputField';
29
28
  export var TextInput = createContainer('div')({
30
29
  displayName: 'TextInput',
31
- modelHook: useTextInputModel,
30
+ modelHook: useFormFieldModel,
32
31
  subComponents: {
33
32
  Field: TextInputField,
34
33
  Label: FormField.Label,
@@ -15,8 +15,8 @@ import { jsx } from '@emotion/react';
15
15
  import { borderRadius, inputColors, space, type, } from '@workday/canvas-kit-react/tokens';
16
16
  import { createSubcomponent, useTheme } from '@workday/canvas-kit-react/common';
17
17
  import { useThemedRing } from '@workday/canvas-kit-labs-react/common';
18
- import { FormField } from '@workday/canvas-kit-preview-react/form-field';
19
- import { useTextInputField, useTextInputModel } from './hooks';
18
+ import { FormField, useFormFieldModel } from '@workday/canvas-kit-preview-react/form-field';
19
+ import { useTextInputField } from './hooks';
20
20
  var baseStyles = {
21
21
  transition: '0.2s box-shadow, 0.2s border-color',
22
22
  '&::placeholder': {
@@ -42,7 +42,7 @@ var baseStyles = {
42
42
  };
43
43
  export var TextInputField = createSubcomponent('input')({
44
44
  displayName: 'TextInput.Field',
45
- modelHook: useTextInputModel,
45
+ modelHook: useFormFieldModel,
46
46
  elemPropsHook: useTextInputField,
47
47
  })(function (elemProps, Element, model) {
48
48
  var theme = useTheme();
@@ -8,7 +8,7 @@ export declare const useTextInputField: <P extends {}, R>(model: {
8
8
  isRequired: boolean;
9
9
  };
10
10
  events: {};
11
- }, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | import("react").RefObject<R> | null | undefined) => {
11
+ }, elemProps?: P | undefined, ref?: import("react").Ref<R> | undefined) => {
12
12
  type: string;
13
13
  } & P & (R extends HTMLOrSVGElement ? {
14
14
  ref: import("react").Ref<R>;
@@ -1,3 +1,4 @@
1
+ /** @deprecated Please use `useFormFieldModel` instead */
1
2
  export declare const useTextInputModel: (<TT_Special_Generic>(config?: (Partial<{
2
3
  hasError: boolean;
3
4
  id: string;
@@ -1 +1 @@
1
- {"version":3,"file":"useTextInputModel.d.ts","sourceRoot":"","sources":["../../../../../text-input/lib/hooks/useTextInputModel.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;EAAoB,CAAC"}
1
+ {"version":3,"file":"useTextInputModel.d.ts","sourceRoot":"","sources":["../../../../../text-input/lib/hooks/useTextInputModel.ts"],"names":[],"mappings":"AAEA,yDAAyD;AACzD,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;EAAoB,CAAC"}
@@ -1,2 +1,3 @@
1
1
  import { useFormFieldModel } from '@workday/canvas-kit-preview-react/form-field';
2
+ /** @deprecated Please use `useFormFieldModel` instead */
2
3
  export var useTextInputModel = useFormFieldModel;
@@ -5,7 +5,6 @@ export const useFormFieldModel = createModelHook({
5
5
  /**
6
6
  * Optional flag to denote if this field has an error to display. When true the `FormField.Input` will have
7
7
  * `required` set to true, and usually some subcomponents will have a error color applied.
8
- * @default false
9
8
  */
10
9
  hasError: false,
11
10
  /**
@@ -16,13 +15,12 @@ export const useFormFieldModel = createModelHook({
16
15
  * - `FormField.Hint` will set `id` to `hint-${id}`
17
16
  *
18
17
  * If a value is not provided, a unique id will be automatically created by `useUniqueId()`.
19
- * @default `useUniqueId()`
18
+ * @default {useUniqueId}
20
19
  */
21
20
  id: '',
22
21
  /**
23
22
  * Optional flag to denote if this field is required. When true the `FormField.Input` will have
24
23
  * `required` set to true, and an asterisk will be appended to the `FormField.Label`.
25
- * @default false
26
24
  */
27
25
  isRequired: false,
28
26
  },
package/menu/lib/Menu.tsx CHANGED
@@ -78,12 +78,19 @@ const List = styled('ul')({
78
78
  });
79
79
 
80
80
  /**
81
- * ### Deprecated Menu
81
+ * As of Canvas Kit v8, this component is being soft-deprecated. It will be hard-deprecated
82
+ * (completely removed) in v9. Please see the [upgrade
83
+ * guide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page) for
84
+ * more information.
82
85
  *
83
- * As of Canvas Kit v8, this component is being soft-deprecated.
84
- * It will be hard-deprecated (completely removed) in v9. Please see the
85
- * [upgrade guide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page)
86
- * for more information.
86
+ * `DeprecatedMenu` renders a styled `<ul role="menu">` element within a {@link Card} and follows
87
+ * the [Active Menu
88
+ * pattern](https://www.w3.org/TR/wai-aria-practices/examples/menu-button/menu-button-actions-active-descendant.html)
89
+ * using `aria-activedescendant`.
90
+ *
91
+ * Undocumented props are spread to the underlying `<ul>` element.
92
+ *
93
+ * @deprecated
87
94
  */
88
95
  export class DeprecatedMenu extends React.Component<DeprecatedMenuProps, DeprecatedMenuState> {
89
96
  private id = generateUniqueId();
@@ -254,12 +254,22 @@ const scrollIntoViewIfNeeded = (elem: HTMLElement, centerIfNeeded = true): void
254
254
  };
255
255
 
256
256
  /**
257
- * ### Deprecated Menu Item
257
+ * `DeprecatedMenuItem` renders an `<li>` element with the correct attributes to ensure it is
258
+ * accessible. If you choose to implement your own custom menu items, be sure to use semantic `<li>`
259
+ * elements with the following attributes:
258
260
  *
259
- * As of Canvas Kit v8, Menu is being soft-deprecated.
260
- * It will be hard-deprecated (completely removed) in v9. Please see the
261
- * [upgrade guide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page)
262
- * for more information.
261
+ * - `role="menuitem"`
262
+ * - `tabindex={-1}`
263
+ * - `id`s following this pattern: `${MenuId}-${index}`
264
+ *
265
+ * As of Canvas Kit v8, Menu is being soft-deprecated. It will be hard-deprecated (completely
266
+ * removed) in v9. Please see the [upgrade
267
+ * guide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page) for
268
+ * more information.
269
+ *
270
+ * Undocumented props are spread to the underlying `<li>` element.
271
+ *
272
+ * @deprecated
263
273
  */
264
274
  export class DeprecatedMenuItem extends React.Component<DeprecatedMenuItemProps> {
265
275
  ref = React.createRef<HTMLLIElement>();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workday/canvas-kit-preview-react",
3
- "version": "9.0.0-alpha.336-next.6+d1c0111f",
3
+ "version": "9.0.0-alpha.344-next.3+55b3fe7a",
4
4
  "description": "Canvas Kit Preview is made up of components that have the full design and a11y review, are part of the DS ecosystem and are approved for use in product. The API's could be subject to change, but not without strong communication and migration strategies.",
5
5
  "author": "Workday, Inc. (https://www.workday.com)",
6
6
  "license": "Apache-2.0",
@@ -46,16 +46,16 @@
46
46
  "dependencies": {
47
47
  "@emotion/react": "^11.7.1",
48
48
  "@emotion/styled": "^11.6.0",
49
- "@workday/canvas-kit-react": "^9.0.0-alpha.336-next.6+d1c0111f",
49
+ "@workday/canvas-kit-react": "^9.0.0-alpha.344-next.3+55b3fe7a",
50
50
  "@workday/canvas-system-icons-web": "^3.0.0",
51
51
  "@workday/design-assets-types": "^0.2.8"
52
52
  },
53
53
  "devDependencies": {
54
54
  "@workday/canvas-accent-icons-web": "^3.0.0",
55
- "@workday/canvas-kit-labs-react": "^9.0.0-alpha.336-next.6+d1c0111f",
55
+ "@workday/canvas-kit-labs-react": "^9.0.0-alpha.344-next.3+55b3fe7a",
56
56
  "formik": "^2.2.9",
57
57
  "react-hook-form": "7.36.1",
58
58
  "yup": "^0.32.11"
59
59
  },
60
- "gitHead": "d1c0111f20f012765e9e6bba83aeee320c84f2a6"
60
+ "gitHead": "55b3fe7a6121efe010ccc7dcb961e2274c08c16d"
61
61
  }