@procore/core-react 10.30.0-rc.3 → 10.30.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.
- package/CHANGELOG.md +12 -1
- package/dist/esm/components/FileSelect/ThumbnailList/ThumbnailList.styles.d.ts +1 -4
- package/dist/esm/components/Form/Form.js +12 -10
- package/dist/esm/components/Form/Form.js.map +1 -1
- package/dist/esm/components/Form/Form.types.d.ts +5 -1
- package/dist/esm/components/TextEditor/TextEditor.js +1 -1
- package/dist/esm/components/TextEditor/TextEditor.js.map +1 -1
- package/dist/esm/components/TextEditor/TextEditor.types.d.ts +1 -1
- package/dist/esm/components/Thumbnail/Thumbnail.d.ts +2 -5
- package/dist/esm/components/Thumbnail/Thumbnail.types.d.ts +2 -2
- package/dist/esm/components/ThumbnailGrid/ThumbnailGrid.styles.d.ts +1 -4
- package/dist/esm/components/Tile/Tile.types.d.ts +3 -12
- package/dist/esm/layouts/IconLayout/IconLayout.d.ts +1 -1
- package/dist/esm/layouts/IconLayout/index.d.ts +1 -1
- package/dist/esm/layouts/IconLayout/index.js.map +1 -1
- package/dist/esm/utils/propsTypedoc.d.ts +77 -77
- package/dist/esm/utils/propsTypedoc.js +155 -64
- package/dist/esm/utils/propsTypedoc.js.map +1 -1
- package/dist/typedoc/components/Avatar/Avatar.types.json +17 -17
- package/dist/typedoc/components/AvatarStack/AvatarStack.types.json +22 -22
- package/dist/typedoc/components/Badge/Badge.types.json +6 -6
- package/dist/typedoc/components/Banner/Banner.types.json +12 -12
- package/dist/typedoc/components/Breadcrumbs/Breadcrumbs.types.json +7 -7
- package/dist/typedoc/components/Button/Button.types.json +11 -11
- package/dist/typedoc/components/Calendar/Calendar.types.json +107 -81
- package/dist/typedoc/components/Card/Card.types.json +6 -6
- package/dist/typedoc/components/Checkbox/Checkbox.types.json +7 -7
- package/dist/typedoc/components/ContactItem/ContactItem.types.json +9 -9
- package/dist/typedoc/components/DateInput/DateInput.types.json +35 -35
- package/dist/typedoc/components/DateSelect/DateSelect.types.json +13 -13
- package/dist/typedoc/components/Dropdown/Dropdown.types.json +37 -37
- package/dist/typedoc/components/DropdownFlyout/DropdownFlyout.types.json +32 -32
- package/dist/typedoc/components/Dropzone/Dropzone.types.json +42 -42
- package/dist/typedoc/components/EmptyState/EmptyState.types.json +14 -14
- package/dist/typedoc/components/FileList/FileList.types.json +9 -9
- package/dist/typedoc/components/FileSelect/FileSelect.types.json +355 -34
- package/dist/typedoc/components/FileSelect/GridSource/GridSource.types.json +20 -20
- package/dist/typedoc/components/FileSelect/LocalSource/LocalSource.types.json +165 -15
- package/dist/typedoc/components/FileSelect/TreeSource/TreeSource.types.json +9 -9
- package/dist/typedoc/components/Font/Font.types.json +7 -7
- package/dist/typedoc/components/Form/Form.types.json +746 -746
- package/dist/typedoc/components/GroupSelect/GroupSelect.types.json +61 -61
- package/dist/typedoc/components/Icon/Icon.types.json +10 -10
- package/dist/typedoc/components/Input/Input.types.json +2 -2
- package/dist/typedoc/components/Link/Link.types.json +4 -4
- package/dist/typedoc/components/Menu/Menu.types.json +366 -92
- package/dist/typedoc/components/MenuImperative/MenuImperative.types.json +259 -68
- package/dist/typedoc/components/Modal/Modal.types.json +27 -27
- package/dist/typedoc/components/MultiSelect/MultiSelect.types.json +672 -38
- package/dist/typedoc/components/Notation/Notation.types.json +4 -4
- package/dist/typedoc/components/NumberInput/NumberInput.types.json +25 -25
- package/dist/typedoc/components/OverlayTrigger/OverlayTrigger.json +18 -18
- package/dist/typedoc/components/Pagination/Pagination.types.json +430 -8
- package/dist/typedoc/components/Panel/Panel.types.json +17 -17
- package/dist/typedoc/components/Pill/Pill.types.json +1 -1
- package/dist/typedoc/components/PillSelect/PillSelect.types.json +48 -48
- package/dist/typedoc/components/Popover/Popover.types.json +9 -9
- package/dist/typedoc/components/ProgressBar/ProgressBar.types.json +5 -5
- package/dist/typedoc/components/RadioButton/RadioButton.types.json +6 -6
- package/dist/typedoc/components/Required/Required.types.json +5 -5
- package/dist/typedoc/components/Search/Search.types.json +21 -21
- package/dist/typedoc/components/SegmentedController/SegmentedController.types.json +20 -20
- package/dist/typedoc/components/Select/Select.types.json +269 -33
- package/dist/typedoc/components/Slider/Slider.types.json +6 -6
- package/dist/typedoc/components/Spinner/Spinner.types.json +8 -8
- package/dist/typedoc/components/Switch/Switch.types.json +3 -3
- package/dist/typedoc/components/Table/Table.types.json +272 -102
- package/dist/typedoc/components/Tabs/Tabs.types.json +89 -17
- package/dist/typedoc/components/Tearsheet/Tearsheet.types.json +9 -9
- package/dist/typedoc/components/TextArea/TextArea.types.json +3 -3
- package/dist/typedoc/components/TextEditor/TextEditor.types.json +8 -8
- package/dist/typedoc/components/TextEditorOutput/TextEditorOutput.types.json +3 -3
- package/dist/typedoc/components/Thumbnail/Thumbnail.types.json +460 -16
- package/dist/typedoc/components/TieredDropdown/TieredDropdown.types.json +47 -47
- package/dist/typedoc/components/TieredSelect/TieredSelect.types.json +602 -34
- package/dist/typedoc/components/Tile/Tile.types.json +36 -36
- package/dist/typedoc/components/Toast/Toast.types.json +4 -4
- package/dist/typedoc/components/ToggleButton/ToggleButton.types.json +3 -3
- package/dist/typedoc/components/Token/Token.types.json +4 -4
- package/dist/typedoc/components/Tooltip/Tooltip.types.json +13 -13
- package/dist/typedoc/components/Tree/Tree.types.json +85 -85
- package/dist/typedoc/components/Typeahead/Typeahead.types.json +2 -2
- package/dist/typedoc/components/Typography/Typography.types.json +8 -8
- package/dist/typedoc/deprecations.json +1 -1
- package/dist/typedoc/layouts/Box/Box.types.json +66 -66
- package/dist/typedoc/layouts/DetailPage/DetailPage.json +11 -11
- package/dist/typedoc/layouts/Flex/Flex.types.json +26 -26
- package/dist/typedoc/layouts/FlexList/FlexList.types.json +29 -29
- package/dist/typedoc/layouts/Grid/Grid.json +12 -12
- package/dist/typedoc/layouts/IconLayout/IconLayout.json +48 -1
- package/dist/typedoc/layouts/LegacyDetailPage/LegacyDetailPage.json +6 -6
- package/dist/typedoc/layouts/ListPage/ListPage.types.json +10 -10
- package/dist/typedoc/layouts/NextDetailPage/NextDetailPage.types.json +8 -8
- package/dist/typedoc/layouts/NextGrid/NextGrid.types.json +8 -8
- package/dist/typedoc/layouts/PageLayout/PageLayout.types.json +7 -7
- package/dist/typedoc/layouts/ToolHeader/ToolHeader.types.json +8 -8
- package/dist/typedoc/utils/types.json +3 -3
- package/package.json +5 -5
- package/typedoc.ts +9 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
|
-
"
|
|
3
|
-
"name": "
|
|
2
|
+
"FooterProps": {
|
|
3
|
+
"name": "FooterProps",
|
|
4
4
|
"properties": [
|
|
5
5
|
{
|
|
6
6
|
"name": "alignContent",
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"description": "",
|
|
11
11
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
12
12
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
13
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
13
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L118"
|
|
14
14
|
},
|
|
15
15
|
{
|
|
16
16
|
"name": "alignItems",
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"description": "",
|
|
21
21
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
22
22
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
23
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
23
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L122"
|
|
24
24
|
},
|
|
25
25
|
{
|
|
26
26
|
"name": "alignSelf",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"description": "",
|
|
31
31
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
32
32
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
33
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
33
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L126"
|
|
34
34
|
},
|
|
35
35
|
{
|
|
36
36
|
"name": "children",
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
"description": "Instead of using the default children, you can pass in your own.",
|
|
41
41
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
|
|
42
42
|
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
43
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
43
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L40"
|
|
44
44
|
},
|
|
45
45
|
{
|
|
46
46
|
"name": "className",
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
"description": "Additional classNames",
|
|
51
51
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
|
|
52
52
|
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
53
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
53
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L45"
|
|
54
54
|
},
|
|
55
55
|
{
|
|
56
56
|
"name": "display",
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
"description": "",
|
|
61
61
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
62
62
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
63
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
63
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L146"
|
|
64
64
|
},
|
|
65
65
|
{
|
|
66
66
|
"name": "flex",
|
|
@@ -70,7 +70,7 @@
|
|
|
70
70
|
"description": "Alias to the `flex` property on a flexbox child.",
|
|
71
71
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Alias to the <code>flex</code> property on a flexbox child.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
72
72
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
73
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
73
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L152"
|
|
74
74
|
},
|
|
75
75
|
{
|
|
76
76
|
"name": "flexBasis",
|
|
@@ -80,7 +80,7 @@
|
|
|
80
80
|
"description": "Alias to the `basis` property on a flexbox child.",
|
|
81
81
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Alias to the <code>basis</code> property on a flexbox child.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
82
82
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
83
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
83
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L158"
|
|
84
84
|
},
|
|
85
85
|
{
|
|
86
86
|
"name": "flexDirection",
|
|
@@ -90,7 +90,7 @@
|
|
|
90
90
|
"description": "Alias to the `direction` property on a flexbox child.",
|
|
91
91
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Alias to the <code>direction</code> property on a flexbox child.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
92
92
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
93
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
93
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L164"
|
|
94
94
|
},
|
|
95
95
|
{
|
|
96
96
|
"name": "flexGrow",
|
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
"description": "Alias to the `grow` property on a flexbox child.",
|
|
101
101
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Alias to the <code>grow</code> property on a flexbox child.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
102
102
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
103
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
103
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L170"
|
|
104
104
|
},
|
|
105
105
|
{
|
|
106
106
|
"name": "flexShrink",
|
|
@@ -110,7 +110,7 @@
|
|
|
110
110
|
"description": "Alias to the `shrink` property on a flexbox child.",
|
|
111
111
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Alias to the <code>shrink</code> property on a flexbox child.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
112
112
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
113
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
113
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L176"
|
|
114
114
|
},
|
|
115
115
|
{
|
|
116
116
|
"name": "flexWrap",
|
|
@@ -120,7 +120,7 @@
|
|
|
120
120
|
"description": "Alias to the `wrap` property on a flexbox child.",
|
|
121
121
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Alias to the <code>wrap</code> property on a flexbox child.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
122
122
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
123
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
123
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L182"
|
|
124
124
|
},
|
|
125
125
|
{
|
|
126
126
|
"name": "justifyContent",
|
|
@@ -130,7 +130,7 @@
|
|
|
130
130
|
"description": "",
|
|
131
131
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
132
132
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
133
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
133
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L130"
|
|
134
134
|
},
|
|
135
135
|
{
|
|
136
136
|
"name": "margin",
|
|
@@ -140,7 +140,7 @@
|
|
|
140
140
|
"description": "",
|
|
141
141
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
142
142
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
143
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
143
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L69"
|
|
144
144
|
},
|
|
145
145
|
{
|
|
146
146
|
"name": "marginBottom",
|
|
@@ -150,7 +150,7 @@
|
|
|
150
150
|
"description": "",
|
|
151
151
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
152
152
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
153
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
153
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L73"
|
|
154
154
|
},
|
|
155
155
|
{
|
|
156
156
|
"name": "marginLeft",
|
|
@@ -160,7 +160,7 @@
|
|
|
160
160
|
"description": "",
|
|
161
161
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
162
162
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
163
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
163
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L77"
|
|
164
164
|
},
|
|
165
165
|
{
|
|
166
166
|
"name": "marginRight",
|
|
@@ -170,7 +170,7 @@
|
|
|
170
170
|
"description": "",
|
|
171
171
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
172
172
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
173
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
173
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L81"
|
|
174
174
|
},
|
|
175
175
|
{
|
|
176
176
|
"name": "marginTop",
|
|
@@ -180,7 +180,7 @@
|
|
|
180
180
|
"description": "",
|
|
181
181
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
182
182
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
183
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
183
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L85"
|
|
184
184
|
},
|
|
185
185
|
{
|
|
186
186
|
"name": "order",
|
|
@@ -190,7 +190,7 @@
|
|
|
190
190
|
"description": "Alias to the `order` property on a flexbox child.",
|
|
191
191
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Alias to the <code>order</code> property on a flexbox child.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
192
192
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
193
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
193
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L188"
|
|
194
194
|
},
|
|
195
195
|
{
|
|
196
196
|
"name": "padding",
|
|
@@ -200,7 +200,7 @@
|
|
|
200
200
|
"description": "",
|
|
201
201
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
202
202
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
203
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
203
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L92"
|
|
204
204
|
},
|
|
205
205
|
{
|
|
206
206
|
"name": "paddingBottom",
|
|
@@ -210,7 +210,7 @@
|
|
|
210
210
|
"description": "",
|
|
211
211
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
212
212
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
213
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
213
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L96"
|
|
214
214
|
},
|
|
215
215
|
{
|
|
216
216
|
"name": "paddingLeft",
|
|
@@ -220,7 +220,7 @@
|
|
|
220
220
|
"description": "",
|
|
221
221
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
222
222
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
223
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
223
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L100"
|
|
224
224
|
},
|
|
225
225
|
{
|
|
226
226
|
"name": "paddingRight",
|
|
@@ -230,7 +230,7 @@
|
|
|
230
230
|
"description": "",
|
|
231
231
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
232
232
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
233
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
233
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L104"
|
|
234
234
|
},
|
|
235
235
|
{
|
|
236
236
|
"name": "paddingTop",
|
|
@@ -240,7 +240,7 @@
|
|
|
240
240
|
"description": "",
|
|
241
241
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
242
242
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
243
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
243
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L108"
|
|
244
244
|
},
|
|
245
245
|
{
|
|
246
246
|
"name": "style",
|
|
@@ -250,7 +250,7 @@
|
|
|
250
250
|
"description": "Additional CSS styles",
|
|
251
251
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
|
|
252
252
|
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
253
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
253
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L50"
|
|
254
254
|
},
|
|
255
255
|
{
|
|
256
256
|
"name": "tabIndex",
|
|
@@ -260,7 +260,7 @@
|
|
|
260
260
|
"description": "",
|
|
261
261
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
262
262
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
263
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
263
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L192"
|
|
264
264
|
},
|
|
265
265
|
{
|
|
266
266
|
"name": "textAlign",
|
|
@@ -270,13 +270,13 @@
|
|
|
270
270
|
"description": "",
|
|
271
271
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
272
272
|
"sourceFile": "packages/core-react/src/layouts/Box/Box.types.ts",
|
|
273
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
273
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/layouts/Box/Box.types.ts#L196"
|
|
274
274
|
}
|
|
275
275
|
],
|
|
276
276
|
"description": ""
|
|
277
277
|
},
|
|
278
|
-
"
|
|
279
|
-
"name": "
|
|
278
|
+
"GroupProps": {
|
|
279
|
+
"name": "GroupProps",
|
|
280
280
|
"properties": [
|
|
281
281
|
{
|
|
282
282
|
"name": "className",
|
|
@@ -286,7 +286,7 @@
|
|
|
286
286
|
"description": "",
|
|
287
287
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
288
288
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
289
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
289
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L75"
|
|
290
290
|
},
|
|
291
291
|
{
|
|
292
292
|
"name": "clickable",
|
|
@@ -296,7 +296,7 @@
|
|
|
296
296
|
"description": "Can the group item be clicked",
|
|
297
297
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Can the group item be clicked</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
298
298
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
299
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
299
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L81"
|
|
300
300
|
},
|
|
301
301
|
{
|
|
302
302
|
"name": "item",
|
|
@@ -306,13 +306,13 @@
|
|
|
306
306
|
"description": "Value which can be passed around various callback functions.\nCan be anything!",
|
|
307
307
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Value which can be passed around various callback functions.\nCan be anything!</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
308
308
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
309
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
309
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L88"
|
|
310
310
|
}
|
|
311
311
|
],
|
|
312
312
|
"description": ""
|
|
313
313
|
},
|
|
314
|
-
"
|
|
315
|
-
"name": "
|
|
314
|
+
"HeaderProps": {
|
|
315
|
+
"name": "HeaderProps",
|
|
316
316
|
"properties": [
|
|
317
317
|
{
|
|
318
318
|
"name": "children",
|
|
@@ -322,7 +322,7 @@
|
|
|
322
322
|
"description": "Instead of using the default children, you can pass in your own.",
|
|
323
323
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
|
|
324
324
|
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
325
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
325
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L40"
|
|
326
326
|
},
|
|
327
327
|
{
|
|
328
328
|
"name": "className",
|
|
@@ -332,7 +332,7 @@
|
|
|
332
332
|
"description": "Additional classNames",
|
|
333
333
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
|
|
334
334
|
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
335
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
335
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L45"
|
|
336
336
|
},
|
|
337
337
|
{
|
|
338
338
|
"name": "style",
|
|
@@ -342,7 +342,7 @@
|
|
|
342
342
|
"description": "Additional CSS styles",
|
|
343
343
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
|
|
344
344
|
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
345
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
345
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L50"
|
|
346
346
|
},
|
|
347
347
|
{
|
|
348
348
|
"name": "tabIndex",
|
|
@@ -352,13 +352,13 @@
|
|
|
352
352
|
"description": "",
|
|
353
353
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
354
354
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
355
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
355
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L124"
|
|
356
356
|
}
|
|
357
357
|
],
|
|
358
358
|
"description": ""
|
|
359
359
|
},
|
|
360
|
-
"
|
|
361
|
-
"name": "
|
|
360
|
+
"ItemProps": {
|
|
361
|
+
"name": "ItemProps",
|
|
362
362
|
"properties": [
|
|
363
363
|
{
|
|
364
364
|
"name": "children",
|
|
@@ -368,7 +368,7 @@
|
|
|
368
368
|
"description": "",
|
|
369
369
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
370
370
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
371
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
371
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L44"
|
|
372
372
|
},
|
|
373
373
|
{
|
|
374
374
|
"name": "className",
|
|
@@ -378,7 +378,7 @@
|
|
|
378
378
|
"description": "",
|
|
379
379
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
380
380
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
381
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
381
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L48"
|
|
382
382
|
},
|
|
383
383
|
{
|
|
384
384
|
"name": "index",
|
|
@@ -388,7 +388,7 @@
|
|
|
388
388
|
"description": "",
|
|
389
389
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
390
390
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
391
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
391
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L33"
|
|
392
392
|
},
|
|
393
393
|
{
|
|
394
394
|
"name": "item",
|
|
@@ -398,7 +398,7 @@
|
|
|
398
398
|
"description": "Value which can be passed around various callback functions.\nCan be anything!",
|
|
399
399
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Value which can be passed around various callback functions.\nCan be anything!</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
400
400
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
401
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
401
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L54"
|
|
402
402
|
},
|
|
403
403
|
{
|
|
404
404
|
"name": "ref",
|
|
@@ -408,7 +408,7 @@
|
|
|
408
408
|
"description": "",
|
|
409
409
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
410
410
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
411
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
411
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L37"
|
|
412
412
|
},
|
|
413
413
|
{
|
|
414
414
|
"name": "selected",
|
|
@@ -418,7 +418,7 @@
|
|
|
418
418
|
"description": "Is the item selected",
|
|
419
419
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Is the item selected</p>\n</div><dl class=\"tsd-comment-tags\"><dt>default</dt><dd><p>false</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
420
420
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
421
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
421
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L64"
|
|
422
422
|
},
|
|
423
423
|
{
|
|
424
424
|
"name": "style",
|
|
@@ -428,7 +428,7 @@
|
|
|
428
428
|
"description": "Additional CSS styles",
|
|
429
429
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
|
|
430
430
|
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
431
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
431
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L50"
|
|
432
432
|
},
|
|
433
433
|
{
|
|
434
434
|
"name": "suggested",
|
|
@@ -438,7 +438,7 @@
|
|
|
438
438
|
"description": "",
|
|
439
439
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
440
440
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
441
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
441
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L68"
|
|
442
442
|
},
|
|
443
443
|
{
|
|
444
444
|
"name": "onClick",
|
|
@@ -448,43 +448,159 @@
|
|
|
448
448
|
"description": "",
|
|
449
449
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
450
450
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
451
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
451
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L58"
|
|
452
452
|
}
|
|
453
453
|
],
|
|
454
454
|
"description": ""
|
|
455
455
|
},
|
|
456
|
-
"
|
|
457
|
-
"name": "
|
|
456
|
+
"MenuHook": {
|
|
457
|
+
"name": "MenuHook",
|
|
458
458
|
"properties": [
|
|
459
459
|
{
|
|
460
|
-
"name": "
|
|
460
|
+
"name": "domHandlers",
|
|
461
|
+
"required": true,
|
|
462
|
+
"type": "<span class=\"tsd-signature-symbol\">{ </span>onKeyDown<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">any</span><span class=\"tsd-signature-symbol\"> }</span>",
|
|
463
|
+
"typeDetail": "<span class=\"tsd-signature-symbol\">{ </span>onKeyDown<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">any</span><span class=\"tsd-signature-symbol\"> }</span>",
|
|
464
|
+
"description": "",
|
|
465
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
466
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
467
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L168"
|
|
468
|
+
},
|
|
469
|
+
{
|
|
470
|
+
"name": "highlighted",
|
|
471
|
+
"required": true,
|
|
472
|
+
"type": "<span class=\"tsd-signature-type\">MutableRefObject</span><span class=\"tsd-signature-symbol\"><</span><span class=\"tsd-signature-type\">null</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">HTMLDivElement</span><span class=\"tsd-signature-symbol\">></span>",
|
|
473
|
+
"typeDetail": "<span class=\"tsd-signature-type\">MutableRefObject</span><span class=\"tsd-signature-symbol\"><</span><span class=\"tsd-signature-type\">null</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">HTMLDivElement</span><span class=\"tsd-signature-symbol\">></span>",
|
|
474
|
+
"description": "",
|
|
475
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
476
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
477
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L174"
|
|
478
|
+
},
|
|
479
|
+
{
|
|
480
|
+
"name": "isSelectable",
|
|
481
|
+
"required": true,
|
|
482
|
+
"type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ElementTypeChecker</a>",
|
|
483
|
+
"typeDetail": "<span class=\"tsd-signature-symbol\">(</span>element<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">any</span>, index<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">number</span>, list<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">any</span><span class=\"tsd-signature-symbol\">[]</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\"> => </span><span class=\"tsd-signature-type\">boolean</span>",
|
|
484
|
+
"description": "",
|
|
485
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
486
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
487
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L178"
|
|
488
|
+
},
|
|
489
|
+
{
|
|
490
|
+
"name": "listNavigation",
|
|
491
|
+
"required": true,
|
|
492
|
+
"type": "<span class=\"tsd-signature-type\">ListNavigationApi</span>",
|
|
493
|
+
"typeDetail": "<span class=\"tsd-signature-type\">ListNavigationApi</span>",
|
|
494
|
+
"description": "",
|
|
495
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
496
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
497
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L182"
|
|
498
|
+
},
|
|
499
|
+
{
|
|
500
|
+
"name": "multiple",
|
|
501
|
+
"required": true,
|
|
502
|
+
"type": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
503
|
+
"typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
504
|
+
"description": "",
|
|
505
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
506
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
507
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L186"
|
|
508
|
+
},
|
|
509
|
+
{
|
|
510
|
+
"name": "scrollable",
|
|
511
|
+
"required": true,
|
|
512
|
+
"type": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
513
|
+
"typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
514
|
+
"description": "",
|
|
515
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>default</dt><dd><p>true</p>\n</dd></dl></div>",
|
|
516
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
517
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L195"
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
"name": "search",
|
|
521
|
+
"required": true,
|
|
522
|
+
"type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Interface\">SearchHook</a>",
|
|
523
|
+
"typeDetail": "<span class=\"tsd-signature-type\">any</span>",
|
|
524
|
+
"description": "",
|
|
525
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
526
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
527
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L199"
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
"name": "onScrollBottom",
|
|
461
531
|
"required": false,
|
|
462
|
-
"type": "
|
|
463
|
-
"typeDetail": "<span class=\"tsd-signature-type\">
|
|
532
|
+
"type": "Function",
|
|
533
|
+
"typeDetail": "on<wbr/>Scroll<wbr/>Bottom<span class=\"tsd-signature-symbol\">(</span>e<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">Event</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
|
|
464
534
|
"description": "",
|
|
465
535
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
466
536
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
467
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
537
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L190"
|
|
468
538
|
},
|
|
469
539
|
{
|
|
470
|
-
"name": "
|
|
540
|
+
"name": "selectItem",
|
|
541
|
+
"required": true,
|
|
542
|
+
"type": "Function",
|
|
543
|
+
"typeDetail": "select<wbr/>Item<span class=\"tsd-signature-symbol\">(</span>selection<span class=\"tsd-signature-symbol\">: </span><a class=\"tsd-signature-type\" data-tsd-kind=\"Namespace\">Menu</a><span class=\"tsd-signature-symbol\">.</span><a class=\"tsd-signature-type\" data-tsd-kind=\"Interface\">Selection</a><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
|
|
544
|
+
"description": "",
|
|
545
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
546
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
547
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L203"
|
|
548
|
+
}
|
|
549
|
+
],
|
|
550
|
+
"description": ""
|
|
551
|
+
},
|
|
552
|
+
"MenuHookConfig": {
|
|
553
|
+
"name": "MenuHookConfig",
|
|
554
|
+
"properties": [
|
|
555
|
+
{
|
|
556
|
+
"name": "isSelectable",
|
|
471
557
|
"required": false,
|
|
472
|
-
"type": "<
|
|
473
|
-
"typeDetail": "<span class=\"tsd-signature-type\">
|
|
558
|
+
"type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ElementTypeChecker</a>",
|
|
559
|
+
"typeDetail": "<span class=\"tsd-signature-symbol\">(</span>element<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">any</span>, index<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">number</span>, list<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">any</span><span class=\"tsd-signature-symbol\">[]</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\"> => </span><span class=\"tsd-signature-type\">boolean</span>",
|
|
474
560
|
"description": "",
|
|
475
561
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
476
562
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
477
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
563
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L133"
|
|
478
564
|
},
|
|
479
565
|
{
|
|
480
|
-
"name": "
|
|
566
|
+
"name": "keyHandlerRef",
|
|
481
567
|
"required": false,
|
|
482
|
-
"type": "<span class=\"tsd-signature-type\">
|
|
483
|
-
"typeDetail": "<span class=\"tsd-signature-type\">
|
|
568
|
+
"type": "<span class=\"tsd-signature-type\">RefObject</span><span class=\"tsd-signature-symbol\"><</span><span class=\"tsd-signature-type\">HTMLElement</span><span class=\"tsd-signature-symbol\">></span>",
|
|
569
|
+
"typeDetail": "<span class=\"tsd-signature-type\">RefObject</span><span class=\"tsd-signature-symbol\"><</span><span class=\"tsd-signature-type\">HTMLElement</span><span class=\"tsd-signature-symbol\">></span>",
|
|
484
570
|
"description": "",
|
|
485
571
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
486
572
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
487
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
573
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L137"
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
"name": "multiple",
|
|
577
|
+
"required": false,
|
|
578
|
+
"type": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
579
|
+
"typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
580
|
+
"description": "",
|
|
581
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
582
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
583
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L141"
|
|
584
|
+
},
|
|
585
|
+
{
|
|
586
|
+
"name": "onScrollBottom",
|
|
587
|
+
"required": false,
|
|
588
|
+
"type": "<span class=\"tsd-signature-symbol\">(</span>e<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">Event</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\"> => </span><span class=\"tsd-signature-type\">void</span>",
|
|
589
|
+
"typeDetail": "<span class=\"tsd-signature-symbol\">(</span>e<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">Event</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\"> => </span><span class=\"tsd-signature-type\">void</span>",
|
|
590
|
+
"description": "",
|
|
591
|
+
"descriptionHtml": "",
|
|
592
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
593
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L145"
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
"name": "onSelect",
|
|
597
|
+
"required": false,
|
|
598
|
+
"type": "<span class=\"tsd-signature-symbol\">(</span>selection<span class=\"tsd-signature-symbol\">: </span><a class=\"tsd-signature-type\" data-tsd-kind=\"Namespace\">Menu</a><span class=\"tsd-signature-symbol\">.</span><a class=\"tsd-signature-type\" data-tsd-kind=\"Interface\">Selection</a><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\"> => </span><span class=\"tsd-signature-type\">void</span>",
|
|
599
|
+
"typeDetail": "<span class=\"tsd-signature-symbol\">(</span>selection<span class=\"tsd-signature-symbol\">: </span><a class=\"tsd-signature-type\" data-tsd-kind=\"Namespace\">Menu</a><span class=\"tsd-signature-symbol\">.</span><a class=\"tsd-signature-type\" data-tsd-kind=\"Interface\">Selection</a><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\"> => </span><span class=\"tsd-signature-type\">void</span>",
|
|
600
|
+
"description": "",
|
|
601
|
+
"descriptionHtml": "",
|
|
602
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
603
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L153"
|
|
488
604
|
},
|
|
489
605
|
{
|
|
490
606
|
"name": "scrollable",
|
|
@@ -492,9 +608,29 @@
|
|
|
492
608
|
"type": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
493
609
|
"typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
494
610
|
"description": "",
|
|
495
|
-
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>
|
|
611
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
496
612
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
497
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
613
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L157"
|
|
614
|
+
},
|
|
615
|
+
{
|
|
616
|
+
"name": "usingSearchHook",
|
|
617
|
+
"required": false,
|
|
618
|
+
"type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Interface\">SearchHook</a>",
|
|
619
|
+
"typeDetail": "<span class=\"tsd-signature-type\">any</span>",
|
|
620
|
+
"description": "",
|
|
621
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
622
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
623
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L161"
|
|
624
|
+
},
|
|
625
|
+
{
|
|
626
|
+
"name": "onSearch",
|
|
627
|
+
"required": false,
|
|
628
|
+
"type": "Function",
|
|
629
|
+
"typeDetail": "on<wbr/>Search<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">ChangeEvent</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
|
|
630
|
+
"description": "",
|
|
631
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
632
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
633
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L149"
|
|
498
634
|
}
|
|
499
635
|
],
|
|
500
636
|
"description": ""
|
|
@@ -510,7 +646,7 @@
|
|
|
510
646
|
"description": "",
|
|
511
647
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
512
648
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
513
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
649
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L260"
|
|
514
650
|
},
|
|
515
651
|
{
|
|
516
652
|
"name": "children",
|
|
@@ -520,7 +656,7 @@
|
|
|
520
656
|
"description": "Instead of using the default children, you can pass in your own.",
|
|
521
657
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
|
|
522
658
|
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
523
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
659
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L40"
|
|
524
660
|
},
|
|
525
661
|
{
|
|
526
662
|
"name": "className",
|
|
@@ -530,19 +666,19 @@
|
|
|
530
666
|
"description": "Additional classNames",
|
|
531
667
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
|
|
532
668
|
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
533
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
669
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L45"
|
|
534
670
|
},
|
|
535
671
|
{
|
|
536
672
|
"name": "isSelectable",
|
|
537
673
|
"required": false,
|
|
538
|
-
"type": "<
|
|
539
|
-
"typeDetail": "<span class=\"tsd-signature-type\">
|
|
674
|
+
"type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ElementTypeChecker</a>",
|
|
675
|
+
"typeDetail": "<span class=\"tsd-signature-symbol\">(</span>element<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">any</span>, index<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">number</span>, list<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">any</span><span class=\"tsd-signature-symbol\">[]</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\"> => </span><span class=\"tsd-signature-type\">boolean</span>",
|
|
540
676
|
"description": "<CodeBlock>\n (element: any, index?: number, list?: any[]) => boolean\n</CodeBlock>",
|
|
541
677
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<CodeBlock>\n (element: any, index?: number, list?: any[]) => boolean\n</CodeBlock></div><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p>The <code>isSelectable</code> prop has been deprecated and will be removed in a future version.\nMenu item selection is now handled internally and there is no need to configure this\nanymore.</p>\n</dd><dt>deprecatedsince</dt><dd><p>10.20.0</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
542
678
|
"deprecated": "\n\nThe `isSelectable` prop has been deprecated and will be removed in a future version.\nMenu item selection is now handled internally and there is no need to configure this\nanymore.\n",
|
|
543
679
|
"deprecatedSince": "10.20.0",
|
|
544
680
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
545
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
681
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L222"
|
|
546
682
|
},
|
|
547
683
|
{
|
|
548
684
|
"name": "keyHandlerRef",
|
|
@@ -552,7 +688,7 @@
|
|
|
552
688
|
"description": "Ref object which will get the key handler listeners",
|
|
553
689
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Ref object which will get the key handler listeners</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
554
690
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
555
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
691
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L228"
|
|
556
692
|
},
|
|
557
693
|
{
|
|
558
694
|
"name": "scrollable",
|
|
@@ -562,7 +698,7 @@
|
|
|
562
698
|
"description": "",
|
|
563
699
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>default</dt><dd><p>true</p>\n</dd></dl></div>",
|
|
564
700
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
565
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
701
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L108"
|
|
566
702
|
},
|
|
567
703
|
{
|
|
568
704
|
"name": "style",
|
|
@@ -572,17 +708,17 @@
|
|
|
572
708
|
"description": "Additional CSS styles",
|
|
573
709
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
|
|
574
710
|
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
575
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
711
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L50"
|
|
576
712
|
},
|
|
577
713
|
{
|
|
578
714
|
"name": "usingHook",
|
|
579
715
|
"required": false,
|
|
580
|
-
"type": "<
|
|
581
|
-
"typeDetail": "<span class=\"tsd-signature-type\">
|
|
716
|
+
"type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Interface\">MenuHook</a>",
|
|
717
|
+
"typeDetail": "<span class=\"tsd-signature-type\">any</span>",
|
|
582
718
|
"description": "",
|
|
583
719
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
584
720
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
585
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
721
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L254"
|
|
586
722
|
},
|
|
587
723
|
{
|
|
588
724
|
"name": "onScrollBottom",
|
|
@@ -592,17 +728,17 @@
|
|
|
592
728
|
"description": "",
|
|
593
729
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
594
730
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
595
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
731
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L232"
|
|
596
732
|
},
|
|
597
733
|
{
|
|
598
734
|
"name": "onSelect",
|
|
599
735
|
"required": false,
|
|
600
736
|
"type": "Function",
|
|
601
|
-
"typeDetail": "on<wbr/>Select<span class=\"tsd-signature-symbol\">(</span>selection<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">Selection</
|
|
737
|
+
"typeDetail": "on<wbr/>Select<span class=\"tsd-signature-symbol\">(</span>selection<span class=\"tsd-signature-symbol\">: </span><a class=\"tsd-signature-type\" data-tsd-kind=\"Namespace\">Menu</a><span class=\"tsd-signature-symbol\">.</span><a class=\"tsd-signature-type\" data-tsd-kind=\"Interface\">Selection</a><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">any</span>",
|
|
602
738
|
"description": "<div>Callback for selecting an item from the menu</div>\n<CodeBlock>\n{\n '({ event: ReactEvent, item: Menu.Item.props.item, group: bool }) => void'\n}\n</CodeBlock>\n<div>\n <Code>item</Code> will be the <Code>item</Code> prop supplied to the{' '}\n <Code>Item</Code> component\n <br />\n <Code>group</Code> will be <Code>true</Code> if the clicked item was\n a group label\n</div>",
|
|
603
739
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<div>Callback for selecting an item from the menu</div>\n<CodeBlock>\n{\n '({ event: ReactEvent, item: Menu.Item.props.item, group: bool }) => void'\n}\n</CodeBlock>\n<div>\n <Code>item</Code> will be the <Code>item</Code> prop supplied to the{' '}\n <Code>Item</Code> component\n <br />\n <Code>group</Code> will be <Code>true</Code> if the clicked item was\n a group label\n</div></div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
604
740
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
605
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
741
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L250"
|
|
606
742
|
}
|
|
607
743
|
],
|
|
608
744
|
"description": ""
|
|
@@ -618,7 +754,7 @@
|
|
|
618
754
|
"description": "",
|
|
619
755
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
620
756
|
"sourceFile": "packages/core-react/src/components/Search/Search.types.ts",
|
|
621
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
757
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Search/Search.types.ts#L107"
|
|
622
758
|
},
|
|
623
759
|
{
|
|
624
760
|
"name": "error",
|
|
@@ -628,7 +764,7 @@
|
|
|
628
764
|
"description": "Controls the error state of the `Input`, changing the\nbackground color and border colors to red",
|
|
629
765
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Controls the error state of the <code>Input</code>, changing the\nbackground color and border colors to red</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
630
766
|
"sourceFile": "packages/core-react/src/components/Input/Input.types.ts",
|
|
631
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
767
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Input/Input.types.ts#L9"
|
|
632
768
|
},
|
|
633
769
|
{
|
|
634
770
|
"name": "i18nScope",
|
|
@@ -638,7 +774,7 @@
|
|
|
638
774
|
"description": "The i18n key to use for the menu search's configurable strings. Defaults to\nusing the core library's default strings.",
|
|
639
775
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The i18n key to use for the menu search's configurable strings. Defaults to\nusing the core library's default strings.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
640
776
|
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
641
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
777
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L117"
|
|
642
778
|
},
|
|
643
779
|
{
|
|
644
780
|
"name": "initialValue",
|
|
@@ -648,7 +784,7 @@
|
|
|
648
784
|
"description": "",
|
|
649
785
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
650
786
|
"sourceFile": "packages/core-react/src/components/Search/Search.types.ts",
|
|
651
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
787
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Search/Search.types.ts#L8"
|
|
652
788
|
},
|
|
653
789
|
{
|
|
654
790
|
"name": "typeahead",
|
|
@@ -660,7 +796,7 @@
|
|
|
660
796
|
"deprecated": "\n\nThe `typeahead` prop has been deprecated and will be removed in a future version.\n\nA new component, `Typeahead`, has been introduced with specific UX for typeahead-like\nbehavior. Please use this component instead.\n\n**Before**\n\n<Search typeahead onChange={() => { ... }} />\n\n**After**\n\n<Typeahead onChange={() => { ... }} />\n",
|
|
661
797
|
"deprecatedSince": "10.20.0\n",
|
|
662
798
|
"sourceFile": "packages/core-react/src/components/Search/Search.types.ts",
|
|
663
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
799
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Search/Search.types.ts#L64"
|
|
664
800
|
},
|
|
665
801
|
{
|
|
666
802
|
"name": "usingHook",
|
|
@@ -670,7 +806,7 @@
|
|
|
670
806
|
"description": "",
|
|
671
807
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
672
808
|
"sourceFile": "packages/core-react/src/components/Search/Search.types.ts",
|
|
673
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
809
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Search/Search.types.ts#L111"
|
|
674
810
|
},
|
|
675
811
|
{
|
|
676
812
|
"name": "value",
|
|
@@ -680,7 +816,7 @@
|
|
|
680
816
|
"description": "Initial value string",
|
|
681
817
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Initial value string</p>\n</div><dl class=\"tsd-comment-tags\"><dt>default</dt><dd><p>''</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
682
818
|
"sourceFile": "packages/core-react/src/components/Search/Search.types.ts",
|
|
683
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
819
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Search/Search.types.ts#L118"
|
|
684
820
|
},
|
|
685
821
|
{
|
|
686
822
|
"name": "variant",
|
|
@@ -691,7 +827,7 @@
|
|
|
691
827
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p>Use the <code>error</code> prop instead</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
692
828
|
"deprecated": "Use the `error` prop instead",
|
|
693
829
|
"sourceFile": "packages/core-react/src/components/Input/Input.types.ts",
|
|
694
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
830
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Input/Input.types.ts#L15"
|
|
695
831
|
},
|
|
696
832
|
{
|
|
697
833
|
"name": "onClear",
|
|
@@ -701,7 +837,7 @@
|
|
|
701
837
|
"description": "",
|
|
702
838
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
703
839
|
"sourceFile": "packages/core-react/src/components/Search/Search.types.ts",
|
|
704
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
840
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Search/Search.types.ts#L34"
|
|
705
841
|
},
|
|
706
842
|
{
|
|
707
843
|
"name": "onSubmit",
|
|
@@ -711,7 +847,145 @@
|
|
|
711
847
|
"description": "<div>Input handler for search variant</div>\n<CodeBlock>(value: string) => void</CodeBlock>",
|
|
712
848
|
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<div>Input handler for search variant</div>\n<CodeBlock>(value: string) => void</CodeBlock></div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
713
849
|
"sourceFile": "packages/core-react/src/components/Search/Search.types.ts",
|
|
714
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
850
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Search/Search.types.ts#L41"
|
|
851
|
+
}
|
|
852
|
+
],
|
|
853
|
+
"description": ""
|
|
854
|
+
},
|
|
855
|
+
"NavigationProps": {
|
|
856
|
+
"name": "NavigationProps",
|
|
857
|
+
"properties": [
|
|
858
|
+
{
|
|
859
|
+
"name": "children",
|
|
860
|
+
"required": false,
|
|
861
|
+
"type": "<span class=\"tsd-signature-type\">ReactNode</span>",
|
|
862
|
+
"typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
|
|
863
|
+
"description": "Instead of using the default children, you can pass in your own.",
|
|
864
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
|
|
865
|
+
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
866
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L40"
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
"name": "className",
|
|
870
|
+
"required": false,
|
|
871
|
+
"type": "<span class=\"tsd-signature-type\">string</span>",
|
|
872
|
+
"typeDetail": "<span class=\"tsd-signature-type\">string</span>",
|
|
873
|
+
"description": "Additional classNames",
|
|
874
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
|
|
875
|
+
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
876
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L45"
|
|
877
|
+
},
|
|
878
|
+
{
|
|
879
|
+
"name": "index",
|
|
880
|
+
"required": false,
|
|
881
|
+
"type": "<span class=\"tsd-signature-type\">number</span>",
|
|
882
|
+
"typeDetail": "<span class=\"tsd-signature-type\">number</span>",
|
|
883
|
+
"description": "",
|
|
884
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
885
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
886
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L33"
|
|
887
|
+
},
|
|
888
|
+
{
|
|
889
|
+
"name": "ref",
|
|
890
|
+
"required": false,
|
|
891
|
+
"type": "<span class=\"tsd-signature-type\">Ref</span><span class=\"tsd-signature-symbol\"><</span><span class=\"tsd-signature-type\">any</span><span class=\"tsd-signature-symbol\">></span>",
|
|
892
|
+
"typeDetail": "<span class=\"tsd-signature-type\">Ref</span><span class=\"tsd-signature-symbol\"><</span><span class=\"tsd-signature-type\">any</span><span class=\"tsd-signature-symbol\">></span>",
|
|
893
|
+
"description": "",
|
|
894
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
895
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
896
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L37"
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
"name": "style",
|
|
900
|
+
"required": false,
|
|
901
|
+
"type": "<span class=\"tsd-signature-type\">CSSProperties</span>",
|
|
902
|
+
"typeDetail": "<span class=\"tsd-signature-type\">CSSProperties</span>",
|
|
903
|
+
"description": "Additional CSS styles",
|
|
904
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
|
|
905
|
+
"sourceFile": "packages/core-react/src/utils/types.ts",
|
|
906
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/utils/types.ts#L50"
|
|
907
|
+
}
|
|
908
|
+
],
|
|
909
|
+
"description": ""
|
|
910
|
+
},
|
|
911
|
+
"OptionsProps": {
|
|
912
|
+
"name": "OptionsProps",
|
|
913
|
+
"properties": [
|
|
914
|
+
{
|
|
915
|
+
"name": "children",
|
|
916
|
+
"required": false,
|
|
917
|
+
"type": "<span class=\"tsd-signature-type\">ReactNode</span>",
|
|
918
|
+
"typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
|
|
919
|
+
"description": "",
|
|
920
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
921
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
922
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L95"
|
|
923
|
+
},
|
|
924
|
+
{
|
|
925
|
+
"name": "className",
|
|
926
|
+
"required": false,
|
|
927
|
+
"type": "<span class=\"tsd-signature-type\">string</span>",
|
|
928
|
+
"typeDetail": "<span class=\"tsd-signature-type\">string</span>",
|
|
929
|
+
"description": "",
|
|
930
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
931
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
932
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L99"
|
|
933
|
+
},
|
|
934
|
+
{
|
|
935
|
+
"name": "padding",
|
|
936
|
+
"required": false,
|
|
937
|
+
"type": "<span class=\"tsd-signature-type\">string</span>",
|
|
938
|
+
"typeDetail": "<span class=\"tsd-signature-type\">string</span>",
|
|
939
|
+
"description": "",
|
|
940
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
941
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
942
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L103"
|
|
943
|
+
},
|
|
944
|
+
{
|
|
945
|
+
"name": "scrollable",
|
|
946
|
+
"required": false,
|
|
947
|
+
"type": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
948
|
+
"typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
949
|
+
"description": "",
|
|
950
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>default</dt><dd><p>true</p>\n</dd></dl></div>",
|
|
951
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
952
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L108"
|
|
953
|
+
}
|
|
954
|
+
],
|
|
955
|
+
"description": ""
|
|
956
|
+
},
|
|
957
|
+
"Selection": {
|
|
958
|
+
"name": "Selection",
|
|
959
|
+
"properties": [
|
|
960
|
+
{
|
|
961
|
+
"name": "event",
|
|
962
|
+
"required": true,
|
|
963
|
+
"type": "<span class=\"tsd-signature-type\">Event</span>",
|
|
964
|
+
"typeDetail": "<span class=\"tsd-signature-type\">Event</span>",
|
|
965
|
+
"description": "",
|
|
966
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
967
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
968
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L18"
|
|
969
|
+
},
|
|
970
|
+
{
|
|
971
|
+
"name": "group",
|
|
972
|
+
"required": true,
|
|
973
|
+
"type": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
974
|
+
"typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
975
|
+
"description": "",
|
|
976
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
977
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
978
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L22"
|
|
979
|
+
},
|
|
980
|
+
{
|
|
981
|
+
"name": "item",
|
|
982
|
+
"required": true,
|
|
983
|
+
"type": "<span class=\"tsd-signature-type\">any</span>",
|
|
984
|
+
"typeDetail": "<span class=\"tsd-signature-type\">any</span>",
|
|
985
|
+
"description": "",
|
|
986
|
+
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
|
|
987
|
+
"sourceFile": "packages/core-react/src/components/Menu/Menu.types.ts",
|
|
988
|
+
"sourceUrl": "https://github.com/procore/core/blob/387cc181c/packages/core-react/src/components/Menu/Menu.types.ts#L26"
|
|
715
989
|
}
|
|
716
990
|
],
|
|
717
991
|
"description": ""
|