@hubspot/ui-extensions 0.11.0 → 0.11.1
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/dist/__synced__/remoteComponents.synced.d.ts +85 -354
- package/dist/__synced__/remoteComponents.synced.js +88 -83
- package/dist/__synced__/types/components/index.synced.d.ts +38 -38
- package/dist/__synced__/types/index.synced.d.ts +7 -7
- package/dist/__synced__/types/index.synced.js +1 -9
- package/dist/__synced__/types/shared.synced.d.ts +2 -3
- package/dist/__synced__/utils/remote-component-registry.synced.d.ts +80 -0
- package/dist/__synced__/utils/remote-component-registry.synced.js +64 -0
- package/dist/experimental/testing/internal/constants.d.ts +2 -0
- package/dist/experimental/testing/internal/constants.js +1 -0
- package/dist/experimental/testing/internal/debug.d.ts +8 -0
- package/dist/experimental/testing/internal/debug.js +10 -0
- package/dist/experimental/testing/internal/element.d.ts +11 -0
- package/dist/experimental/testing/internal/element.js +67 -0
- package/dist/experimental/testing/internal/errors.d.ts +44 -0
- package/dist/experimental/testing/internal/errors.js +52 -0
- package/dist/experimental/testing/internal/fragment.d.ts +8 -0
- package/dist/experimental/testing/internal/fragment.js +44 -0
- package/dist/experimental/testing/internal/print.d.ts +6 -0
- package/dist/experimental/testing/internal/print.js +114 -0
- package/dist/experimental/testing/internal/query.d.ts +57 -0
- package/dist/experimental/testing/internal/query.js +231 -0
- package/dist/experimental/testing/internal/root.d.ts +8 -0
- package/dist/experimental/testing/internal/root.js +44 -0
- package/dist/experimental/testing/internal/text.d.ts +9 -0
- package/dist/experimental/testing/internal/text.js +16 -0
- package/dist/experimental/testing/types.d.ts +1 -1
- package/dist/hubspot.d.ts +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/pages/home/index.d.ts +1 -1
- package/dist/pages/home/index.js +1 -1
- package/package.json +10 -5
- package/dist/coreComponents.d.ts +0 -848
- package/dist/coreComponents.js +0 -582
- package/dist/experimental/types.d.ts +0 -240
- package/dist/experimental/types.js +0 -5
- package/dist/types.d.ts +0 -3214
- package/dist/types.js +0 -244
|
@@ -1,6 +1,11 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
import { createRemoteComponentRegistry } from './utils/remote-component-registry.synced';
|
|
2
|
+
/**
|
|
3
|
+
* Represents a registry of HubSpot-provided React components that should only be used **internally** by the UI extension SDK.
|
|
4
|
+
*
|
|
5
|
+
* @internal
|
|
6
|
+
*/
|
|
7
|
+
export const __hubSpotComponentRegistry = createRemoteComponentRegistry();
|
|
8
|
+
const { createAndRegisterRemoteReactComponent, createAndRegisterRemoteCompoundReactComponent, } = __hubSpotComponentRegistry;
|
|
4
9
|
/**
|
|
5
10
|
* The `Alert` component renders an alert within a card. Use this component to give usage guidance, notify users of action results, or warn them about potential issues or failures.
|
|
6
11
|
*
|
|
@@ -9,7 +14,7 @@ import { createRemoteReactComponent } from '@remote-ui/react';
|
|
|
9
14
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/alert Docs}
|
|
10
15
|
* - {@link https://app.hubspot.com/docs/48008916/reference/ui-components/standard-components/alert#variants Variants}
|
|
11
16
|
*/
|
|
12
|
-
export const Alert =
|
|
17
|
+
export const Alert = createAndRegisterRemoteReactComponent('Alert');
|
|
13
18
|
/**
|
|
14
19
|
* The `Button` component renders a single button. Use this component to enable users to perform actions, such as submitting a form, sending data to an external system, or deleting data.
|
|
15
20
|
*
|
|
@@ -19,7 +24,7 @@ export const Alert = createRemoteReactComponent('Alert');
|
|
|
19
24
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/button#usage-examples Examples}
|
|
20
25
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/design-patterns#button Design Pattern Examples}
|
|
21
26
|
*/
|
|
22
|
-
export const Button =
|
|
27
|
+
export const Button = createAndRegisterRemoteReactComponent('Button', {
|
|
23
28
|
fragmentProps: ['overlay'],
|
|
24
29
|
});
|
|
25
30
|
/**
|
|
@@ -29,8 +34,8 @@ export const Button = createRemoteReactComponent('Button', {
|
|
|
29
34
|
*
|
|
30
35
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/button-row Docs}
|
|
31
36
|
*/
|
|
32
|
-
export const ButtonRow =
|
|
33
|
-
export const Card =
|
|
37
|
+
export const ButtonRow = createAndRegisterRemoteReactComponent('ButtonRow');
|
|
38
|
+
export const Card = createAndRegisterRemoteReactComponent('Card');
|
|
34
39
|
/**
|
|
35
40
|
* The `DescriptionList` component renders pairs of labels and values. Use this component to display pairs of labels and values in a way that's easy to read at a glance.
|
|
36
41
|
*
|
|
@@ -38,7 +43,7 @@ export const Card = createRemoteReactComponent('Card');
|
|
|
38
43
|
*
|
|
39
44
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/description-list Docs}
|
|
40
45
|
*/
|
|
41
|
-
export const DescriptionList =
|
|
46
|
+
export const DescriptionList = createAndRegisterRemoteReactComponent('DescriptionList');
|
|
42
47
|
/**
|
|
43
48
|
* The `DescriptionListItem` component renders a single set of a label and value. Use this component within a `DescriptionList` component.
|
|
44
49
|
*
|
|
@@ -46,7 +51,7 @@ export const DescriptionList = createRemoteReactComponent('DescriptionList');
|
|
|
46
51
|
*
|
|
47
52
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/description-list Docs}
|
|
48
53
|
*/
|
|
49
|
-
export const DescriptionListItem =
|
|
54
|
+
export const DescriptionListItem = createAndRegisterRemoteReactComponent('DescriptionListItem');
|
|
50
55
|
/**
|
|
51
56
|
* The `Divider` component renders a grey, horizontal line for spacing out components vertically or creating sections in an extension. Use this component to space out other components when the content needs more separation than white space.
|
|
52
57
|
*
|
|
@@ -54,7 +59,7 @@ export const DescriptionListItem = createRemoteReactComponent('DescriptionListIt
|
|
|
54
59
|
*
|
|
55
60
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/divider Docs}
|
|
56
61
|
*/
|
|
57
|
-
export const Divider =
|
|
62
|
+
export const Divider = createAndRegisterRemoteReactComponent('Divider');
|
|
58
63
|
/**
|
|
59
64
|
* The `EmptyState` component sets the content that appears when the extension is in an empty state. Use this component when there's no content or data to help guide users.
|
|
60
65
|
*
|
|
@@ -62,7 +67,7 @@ export const Divider = createRemoteReactComponent('Divider');
|
|
|
62
67
|
*
|
|
63
68
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/empty-state Docs}
|
|
64
69
|
*/
|
|
65
|
-
export const EmptyState =
|
|
70
|
+
export const EmptyState = createAndRegisterRemoteReactComponent('EmptyState');
|
|
66
71
|
/**
|
|
67
72
|
* The `ErrorState` component sets the content of an erroring extension. Use this component to guide users through resolving errors that your extension might encounter.
|
|
68
73
|
*
|
|
@@ -70,7 +75,7 @@ export const EmptyState = createRemoteReactComponent('EmptyState');
|
|
|
70
75
|
*
|
|
71
76
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/error-state Docs}
|
|
72
77
|
*/
|
|
73
|
-
export const ErrorState =
|
|
78
|
+
export const ErrorState = createAndRegisterRemoteReactComponent('ErrorState');
|
|
74
79
|
/**
|
|
75
80
|
* The `Form` component renders a form that can contain other subcomponents, such as `Input`, `Select`, and `Button`. Use this component to enable users to submit data to HubSpot or an external system.
|
|
76
81
|
*
|
|
@@ -79,7 +84,7 @@ export const ErrorState = createRemoteReactComponent('ErrorState');
|
|
|
79
84
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/form Docs}
|
|
80
85
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/design-patterns#form Design Pattern Examples}
|
|
81
86
|
*/
|
|
82
|
-
export const Form =
|
|
87
|
+
export const Form = createAndRegisterRemoteReactComponent('Form');
|
|
83
88
|
/**
|
|
84
89
|
* The `Heading` component renders large heading text. Use this component to introduce or differentiate sections of your component.
|
|
85
90
|
*
|
|
@@ -87,7 +92,7 @@ export const Form = createRemoteReactComponent('Form');
|
|
|
87
92
|
*
|
|
88
93
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/heading Docs}
|
|
89
94
|
*/
|
|
90
|
-
export const Heading =
|
|
95
|
+
export const Heading = createAndRegisterRemoteReactComponent('Heading');
|
|
91
96
|
/**
|
|
92
97
|
* The `Image` component renders an image. Use this component to add a logo or other visual brand identity asset, or to accentuate other content in the extension.
|
|
93
98
|
*
|
|
@@ -95,7 +100,7 @@ export const Heading = createRemoteReactComponent('Heading');
|
|
|
95
100
|
*
|
|
96
101
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/image Docs}
|
|
97
102
|
*/
|
|
98
|
-
export const Image =
|
|
103
|
+
export const Image = createAndRegisterRemoteReactComponent('Image', {
|
|
99
104
|
fragmentProps: ['overlay'],
|
|
100
105
|
});
|
|
101
106
|
/**
|
|
@@ -105,7 +110,7 @@ export const Image = createRemoteReactComponent('Image', {
|
|
|
105
110
|
*
|
|
106
111
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/input Docs}
|
|
107
112
|
*/
|
|
108
|
-
export const Input =
|
|
113
|
+
export const Input = createAndRegisterRemoteReactComponent('Input');
|
|
109
114
|
/**
|
|
110
115
|
* The `Link` component renders a clickable hyperlink. Use links to direct users to an external web page or another part of the HubSpot app.
|
|
111
116
|
*
|
|
@@ -113,7 +118,7 @@ export const Input = createRemoteReactComponent('Input');
|
|
|
113
118
|
*
|
|
114
119
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/link Docs}
|
|
115
120
|
*/
|
|
116
|
-
export const Link =
|
|
121
|
+
export const Link = createAndRegisterRemoteReactComponent('Link', {
|
|
117
122
|
fragmentProps: ['overlay'],
|
|
118
123
|
});
|
|
119
124
|
/**
|
|
@@ -123,11 +128,11 @@ export const Link = createRemoteReactComponent('Link', {
|
|
|
123
128
|
*
|
|
124
129
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/text-area Docs}
|
|
125
130
|
*/
|
|
126
|
-
export const TextArea =
|
|
131
|
+
export const TextArea = createAndRegisterRemoteReactComponent('TextArea');
|
|
127
132
|
// Textarea was changed to TextArea
|
|
128
133
|
// Exporting both for backwards compat
|
|
129
134
|
/** @deprecated use TextArea instead. With a capital A.*/
|
|
130
|
-
export const Textarea =
|
|
135
|
+
export const Textarea = createAndRegisterRemoteReactComponent('Textarea');
|
|
131
136
|
/**
|
|
132
137
|
* The `LoadingSpinner` component renders a visual indicator for when an extension is loading or processing data.
|
|
133
138
|
*
|
|
@@ -135,7 +140,7 @@ export const Textarea = createRemoteReactComponent('Textarea');
|
|
|
135
140
|
*
|
|
136
141
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/loading-spinner Docs}
|
|
137
142
|
*/
|
|
138
|
-
export const LoadingSpinner =
|
|
143
|
+
export const LoadingSpinner = createAndRegisterRemoteReactComponent('LoadingSpinner');
|
|
139
144
|
/**
|
|
140
145
|
* The `ProgressBar` component renders a visual indicator showing a numeric and/or percentage-based representation of progress. The percentage is calculated based on the maximum possible value specified in the component.
|
|
141
146
|
*
|
|
@@ -143,7 +148,7 @@ export const LoadingSpinner = createRemoteReactComponent('LoadingSpinner');
|
|
|
143
148
|
*
|
|
144
149
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/progress-bar Docs}
|
|
145
150
|
*/
|
|
146
|
-
export const ProgressBar =
|
|
151
|
+
export const ProgressBar = createAndRegisterRemoteReactComponent('ProgressBar');
|
|
147
152
|
/**
|
|
148
153
|
* The `Select` component renders a dropdown menu select field where a user can select a single value. A search bar will be automatically included when there are more than seven options. Like other inputs, this component should be used within a `Form` that has a submit button.
|
|
149
154
|
*
|
|
@@ -151,7 +156,7 @@ export const ProgressBar = createRemoteReactComponent('ProgressBar');
|
|
|
151
156
|
*
|
|
152
157
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/select Docs}
|
|
153
158
|
*/
|
|
154
|
-
export const Select =
|
|
159
|
+
export const Select = createAndRegisterRemoteReactComponent('Select');
|
|
155
160
|
/**
|
|
156
161
|
* The `Tag` component renders a tag to label or categorize information or other components. Tags can be static or clickable for invoking functions.
|
|
157
162
|
*
|
|
@@ -159,7 +164,7 @@ export const Select = createRemoteReactComponent('Select');
|
|
|
159
164
|
*
|
|
160
165
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/tag Docs}
|
|
161
166
|
*/
|
|
162
|
-
export const Tag =
|
|
167
|
+
export const Tag = createAndRegisterRemoteReactComponent('Tag', {
|
|
163
168
|
fragmentProps: ['overlay'],
|
|
164
169
|
});
|
|
165
170
|
/**
|
|
@@ -169,7 +174,7 @@ export const Tag = createRemoteReactComponent('Tag', {
|
|
|
169
174
|
*
|
|
170
175
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/text Docs}
|
|
171
176
|
*/
|
|
172
|
-
export const Text =
|
|
177
|
+
export const Text = createAndRegisterRemoteReactComponent('Text');
|
|
173
178
|
/**
|
|
174
179
|
* The `Tile` component renders a square tile that can contain other components. Use this component to create groups of related components.
|
|
175
180
|
*
|
|
@@ -177,9 +182,9 @@ export const Text = createRemoteReactComponent('Text');
|
|
|
177
182
|
*
|
|
178
183
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/tile Docs}
|
|
179
184
|
*/
|
|
180
|
-
export const Tile =
|
|
185
|
+
export const Tile = createAndRegisterRemoteReactComponent('Tile');
|
|
181
186
|
/** @deprecated use Flex instead. It will be removed in the next release. */
|
|
182
|
-
export const Stack =
|
|
187
|
+
export const Stack = createAndRegisterRemoteReactComponent('Stack');
|
|
183
188
|
/**
|
|
184
189
|
* The `ToggleGroup` component renders a list of selectable options, either in radio button or checkbox form.
|
|
185
190
|
*
|
|
@@ -187,7 +192,7 @@ export const Stack = createRemoteReactComponent('Stack');
|
|
|
187
192
|
*
|
|
188
193
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/toggle-group Docs}
|
|
189
194
|
*/
|
|
190
|
-
export const ToggleGroup =
|
|
195
|
+
export const ToggleGroup = createAndRegisterRemoteReactComponent('ToggleGroup');
|
|
191
196
|
/**
|
|
192
197
|
* The `StatisticsItem` component renders a single data point within a `Statistics` component. Use this component to display a single data point, such as a number or percentage.
|
|
193
198
|
*
|
|
@@ -195,7 +200,7 @@ export const ToggleGroup = createRemoteReactComponent('ToggleGroup');
|
|
|
195
200
|
*
|
|
196
201
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/statistics Docs}
|
|
197
202
|
*/
|
|
198
|
-
export const StatisticsItem =
|
|
203
|
+
export const StatisticsItem = createAndRegisterRemoteReactComponent('StatisticsItem');
|
|
199
204
|
/**
|
|
200
205
|
* The `Statistics` component renders a visual spotlight of one or more data points. Includes the `StatisticsItem` and `StatisticsTrend` subcomponents.
|
|
201
206
|
*
|
|
@@ -203,7 +208,7 @@ export const StatisticsItem = createRemoteReactComponent('StatisticsItem');
|
|
|
203
208
|
*
|
|
204
209
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/statistics Docs}
|
|
205
210
|
*/
|
|
206
|
-
export const Statistics =
|
|
211
|
+
export const Statistics = createAndRegisterRemoteReactComponent('Statistics');
|
|
207
212
|
/**
|
|
208
213
|
* The `StatisticsTrend` component renders a percentage trend value and direction alonside a `StatisticsItem` component. Use this component within the `StatisticsItem` component.
|
|
209
214
|
*
|
|
@@ -211,7 +216,7 @@ export const Statistics = createRemoteReactComponent('Statistics');
|
|
|
211
216
|
*
|
|
212
217
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/statistics Docs}
|
|
213
218
|
*/
|
|
214
|
-
export const StatisticsTrend =
|
|
219
|
+
export const StatisticsTrend = createAndRegisterRemoteReactComponent('StatisticsTrend');
|
|
215
220
|
/**
|
|
216
221
|
* The `Table` component renders a table. To format the table, use the subcomponents `TableHead`, `TableRow`, `TableHeader`, `TableBody`, `TableCell`and `TableFooter`.
|
|
217
222
|
*
|
|
@@ -220,7 +225,7 @@ export const StatisticsTrend = createRemoteReactComponent('StatisticsTrend');
|
|
|
220
225
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
221
226
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/design-patterns#table Design Pattern Example}
|
|
222
227
|
*/
|
|
223
|
-
export const Table =
|
|
228
|
+
export const Table = createAndRegisterRemoteReactComponent('Table');
|
|
224
229
|
/**
|
|
225
230
|
* The `TableFooter` component renders a footer within a `Table` component. Use this component to display totals or other summary information.
|
|
226
231
|
*
|
|
@@ -228,7 +233,7 @@ export const Table = createRemoteReactComponent('Table');
|
|
|
228
233
|
*
|
|
229
234
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
230
235
|
*/
|
|
231
|
-
export const TableFooter =
|
|
236
|
+
export const TableFooter = createAndRegisterRemoteReactComponent('TableFooter');
|
|
232
237
|
/**
|
|
233
238
|
* The `TableCell` component renders individual cells within the `TableBody` component.
|
|
234
239
|
*
|
|
@@ -236,7 +241,7 @@ export const TableFooter = createRemoteReactComponent('TableFooter');
|
|
|
236
241
|
*
|
|
237
242
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
238
243
|
*/
|
|
239
|
-
export const TableCell =
|
|
244
|
+
export const TableCell = createAndRegisterRemoteReactComponent('TableCell');
|
|
240
245
|
/**
|
|
241
246
|
* The `TableRow` component renders a row within the `TableBody` or `TableHead` component.
|
|
242
247
|
*
|
|
@@ -244,7 +249,7 @@ export const TableCell = createRemoteReactComponent('TableCell');
|
|
|
244
249
|
*
|
|
245
250
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
246
251
|
*/
|
|
247
|
-
export const TableRow =
|
|
252
|
+
export const TableRow = createAndRegisterRemoteReactComponent('TableRow');
|
|
248
253
|
/**
|
|
249
254
|
* The `TableBody` component renders the body (rows and cells) of a table within the `Table` component.
|
|
250
255
|
*
|
|
@@ -252,7 +257,7 @@ export const TableRow = createRemoteReactComponent('TableRow');
|
|
|
252
257
|
*
|
|
253
258
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
254
259
|
*/
|
|
255
|
-
export const TableBody =
|
|
260
|
+
export const TableBody = createAndRegisterRemoteReactComponent('TableBody');
|
|
256
261
|
/**
|
|
257
262
|
* The `TableHeader` component renders individual cells containing bolded column labels, within `TableHead`.
|
|
258
263
|
*
|
|
@@ -260,7 +265,7 @@ export const TableBody = createRemoteReactComponent('TableBody');
|
|
|
260
265
|
*
|
|
261
266
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
262
267
|
*/
|
|
263
|
-
export const TableHeader =
|
|
268
|
+
export const TableHeader = createAndRegisterRemoteReactComponent('TableHeader');
|
|
264
269
|
/**
|
|
265
270
|
* The `TableHead` component renders the header section of the `Table` component, containing column labels.
|
|
266
271
|
*
|
|
@@ -268,7 +273,7 @@ export const TableHeader = createRemoteReactComponent('TableHeader');
|
|
|
268
273
|
*
|
|
269
274
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
270
275
|
*/
|
|
271
|
-
export const TableHead =
|
|
276
|
+
export const TableHead = createAndRegisterRemoteReactComponent('TableHead');
|
|
272
277
|
/**
|
|
273
278
|
* The `NumberInput` component renders a number input field. Like other inputs, this component should be used within a `Form` that has a submit button.
|
|
274
279
|
*
|
|
@@ -276,7 +281,7 @@ export const TableHead = createRemoteReactComponent('TableHead');
|
|
|
276
281
|
*
|
|
277
282
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/number-input Docs}
|
|
278
283
|
*/
|
|
279
|
-
export const NumberInput =
|
|
284
|
+
export const NumberInput = createAndRegisterRemoteReactComponent('NumberInput');
|
|
280
285
|
/**
|
|
281
286
|
* The `Box` component renders an empty div container for fine tuning the spacing of components. Commonly used with the `Flex` component.
|
|
282
287
|
*
|
|
@@ -285,7 +290,7 @@ export const NumberInput = createRemoteReactComponent('NumberInput');
|
|
|
285
290
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/box Docs}
|
|
286
291
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/flex-and-box Flex and Box Example}
|
|
287
292
|
*/
|
|
288
|
-
export const Box =
|
|
293
|
+
export const Box = createAndRegisterRemoteReactComponent('Box');
|
|
289
294
|
/**
|
|
290
295
|
* The `StepIndicator` component renders an indicator to show the current step of a multi-step process.
|
|
291
296
|
*
|
|
@@ -293,7 +298,7 @@ export const Box = createRemoteReactComponent('Box');
|
|
|
293
298
|
*
|
|
294
299
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/step-indicator Docs}
|
|
295
300
|
*/
|
|
296
|
-
export const StepIndicator =
|
|
301
|
+
export const StepIndicator = createAndRegisterRemoteReactComponent('StepIndicator');
|
|
297
302
|
/**
|
|
298
303
|
* The `Accordion` component renders an expandable and collapsable section that can contain other components. This component can be helpful for saving space and breaking up extension content.
|
|
299
304
|
*
|
|
@@ -301,7 +306,7 @@ export const StepIndicator = createRemoteReactComponent('StepIndicator');
|
|
|
301
306
|
*
|
|
302
307
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/accordion Docs}
|
|
303
308
|
*/
|
|
304
|
-
export const Accordion =
|
|
309
|
+
export const Accordion = createAndRegisterRemoteReactComponent('Accordion');
|
|
305
310
|
/**
|
|
306
311
|
* The MultiSelect component renders a dropdown menu select field where a user can select multiple values. Commonly used within the `Form` component.
|
|
307
312
|
*
|
|
@@ -309,7 +314,7 @@ export const Accordion = createRemoteReactComponent('Accordion');
|
|
|
309
314
|
*
|
|
310
315
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/multi-select Docs}
|
|
311
316
|
*/
|
|
312
|
-
export const MultiSelect =
|
|
317
|
+
export const MultiSelect = createAndRegisterRemoteReactComponent('MultiSelect');
|
|
313
318
|
/**
|
|
314
319
|
* The `Flex` component renders a flex container that can contain other components, and arrange them with props. Use this component to create a flexible and responsive layout.
|
|
315
320
|
*
|
|
@@ -318,7 +323,7 @@ export const MultiSelect = createRemoteReactComponent('MultiSelect');
|
|
|
318
323
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/flex Docs}
|
|
319
324
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/flex-and-box Flex and Box Example}
|
|
320
325
|
*/
|
|
321
|
-
export const Flex =
|
|
326
|
+
export const Flex = createAndRegisterRemoteReactComponent('Flex');
|
|
322
327
|
/**
|
|
323
328
|
* The `DateInput` component renders an input field where a user can select a date. Commonly used within the `Form` component.
|
|
324
329
|
*
|
|
@@ -326,7 +331,7 @@ export const Flex = createRemoteReactComponent('Flex');
|
|
|
326
331
|
*
|
|
327
332
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/date-input Docs}
|
|
328
333
|
*/
|
|
329
|
-
export const DateInput =
|
|
334
|
+
export const DateInput = createAndRegisterRemoteReactComponent('DateInput');
|
|
330
335
|
/**
|
|
331
336
|
* The `Checkbox` component renders a single checkbox input. Commonly used within the `Form` component. If you want to display multiple checkboxes, you should use `ToggleGroup` instead, as it comes with extra logic for handling multiple checkboxes.
|
|
332
337
|
*
|
|
@@ -334,11 +339,11 @@ export const DateInput = createRemoteReactComponent('DateInput');
|
|
|
334
339
|
*
|
|
335
340
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/checkbox Docs}
|
|
336
341
|
*/
|
|
337
|
-
export const Checkbox =
|
|
342
|
+
export const Checkbox = createAndRegisterRemoteReactComponent('Checkbox');
|
|
338
343
|
/**
|
|
339
344
|
* The `RadioButton` component renders a single radio input. Commonly used within the `Form` component. If you want to display multiple radio inputs, you should use `ToggleGroup` instead, as it comes with extra logic for handling multiple inputs.
|
|
340
345
|
*/
|
|
341
|
-
export const RadioButton =
|
|
346
|
+
export const RadioButton = createAndRegisterRemoteReactComponent('RadioButton');
|
|
342
347
|
/**
|
|
343
348
|
* The `List` component renders a list of items. Use this component to display a list of items, such as a list of contacts, tasks, or other data. A list can be styled as a bulleted list or a numbered list.
|
|
344
349
|
*
|
|
@@ -346,7 +351,7 @@ export const RadioButton = createRemoteReactComponent('RadioButton');
|
|
|
346
351
|
*
|
|
347
352
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/list Docs}
|
|
348
353
|
*/
|
|
349
|
-
export const List =
|
|
354
|
+
export const List = createAndRegisterRemoteReactComponent('List');
|
|
350
355
|
/**
|
|
351
356
|
* The `Toggle` component renders a boolean toggle switch that can be configured with sizing, label position, read-only, and more.
|
|
352
357
|
*
|
|
@@ -354,8 +359,7 @@ export const List = createRemoteReactComponent('List');
|
|
|
354
359
|
*
|
|
355
360
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/toggle Docs}
|
|
356
361
|
*/
|
|
357
|
-
export const Toggle =
|
|
358
|
-
const DropdownInternal = createRemoteReactComponent('Dropdown');
|
|
362
|
+
export const Toggle = createAndRegisterRemoteReactComponent('Toggle');
|
|
359
363
|
/**
|
|
360
364
|
* The `Dropdown` component renders a dropdown menu that can appear as a button or hyperlink. Use this component to enable users to select from multiple options in a compact list.
|
|
361
365
|
*
|
|
@@ -363,18 +367,19 @@ const DropdownInternal = createRemoteReactComponent('Dropdown');
|
|
|
363
367
|
*
|
|
364
368
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/dropdown Docs}
|
|
365
369
|
*/
|
|
366
|
-
export
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
370
|
+
export const Dropdown = createAndRegisterRemoteCompoundReactComponent('Dropdown', {
|
|
371
|
+
compoundComponentProperties: {
|
|
372
|
+
/**
|
|
373
|
+
* The `Dropdown.ButtonItem` component represents a single option within a `Dropdown` menu. Use this component as a child of the `Dropdown` component.
|
|
374
|
+
*
|
|
375
|
+
* **Links:**
|
|
376
|
+
*
|
|
377
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/dropdown Docs}
|
|
378
|
+
*/
|
|
379
|
+
ButtonItem: createAndRegisterRemoteReactComponent('DropdownButtonItem', {
|
|
380
|
+
fragmentProps: ['overlay'],
|
|
381
|
+
}),
|
|
382
|
+
},
|
|
378
383
|
});
|
|
379
384
|
/**
|
|
380
385
|
* The Panel component renders a panel overlay on the right side of the page and contains other components.
|
|
@@ -385,7 +390,7 @@ Dropdown.ButtonItem = createRemoteReactComponent('DropdownButtonItem', {
|
|
|
385
390
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
386
391
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/design-patterns#panel Design Pattern Examples}
|
|
387
392
|
*/
|
|
388
|
-
export const Panel =
|
|
393
|
+
export const Panel = createAndRegisterRemoteReactComponent('Panel');
|
|
389
394
|
/**
|
|
390
395
|
* The `PanelFooter` is a sticky footer component displayed at the bottom of a `Panel` component. Use this component to display actions or other content that should be visible at all times. Include only one `PanelFooter` component per `Panel`.
|
|
391
396
|
*
|
|
@@ -394,7 +399,7 @@ export const Panel = createRemoteReactComponent('Panel');
|
|
|
394
399
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/panel-footer Docs}
|
|
395
400
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
396
401
|
*/
|
|
397
|
-
export const PanelFooter =
|
|
402
|
+
export const PanelFooter = createAndRegisterRemoteReactComponent('PanelFooter');
|
|
398
403
|
/**
|
|
399
404
|
* The `PanelBody` component is a container that wraps the panel's content and makes it scrollable. Include only one `PanelBody` component per `Panel`.
|
|
400
405
|
*
|
|
@@ -403,7 +408,7 @@ export const PanelFooter = createRemoteReactComponent('PanelFooter');
|
|
|
403
408
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/panel-footer Docs}
|
|
404
409
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
405
410
|
*/
|
|
406
|
-
export const PanelBody =
|
|
411
|
+
export const PanelBody = createAndRegisterRemoteReactComponent('PanelBody');
|
|
407
412
|
/**
|
|
408
413
|
* The `PanelSection` component is a container that adds padding and bottom margin to provide spacing between content. Use the `PanelSection` component to separate content within a `PanelBody`.
|
|
409
414
|
*
|
|
@@ -412,7 +417,7 @@ export const PanelBody = createRemoteReactComponent('PanelBody');
|
|
|
412
417
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/panel-footer Docs}
|
|
413
418
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
414
419
|
*/
|
|
415
|
-
export const PanelSection =
|
|
420
|
+
export const PanelSection = createAndRegisterRemoteReactComponent('PanelSection');
|
|
416
421
|
/**
|
|
417
422
|
* The `StepperInput` component renders a number input field that can be increased or decreased by a set number. Commonly used within the `Form` component.
|
|
418
423
|
*
|
|
@@ -420,7 +425,7 @@ export const PanelSection = createRemoteReactComponent('PanelSection');
|
|
|
420
425
|
*
|
|
421
426
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/stepper-input Docs}
|
|
422
427
|
*/
|
|
423
|
-
export const StepperInput =
|
|
428
|
+
export const StepperInput = createAndRegisterRemoteReactComponent('StepperInput');
|
|
424
429
|
/**
|
|
425
430
|
* The Modal component renders a pop-up overlay that can contain other components.
|
|
426
431
|
*
|
|
@@ -430,7 +435,7 @@ export const StepperInput = createRemoteReactComponent('StepperInput');
|
|
|
430
435
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
431
436
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/design-patterns#modal Design Pattern Examples}
|
|
432
437
|
*/
|
|
433
|
-
export const Modal =
|
|
438
|
+
export const Modal = createAndRegisterRemoteReactComponent('Modal');
|
|
434
439
|
/**
|
|
435
440
|
* The `ModalBody` component contains the main content of the modal. One `ModalBody` is required per `Modal`.
|
|
436
441
|
*
|
|
@@ -439,7 +444,7 @@ export const Modal = createRemoteReactComponent('Modal');
|
|
|
439
444
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/modal Docs}
|
|
440
445
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
441
446
|
*/
|
|
442
|
-
export const ModalBody =
|
|
447
|
+
export const ModalBody = createAndRegisterRemoteReactComponent('ModalBody');
|
|
443
448
|
/**
|
|
444
449
|
* The `ModalFooter` component is an optional component to format the footer section of the modal. Use one `ModalFooter` per `Modal`.
|
|
445
450
|
*
|
|
@@ -448,7 +453,7 @@ export const ModalBody = createRemoteReactComponent('ModalBody');
|
|
|
448
453
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/modal Docs}
|
|
449
454
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
450
455
|
*/
|
|
451
|
-
export const ModalFooter =
|
|
456
|
+
export const ModalFooter = createAndRegisterRemoteReactComponent('ModalFooter');
|
|
452
457
|
/**
|
|
453
458
|
* Use the `Icon` component to render a visual icon within other components. It can generally be used inside most components, excluding ones that don't support child components.
|
|
454
459
|
*
|
|
@@ -456,7 +461,7 @@ export const ModalFooter = createRemoteReactComponent('ModalFooter');
|
|
|
456
461
|
*
|
|
457
462
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/icon Docs}
|
|
458
463
|
*/
|
|
459
|
-
export const Icon =
|
|
464
|
+
export const Icon = createAndRegisterRemoteReactComponent('Icon');
|
|
460
465
|
/**
|
|
461
466
|
* The `StatusTag` component renders a visual indicator to display the current status of an item. Status tags can be static or clickable.
|
|
462
467
|
*
|
|
@@ -465,7 +470,7 @@ export const Icon = createRemoteReactComponent('Icon');
|
|
|
465
470
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/status-tag Docs}
|
|
466
471
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/status-tag#variants Variants}
|
|
467
472
|
*/
|
|
468
|
-
export const StatusTag =
|
|
473
|
+
export const StatusTag = createAndRegisterRemoteReactComponent('StatusTag');
|
|
469
474
|
/**
|
|
470
475
|
* The `LoadingButton` component renders a button with loading state options.
|
|
471
476
|
*
|
|
@@ -473,7 +478,7 @@ export const StatusTag = createRemoteReactComponent('StatusTag');
|
|
|
473
478
|
*
|
|
474
479
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/loading-button Docs}
|
|
475
480
|
*/
|
|
476
|
-
export const LoadingButton =
|
|
481
|
+
export const LoadingButton = createAndRegisterRemoteReactComponent('LoadingButton', {
|
|
477
482
|
fragmentProps: ['overlay'],
|
|
478
483
|
});
|
|
479
484
|
/**
|
|
@@ -485,7 +490,7 @@ export const LoadingButton = createRemoteReactComponent('LoadingButton', {
|
|
|
485
490
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/charts Charts Docs}
|
|
486
491
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/charts-example Charts Example}
|
|
487
492
|
*/
|
|
488
|
-
export const BarChart =
|
|
493
|
+
export const BarChart = createAndRegisterRemoteReactComponent('BarChart');
|
|
489
494
|
/**
|
|
490
495
|
* The `LineChart` component renders a line chart for visualizing data. This type of chart is best suited for time series plots or trend data.
|
|
491
496
|
*
|
|
@@ -495,7 +500,7 @@ export const BarChart = createRemoteReactComponent('BarChart');
|
|
|
495
500
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/charts Charts Docs}
|
|
496
501
|
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/charts-example Charts Example}
|
|
497
502
|
*/
|
|
498
|
-
export const LineChart =
|
|
503
|
+
export const LineChart = createAndRegisterRemoteReactComponent('LineChart');
|
|
499
504
|
/**
|
|
500
505
|
* `Tabs` allow you to group related content in a compact space, allowing users to switch between views without leaving the page.
|
|
501
506
|
* @example
|
|
@@ -510,7 +515,7 @@ export const LineChart = createRemoteReactComponent('LineChart');
|
|
|
510
515
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/tabs Documentation}
|
|
511
516
|
* - {@link https://github.com/hubspotdev/uie-tabbed-product-carousel Tabs Example}
|
|
512
517
|
*/
|
|
513
|
-
export const Tabs =
|
|
518
|
+
export const Tabs = createAndRegisterRemoteReactComponent('Tabs');
|
|
514
519
|
/**
|
|
515
520
|
* Each `Tab` represents a single tab (or "view") within the parent `Tabs` component.
|
|
516
521
|
* @example
|
|
@@ -525,7 +530,7 @@ export const Tabs = createRemoteReactComponent('Tabs');
|
|
|
525
530
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/tabs Documentation}
|
|
526
531
|
* - {@link https://github.com/hubspotdev/uie-tabbed-product-carousel Tabs Example}
|
|
527
532
|
*/
|
|
528
|
-
export const Tab =
|
|
533
|
+
export const Tab = createAndRegisterRemoteReactComponent('Tab');
|
|
529
534
|
/**
|
|
530
535
|
* The `Illustration` component renders an illustration.
|
|
531
536
|
*
|
|
@@ -533,14 +538,14 @@ export const Tab = createRemoteReactComponent('Tab');
|
|
|
533
538
|
*
|
|
534
539
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/illustration Illustration Docs}
|
|
535
540
|
*/
|
|
536
|
-
export const Illustration =
|
|
541
|
+
export const Illustration = createAndRegisterRemoteReactComponent('Illustration');
|
|
537
542
|
/**
|
|
538
543
|
* The `Tooltip` component renders a tooltip for a component.
|
|
539
544
|
*
|
|
540
545
|
* **Links:**
|
|
541
546
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/tooltip Documentation}
|
|
542
547
|
*/
|
|
543
|
-
export const Tooltip =
|
|
548
|
+
export const Tooltip = createAndRegisterRemoteReactComponent('Tooltip');
|
|
544
549
|
/**
|
|
545
550
|
* The `SearchInput` component renders a search input field.
|
|
546
551
|
*
|
|
@@ -548,7 +553,7 @@ export const Tooltip = createRemoteReactComponent('Tooltip');
|
|
|
548
553
|
*
|
|
549
554
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/search-input SearchInput Docs}
|
|
550
555
|
*/
|
|
551
|
-
export const SearchInput =
|
|
556
|
+
export const SearchInput = createAndRegisterRemoteReactComponent('SearchInput');
|
|
552
557
|
/**
|
|
553
558
|
* The `TimeInput` component renders an input field where a user can select a time. Commonly used within the `Form` component.
|
|
554
559
|
*
|
|
@@ -556,7 +561,7 @@ export const SearchInput = createRemoteReactComponent('SearchInput');
|
|
|
556
561
|
*
|
|
557
562
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/time-input Docs}
|
|
558
563
|
*/
|
|
559
|
-
export const TimeInput =
|
|
564
|
+
export const TimeInput = createAndRegisterRemoteReactComponent('TimeInput');
|
|
560
565
|
/**
|
|
561
566
|
* The `CurrencyInput` component renders a currency input field with proper formatting,
|
|
562
567
|
* currency symbols, and locale-specific display patterns. Commonly used within the `Form` component.
|
|
@@ -565,14 +570,14 @@ export const TimeInput = createRemoteReactComponent('TimeInput');
|
|
|
565
570
|
*
|
|
566
571
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/currency-input Docs}
|
|
567
572
|
*/
|
|
568
|
-
export const CurrencyInput =
|
|
573
|
+
export const CurrencyInput = createAndRegisterRemoteReactComponent('CurrencyInput');
|
|
569
574
|
/**
|
|
570
575
|
* The `Inline` component spreads aligns its children horizontally (along the x-axis).
|
|
571
576
|
*
|
|
572
577
|
* **Links:**
|
|
573
578
|
*
|
|
574
579
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/inline Docs}
|
|
575
|
-
*/ export const Inline =
|
|
580
|
+
*/ export const Inline = createAndRegisterRemoteReactComponent('Inline');
|
|
576
581
|
/**
|
|
577
582
|
* The `AutoGrid` component renders a responsive grid layout that automatically adjusts the number of columns based on available space. Use this component to create flexible grid layouts for cards, tiles, or other content.
|
|
578
583
|
*
|
|
@@ -580,4 +585,4 @@ export const CurrencyInput = createRemoteReactComponent('CurrencyInput');
|
|
|
580
585
|
*
|
|
581
586
|
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/simple-grid Docs}
|
|
582
587
|
*/
|
|
583
|
-
export const AutoGrid =
|
|
588
|
+
export const AutoGrid = createAndRegisterRemoteReactComponent('AutoGrid');
|