@procore/core-react 10.20.0-rc.91 → 10.20.0-rc.95

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 (197) hide show
  1. package/dist/esm/components/Avatar/Avatar.types.d.ts +41 -2
  2. package/dist/esm/components/Card/Card.types.d.ts +16 -1
  3. package/dist/esm/components/FileSelect/FileSelect.types.d.ts +17 -60
  4. package/dist/esm/components/Menu/Menu.types.d.ts +8 -13
  5. package/dist/esm/components/Pagination/Pagination.d.ts +35 -7
  6. package/dist/esm/components/Pagination/Pagination.js +35 -7
  7. package/dist/esm/components/Pagination/Pagination.js.map +1 -1
  8. package/dist/esm/components/Pagination/Pagination.types.d.ts +16 -1
  9. package/dist/esm/components/Search/Search.types.d.ts +36 -7
  10. package/dist/esm/components/SegmentedController/SegmentedController.d.ts +66 -7
  11. package/dist/esm/components/SegmentedController/SegmentedController.js +66 -7
  12. package/dist/esm/components/SegmentedController/SegmentedController.js.map +1 -1
  13. package/dist/esm/components/TextArea/TextArea.types.d.ts +13 -1
  14. package/dist/esm/components/TextEditor/TextEditor.d.ts +16 -1
  15. package/dist/esm/components/TextEditor/TextEditor.js +16 -1
  16. package/dist/esm/components/TextEditor/TextEditor.js.map +1 -1
  17. package/dist/esm/components/TextEditor/TextEditor.types.d.ts +21 -2
  18. package/dist/esm/components/Token/Token.types.d.ts +15 -1
  19. package/dist/esm/components/Tree/Tree.js +3 -3
  20. package/dist/esm/components/Tree/Tree.js.map +1 -1
  21. package/dist/esm/components/Tree/Tree.styles.d.ts +1 -0
  22. package/dist/esm/components/Tree/Tree.styles.js +4 -2
  23. package/dist/esm/components/Tree/Tree.styles.js.map +1 -1
  24. package/dist/esm/layouts/Box/Box.types.d.ts +5 -1
  25. package/dist/esm/layouts/DetailPage/DetailPage.d.ts +8 -1
  26. package/dist/esm/layouts/DetailPage/DetailPage.js +8 -1
  27. package/dist/esm/layouts/DetailPage/DetailPage.js.map +1 -1
  28. package/dist/esm/layouts/Grid/Grid.d.ts +9 -1
  29. package/dist/esm/layouts/Grid/Grid.js +9 -1
  30. package/dist/esm/layouts/Grid/Grid.js.map +1 -1
  31. package/dist/esm/layouts/LegacyDetailPage/LegacyDetailPage.d.ts +8 -40
  32. package/dist/esm/layouts/LegacyDetailPage/LegacyDetailPage.js +8 -43
  33. package/dist/esm/layouts/LegacyDetailPage/LegacyDetailPage.js.map +1 -1
  34. package/dist/esm/layouts/ToolHeader/ToolHeader.d.ts +7 -1
  35. package/dist/esm/layouts/ToolHeader/ToolHeader.js +7 -1
  36. package/dist/esm/layouts/ToolHeader/ToolHeader.js.map +1 -1
  37. package/dist/esm/state/Anchor.d.ts +5 -1
  38. package/dist/esm/state/Anchor.js.map +1 -1
  39. package/dist/esm/state/Buffer.d.ts +5 -1
  40. package/dist/esm/state/Buffer.js +5 -1
  41. package/dist/esm/state/Buffer.js.map +1 -1
  42. package/dist/esm/state/Event.d.ts +5 -1
  43. package/dist/esm/state/Event.js +5 -1
  44. package/dist/esm/state/Event.js.map +1 -1
  45. package/dist/esm/state/I18n.d.ts +5 -1
  46. package/dist/esm/state/I18n.js +5 -1
  47. package/dist/esm/state/I18n.js.map +1 -1
  48. package/dist/esm/state/ListNavigation.d.ts +5 -1
  49. package/dist/esm/state/ListNavigation.js +5 -1
  50. package/dist/esm/state/ListNavigation.js.map +1 -1
  51. package/dist/esm/state/TextEntry.d.ts +5 -1
  52. package/dist/esm/state/TextEntry.js +5 -1
  53. package/dist/esm/state/TextEntry.js.map +1 -1
  54. package/dist/esm/state/Trigger.d.ts +5 -1
  55. package/dist/esm/state/Trigger.js +5 -1
  56. package/dist/esm/state/Trigger.js.map +1 -1
  57. package/dist/esm/state/Visibility.d.ts +5 -1
  58. package/dist/esm/state/Visibility.js +5 -1
  59. package/dist/esm/state/Visibility.js.map +1 -1
  60. package/dist/esm/state/ZIndex.d.ts +5 -1
  61. package/dist/esm/state/ZIndex.js +5 -1
  62. package/dist/esm/state/ZIndex.js.map +1 -1
  63. package/dist/props/Avatar.json +1 -1
  64. package/dist/props/Card.json +1 -1
  65. package/dist/props/FileSelect.json +1 -1
  66. package/dist/props/Form.json +1 -1
  67. package/dist/props/Menu.json +1 -1
  68. package/dist/props/Pagination.json +1 -1
  69. package/dist/props/Search.json +1 -1
  70. package/dist/props/TextArea.json +1 -1
  71. package/dist/props/TextEditor.json +1 -1
  72. package/dist/props/Token.json +1 -1
  73. package/dist/props/allProps.json +437 -339
  74. package/dist/typedoc/components/Avatar/Avatar.types.json +198 -0
  75. package/dist/typedoc/components/AvatarStack/AvatarStack.types.json +226 -0
  76. package/dist/typedoc/components/Badge/Badge.types.json +74 -0
  77. package/dist/typedoc/components/Banner/Banner.types.json +141 -0
  78. package/dist/typedoc/components/Breadcrumbs/Breadcrumbs.types.json +84 -0
  79. package/dist/typedoc/components/Button/Button.types.json +124 -0
  80. package/dist/typedoc/components/Calendar/Calendar.types.json +846 -0
  81. package/dist/typedoc/components/Card/Card.types.json +69 -0
  82. package/dist/typedoc/components/Checkbox/Checkbox.types.json +78 -0
  83. package/dist/typedoc/components/ContactItem/ContactItem.types.json +98 -0
  84. package/dist/typedoc/components/DateInput/DateInput.types.json +376 -0
  85. package/dist/typedoc/components/DateSelect/DateSelect.types.json +138 -0
  86. package/dist/typedoc/components/Dropdown/Dropdown.types.json +366 -0
  87. package/dist/typedoc/components/DropdownFlyout/DropdownFlyout.types.json +358 -0
  88. package/dist/typedoc/components/Dropzone/Dropzone.types.json +498 -0
  89. package/dist/typedoc/components/EmptyState/EmptyState.types.json +172 -0
  90. package/dist/typedoc/components/FileList/FileList.types.json +38 -0
  91. package/dist/typedoc/components/FileSelect/FileSelect.types.json +264 -0
  92. package/dist/typedoc/components/FileSelect/GridSource/GridSource.types.json +215 -0
  93. package/dist/typedoc/components/FileSelect/LocalSource/LocalSource.types.json +148 -0
  94. package/dist/typedoc/components/FileSelect/TreeSource/TreeSource.types.json +169 -0
  95. package/dist/typedoc/components/Font/Font.types.json +78 -0
  96. package/dist/typedoc/components/Form/Form.types.json +6870 -0
  97. package/dist/typedoc/components/GroupSelect/GroupSelect.types.json +520 -0
  98. package/dist/typedoc/components/Icon/Icon.types.json +114 -0
  99. package/dist/typedoc/components/Input/Input.types.json +29 -0
  100. package/dist/typedoc/components/Link/Link.types.json +48 -0
  101. package/dist/typedoc/components/Menu/Menu.types.json +717 -0
  102. package/dist/typedoc/components/MenuImperative/MenuImperative.types.json +732 -0
  103. package/dist/typedoc/components/Modal/Modal.types.json +302 -0
  104. package/dist/typedoc/components/MultiSelect/MultiSelect.types.json +298 -0
  105. package/dist/typedoc/components/Notation/Notation.types.json +48 -0
  106. package/dist/typedoc/components/NumberInput/NumberInput.types.json +288 -0
  107. package/dist/typedoc/components/OverlayTrigger/OverlayTrigger.json +188 -0
  108. package/dist/typedoc/components/Pagination/Pagination.types.json +89 -0
  109. package/dist/typedoc/components/Panel/Panel.types.json +208 -0
  110. package/dist/typedoc/components/Pill/Pill.types.json +18 -0
  111. package/dist/typedoc/components/PillSelect/PillSelect.types.json +486 -0
  112. package/dist/typedoc/components/Popover/Popover.types.json +104 -0
  113. package/dist/typedoc/components/ProgressBar/ProgressBar.types.json +58 -0
  114. package/dist/typedoc/components/RadioButton/RadioButton.types.json +68 -0
  115. package/dist/typedoc/components/Required/Required.types.json +58 -0
  116. package/dist/typedoc/components/Search/Search.types.json +233 -0
  117. package/dist/typedoc/components/SegmentedController/SegmentedController.types.json +221 -0
  118. package/dist/typedoc/components/Select/Select.types.json +330 -0
  119. package/dist/typedoc/components/Slider/Slider.types.json +68 -0
  120. package/dist/typedoc/components/Spinner/Spinner.types.json +89 -0
  121. package/dist/typedoc/components/Switch/Switch.types.json +38 -0
  122. package/dist/typedoc/components/Table/Table.types.json +1033 -0
  123. package/dist/typedoc/components/Tabs/Tabs.types.json +157 -0
  124. package/dist/typedoc/components/TextArea/TextArea.types.json +39 -0
  125. package/dist/typedoc/components/TextEditor/TextEditor.types.json +79 -0
  126. package/dist/typedoc/components/Thumbnail/Thumbnail.types.json +128 -0
  127. package/dist/typedoc/components/TieredDropdown/TieredDropdown.types.json +424 -0
  128. package/dist/typedoc/components/TieredSelect/TieredSelect.types.json +278 -0
  129. package/dist/typedoc/components/Tile/Tile.types.json +338 -0
  130. package/dist/typedoc/components/Toast/Toast.types.json +48 -0
  131. package/dist/typedoc/components/ToggleButton/ToggleButton.types.json +38 -0
  132. package/dist/typedoc/components/Token/Token.types.json +125 -0
  133. package/dist/typedoc/components/Tooltip/Tooltip.types.json +144 -0
  134. package/dist/typedoc/components/Tree/Tree.types.json +1271 -0
  135. package/dist/typedoc/components/Typeahead/Typeahead.types.json +28 -0
  136. package/dist/typedoc/components/Typography/Typography.types.json +88 -0
  137. package/dist/typedoc/layouts/Box/Box.types.json +742 -0
  138. package/dist/typedoc/layouts/DetailPage/DetailPage.json +124 -0
  139. package/dist/typedoc/layouts/Flex/Flex.types.json +268 -0
  140. package/dist/typedoc/layouts/FlexList/FlexList.types.json +298 -0
  141. package/dist/typedoc/layouts/Grid/Grid.json +120 -0
  142. package/dist/typedoc/layouts/IconLayout/IconLayout.json +1 -0
  143. package/dist/typedoc/layouts/LegacyDetailPage/LegacyDetailPage.json +48 -0
  144. package/dist/typedoc/layouts/ListPage/ListPage.types.json +115 -0
  145. package/dist/typedoc/layouts/NextDetailPage/NextDetailPage.types.json +48 -0
  146. package/dist/typedoc/layouts/NextGrid/NextGrid.types.json +105 -0
  147. package/dist/typedoc/layouts/PageLayout/PageLayout.types.json +90 -0
  148. package/dist/typedoc/layouts/ToolHeader/ToolHeader.types.json +95 -0
  149. package/dist/typedoc/utils/types.json +38 -0
  150. package/package.json +9 -7
  151. package/storybook-static/0.25cdfc54d577d52c1c6b.manager.bundle.js +1 -0
  152. package/storybook-static/0.66071c6b.iframe.bundle.js +1 -0
  153. package/storybook-static/1.cb03d9ea.iframe.bundle.js +3 -0
  154. package/storybook-static/{1.f604ac3e.iframe.bundle.js.LICENSE.txt → 1.cb03d9ea.iframe.bundle.js.LICENSE.txt} +0 -0
  155. package/storybook-static/1.cb03d9ea.iframe.bundle.js.map +1 -0
  156. package/storybook-static/2.e3f1ddbd.iframe.bundle.js +1 -0
  157. package/storybook-static/4.ca3fc33a26ad8acaa0cf.manager.bundle.js +2 -0
  158. package/storybook-static/{4.37d215da3480ddf79684.manager.bundle.js.LICENSE.txt → 4.ca3fc33a26ad8acaa0cf.manager.bundle.js.LICENSE.txt} +0 -0
  159. package/storybook-static/5.c7334e99bca309dc0f6b.manager.bundle.js +1 -0
  160. package/storybook-static/{6.72a5c826f7b9ba2a1008.manager.bundle.js → 6.8684078c90624aaf5c12.manager.bundle.js} +2 -2
  161. package/storybook-static/{6.72a5c826f7b9ba2a1008.manager.bundle.js.LICENSE.txt → 6.8684078c90624aaf5c12.manager.bundle.js.LICENSE.txt} +0 -0
  162. package/storybook-static/7.2d596a64.iframe.bundle.js +3 -0
  163. package/storybook-static/{7.be450f50.iframe.bundle.js.LICENSE.txt → 7.2d596a64.iframe.bundle.js.LICENSE.txt} +1 -1
  164. package/storybook-static/7.2d596a64.iframe.bundle.js.map +1 -0
  165. package/storybook-static/{7.5bf306f93261894e2733.manager.bundle.js → 7.5dd8b1d63c6ccb2b7d4f.manager.bundle.js} +1 -1
  166. package/storybook-static/{8.38854c3a6e86288d54cc.manager.bundle.js → 8.9c2959b68dd6b32c4949.manager.bundle.js} +1 -1
  167. package/storybook-static/8.a80b4344.iframe.bundle.js +1 -0
  168. package/storybook-static/iframe.html +1 -1
  169. package/storybook-static/index.html +1 -1
  170. package/storybook-static/main.01bf0da23679c71a30ae.manager.bundle.js +1 -0
  171. package/storybook-static/{main.1538a289.iframe.bundle.js → main.8bf17d1f.iframe.bundle.js} +1 -1
  172. package/storybook-static/{runtime~main.3937db5d0c29ffeb9085.manager.bundle.js → runtime~main.f7aa4e9b5144dc1a277f.manager.bundle.js} +1 -1
  173. package/storybook-static/{runtime~main.ab98e1f1.iframe.bundle.js → runtime~main.f83a03f8.iframe.bundle.js} +1 -1
  174. package/storybook-static/vendors~main.9381682917547df19d6c.manager.bundle.js +2 -0
  175. package/storybook-static/{vendors~main.3cce118bc9035e221837.manager.bundle.js.LICENSE.txt → vendors~main.9381682917547df19d6c.manager.bundle.js.LICENSE.txt} +0 -6
  176. package/storybook-static/vendors~main.d8755a0a.iframe.bundle.js +3 -0
  177. package/storybook-static/{vendors~main.484f0d61.iframe.bundle.js.LICENSE.txt → vendors~main.d8755a0a.iframe.bundle.js.LICENSE.txt} +0 -0
  178. package/storybook-static/vendors~main.d8755a0a.iframe.bundle.js.map +1 -0
  179. package/tsconfig.json +6 -0
  180. package/tsconfig.prod.json +1 -1
  181. package/typedoc.js +1 -1
  182. package/typedoc.ts +187 -0
  183. package/storybook-static/0.41e28a0bb94d5e5489a5.manager.bundle.js +0 -1
  184. package/storybook-static/0.b4bb1ac1.iframe.bundle.js +0 -1
  185. package/storybook-static/1.f604ac3e.iframe.bundle.js +0 -3
  186. package/storybook-static/1.f604ac3e.iframe.bundle.js.map +0 -1
  187. package/storybook-static/2.127b3eae.iframe.bundle.js +0 -1
  188. package/storybook-static/4.37d215da3480ddf79684.manager.bundle.js +0 -2
  189. package/storybook-static/5.81000771920a22421f7b.manager.bundle.js +0 -1
  190. package/storybook-static/7.be450f50.iframe.bundle.js +0 -3
  191. package/storybook-static/7.be450f50.iframe.bundle.js.map +0 -1
  192. package/storybook-static/8.8a74f8ce.iframe.bundle.js +0 -1
  193. package/storybook-static/main.2ac4adfe9a439a3c1992.manager.bundle.js +0 -1
  194. package/storybook-static/vendors~main.3cce118bc9035e221837.manager.bundle.js +0 -2
  195. package/storybook-static/vendors~main.484f0d61.iframe.bundle.js +0 -3
  196. package/storybook-static/vendors~main.484f0d61.iframe.bundle.js.map +0 -1
  197. package/tsconfig.dev.json +0 -4
@@ -3,25 +3,64 @@ export declare type AvatarSize = Extract<Size, 'md' | 'lg' | 'xl'>;
3
3
  export interface AvatarProps extends Props {
4
4
  /**
5
5
  * Sets the avatar's clickable state
6
+ *
6
7
  * @defaultValue false
7
8
  */
8
9
  clickable?: boolean;
9
10
  /**
10
11
  * Sets the avatar's disabled state
12
+ *
11
13
  * @defaultValue false
12
14
  */
13
15
  disabled?: boolean;
14
16
  /**
15
17
  * Sets the avatar's size
18
+ *
16
19
  * @defaultValue md
17
- * @deprecated Partially deprecated: "xl" will be removed in a future version. Please use "lg" instead of "xl".
20
+ *
21
+ * @deprecated
22
+ *
23
+ * Size "xl" has been deprecated and will be removed in a future version.
24
+ * Please use "lg" instead of "xl".
25
+ *
26
+ * **Before**
27
+ *
28
+ * `<Avatar size="xl" />`
29
+ *
30
+ * **After**
31
+ *
32
+ * `<Avatar size="lg" />`
33
+ *
34
+ * @deprecatedSince 10.20.0
18
35
  */
19
36
  size?: AvatarSize;
20
37
  }
21
38
  export interface AvatarIconProps extends Props {
22
39
  /**
23
40
  * The icon to display
24
- * @deprecated Partially deprecated: string icon variant will be removed in the future. Please use the React components directly from the `@procore/core-icons/dist` package.
41
+ *
42
+ * @deprecated
43
+ *
44
+ * The `string` type icon has been deprecated and will be removed in the future.
45
+ * Please use a React icon component from the `@procore/core-icons/dist` package.
46
+ *
47
+ * **Before**
48
+ *
49
+ * ```
50
+ * <Avatar>
51
+ * <Avatar.Icon icon="building" />
52
+ * </Avatar>
53
+ * ```
54
+ *
55
+ * **After**
56
+ *
57
+ * ```
58
+ * <Avatar>
59
+ * <Avatar.Icon icon={<Building />} />
60
+ * </Avatar>
61
+ * ```
62
+
63
+ * @deprecatedSince 10.20.0
25
64
  */
26
65
  icon: string | React.ReactNode;
27
66
  }
@@ -8,11 +8,26 @@ export declare type CardVariant = 'hoverable';
8
8
  export interface CardProps extends Props {
9
9
  /**
10
10
  * The card level for determining the shadow
11
- * @deprecated "level" prop will be removed in a future version. Use "shadowStrength" prop instead for determining the shadow.
11
+ *
12
+ * @deprecated
13
+ *
14
+ * The `level` prop has been deprecated and will be removed in a future version.
15
+ * Please use the `shadowStrength` prop instead.
16
+ *
17
+ * **Before**
18
+ *
19
+ * <Card level={20} />
20
+ *
21
+ * **After**
22
+ *
23
+ * <Card shadowStrength={2} />
24
+ *
25
+ * @deprecatedSince 10.20.0
12
26
  */
13
27
  level?: CardLevel;
14
28
  /**
15
29
  * Determines shadow strength
30
+ *
16
31
  * @defaultValue 1
17
32
  */
18
33
  shadowStrength?: ShadowStrength;
@@ -61,27 +61,17 @@ export interface QaTags {
61
61
  }
62
62
  export interface FileSelectProps extends Omit<DivAttributes, 'onError' | 'onProgress'> {
63
63
  /**
64
- * <Code>(addedValues: FileSelectValue) => void</Code>
65
- * <br />
66
- * <br />
67
64
  * To be called every time when the files are uploaded directly or
68
65
  * attached via file explorer. The input data should be appended to the
69
66
  * current value. Files with upload errors are omitted.
70
67
  */
71
68
  onAdd?: (value: FileSelectValue) => void;
72
69
  /**
73
- * <Code>(valueEntry: FileSelectValueEntry) => void</Code>
74
- * <br />
75
- * <br />
76
- * To be called whenever the file is removed by user from the primary
77
- * token list. Removed item should be deleted from the current value by{' '}
78
- * <Code>id</Code> key
70
+ * To be called whenever the file is removed by user from the primary token
71
+ * list. Removed item should be deleted from the current value by `id` key
79
72
  */
80
73
  onRemove?: (valueEntry: FileSelectValueEntry) => void;
81
74
  /**
82
- * <Code>(fileId: string, progress: number) => void</Code>
83
- * <br />
84
- * <br />
85
75
  * To be called whenever the upload progress is changed
86
76
  */
87
77
  onProgress?: (fileId: ValueId, progress: number) => void;
@@ -90,33 +80,23 @@ export interface FileSelectProps extends Omit<DivAttributes, 'onError' | 'onProg
90
80
  * local file. If you want to restrict certain uploads, you can use this
91
81
  * callback. Returning true continues the upload, while false will prevent
92
82
  * upload.
93
- * <Code>{'(files: ThumbnailListItem[]) => Promise<boolean>'}</Code>
94
83
  */
95
84
  beforeLocalFileUpload?: (files: ThumbnailListItem[]) => Promise<boolean>;
96
85
  /**
97
- * <Code>(isPendingUpload: boolean) => void</Code>
98
- * <br />
99
- * <br />
100
86
  * To be called whenever upload state is changed
101
87
  */
102
88
  onUploadStateChange?: (isPendingUpload: boolean) => void;
103
89
  /**
104
- * <Code>(fileId: string, error: unknown) => void</Code>
105
- * <br />
106
- * <br />
107
90
  * To be called whenever an upload error occures
108
91
  */
109
92
  onError?: (fileId: ValueId, error: unknown) => void;
110
93
  /**
111
- * <Code>(file: FileSelectValueEntry) => void</Code>
112
- * <br />
113
- * <br />
114
94
  * To be called when attached file receives a click
115
95
  */
116
96
  onFileTokenClick?: (file: FileSelectValueEntry) => void;
117
97
  /**
118
- * An optional content renderer for the dropzone. Accepts{' '}
119
- * <Code>{'{ open, disabled, errorMessage }'}</Code> as a single argument,
98
+ * An optional content renderer for the dropzone. Accepts
99
+ * `{ open, disabled, errorMessage }` as a single argument,
120
100
  * allowing to control the dropzone and display different content depending
121
101
  * on dropzone state
122
102
  */
@@ -131,64 +111,41 @@ export interface FileSelectProps extends Omit<DivAttributes, 'onError' | 'onProg
131
111
  */
132
112
  hideLocalSource?: boolean;
133
113
  /**
134
- * <Code>(sourceId: string, sourceValueEntry: unknown) => string</Code>
135
- * <br />
136
- * <br />
137
- * Customize the token label for a given source value. By default,{' '}
138
- * <Code>sourceValueEntry.name</Code> is returned.
114
+ * Customize the token label for a given source value. By default,
115
+ * `sourceValueEntry.name` is returned.
139
116
  */
140
117
  getTokenLabel?: (sourceId: string, sourceValueEntry: unknown) => string;
141
118
  localSourceDropzoneContentRenderer?: (dropzoneProps: DropzoneContentProps) => React.ReactNode;
142
119
  /**
143
- * <Code>(file: File) => string</Code>
144
- * <br />
145
- * <br />A function returning an upload URL for a given file. An
146
- * alternative to <Code>uploadFile</Code> which allows manual control of
120
+ * A function returning an upload URL for a given file. An
121
+ * alternative to `uploadFile` which allows manual control of
147
122
  * the network request for file upload.
148
123
  */
149
124
  getEndpoint?: (file: File) => string;
150
125
  /**
151
- * <Code>(file: File) => HTTPRequestMethod</Code>
152
- * <br />
153
- * <br />A function returning an upload HTTP method for a given file.
154
- * Returns <Code>POST</Code> by default.
126
+ * A function returning an upload HTTP method for a given file.
127
+ * Returns `POST` by default.
155
128
  */
156
129
  getMethod?: (file: File) => Method;
157
130
  /**
158
- * <Code>(file: File) => string</Code>
159
- * <br />
160
- * <br />A function returning an upload payload <Code>FormData</Code> key
161
- * for a given file. Returns <Code>file</Code> by default.
131
+ * A function returning an upload payload `FormData` key
132
+ * for a given file. Returns `file` by default.
162
133
  */
163
134
  getPayloadKey?: (file: File) => string;
164
135
  /**
165
- * <Code>(file: File) => FormData</Code>
166
- * <br />
167
- * <br />A function returning an upload payload <Code>FormData</Code>{' '}
168
- * object for a given file. When defined, <Code>getPayloadKey</Code> is
136
+ * A function returning an upload payload `FormData`
137
+ * object for a given file. When defined, `getPayloadKey` is
169
138
  * ignored.
170
139
  */
171
140
  getPayload?: (file: File) => FormData;
172
141
  /**
173
- * <Code>(file: File) => object</Code>
174
- * <br />
175
- * <br />A function returning an upload request headers. Returns empty
142
+ * A function returning an upload request headers. Returns empty
176
143
  * object by default.
177
144
  */
178
145
  getHeaders?: (file: File) => Record<string, string>;
179
146
  /**
180
- * <Code>
181
- * (file: File,{' '}
182
- * {`{
183
- * onProgress: (progress: number) => void
184
- * onSuccess: (response: unknown) => void
185
- * onError: (error: unknown) => void
186
- * }`}
187
- * ) => string
188
- * </Code>
189
- * <br />
190
- * <br />A function for manually controlling the network request for file
191
- * upload. An alternative to using <Code>getEndpoint</Code> which handles
147
+ * A function for manually controlling the network request for file
148
+ * upload. An alternative to using `getEndpoint` which handles
192
149
  * the network request itself.
193
150
  */
194
151
  uploadFile?: UploadFile;
@@ -62,12 +62,6 @@ export interface HeaderProps extends Props {
62
62
  export interface FooterProps extends Omit<BoxProps, 'as'> {
63
63
  }
64
64
  export interface MenuHookConfig {
65
- /**
66
- * @deprecated
67
- * <CodeBlock>
68
- * (element: any, index?: number, list?: any[]) => boolean
69
- * </CodeBlock>
70
- */
71
65
  isSelectable?: MenuHook['isSelectable'];
72
66
  keyHandlerRef?: React.RefObject<HTMLElement>;
73
67
  multiple?: boolean;
@@ -82,12 +76,6 @@ export interface MenuHook {
82
76
  onKeyDown: (e: React.KeyboardEvent<HTMLElement>) => void;
83
77
  };
84
78
  highlighted: React.MutableRefObject<HTMLDivElement | null>;
85
- /**
86
- * @deprecated
87
- * <CodeBlock>
88
- * (element: any, index?: number, list?: any[]) => boolean
89
- * </CodeBlock>
90
- */
91
79
  isSelectable: ElementTypeChecker;
92
80
  listNavigation: ListNavigationApi;
93
81
  multiple: boolean;
@@ -101,10 +89,17 @@ export interface MenuHook {
101
89
  }
102
90
  export interface MenuProps extends Props, Omit<OptionsProps, 'padding'> {
103
91
  /**
104
- * @deprecated
105
92
  * <CodeBlock>
106
93
  * (element: any, index?: number, list?: any[]) => boolean
107
94
  * </CodeBlock>
95
+ *
96
+ * @deprecated
97
+ *
98
+ * The `isSelectable` prop has been deprecated and will be removed in a future version.
99
+ * Menu item selection is now handled internally and there is no need to configure this
100
+ * anymore.
101
+ *
102
+ * @deprecatedSince 10.20.0
108
103
  */
109
104
  isSelectable?: ElementTypeChecker;
110
105
  /**
@@ -11,33 +11,61 @@ export declare const Field: React.ForwardRefExoticComponent<DivAttributes & Fiel
11
11
  export declare const Pagination_: React.ForwardRefExoticComponent<PresetPaginationProps & React.RefAttributes<HTMLDivElement>>;
12
12
  export declare const Pagination: React.ForwardRefExoticComponent<PresetPaginationProps & React.RefAttributes<HTMLDivElement>> & {
13
13
  /**
14
- * @deprecated Pagination subcomponents will be removed in a future version
14
+ * @deprecated
15
+ *
16
+ * Pagination subcomponents will be removed in a future version
17
+ *
18
+ * @deprecatedSince 10.20.0
15
19
  */
16
20
  Container: React.ForwardRefExoticComponent<DivAttributes & Props & React.RefAttributes<HTMLDivElement>>;
17
21
  /**
18
- * @deprecated Pagination subcomponents will be removed in a future version
22
+ * @deprecated
23
+ *
24
+ * Pagination subcomponents will be removed in a future version
25
+ *
26
+ * @deprecatedSince 10.20.0
19
27
  */
20
28
  Field: React.ForwardRefExoticComponent<DivAttributes & FieldProps & React.RefAttributes<HTMLDivElement>>;
21
29
  /**
22
- * @deprecated Pagination subcomponents will be removed in a future version
30
+ * @deprecated
31
+ *
32
+ * Pagination subcomponents will be removed in a future version
33
+ *
34
+ * @deprecatedSince 10.20.0
23
35
  */
24
36
  Footer: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLDivElement>>;
25
37
  /**
26
- * @deprecated Pagination subcomponents will be removed in a future version
38
+ * @deprecated
39
+ *
40
+ * Pagination subcomponents will be removed in a future version
41
+ *
42
+ * @deprecatedSince 10.20.0
27
43
  */
28
44
  Label: React.ForwardRefExoticComponent<SpanAttributes & Props & {
29
45
  color?: Color | undefined;
30
46
  } & React.RefAttributes<HTMLSpanElement>>;
31
47
  /**
32
- * @deprecated Please use <Button icon={\<ChevronRight /\>} variant="tertiary" />
48
+ * @deprecated
49
+ *
50
+ * Please use <Button icon={\<ChevronRight /\>} variant="tertiary" />
51
+ *
52
+ * @deprecatedSince 10.20.0
33
53
  */
34
54
  Next: React.ForwardRefExoticComponent<ButtonAttributes & NavigationIconProps & React.RefAttributes<HTMLButtonElement>>;
35
55
  /**
36
- * @deprecated Pagination subcomponents will be removed in a future version
56
+ * @deprecated
57
+ *
58
+ * Pagination subcomponents will be removed in a future version
59
+ *
60
+ * @deprecatedSince 10.20.0
37
61
  */
38
62
  Notation: React.ForwardRefExoticComponent<PageNotationProps & React.RefAttributes<HTMLDivElement>>;
39
63
  /**
40
- * @deprecated Please use <Button icon={\<ChevronLeft /\>} variant="tertiary" />
64
+ * @deprecated
65
+ *
66
+ * Please use <Button icon={\<ChevronLeft /\>} variant="tertiary" />
67
+ *
68
+ * @deprecatedSince 10.20.0
41
69
  */
42
70
  Prev: React.ForwardRefExoticComponent<ButtonAttributes & NavigationIconProps & React.RefAttributes<HTMLButtonElement>>;
43
71
  };
@@ -111,31 +111,59 @@ Notation.displayName = 'Pagination.Notation';
111
111
  Prev.displayName = 'Pagination.Prev';
112
112
  export var Pagination = addSubcomponents({
113
113
  /**
114
- * @deprecated Pagination subcomponents will be removed in a future version
114
+ * @deprecated
115
+ *
116
+ * Pagination subcomponents will be removed in a future version
117
+ *
118
+ * @deprecatedSince 10.20.0
115
119
  */
116
120
  Container: Container,
117
121
  /**
118
- * @deprecated Pagination subcomponents will be removed in a future version
122
+ * @deprecated
123
+ *
124
+ * Pagination subcomponents will be removed in a future version
125
+ *
126
+ * @deprecatedSince 10.20.0
119
127
  */
120
128
  Field: Field,
121
129
  /**
122
- * @deprecated Pagination subcomponents will be removed in a future version
130
+ * @deprecated
131
+ *
132
+ * Pagination subcomponents will be removed in a future version
133
+ *
134
+ * @deprecatedSince 10.20.0
123
135
  */
124
136
  Footer: Footer,
125
137
  /**
126
- * @deprecated Pagination subcomponents will be removed in a future version
138
+ * @deprecated
139
+ *
140
+ * Pagination subcomponents will be removed in a future version
141
+ *
142
+ * @deprecatedSince 10.20.0
127
143
  */
128
144
  Label: Label,
129
145
  /**
130
- * @deprecated Please use <Button icon={\<ChevronRight /\>} variant="tertiary" />
146
+ * @deprecated
147
+ *
148
+ * Please use <Button icon={\<ChevronRight /\>} variant="tertiary" />
149
+ *
150
+ * @deprecatedSince 10.20.0
131
151
  */
132
152
  Next: Next,
133
153
  /**
134
- * @deprecated Pagination subcomponents will be removed in a future version
154
+ * @deprecated
155
+ *
156
+ * Pagination subcomponents will be removed in a future version
157
+ *
158
+ * @deprecatedSince 10.20.0
135
159
  */
136
160
  Notation: Notation,
137
161
  /**
138
- * @deprecated Please use <Button icon={\<ChevronLeft /\>} variant="tertiary" />
162
+ * @deprecated
163
+ *
164
+ * Please use <Button icon={\<ChevronLeft /\>} variant="tertiary" />
165
+ *
166
+ * @deprecatedSince 10.20.0
139
167
  */
140
168
  Prev: Prev,
141
169
  }, Pagination_);
@@ -1 +1 @@
1
- {"version":3,"file":"Pagination.js","sourceRoot":"","sources":["../../../../src/components/Pagination/Pagination.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACpE,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC1D,OAAO,GAAG,MAAM,mBAAmB,CAAA;AACnC,OAAO,IAAI,MAAM,oBAAoB,CAAA;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAEjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAO/D,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAElD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AACrD,OAAO,EACL,YAAY,EACZ,eAAe,EACf,iBAAiB,EACjB,eAAe,GAChB,MAAM,qBAAqB,CAAA;AAS5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAErD,SAAS,IAAI,KAAI,CAAC;AAElB,IAAM,aAAa,GAAG,UAAC,EAKA;QAJrB,kBAAc,EAAd,UAAU,mBAAG,CAAC,KAAA,EACd,aAAS,EAAT,KAAK,mBAAG,CAAC,KAAA,EACT,oBAAuB,EAAvB,YAAY,mBAAG,cAAO,CAAC,KAAA,EACvB,eAAW,EAAX,OAAO,mBAAG,CAAC,KAAA;IAEX,IAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,CAAA;IAExC,OAAO;QACL,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,OAAO,EAAE,KAAK,CAAC;QAC1C,OAAO,EAAE,UAAU,KAAK,CAAC;QACzB,MAAM,EAAE,UAAU,KAAK,KAAK;QAC5B,KAAK,OAAA;QACL,UAAU,EAAE,cAAM,OAAA,YAAY,CAAC,UAAU,GAAG,CAAC,CAAC,EAA5B,CAA4B;QAC9C,UAAU,EAAE,UAAC,SAAoB,IAAK,OAAA,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,EAA5B,CAA4B;QAClE,UAAU,EAAE,cAAM,OAAA,YAAY,CAAC,UAAU,GAAG,CAAC,CAAC,EAA5B,CAA4B;QAC9C,KAAK,EAAE,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,OAAO,GAAG,CAAC;KACtC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,SAAS,GAAG,KAAK,CAAC,UAAU,CAGvC,SAAS,SAAS,CAAC,KAAK,EAAE,GAAG;IAC7B,OAAO,oBAAC,IAAI,aAAC,GAAG,EAAE,GAAG,IAAM,KAAK,IAAE,UAAU,EAAC,QAAQ,IAAG,CAAA;AAC1D,CAAC,CAAC,CAAA;AAEF,MAAM,CAAC,IAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAAwB,SAAS,MAAM,CAC3E,KAAK,EACL,GAAG;IAEH,OAAO,oBAAC,cAAc,CAAC,MAAM,aAAC,GAAG,EAAE,GAAG,IAAM,KAAK,IAAE,OAAO,EAAC,WAAW,IAAG,CAAA;AAC3E,CAAC,CAAC,CAAA;AAEF,MAAM,CAAC,IAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CACtC,SAAS,QAAQ,CAAC,EAAqB,EAAE,GAAG;QAAxB,GAAG,SAAA,EAAE,KAAK,WAAA,EAAE,KAAK,WAAA;IACnC,IAAM,IAAI,GAAG,cAAc,EAAE,CAAA;IAC7B,OAAO,CACL,oBAAC,UAAU,IAAC,GAAG,EAAE,GAAG,EAAE,MAAM,QAAC,KAAK,EAAC,QAAQ,IACxC,UAAG,KAAK,cAAI,GAAG,cAAI,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,cAAI,KAAK,CAAE,CACtD,CACd,CAAA;AACH,CAAC,CACF,CAAA;AAED,MAAM,CAAC,IAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAGlC,SAAS,IAAI,CAAC,KAAK,EAAE,GAAG;IACxB,IAAM,IAAI,GAAG,cAAc,EAAE,CAAA;IAC7B,OAAO,CACL,oBAAC,MAAM,aACL,GAAG,EAAE,GAAG,IACJ,KAAK,kBACG,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAC9C,OAAO,EAAC,UAAU,EAClB,IAAI,EAAE,oBAAC,YAAY,OAAG,IACtB,CACH,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,MAAM,CAAC,IAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAGlC,SAAS,IAAI,CAAC,KAAK,EAAE,GAAG;IACxB,IAAM,IAAI,GAAG,cAAc,EAAE,CAAA;IAC7B,OAAO,CACL,oBAAC,MAAM,aACL,GAAG,EAAE,GAAG,IACJ,KAAK,kBACG,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAC9C,OAAO,EAAC,UAAU,EAClB,IAAI,EAAE,oBAAC,WAAW,OAAG,IACrB,CACH,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,IAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAG5B,SAAS,KAAK,CAAC,KAAK,EAAE,GAAG;IACzB,OAAO,oBAAC,UAAU,eAAK,KAAK,IAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;AACtE,CAAC,CAAC,CAAA;AAEF,MAAM,CAAC,IAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAGnC,SAAS,KAAK,CAAC,EAAmB,EAAE,GAAG;QAAtB,QAAQ,cAAA,EAAE,KAAK,WAAA;IAChC,IAAM,IAAI,GAAG,cAAc,EAAE,CAAA;IAE7B,OAAO,CACL;QACE,oBAAC,KAAK;YAAE,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,sBAAsB,CAAC;gBAAU;QACzD,oBAAC,GAAG,IAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAC,IAAI,IAC5B,QAAQ,CACL,CACL,CACJ,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,MAAM,CAAC,IAAM,WAAW,GAAG,KAAK,CAAC,UAAU,CAGzC,SAAS,UAAU,CACnB,EAOC,EACD,GAAG;IAPD,IAAA,kBAAc,EAAd,UAAU,mBAAG,CAAC,KAAA,EACd,UAAU,gBAAA,EACV,KAAK,WAAA,EACL,oBAAmB,EAAnB,YAAY,mBAAG,IAAI,KAAA,EACnB,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA,EACT,KAAK,cANV,gEAOC,CADS;IAIJ,IAAA,KASF,aAAa,CAAC;QAChB,UAAU,YAAA;QACV,KAAK,OAAA;QACL,YAAY,cAAA;QACZ,OAAO,SAAA;KACR,CAAC,EAbA,GAAG,SAAA,EACH,OAAO,aAAA,EACP,MAAM,YAAA,EACN,KAAK,WAAA,EACL,UAAU,gBAAA,EACV,UAAU,gBAAA,EACV,UAAU,gBAAA,EACV,KAAK,WAML,CAAA;IAEF,cAAc,CAAC;QACb,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,iCAAiC;QAC3C,QAAQ,EACN,sEAAsE;KACzE,CAAC,CAAA;IAEF,IAAM,IAAI,GAAG,cAAc,EAAE,CAAA;IAE7B,OAAO,CACL,oBAAC,eAAe,aAAC,GAAG,EAAE,GAAG,IAAM,KAAK;QAClC,oBAAC,eAAe,IAAC,GAAG,EAAE,GAAG,EAAE,MAAM,QAAC,KAAK,EAAC,QAAQ,IAC7C,UAAG,KAAK,cAAI,GAAG,cAAI,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,cAAI,KAAK,CAAE,CACjD;QAClB,oBAAC,iBAAiB;YACf,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,sBAAsB,CAAC;gBAC3B;QACpB,oBAAC,gBAAgB,IACf,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,KAAK,IAAI,CAAC,EACpB,QAAQ,EAAE,UAAU,EACpB,KAAK,EAAE,KAAK,GACZ;QACF,oBAAC,YAAY,IACX,QAAQ,EAAE,OAAO,EACjB,OAAO,EAAC,UAAU,gBACN,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAC9C,IAAI,EAAE,oBAAC,WAAW,OAAG,EACrB,OAAO,EAAE,UAAU,GACnB;QACF,oBAAC,YAAY,IACX,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAC,UAAU,gBACN,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAC9C,IAAI,EAAE,oBAAC,YAAY,OAAG,EACtB,OAAO,EAAE,UAAU,GACnB,CACc,CACnB,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,WAAW,CAAC,WAAW,GAAG,YAAY,CAAA;AAEtC,SAAS,CAAC,WAAW,GAAG,sBAAsB,CAAA;AAE9C,KAAK,CAAC,WAAW,GAAG,kBAAkB,CAAA;AAEtC,MAAM,CAAC,WAAW,GAAG,mBAAmB,CAAA;AAExC,KAAK,CAAC,WAAW,GAAG,kBAAkB,CAAA;AAEtC,IAAI,CAAC,WAAW,GAAG,iBAAiB,CAAA;AAEpC,QAAQ,CAAC,WAAW,GAAG,qBAAqB,CAAA;AAE5C,IAAI,CAAC,WAAW,GAAG,iBAAiB,CAAA;AAEpC,MAAM,CAAC,IAAM,UAAU,GAAG,gBAAgB,CACxC;IACE;;OAEG;IACH,SAAS,WAAA;IACT;;OAEG;IACH,KAAK,OAAA;IACL;;OAEG;IACH,MAAM,QAAA;IACN;;OAEG;IACH,KAAK,OAAA;IACL;;OAEG;IACH,IAAI,MAAA;IACJ;;OAEG;IACH,QAAQ,UAAA;IACR;;OAEG;IACH,IAAI,MAAA;CACL,EACD,WAAW,CACZ,CAAA;AAED,eAAe,UAAU,CAAA"}
1
+ {"version":3,"file":"Pagination.js","sourceRoot":"","sources":["../../../../src/components/Pagination/Pagination.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACpE,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC1D,OAAO,GAAG,MAAM,mBAAmB,CAAA;AACnC,OAAO,IAAI,MAAM,oBAAoB,CAAA;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAEjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAO/D,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAElD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AACrD,OAAO,EACL,YAAY,EACZ,eAAe,EACf,iBAAiB,EACjB,eAAe,GAChB,MAAM,qBAAqB,CAAA;AAS5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAErD,SAAS,IAAI,KAAI,CAAC;AAElB,IAAM,aAAa,GAAG,UAAC,EAKA;QAJrB,kBAAc,EAAd,UAAU,mBAAG,CAAC,KAAA,EACd,aAAS,EAAT,KAAK,mBAAG,CAAC,KAAA,EACT,oBAAuB,EAAvB,YAAY,mBAAG,cAAO,CAAC,KAAA,EACvB,eAAW,EAAX,OAAO,mBAAG,CAAC,KAAA;IAEX,IAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,CAAA;IAExC,OAAO;QACL,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,OAAO,EAAE,KAAK,CAAC;QAC1C,OAAO,EAAE,UAAU,KAAK,CAAC;QACzB,MAAM,EAAE,UAAU,KAAK,KAAK;QAC5B,KAAK,OAAA;QACL,UAAU,EAAE,cAAM,OAAA,YAAY,CAAC,UAAU,GAAG,CAAC,CAAC,EAA5B,CAA4B;QAC9C,UAAU,EAAE,UAAC,SAAoB,IAAK,OAAA,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,EAA5B,CAA4B;QAClE,UAAU,EAAE,cAAM,OAAA,YAAY,CAAC,UAAU,GAAG,CAAC,CAAC,EAA5B,CAA4B;QAC9C,KAAK,EAAE,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,OAAO,GAAG,CAAC;KACtC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,SAAS,GAAG,KAAK,CAAC,UAAU,CAGvC,SAAS,SAAS,CAAC,KAAK,EAAE,GAAG;IAC7B,OAAO,oBAAC,IAAI,aAAC,GAAG,EAAE,GAAG,IAAM,KAAK,IAAE,UAAU,EAAC,QAAQ,IAAG,CAAA;AAC1D,CAAC,CAAC,CAAA;AAEF,MAAM,CAAC,IAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAAwB,SAAS,MAAM,CAC3E,KAAK,EACL,GAAG;IAEH,OAAO,oBAAC,cAAc,CAAC,MAAM,aAAC,GAAG,EAAE,GAAG,IAAM,KAAK,IAAE,OAAO,EAAC,WAAW,IAAG,CAAA;AAC3E,CAAC,CAAC,CAAA;AAEF,MAAM,CAAC,IAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CACtC,SAAS,QAAQ,CAAC,EAAqB,EAAE,GAAG;QAAxB,GAAG,SAAA,EAAE,KAAK,WAAA,EAAE,KAAK,WAAA;IACnC,IAAM,IAAI,GAAG,cAAc,EAAE,CAAA;IAC7B,OAAO,CACL,oBAAC,UAAU,IAAC,GAAG,EAAE,GAAG,EAAE,MAAM,QAAC,KAAK,EAAC,QAAQ,IACxC,UAAG,KAAK,cAAI,GAAG,cAAI,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,cAAI,KAAK,CAAE,CACtD,CACd,CAAA;AACH,CAAC,CACF,CAAA;AAED,MAAM,CAAC,IAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAGlC,SAAS,IAAI,CAAC,KAAK,EAAE,GAAG;IACxB,IAAM,IAAI,GAAG,cAAc,EAAE,CAAA;IAC7B,OAAO,CACL,oBAAC,MAAM,aACL,GAAG,EAAE,GAAG,IACJ,KAAK,kBACG,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAC9C,OAAO,EAAC,UAAU,EAClB,IAAI,EAAE,oBAAC,YAAY,OAAG,IACtB,CACH,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,MAAM,CAAC,IAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAGlC,SAAS,IAAI,CAAC,KAAK,EAAE,GAAG;IACxB,IAAM,IAAI,GAAG,cAAc,EAAE,CAAA;IAC7B,OAAO,CACL,oBAAC,MAAM,aACL,GAAG,EAAE,GAAG,IACJ,KAAK,kBACG,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAC9C,OAAO,EAAC,UAAU,EAClB,IAAI,EAAE,oBAAC,WAAW,OAAG,IACrB,CACH,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,IAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAG5B,SAAS,KAAK,CAAC,KAAK,EAAE,GAAG;IACzB,OAAO,oBAAC,UAAU,eAAK,KAAK,IAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;AACtE,CAAC,CAAC,CAAA;AAEF,MAAM,CAAC,IAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAGnC,SAAS,KAAK,CAAC,EAAmB,EAAE,GAAG;QAAtB,QAAQ,cAAA,EAAE,KAAK,WAAA;IAChC,IAAM,IAAI,GAAG,cAAc,EAAE,CAAA;IAE7B,OAAO,CACL;QACE,oBAAC,KAAK;YAAE,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,sBAAsB,CAAC;gBAAU;QACzD,oBAAC,GAAG,IAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAC,IAAI,IAC5B,QAAQ,CACL,CACL,CACJ,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,MAAM,CAAC,IAAM,WAAW,GAAG,KAAK,CAAC,UAAU,CAGzC,SAAS,UAAU,CACnB,EAOC,EACD,GAAG;IAPD,IAAA,kBAAc,EAAd,UAAU,mBAAG,CAAC,KAAA,EACd,UAAU,gBAAA,EACV,KAAK,WAAA,EACL,oBAAmB,EAAnB,YAAY,mBAAG,IAAI,KAAA,EACnB,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA,EACT,KAAK,cANV,gEAOC,CADS;IAIJ,IAAA,KASF,aAAa,CAAC;QAChB,UAAU,YAAA;QACV,KAAK,OAAA;QACL,YAAY,cAAA;QACZ,OAAO,SAAA;KACR,CAAC,EAbA,GAAG,SAAA,EACH,OAAO,aAAA,EACP,MAAM,YAAA,EACN,KAAK,WAAA,EACL,UAAU,gBAAA,EACV,UAAU,gBAAA,EACV,UAAU,gBAAA,EACV,KAAK,WAML,CAAA;IAEF,cAAc,CAAC;QACb,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,iCAAiC;QAC3C,QAAQ,EACN,sEAAsE;KACzE,CAAC,CAAA;IAEF,IAAM,IAAI,GAAG,cAAc,EAAE,CAAA;IAE7B,OAAO,CACL,oBAAC,eAAe,aAAC,GAAG,EAAE,GAAG,IAAM,KAAK;QAClC,oBAAC,eAAe,IAAC,GAAG,EAAE,GAAG,EAAE,MAAM,QAAC,KAAK,EAAC,QAAQ,IAC7C,UAAG,KAAK,cAAI,GAAG,cAAI,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,cAAI,KAAK,CAAE,CACjD;QAClB,oBAAC,iBAAiB;YACf,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,sBAAsB,CAAC;gBAC3B;QACpB,oBAAC,gBAAgB,IACf,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,KAAK,IAAI,CAAC,EACpB,QAAQ,EAAE,UAAU,EACpB,KAAK,EAAE,KAAK,GACZ;QACF,oBAAC,YAAY,IACX,QAAQ,EAAE,OAAO,EACjB,OAAO,EAAC,UAAU,gBACN,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAC9C,IAAI,EAAE,oBAAC,WAAW,OAAG,EACrB,OAAO,EAAE,UAAU,GACnB;QACF,oBAAC,YAAY,IACX,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAC,UAAU,gBACN,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAC9C,IAAI,EAAE,oBAAC,YAAY,OAAG,EACtB,OAAO,EAAE,UAAU,GACnB,CACc,CACnB,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,WAAW,CAAC,WAAW,GAAG,YAAY,CAAA;AAEtC,SAAS,CAAC,WAAW,GAAG,sBAAsB,CAAA;AAE9C,KAAK,CAAC,WAAW,GAAG,kBAAkB,CAAA;AAEtC,MAAM,CAAC,WAAW,GAAG,mBAAmB,CAAA;AAExC,KAAK,CAAC,WAAW,GAAG,kBAAkB,CAAA;AAEtC,IAAI,CAAC,WAAW,GAAG,iBAAiB,CAAA;AAEpC,QAAQ,CAAC,WAAW,GAAG,qBAAqB,CAAA;AAE5C,IAAI,CAAC,WAAW,GAAG,iBAAiB,CAAA;AAEpC,MAAM,CAAC,IAAM,UAAU,GAAG,gBAAgB,CACxC;IACE;;;;;;OAMG;IACH,SAAS,WAAA;IACT;;;;;;OAMG;IACH,KAAK,OAAA;IACL;;;;;;OAMG;IACH,MAAM,QAAA;IACN;;;;;;OAMG;IACH,KAAK,OAAA;IACL;;;;;;OAMG;IACH,IAAI,MAAA;IACJ;;;;;;OAMG;IACH,QAAQ,UAAA;IACR;;;;;;OAMG;IACH,IAAI,MAAA;CACL,EACD,WAAW,CACZ,CAAA;AAED,eAAe,UAAU,CAAA"}
@@ -30,7 +30,22 @@ export interface PresetPaginationProps extends Props {
30
30
  */
31
31
  perPage?: number;
32
32
  /**
33
- * @deprecated Pagination will handle i18n, please delete this prop.
33
+ * @deprecated
34
+ *
35
+ * The `fieldLabel` has been deprecated and will be removed in a future version.
36
+ * The `Pagination` component now handles i18n internally and this prop has no effect,
37
+ * please remove it from usage.
38
+ *
39
+ *
40
+ * **Before**
41
+ *
42
+ * `<Pagination fieldLabel={window.i18n.t('my.key')} />`
43
+ *
44
+ * **After**
45
+ *
46
+ * `<Pagination />`
47
+ *
48
+ * @deprecatedSince 10.20.0
34
49
  */
35
50
  fieldLabel?: string;
36
51
  }
@@ -3,12 +3,24 @@ import { InputProps } from '../Input';
3
3
  export interface SearchHookConfig {
4
4
  initialValue?: string;
5
5
  /**
6
- * <div style={{ color: 'red' }}>
7
- * DEPRECATED: Use the new Typeahead component
8
- * </div>
9
- * <br />
10
- * <div>Input handler for typeahead variant</div>
11
- * <CodeBlock>(event: ReactEvent) => void</CodeBlock>
6
+ * @deprecated
7
+ *
8
+ * The `onChange` prop has been deprecated and will be removed in a future version.
9
+ *
10
+ * A new component, `Typeahead`, has been introduced with specific UX for typeahead-like
11
+ * behavior. Please use this component instead.
12
+ *
13
+ * **Before**
14
+ *
15
+ * <Search typeahead onChange={() => { ... }} />
16
+ *
17
+ * **After**
18
+ *
19
+ * <Typeahead onChange={() => { ... }} />
20
+ *
21
+ * @deprecatedSince 10.20.0
22
+ *
23
+ * @see https://core.procore.com/latest/web/components/typeahead/react/
12
24
  */
13
25
  onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
14
26
  onClear?: () => void;
@@ -18,7 +30,24 @@ export interface SearchHookConfig {
18
30
  */
19
31
  onSubmit?: (value: string) => void;
20
32
  /**
21
- * @deprecated Please use the new `Typeahead` component
33
+ * @deprecated
34
+ *
35
+ * The `typeahead` prop has been deprecated and will be removed in a future version.
36
+ *
37
+ * A new component, `Typeahead`, has been introduced with specific UX for typeahead-like
38
+ * behavior. Please use this component instead.
39
+ *
40
+ * **Before**
41
+ *
42
+ * <Search typeahead onChange={() => { ... }} />
43
+ *
44
+ * **After**
45
+ *
46
+ * <Typeahead onChange={() => { ... }} />
47
+ *
48
+ * @deprecatedSince 10.20.0
49
+ *
50
+ * @see https://core.procore.com/latest/web/components/typeahead/react/
22
51
  */
23
52
  typeahead?: boolean;
24
53
  }
@@ -2,19 +2,78 @@ import React from 'react';
2
2
  import { ButtonAttributes, DivAttributes } from '../../utils/types';
3
3
  import { SegmentedControllerProps, SegmentedControllerSegmentProps, SegmentedControllerTooltipProps } from './SegmentedController.types';
4
4
  export declare const Segment: React.ForwardRefExoticComponent<ButtonAttributes & SegmentedControllerSegmentProps & React.RefAttributes<HTMLButtonElement>>;
5
+ /**
6
+ * @deprecated
7
+ *
8
+ * The `SegmentedController.Tooltip` component has been deprecated will be
9
+ * removed in a future version.
10
+ *
11
+ * Tooltips are now built into `SegmentedController.Segment`s, and can be added
12
+ * by configuring the `tooltip` prop.
13
+ *
14
+ * **Before**
15
+ *
16
+ * ```
17
+ * <SegmentedController>
18
+ * <SegmentedController.Tooltip tooltip="Item 1 is the first item">
19
+ * <SegmentedController.Segment>
20
+ * Item 1
21
+ * </SegmentedController.Segment>
22
+ * </SegmentedController.Tooltip>
23
+ * </SegmentedController>
24
+ * ```
25
+ *
26
+ * **After**
27
+ *
28
+ * ```
29
+ * <SegmentedController>
30
+ * <SegmentedController.Segment tooltip="Item 1 is the first item">
31
+ * Item 1
32
+ * </SegmentedController.Segment>
33
+ * </SegmentedController>
34
+ * ```
35
+ *
36
+ * @deprecatedSince 10.20.0
37
+ */
5
38
  export declare const Tooltip: React.ForwardRefExoticComponent<SegmentedControllerTooltipProps & React.RefAttributes<HTMLElement>>;
6
39
  /**
7
- * @deprecated Please use `React.useState([number])` hook
40
+ * @deprecated
41
+ *
42
+ * This `SegmentedController.State` utility has been deprecated. Please just
43
+ * use a simple state management hook instead.
44
+ *
45
+ *
46
+ * **Before**
47
+ *
48
+ * ```
49
+ * <SegmentedController.State>
50
+ * {({ selectedIndex, setSelected }) => (
51
+ * <SegmentedController>
52
+ * <SegmentedController.Segment onClick={() => setSelected(0)} active={selectedIndex === 0}>
53
+ * Item 1
54
+ * </SegmentedController.Segment>
55
+ * </SegmentedController>
56
+ * )}
57
+ * </SegmentedController.State>
58
+ * ```
59
+ *
60
+ * **After**
61
+ *
62
+ * ```
63
+ * const [selected, setSelected] = React.useState(0)
64
+ *
65
+ * <SegmentedController onChange={setSelected}>
66
+ * <SegmentedController.Segment active={selectedIndex === 0}>
67
+ * Item 1
68
+ * </SegmentedController.Segment>
69
+ * </SegmentedController>
70
+ * ```
71
+ *
72
+ * @deprecatedSince 10.20.0
8
73
  */
9
74
  export declare const State: (props: any) => JSX.Element;
10
75
  export declare const SegmentedController: React.ForwardRefExoticComponent<Omit<DivAttributes, "onChange"> & SegmentedControllerProps & React.RefAttributes<HTMLDivElement>> & {
11
76
  Segment: React.ForwardRefExoticComponent<ButtonAttributes & SegmentedControllerSegmentProps & React.RefAttributes<HTMLButtonElement>>;
12
- /**
13
- * @deprecated Please use `React.useState([number])` hook
14
- */
15
77
  State: (props: any) => JSX.Element;
16
- /**
17
- * @deprecated This subcomponent will be removed in the future
18
- */
19
78
  Tooltip: React.ForwardRefExoticComponent<SegmentedControllerTooltipProps & React.RefAttributes<HTMLElement>>;
20
79
  };