@hubspot/ui-extensions 0.10.0 → 0.11.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/dist/{pages/home/components.d.ts → __synced__/appHomeRemoteComponents.synced.d.ts} +7 -7
- package/dist/{pages/home/components.js → __synced__/appHomeRemoteComponents.synced.js} +1 -0
- package/dist/{crm/components.d.ts → __synced__/crmRemoteComponents.synced.d.ts} +40 -41
- package/dist/__synced__/crmRemoteComponents.synced.js +15 -0
- package/dist/__synced__/experimental/types.synced.d.ts +241 -0
- package/dist/__synced__/experimental/types.synced.js +5 -0
- package/dist/__synced__/experimentalRemoteComponents.synced.d.ts +94 -0
- package/dist/__synced__/experimentalRemoteComponents.synced.js +56 -0
- package/dist/__synced__/remoteComponents.synced.d.ts +848 -0
- package/dist/__synced__/remoteComponents.synced.js +583 -0
- package/dist/__synced__/types/actions.synced.d.ts +57 -0
- package/dist/__synced__/types/actions.synced.js +1 -0
- package/dist/__synced__/types/components/accordion.synced.d.ts +48 -0
- package/dist/__synced__/types/components/accordion.synced.js +1 -0
- package/dist/__synced__/types/components/alert.synced.d.ts +24 -0
- package/dist/__synced__/types/components/alert.synced.js +1 -0
- package/dist/__synced__/types/components/app-home-header-actions.synced.d.ts +39 -0
- package/dist/__synced__/types/components/app-home-header-actions.synced.js +1 -0
- package/dist/__synced__/types/components/button-row.synced.d.ts +44 -0
- package/dist/__synced__/types/components/button-row.synced.js +1 -0
- package/dist/__synced__/types/components/button.synced.d.ts +89 -0
- package/dist/__synced__/types/components/button.synced.js +1 -0
- package/dist/__synced__/types/components/card.synced.d.ts +12 -0
- package/dist/__synced__/types/components/card.synced.js +1 -0
- package/dist/__synced__/types/components/chart.synced.d.ts +137 -0
- package/dist/__synced__/types/components/chart.synced.js +5 -0
- package/dist/__synced__/types/components/description-list.synced.d.ts +36 -0
- package/dist/__synced__/types/components/description-list.synced.js +1 -0
- package/dist/__synced__/types/components/divider.synced.d.ts +14 -0
- package/dist/__synced__/types/components/divider.synced.js +1 -0
- package/dist/__synced__/types/components/dropdown.synced.d.ts +84 -0
- package/dist/__synced__/types/components/dropdown.synced.js +1 -0
- package/dist/__synced__/types/components/empty-state.synced.d.ts +51 -0
- package/dist/__synced__/types/components/empty-state.synced.js +1 -0
- package/dist/__synced__/types/components/error-state.synced.d.ts +24 -0
- package/dist/__synced__/types/components/error-state.synced.js +1 -0
- package/dist/__synced__/types/components/form.synced.d.ts +29 -0
- package/dist/__synced__/types/components/form.synced.js +1 -0
- package/dist/__synced__/types/components/heading.synced.d.ts +19 -0
- package/dist/__synced__/types/components/heading.synced.js +1 -0
- package/dist/__synced__/types/components/icon.synced.d.ts +29 -0
- package/dist/__synced__/types/components/icon.synced.js +1 -0
- package/dist/__synced__/types/components/iframe.synced.d.ts +20 -0
- package/dist/__synced__/types/components/iframe.synced.js +1 -0
- package/dist/__synced__/types/components/illustration.synced.d.ts +53 -0
- package/dist/__synced__/types/components/illustration.synced.js +43 -0
- package/dist/__synced__/types/components/image.synced.d.ts +40 -0
- package/dist/__synced__/types/components/image.synced.js +1 -0
- package/dist/__synced__/types/components/index.synced.d.ts +38 -0
- package/dist/__synced__/types/components/index.synced.js +1 -0
- package/dist/__synced__/types/components/inputs.synced.d.ts +350 -0
- package/dist/__synced__/types/components/inputs.synced.js +1 -0
- package/dist/__synced__/types/components/layouts.synced.d.ts +172 -0
- package/dist/__synced__/types/components/layouts.synced.js +1 -0
- package/dist/__synced__/types/components/link.synced.d.ts +38 -0
- package/dist/__synced__/types/components/link.synced.js +1 -0
- package/dist/__synced__/types/components/list.synced.d.ts +18 -0
- package/dist/__synced__/types/components/list.synced.js +1 -0
- package/dist/__synced__/types/components/loading-spinner.synced.d.ts +31 -0
- package/dist/__synced__/types/components/loading-spinner.synced.js +1 -0
- package/dist/__synced__/types/components/modal.synced.d.ts +60 -0
- package/dist/__synced__/types/components/modal.synced.js +1 -0
- package/dist/__synced__/types/components/panel.synced.d.ts +73 -0
- package/dist/__synced__/types/components/panel.synced.js +1 -0
- package/dist/__synced__/types/components/progress-bar.synced.d.ts +48 -0
- package/dist/__synced__/types/components/progress-bar.synced.js +1 -0
- package/dist/__synced__/types/components/selects.synced.d.ts +130 -0
- package/dist/__synced__/types/components/selects.synced.js +1 -0
- package/dist/__synced__/types/components/statistics.synced.d.ts +56 -0
- package/dist/__synced__/types/components/statistics.synced.js +1 -0
- package/dist/__synced__/types/components/status-tag.synced.d.ts +42 -0
- package/dist/__synced__/types/components/status-tag.synced.js +1 -0
- package/dist/__synced__/types/components/step-indicator.synced.d.ts +44 -0
- package/dist/__synced__/types/components/step-indicator.synced.js +1 -0
- package/dist/__synced__/types/components/table.synced.d.ts +138 -0
- package/dist/__synced__/types/components/table.synced.js +1 -0
- package/dist/__synced__/types/components/tabs.synced.d.ts +55 -0
- package/dist/__synced__/types/components/tabs.synced.js +1 -0
- package/dist/__synced__/types/components/tag.synced.d.ts +32 -0
- package/dist/__synced__/types/components/tag.synced.js +1 -0
- package/dist/__synced__/types/components/text.synced.d.ts +93 -0
- package/dist/__synced__/types/components/text.synced.js +1 -0
- package/dist/__synced__/types/components/tile.synced.d.ts +24 -0
- package/dist/__synced__/types/components/tile.synced.js +1 -0
- package/dist/__synced__/types/components/toggle.synced.d.ts +60 -0
- package/dist/__synced__/types/components/toggle.synced.js +1 -0
- package/dist/__synced__/types/components/toggleInputs.synced.d.ts +191 -0
- package/dist/__synced__/types/components/toggleInputs.synced.js +1 -0
- package/dist/__synced__/types/components/tooltip.synced.d.ts +12 -0
- package/dist/__synced__/types/components/tooltip.synced.js +1 -0
- package/dist/__synced__/types/context.synced.d.ts +82 -0
- package/dist/__synced__/types/context.synced.js +1 -0
- package/dist/__synced__/types/crm.synced.d.ts +248 -0
- package/dist/__synced__/types/crm.synced.js +1 -0
- package/dist/__synced__/types/extension-points.synced.d.ts +122 -0
- package/dist/__synced__/types/extension-points.synced.js +9 -0
- package/dist/__synced__/types/http-requests.synced.d.ts +106 -0
- package/dist/__synced__/types/http-requests.synced.js +8 -0
- package/dist/__synced__/types/index.synced.d.ts +8 -0
- package/dist/__synced__/types/index.synced.js +9 -0
- package/dist/__synced__/types/reactions.synced.d.ts +12 -0
- package/dist/__synced__/types/reactions.synced.js +1 -0
- package/dist/__synced__/types/shared.synced.d.ts +197 -0
- package/dist/__synced__/types/shared.synced.js +179 -0
- package/dist/coreComponents.d.ts +21 -5
- package/dist/coreComponents.js +23 -1
- package/dist/crm/hooks/useAssociations.d.ts +3 -0
- package/dist/crm/hooks/useAssociations.js +3 -5
- package/dist/crm/hooks/useCrmProperties.d.ts +0 -2
- package/dist/crm/hooks/useCrmProperties.js +0 -7
- package/dist/crm/index.d.ts +2 -2
- package/dist/crm/index.js +1 -2
- package/dist/experimental/index.d.ts +2 -79
- package/dist/experimental/index.js +1 -36
- package/dist/experimental/testing/internal/types-internal.d.ts +47 -0
- package/dist/experimental/testing/internal/types-internal.js +1 -0
- package/dist/experimental/testing/type-utils.d.ts +29 -0
- package/dist/experimental/testing/type-utils.js +37 -0
- package/dist/experimental/testing/types.d.ts +240 -0
- package/dist/experimental/testing/types.js +10 -0
- package/dist/experimental/types.d.ts +4 -9
- package/dist/pages/home/index.d.ts +1 -0
- package/dist/pages/home/index.js +1 -0
- package/dist/types.d.ts +90 -4
- package/dist/types.js +0 -3
- package/package.json +4 -7
- package/dist/crm/components.js +0 -15
- package/dist/experimental/testing/index.d.ts +0 -14
- package/dist/experimental/testing/index.js +0 -33
- package/dist/experimental/testing/jest/matchers/index.d.ts +0 -6
- package/dist/experimental/testing/jest/matchers/index.js +0 -6
- package/dist/utils/createExtensionComponent.d.ts +0 -3
- package/dist/utils/createExtensionComponent.js +0 -4
|
@@ -0,0 +1,848 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
import type * as types from './types/components/index.synced';
|
|
3
|
+
/**
|
|
4
|
+
* 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.
|
|
5
|
+
*
|
|
6
|
+
* **Links:**
|
|
7
|
+
*
|
|
8
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/alert Docs}
|
|
9
|
+
* - {@link https://app.hubspot.com/docs/48008916/reference/ui-components/standard-components/alert#variants Variants}
|
|
10
|
+
*/
|
|
11
|
+
export declare const Alert: "Alert" & {
|
|
12
|
+
readonly type?: "Alert" | undefined;
|
|
13
|
+
readonly props?: types.AlertProps | undefined;
|
|
14
|
+
readonly children?: true | undefined;
|
|
15
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Alert", types.AlertProps, true>>;
|
|
16
|
+
/**
|
|
17
|
+
* 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.
|
|
18
|
+
*
|
|
19
|
+
* **Links:**
|
|
20
|
+
*
|
|
21
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/button Docs}
|
|
22
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/button#usage-examples Examples}
|
|
23
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/design-patterns#button Design Pattern Examples}
|
|
24
|
+
*/
|
|
25
|
+
export declare const Button: "Button" & {
|
|
26
|
+
readonly type?: "Button" | undefined;
|
|
27
|
+
readonly props?: types.ButtonProps | undefined;
|
|
28
|
+
readonly children?: true | undefined;
|
|
29
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Button", types.ButtonProps, true>>;
|
|
30
|
+
/**
|
|
31
|
+
* The `ButtonRow` component renders a row of specified `Button` components. Use this component when you want to include multiple buttons in a row.
|
|
32
|
+
*
|
|
33
|
+
* **Links:**
|
|
34
|
+
*
|
|
35
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/button-row Docs}
|
|
36
|
+
*/
|
|
37
|
+
export declare const ButtonRow: "ButtonRow" & {
|
|
38
|
+
readonly type?: "ButtonRow" | undefined;
|
|
39
|
+
readonly props?: types.ButtonRowProps | undefined;
|
|
40
|
+
readonly children?: true | undefined;
|
|
41
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"ButtonRow", types.ButtonRowProps, true>>;
|
|
42
|
+
export declare const Card: "Card" & {
|
|
43
|
+
readonly type?: "Card" | undefined;
|
|
44
|
+
readonly props?: types.CardProps | undefined;
|
|
45
|
+
readonly children?: true | undefined;
|
|
46
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Card", types.CardProps, true>>;
|
|
47
|
+
/**
|
|
48
|
+
* 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.
|
|
49
|
+
*
|
|
50
|
+
* **Links:**
|
|
51
|
+
*
|
|
52
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/description-list Docs}
|
|
53
|
+
*/
|
|
54
|
+
export declare const DescriptionList: "DescriptionList" & {
|
|
55
|
+
readonly type?: "DescriptionList" | undefined;
|
|
56
|
+
readonly props?: types.DescriptionListProps | undefined;
|
|
57
|
+
readonly children?: true | undefined;
|
|
58
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"DescriptionList", types.DescriptionListProps, true>>;
|
|
59
|
+
/**
|
|
60
|
+
* The `DescriptionListItem` component renders a single set of a label and value. Use this component within a `DescriptionList` component.
|
|
61
|
+
*
|
|
62
|
+
* **Links:**
|
|
63
|
+
*
|
|
64
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/description-list Docs}
|
|
65
|
+
*/
|
|
66
|
+
export declare const DescriptionListItem: "DescriptionListItem" & {
|
|
67
|
+
readonly type?: "DescriptionListItem" | undefined;
|
|
68
|
+
readonly props?: types.DescriptionListItemProps | undefined;
|
|
69
|
+
readonly children?: true | undefined;
|
|
70
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"DescriptionListItem", types.DescriptionListItemProps, true>>;
|
|
71
|
+
/**
|
|
72
|
+
* 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.
|
|
73
|
+
*
|
|
74
|
+
* **Links:**
|
|
75
|
+
*
|
|
76
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/divider Docs}
|
|
77
|
+
*/
|
|
78
|
+
export declare const Divider: "Divider" & {
|
|
79
|
+
readonly type?: "Divider" | undefined;
|
|
80
|
+
readonly props?: types.DividerProps | undefined;
|
|
81
|
+
readonly children?: true | undefined;
|
|
82
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Divider", types.DividerProps, true>>;
|
|
83
|
+
/**
|
|
84
|
+
* 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.
|
|
85
|
+
*
|
|
86
|
+
* **Links:**
|
|
87
|
+
*
|
|
88
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/empty-state Docs}
|
|
89
|
+
*/
|
|
90
|
+
export declare const EmptyState: "EmptyState" & {
|
|
91
|
+
readonly type?: "EmptyState" | undefined;
|
|
92
|
+
readonly props?: types.EmptyStateProps | undefined;
|
|
93
|
+
readonly children?: true | undefined;
|
|
94
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"EmptyState", types.EmptyStateProps, true>>;
|
|
95
|
+
/**
|
|
96
|
+
* The `ErrorState` component sets the content of an erroring extension. Use this component to guide users through resolving errors that your extension might encounter.
|
|
97
|
+
*
|
|
98
|
+
* **Links:**
|
|
99
|
+
*
|
|
100
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/error-state Docs}
|
|
101
|
+
*/
|
|
102
|
+
export declare const ErrorState: "ErrorState" & {
|
|
103
|
+
readonly type?: "ErrorState" | undefined;
|
|
104
|
+
readonly props?: types.ErrorStateProps | undefined;
|
|
105
|
+
readonly children?: true | undefined;
|
|
106
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"ErrorState", types.ErrorStateProps, true>>;
|
|
107
|
+
/**
|
|
108
|
+
* 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.
|
|
109
|
+
*
|
|
110
|
+
* **Links:**
|
|
111
|
+
*
|
|
112
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/form Docs}
|
|
113
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/design-patterns#form Design Pattern Examples}
|
|
114
|
+
*/
|
|
115
|
+
export declare const Form: "Form" & {
|
|
116
|
+
readonly type?: "Form" | undefined;
|
|
117
|
+
readonly props?: types.FormProps | undefined;
|
|
118
|
+
readonly children?: true | undefined;
|
|
119
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Form", types.FormProps, true>>;
|
|
120
|
+
/**
|
|
121
|
+
* The `Heading` component renders large heading text. Use this component to introduce or differentiate sections of your component.
|
|
122
|
+
*
|
|
123
|
+
* **Links:**
|
|
124
|
+
*
|
|
125
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/heading Docs}
|
|
126
|
+
*/
|
|
127
|
+
export declare const Heading: "Heading" & {
|
|
128
|
+
readonly type?: "Heading" | undefined;
|
|
129
|
+
readonly props?: types.HeadingProps | undefined;
|
|
130
|
+
readonly children?: true | undefined;
|
|
131
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Heading", types.HeadingProps, true>>;
|
|
132
|
+
/**
|
|
133
|
+
* 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.
|
|
134
|
+
*
|
|
135
|
+
* **Links:**
|
|
136
|
+
*
|
|
137
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/image Docs}
|
|
138
|
+
*/
|
|
139
|
+
export declare const Image: "Image" & {
|
|
140
|
+
readonly type?: "Image" | undefined;
|
|
141
|
+
readonly props?: types.ImageProps | undefined;
|
|
142
|
+
readonly children?: true | undefined;
|
|
143
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Image", types.ImageProps, true>>;
|
|
144
|
+
/**
|
|
145
|
+
* The `Input` component renders a text input field where a user can enter a custom text value. Like other inputs, this component should be used within a `Form` that has a submit button.
|
|
146
|
+
*
|
|
147
|
+
* **Links:**
|
|
148
|
+
*
|
|
149
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/input Docs}
|
|
150
|
+
*/
|
|
151
|
+
export declare const Input: "Input" & {
|
|
152
|
+
readonly type?: "Input" | undefined;
|
|
153
|
+
readonly props?: types.InputProps | undefined;
|
|
154
|
+
readonly children?: true | undefined;
|
|
155
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Input", types.InputProps, true>>;
|
|
156
|
+
/**
|
|
157
|
+
* The `Link` component renders a clickable hyperlink. Use links to direct users to an external web page or another part of the HubSpot app.
|
|
158
|
+
*
|
|
159
|
+
* **Links:**
|
|
160
|
+
*
|
|
161
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/link Docs}
|
|
162
|
+
*/
|
|
163
|
+
export declare const Link: "Link" & {
|
|
164
|
+
readonly type?: "Link" | undefined;
|
|
165
|
+
readonly props?: types.LinkProps | undefined;
|
|
166
|
+
readonly children?: true | undefined;
|
|
167
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Link", types.LinkProps, true>>;
|
|
168
|
+
/**
|
|
169
|
+
* The `TextArea` component renders a fillable text field. Like other inputs, this component should be used within a `Form` that has a submit button.
|
|
170
|
+
*
|
|
171
|
+
* **Links:**
|
|
172
|
+
*
|
|
173
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/text-area Docs}
|
|
174
|
+
*/
|
|
175
|
+
export declare const TextArea: "TextArea" & {
|
|
176
|
+
readonly type?: "TextArea" | undefined;
|
|
177
|
+
readonly props?: types.TextAreaProps | undefined;
|
|
178
|
+
readonly children?: true | undefined;
|
|
179
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"TextArea", types.TextAreaProps, true>>;
|
|
180
|
+
/** @deprecated use TextArea instead. With a capital A.*/
|
|
181
|
+
export declare const Textarea: "Textarea" & {
|
|
182
|
+
readonly type?: "Textarea" | undefined;
|
|
183
|
+
readonly props?: types.TextAreaProps | undefined;
|
|
184
|
+
readonly children?: true | undefined;
|
|
185
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Textarea", types.TextAreaProps, true>>;
|
|
186
|
+
/**
|
|
187
|
+
* The `LoadingSpinner` component renders a visual indicator for when an extension is loading or processing data.
|
|
188
|
+
*
|
|
189
|
+
* **Links:**
|
|
190
|
+
*
|
|
191
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/loading-spinner Docs}
|
|
192
|
+
*/
|
|
193
|
+
export declare const LoadingSpinner: "LoadingSpinner" & {
|
|
194
|
+
readonly type?: "LoadingSpinner" | undefined;
|
|
195
|
+
readonly props?: types.LoadingSpinnerProps | undefined;
|
|
196
|
+
readonly children?: true | undefined;
|
|
197
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"LoadingSpinner", types.LoadingSpinnerProps, true>>;
|
|
198
|
+
/**
|
|
199
|
+
* 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.
|
|
200
|
+
*
|
|
201
|
+
* **Links:**
|
|
202
|
+
*
|
|
203
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/progress-bar Docs}
|
|
204
|
+
*/
|
|
205
|
+
export declare const ProgressBar: "ProgressBar" & {
|
|
206
|
+
readonly type?: "ProgressBar" | undefined;
|
|
207
|
+
readonly props?: types.ProgressBarProps | undefined;
|
|
208
|
+
readonly children?: true | undefined;
|
|
209
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"ProgressBar", types.ProgressBarProps, true>>;
|
|
210
|
+
/**
|
|
211
|
+
* 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.
|
|
212
|
+
*
|
|
213
|
+
* **Links:**
|
|
214
|
+
*
|
|
215
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/select Docs}
|
|
216
|
+
*/
|
|
217
|
+
export declare const Select: "Select" & {
|
|
218
|
+
readonly type?: "Select" | undefined;
|
|
219
|
+
readonly props?: types.SelectProps | undefined;
|
|
220
|
+
readonly children?: true | undefined;
|
|
221
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Select", types.SelectProps, true>>;
|
|
222
|
+
/**
|
|
223
|
+
* The `Tag` component renders a tag to label or categorize information or other components. Tags can be static or clickable for invoking functions.
|
|
224
|
+
*
|
|
225
|
+
* **Links:**
|
|
226
|
+
*
|
|
227
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/tag Docs}
|
|
228
|
+
*/
|
|
229
|
+
export declare const Tag: "Tag" & {
|
|
230
|
+
readonly type?: "Tag" | undefined;
|
|
231
|
+
readonly props?: types.TagProps | undefined;
|
|
232
|
+
readonly children?: true | undefined;
|
|
233
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Tag", types.TagProps, true>>;
|
|
234
|
+
/**
|
|
235
|
+
* The `Text` component renders text with formatting options.
|
|
236
|
+
*
|
|
237
|
+
* **Links:**
|
|
238
|
+
*
|
|
239
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/text Docs}
|
|
240
|
+
*/
|
|
241
|
+
export declare const Text: "Text" & {
|
|
242
|
+
readonly type?: "Text" | undefined;
|
|
243
|
+
readonly props?: types.TextProps | undefined;
|
|
244
|
+
readonly children?: true | undefined;
|
|
245
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Text", types.TextProps, true>>;
|
|
246
|
+
/**
|
|
247
|
+
* The `Tile` component renders a square tile that can contain other components. Use this component to create groups of related components.
|
|
248
|
+
*
|
|
249
|
+
* **Links:**
|
|
250
|
+
*
|
|
251
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/tile Docs}
|
|
252
|
+
*/
|
|
253
|
+
export declare const Tile: "Tile" & {
|
|
254
|
+
readonly type?: "Tile" | undefined;
|
|
255
|
+
readonly props?: types.TileProps | undefined;
|
|
256
|
+
readonly children?: true | undefined;
|
|
257
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Tile", types.TileProps, true>>;
|
|
258
|
+
/** @deprecated use Flex instead. It will be removed in the next release. */
|
|
259
|
+
export declare const Stack: "Stack" & {
|
|
260
|
+
readonly type?: "Stack" | undefined;
|
|
261
|
+
readonly props?: types.StackProps | undefined;
|
|
262
|
+
readonly children?: true | undefined;
|
|
263
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Stack", types.StackProps, true>>;
|
|
264
|
+
/**
|
|
265
|
+
* The `ToggleGroup` component renders a list of selectable options, either in radio button or checkbox form.
|
|
266
|
+
*
|
|
267
|
+
* **Links:**
|
|
268
|
+
*
|
|
269
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/toggle-group Docs}
|
|
270
|
+
*/
|
|
271
|
+
export declare const ToggleGroup: "ToggleGroup" & {
|
|
272
|
+
readonly type?: "ToggleGroup" | undefined;
|
|
273
|
+
readonly props?: ({
|
|
274
|
+
toggleType: "checkboxList";
|
|
275
|
+
onChange?: ((value: string[]) => void) | undefined;
|
|
276
|
+
value?: string[] | undefined;
|
|
277
|
+
} & import("./types/components/toggleInputs.synced").CommonGroupProps) | ({
|
|
278
|
+
toggleType: "radioButtonList";
|
|
279
|
+
onChange?: ((value: string) => void) | undefined;
|
|
280
|
+
value?: string | undefined;
|
|
281
|
+
} & import("./types/components/toggleInputs.synced").CommonGroupProps) | undefined;
|
|
282
|
+
readonly children?: true | undefined;
|
|
283
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"ToggleGroup", ({
|
|
284
|
+
toggleType: "checkboxList";
|
|
285
|
+
onChange?: ((value: string[]) => void) | undefined;
|
|
286
|
+
value?: string[] | undefined;
|
|
287
|
+
} & import("./types/components/toggleInputs.synced").CommonGroupProps) | ({
|
|
288
|
+
toggleType: "radioButtonList";
|
|
289
|
+
onChange?: ((value: string) => void) | undefined;
|
|
290
|
+
value?: string | undefined;
|
|
291
|
+
} & import("./types/components/toggleInputs.synced").CommonGroupProps), true>>;
|
|
292
|
+
/**
|
|
293
|
+
* 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.
|
|
294
|
+
*
|
|
295
|
+
* **Links:**
|
|
296
|
+
*
|
|
297
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/statistics Docs}
|
|
298
|
+
*/
|
|
299
|
+
export declare const StatisticsItem: "StatisticsItem" & {
|
|
300
|
+
readonly type?: "StatisticsItem" | undefined;
|
|
301
|
+
readonly props?: types.StatisticsItemProps | undefined;
|
|
302
|
+
readonly children?: true | undefined;
|
|
303
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"StatisticsItem", types.StatisticsItemProps, true>>;
|
|
304
|
+
/**
|
|
305
|
+
* The `Statistics` component renders a visual spotlight of one or more data points. Includes the `StatisticsItem` and `StatisticsTrend` subcomponents.
|
|
306
|
+
*
|
|
307
|
+
* **Links:**
|
|
308
|
+
*
|
|
309
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/statistics Docs}
|
|
310
|
+
*/
|
|
311
|
+
export declare const Statistics: "Statistics" & {
|
|
312
|
+
readonly type?: "Statistics" | undefined;
|
|
313
|
+
readonly props?: types.StatisticsProps | undefined;
|
|
314
|
+
readonly children?: true | undefined;
|
|
315
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Statistics", types.StatisticsProps, true>>;
|
|
316
|
+
/**
|
|
317
|
+
* The `StatisticsTrend` component renders a percentage trend value and direction alonside a `StatisticsItem` component. Use this component within the `StatisticsItem` component.
|
|
318
|
+
*
|
|
319
|
+
* **Links:**
|
|
320
|
+
*
|
|
321
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/statistics Docs}
|
|
322
|
+
*/
|
|
323
|
+
export declare const StatisticsTrend: "StatisticsTrend" & {
|
|
324
|
+
readonly type?: "StatisticsTrend" | undefined;
|
|
325
|
+
readonly props?: types.StatisticsTrendProps | undefined;
|
|
326
|
+
readonly children?: true | undefined;
|
|
327
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"StatisticsTrend", types.StatisticsTrendProps, true>>;
|
|
328
|
+
/**
|
|
329
|
+
* The `Table` component renders a table. To format the table, use the subcomponents `TableHead`, `TableRow`, `TableHeader`, `TableBody`, `TableCell`and `TableFooter`.
|
|
330
|
+
*
|
|
331
|
+
* **Links:**
|
|
332
|
+
*
|
|
333
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
334
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/design-patterns#table Design Pattern Example}
|
|
335
|
+
*/
|
|
336
|
+
export declare const Table: "Table" & {
|
|
337
|
+
readonly type?: "Table" | undefined;
|
|
338
|
+
readonly props?: types.TableProps | undefined;
|
|
339
|
+
readonly children?: true | undefined;
|
|
340
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Table", types.TableProps, true>>;
|
|
341
|
+
/**
|
|
342
|
+
* The `TableFooter` component renders a footer within a `Table` component. Use this component to display totals or other summary information.
|
|
343
|
+
*
|
|
344
|
+
* **Links:**
|
|
345
|
+
*
|
|
346
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
347
|
+
*/
|
|
348
|
+
export declare const TableFooter: "TableFooter" & {
|
|
349
|
+
readonly type?: "TableFooter" | undefined;
|
|
350
|
+
readonly props?: types.TableElementProps | undefined;
|
|
351
|
+
readonly children?: true | undefined;
|
|
352
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"TableFooter", types.TableElementProps, true>>;
|
|
353
|
+
/**
|
|
354
|
+
* The `TableCell` component renders individual cells within the `TableBody` component.
|
|
355
|
+
*
|
|
356
|
+
* **Links:**
|
|
357
|
+
*
|
|
358
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
359
|
+
*/
|
|
360
|
+
export declare const TableCell: "TableCell" & {
|
|
361
|
+
readonly type?: "TableCell" | undefined;
|
|
362
|
+
readonly props?: types.TableCellProps | undefined;
|
|
363
|
+
readonly children?: true | undefined;
|
|
364
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"TableCell", types.TableCellProps, true>>;
|
|
365
|
+
/**
|
|
366
|
+
* The `TableRow` component renders a row within the `TableBody` or `TableHead` component.
|
|
367
|
+
*
|
|
368
|
+
* **Links:**
|
|
369
|
+
*
|
|
370
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
371
|
+
*/
|
|
372
|
+
export declare const TableRow: "TableRow" & {
|
|
373
|
+
readonly type?: "TableRow" | undefined;
|
|
374
|
+
readonly props?: types.TableElementProps | undefined;
|
|
375
|
+
readonly children?: true | undefined;
|
|
376
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"TableRow", types.TableElementProps, true>>;
|
|
377
|
+
/**
|
|
378
|
+
* The `TableBody` component renders the body (rows and cells) of a table within the `Table` component.
|
|
379
|
+
*
|
|
380
|
+
* **Links:**
|
|
381
|
+
*
|
|
382
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
383
|
+
*/
|
|
384
|
+
export declare const TableBody: "TableBody" & {
|
|
385
|
+
readonly type?: "TableBody" | undefined;
|
|
386
|
+
readonly props?: types.TableElementProps | undefined;
|
|
387
|
+
readonly children?: true | undefined;
|
|
388
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"TableBody", types.TableElementProps, true>>;
|
|
389
|
+
/**
|
|
390
|
+
* The `TableHeader` component renders individual cells containing bolded column labels, within `TableHead`.
|
|
391
|
+
*
|
|
392
|
+
* **Links:**
|
|
393
|
+
*
|
|
394
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
395
|
+
*/
|
|
396
|
+
export declare const TableHeader: "TableHeader" & {
|
|
397
|
+
readonly type?: "TableHeader" | undefined;
|
|
398
|
+
readonly props?: types.TableHeaderProps | undefined;
|
|
399
|
+
readonly children?: true | undefined;
|
|
400
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"TableHeader", types.TableHeaderProps, true>>;
|
|
401
|
+
/**
|
|
402
|
+
* The `TableHead` component renders the header section of the `Table` component, containing column labels.
|
|
403
|
+
*
|
|
404
|
+
* **Links:**
|
|
405
|
+
*
|
|
406
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/table Docs}
|
|
407
|
+
*/
|
|
408
|
+
export declare const TableHead: "TableHead" & {
|
|
409
|
+
readonly type?: "TableHead" | undefined;
|
|
410
|
+
readonly props?: types.TableElementProps | undefined;
|
|
411
|
+
readonly children?: true | undefined;
|
|
412
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"TableHead", types.TableElementProps, true>>;
|
|
413
|
+
/**
|
|
414
|
+
* The `NumberInput` component renders a number input field. Like other inputs, this component should be used within a `Form` that has a submit button.
|
|
415
|
+
*
|
|
416
|
+
* **Links:**
|
|
417
|
+
*
|
|
418
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/number-input Docs}
|
|
419
|
+
*/
|
|
420
|
+
export declare const NumberInput: "NumberInput" & {
|
|
421
|
+
readonly type?: "NumberInput" | undefined;
|
|
422
|
+
readonly props?: types.NumberInputProps | undefined;
|
|
423
|
+
readonly children?: true | undefined;
|
|
424
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"NumberInput", types.NumberInputProps, true>>;
|
|
425
|
+
/**
|
|
426
|
+
* The `Box` component renders an empty div container for fine tuning the spacing of components. Commonly used with the `Flex` component.
|
|
427
|
+
*
|
|
428
|
+
* **Links:**
|
|
429
|
+
*
|
|
430
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/box Docs}
|
|
431
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/flex-and-box Flex and Box Example}
|
|
432
|
+
*/
|
|
433
|
+
export declare const Box: "Box" & {
|
|
434
|
+
readonly type?: "Box" | undefined;
|
|
435
|
+
readonly props?: types.BoxProps | undefined;
|
|
436
|
+
readonly children?: true | undefined;
|
|
437
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Box", types.BoxProps, true>>;
|
|
438
|
+
/**
|
|
439
|
+
* The `StepIndicator` component renders an indicator to show the current step of a multi-step process.
|
|
440
|
+
*
|
|
441
|
+
* **Links:**
|
|
442
|
+
*
|
|
443
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/step-indicator Docs}
|
|
444
|
+
*/
|
|
445
|
+
export declare const StepIndicator: "StepIndicator" & {
|
|
446
|
+
readonly type?: "StepIndicator" | undefined;
|
|
447
|
+
readonly props?: types.StepIndicatorProps | undefined;
|
|
448
|
+
readonly children?: true | undefined;
|
|
449
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"StepIndicator", types.StepIndicatorProps, true>>;
|
|
450
|
+
/**
|
|
451
|
+
* 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.
|
|
452
|
+
*
|
|
453
|
+
* **Links:**
|
|
454
|
+
*
|
|
455
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/accordion Docs}
|
|
456
|
+
*/
|
|
457
|
+
export declare const Accordion: "Accordion" & {
|
|
458
|
+
readonly type?: "Accordion" | undefined;
|
|
459
|
+
readonly props?: types.AccordionProps | undefined;
|
|
460
|
+
readonly children?: true | undefined;
|
|
461
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Accordion", types.AccordionProps, true>>;
|
|
462
|
+
/**
|
|
463
|
+
* The MultiSelect component renders a dropdown menu select field where a user can select multiple values. Commonly used within the `Form` component.
|
|
464
|
+
*
|
|
465
|
+
* **Links:**
|
|
466
|
+
*
|
|
467
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/multi-select Docs}
|
|
468
|
+
*/
|
|
469
|
+
export declare const MultiSelect: "MultiSelect" & {
|
|
470
|
+
readonly type?: "MultiSelect" | undefined;
|
|
471
|
+
readonly props?: types.MultiSelectProps | undefined;
|
|
472
|
+
readonly children?: true | undefined;
|
|
473
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"MultiSelect", types.MultiSelectProps, true>>;
|
|
474
|
+
/**
|
|
475
|
+
* 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.
|
|
476
|
+
*
|
|
477
|
+
* **Links:**
|
|
478
|
+
*
|
|
479
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/flex Docs}
|
|
480
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/flex-and-box Flex and Box Example}
|
|
481
|
+
*/
|
|
482
|
+
export declare const Flex: "Flex" & {
|
|
483
|
+
readonly type?: "Flex" | undefined;
|
|
484
|
+
readonly props?: types.FlexProps | undefined;
|
|
485
|
+
readonly children?: true | undefined;
|
|
486
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Flex", types.FlexProps, true>>;
|
|
487
|
+
/**
|
|
488
|
+
* The `DateInput` component renders an input field where a user can select a date. Commonly used within the `Form` component.
|
|
489
|
+
*
|
|
490
|
+
* **Links:**
|
|
491
|
+
*
|
|
492
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/date-input Docs}
|
|
493
|
+
*/
|
|
494
|
+
export declare const DateInput: "DateInput" & {
|
|
495
|
+
readonly type?: "DateInput" | undefined;
|
|
496
|
+
readonly props?: types.DateInputProps | undefined;
|
|
497
|
+
readonly children?: true | undefined;
|
|
498
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"DateInput", types.DateInputProps, true>>;
|
|
499
|
+
/**
|
|
500
|
+
* 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.
|
|
501
|
+
*
|
|
502
|
+
* **Links:**
|
|
503
|
+
*
|
|
504
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/checkbox Docs}
|
|
505
|
+
*/
|
|
506
|
+
export declare const Checkbox: "Checkbox" & {
|
|
507
|
+
readonly type?: "Checkbox" | undefined;
|
|
508
|
+
readonly props?: types.CheckboxProps | undefined;
|
|
509
|
+
readonly children?: true | undefined;
|
|
510
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Checkbox", types.CheckboxProps, true>>;
|
|
511
|
+
/**
|
|
512
|
+
* 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.
|
|
513
|
+
*/
|
|
514
|
+
export declare const RadioButton: "RadioButton" & {
|
|
515
|
+
readonly type?: "RadioButton" | undefined;
|
|
516
|
+
readonly props?: types.RadioButtonProps | undefined;
|
|
517
|
+
readonly children?: true | undefined;
|
|
518
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"RadioButton", types.RadioButtonProps, true>>;
|
|
519
|
+
/**
|
|
520
|
+
* 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.
|
|
521
|
+
*
|
|
522
|
+
* **Links:**
|
|
523
|
+
*
|
|
524
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/list Docs}
|
|
525
|
+
*/
|
|
526
|
+
export declare const List: "List" & {
|
|
527
|
+
readonly type?: "List" | undefined;
|
|
528
|
+
readonly props?: types.ListProps | undefined;
|
|
529
|
+
readonly children?: true | undefined;
|
|
530
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"List", types.ListProps, true>>;
|
|
531
|
+
/**
|
|
532
|
+
* The `Toggle` component renders a boolean toggle switch that can be configured with sizing, label position, read-only, and more.
|
|
533
|
+
*
|
|
534
|
+
* **Links:**
|
|
535
|
+
*
|
|
536
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/toggle Docs}
|
|
537
|
+
*/
|
|
538
|
+
export declare const Toggle: "Toggle" & {
|
|
539
|
+
readonly type?: "Toggle" | undefined;
|
|
540
|
+
readonly props?: types.ToggleProps | undefined;
|
|
541
|
+
readonly children?: true | undefined;
|
|
542
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Toggle", types.ToggleProps, true>>;
|
|
543
|
+
/**
|
|
544
|
+
* 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.
|
|
545
|
+
*
|
|
546
|
+
* **Links:**
|
|
547
|
+
*
|
|
548
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/dropdown Docs}
|
|
549
|
+
*/
|
|
550
|
+
export declare function Dropdown(props: types.DropdownProps): JSX.Element;
|
|
551
|
+
export declare namespace Dropdown {
|
|
552
|
+
var ButtonItem: "DropdownButtonItem" & {
|
|
553
|
+
readonly type?: "DropdownButtonItem" | undefined;
|
|
554
|
+
readonly props?: types.DropdownButtonItemProps | undefined;
|
|
555
|
+
readonly children?: true | undefined;
|
|
556
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"DropdownButtonItem", types.DropdownButtonItemProps, true>>;
|
|
557
|
+
}
|
|
558
|
+
/**
|
|
559
|
+
* The Panel component renders a panel overlay on the right side of the page and contains other components.
|
|
560
|
+
*
|
|
561
|
+
* **Links:**
|
|
562
|
+
*
|
|
563
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/panel Docs}
|
|
564
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
565
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/design-patterns#panel Design Pattern Examples}
|
|
566
|
+
*/
|
|
567
|
+
export declare const Panel: "Panel" & {
|
|
568
|
+
readonly type?: "Panel" | undefined;
|
|
569
|
+
readonly props?: types.PanelProps | undefined;
|
|
570
|
+
readonly children?: true | undefined;
|
|
571
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Panel", types.PanelProps, true>>;
|
|
572
|
+
/**
|
|
573
|
+
* 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`.
|
|
574
|
+
*
|
|
575
|
+
* **Links:**
|
|
576
|
+
*
|
|
577
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/panel-footer Docs}
|
|
578
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
579
|
+
*/
|
|
580
|
+
export declare const PanelFooter: "PanelFooter" & {
|
|
581
|
+
readonly type?: "PanelFooter" | undefined;
|
|
582
|
+
readonly props?: types.PanelFooterProps | undefined;
|
|
583
|
+
readonly children?: true | undefined;
|
|
584
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"PanelFooter", types.PanelFooterProps, true>>;
|
|
585
|
+
/**
|
|
586
|
+
* The `PanelBody` component is a container that wraps the panel's content and makes it scrollable. Include only one `PanelBody` component per `Panel`.
|
|
587
|
+
*
|
|
588
|
+
* **Links:**
|
|
589
|
+
*
|
|
590
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/panel-footer Docs}
|
|
591
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
592
|
+
*/
|
|
593
|
+
export declare const PanelBody: "PanelBody" & {
|
|
594
|
+
readonly type?: "PanelBody" | undefined;
|
|
595
|
+
readonly props?: types.PanelBodyProps | undefined;
|
|
596
|
+
readonly children?: true | undefined;
|
|
597
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"PanelBody", types.PanelBodyProps, true>>;
|
|
598
|
+
/**
|
|
599
|
+
* 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`.
|
|
600
|
+
*
|
|
601
|
+
* **Links:**
|
|
602
|
+
*
|
|
603
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/panel-footer Docs}
|
|
604
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
605
|
+
*/
|
|
606
|
+
export declare const PanelSection: "PanelSection" & {
|
|
607
|
+
readonly type?: "PanelSection" | undefined;
|
|
608
|
+
readonly props?: types.PanelSectionProps | undefined;
|
|
609
|
+
readonly children?: true | undefined;
|
|
610
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"PanelSection", types.PanelSectionProps, true>>;
|
|
611
|
+
/**
|
|
612
|
+
* The `StepperInput` component renders a number input field that can be increased or decreased by a set number. Commonly used within the `Form` component.
|
|
613
|
+
*
|
|
614
|
+
* **Links:**
|
|
615
|
+
*
|
|
616
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/stepper-input Docs}
|
|
617
|
+
*/
|
|
618
|
+
export declare const StepperInput: "StepperInput" & {
|
|
619
|
+
readonly type?: "StepperInput" | undefined;
|
|
620
|
+
readonly props?: types.StepperInputProps | undefined;
|
|
621
|
+
readonly children?: true | undefined;
|
|
622
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"StepperInput", types.StepperInputProps, true>>;
|
|
623
|
+
/**
|
|
624
|
+
* The Modal component renders a pop-up overlay that can contain other components.
|
|
625
|
+
*
|
|
626
|
+
* **Links:**
|
|
627
|
+
*
|
|
628
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/modal Docs}
|
|
629
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
630
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/design-patterns#modal Design Pattern Examples}
|
|
631
|
+
*/
|
|
632
|
+
export declare const Modal: "Modal" & {
|
|
633
|
+
readonly type?: "Modal" | undefined;
|
|
634
|
+
readonly props?: types.ModalProps | undefined;
|
|
635
|
+
readonly children?: true | undefined;
|
|
636
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Modal", types.ModalProps, true>>;
|
|
637
|
+
/**
|
|
638
|
+
* The `ModalBody` component contains the main content of the modal. One `ModalBody` is required per `Modal`.
|
|
639
|
+
*
|
|
640
|
+
* **Links:**
|
|
641
|
+
*
|
|
642
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/modal Docs}
|
|
643
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
644
|
+
*/
|
|
645
|
+
export declare const ModalBody: "ModalBody" & {
|
|
646
|
+
readonly type?: "ModalBody" | undefined;
|
|
647
|
+
readonly props?: types.ModalBodyProps | undefined;
|
|
648
|
+
readonly children?: true | undefined;
|
|
649
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"ModalBody", types.ModalBodyProps, true>>;
|
|
650
|
+
/**
|
|
651
|
+
* The `ModalFooter` component is an optional component to format the footer section of the modal. Use one `ModalFooter` per `Modal`.
|
|
652
|
+
*
|
|
653
|
+
* **Links:**
|
|
654
|
+
*
|
|
655
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/modal Docs}
|
|
656
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/overlay-example Overlay Example}
|
|
657
|
+
*/
|
|
658
|
+
export declare const ModalFooter: "ModalFooter" & {
|
|
659
|
+
readonly type?: "ModalFooter" | undefined;
|
|
660
|
+
readonly props?: types.ModalFooterProps | undefined;
|
|
661
|
+
readonly children?: true | undefined;
|
|
662
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"ModalFooter", types.ModalFooterProps, true>>;
|
|
663
|
+
/**
|
|
664
|
+
* 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.
|
|
665
|
+
*
|
|
666
|
+
* **Links:**
|
|
667
|
+
*
|
|
668
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/icon Docs}
|
|
669
|
+
*/
|
|
670
|
+
export declare const Icon: "Icon" & {
|
|
671
|
+
readonly type?: "Icon" | undefined;
|
|
672
|
+
readonly props?: types.IconProps | undefined;
|
|
673
|
+
readonly children?: true | undefined;
|
|
674
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Icon", types.IconProps, true>>;
|
|
675
|
+
/**
|
|
676
|
+
* The `StatusTag` component renders a visual indicator to display the current status of an item. Status tags can be static or clickable.
|
|
677
|
+
*
|
|
678
|
+
* **Links:**
|
|
679
|
+
*
|
|
680
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/status-tag Docs}
|
|
681
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/status-tag#variants Variants}
|
|
682
|
+
*/
|
|
683
|
+
export declare const StatusTag: "StatusTag" & {
|
|
684
|
+
readonly type?: "StatusTag" | undefined;
|
|
685
|
+
readonly props?: types.StatusTagProps | undefined;
|
|
686
|
+
readonly children?: true | undefined;
|
|
687
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"StatusTag", types.StatusTagProps, true>>;
|
|
688
|
+
/**
|
|
689
|
+
* The `LoadingButton` component renders a button with loading state options.
|
|
690
|
+
*
|
|
691
|
+
* **Links:**
|
|
692
|
+
*
|
|
693
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/loading-button Docs}
|
|
694
|
+
*/
|
|
695
|
+
export declare const LoadingButton: "LoadingButton" & {
|
|
696
|
+
readonly type?: "LoadingButton" | undefined;
|
|
697
|
+
readonly props?: types.LoadingButtonProps | undefined;
|
|
698
|
+
readonly children?: true | undefined;
|
|
699
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"LoadingButton", types.LoadingButtonProps, true>>;
|
|
700
|
+
/**
|
|
701
|
+
* The `BarChart` component renders a bar chart for visualizing data. This type of chart is best suited for comparing categorical data.
|
|
702
|
+
*
|
|
703
|
+
* **Links:**
|
|
704
|
+
*
|
|
705
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/bar-chart BarChart Docs}
|
|
706
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/charts Charts Docs}
|
|
707
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/charts-example Charts Example}
|
|
708
|
+
*/
|
|
709
|
+
export declare const BarChart: "BarChart" & {
|
|
710
|
+
readonly type?: "BarChart" | undefined;
|
|
711
|
+
readonly props?: types.ChartProps | undefined;
|
|
712
|
+
readonly children?: true | undefined;
|
|
713
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"BarChart", types.ChartProps, true>>;
|
|
714
|
+
/**
|
|
715
|
+
* The `LineChart` component renders a line chart for visualizing data. This type of chart is best suited for time series plots or trend data.
|
|
716
|
+
*
|
|
717
|
+
* **Links:**
|
|
718
|
+
*
|
|
719
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/line-chart LineChart Docs}
|
|
720
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/charts Charts Docs}
|
|
721
|
+
* - {@link https://github.com/HubSpot/ui-extensions-examples/tree/main/charts-example Charts Example}
|
|
722
|
+
*/
|
|
723
|
+
export declare const LineChart: "LineChart" & {
|
|
724
|
+
readonly type?: "LineChart" | undefined;
|
|
725
|
+
readonly props?: types.ChartProps | undefined;
|
|
726
|
+
readonly children?: true | undefined;
|
|
727
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"LineChart", types.ChartProps, true>>;
|
|
728
|
+
/**
|
|
729
|
+
* `Tabs` allow you to group related content in a compact space, allowing users to switch between views without leaving the page.
|
|
730
|
+
* @example
|
|
731
|
+
* ```tsx
|
|
732
|
+
* <Tabs defaultSelected="1">
|
|
733
|
+
* <Tab tabId="1">First tab content</Tab>
|
|
734
|
+
* <Tab tabId="2">Second tab content</Tab>
|
|
735
|
+
* </Tabs>
|
|
736
|
+
* ```
|
|
737
|
+
*
|
|
738
|
+
* **Links:**
|
|
739
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/tabs Documentation}
|
|
740
|
+
* - {@link https://github.com/hubspotdev/uie-tabbed-product-carousel Tabs Example}
|
|
741
|
+
*/
|
|
742
|
+
export declare const Tabs: "Tabs" & {
|
|
743
|
+
readonly type?: "Tabs" | undefined;
|
|
744
|
+
readonly props?: types.TabsProps | undefined;
|
|
745
|
+
readonly children?: true | undefined;
|
|
746
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Tabs", types.TabsProps, true>>;
|
|
747
|
+
/**
|
|
748
|
+
* Each `Tab` represents a single tab (or "view") within the parent `Tabs` component.
|
|
749
|
+
* @example
|
|
750
|
+
* ```tsx
|
|
751
|
+
* <Tabs defaultSelected="1">
|
|
752
|
+
* <Tab tabId="1">First tab content</Tab>
|
|
753
|
+
* <Tab tabId="2">Second tab content</Tab>
|
|
754
|
+
* </Tabs>
|
|
755
|
+
* ```
|
|
756
|
+
*
|
|
757
|
+
* **Links:**
|
|
758
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/tabs Documentation}
|
|
759
|
+
* - {@link https://github.com/hubspotdev/uie-tabbed-product-carousel Tabs Example}
|
|
760
|
+
*/
|
|
761
|
+
export declare const Tab: "Tab" & {
|
|
762
|
+
readonly type?: "Tab" | undefined;
|
|
763
|
+
readonly props?: types.TabProps | undefined;
|
|
764
|
+
readonly children?: true | undefined;
|
|
765
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Tab", types.TabProps, true>>;
|
|
766
|
+
/**
|
|
767
|
+
* The `Illustration` component renders an illustration.
|
|
768
|
+
*
|
|
769
|
+
* **Links:**
|
|
770
|
+
*
|
|
771
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/illustration Illustration Docs}
|
|
772
|
+
*/
|
|
773
|
+
export declare const Illustration: "Illustration" & {
|
|
774
|
+
readonly type?: "Illustration" | undefined;
|
|
775
|
+
readonly props?: types.IllustrationProps | undefined;
|
|
776
|
+
readonly children?: true | undefined;
|
|
777
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Illustration", types.IllustrationProps, true>>;
|
|
778
|
+
/**
|
|
779
|
+
* The `Tooltip` component renders a tooltip for a component.
|
|
780
|
+
*
|
|
781
|
+
* **Links:**
|
|
782
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/tooltip Documentation}
|
|
783
|
+
*/
|
|
784
|
+
export declare const Tooltip: "Tooltip" & {
|
|
785
|
+
readonly type?: "Tooltip" | undefined;
|
|
786
|
+
readonly props?: types.TooltipProps | undefined;
|
|
787
|
+
readonly children?: true | undefined;
|
|
788
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Tooltip", types.TooltipProps, true>>;
|
|
789
|
+
/**
|
|
790
|
+
* The `SearchInput` component renders a search input field.
|
|
791
|
+
*
|
|
792
|
+
* **Links:**
|
|
793
|
+
*
|
|
794
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/search-input SearchInput Docs}
|
|
795
|
+
*/
|
|
796
|
+
export declare const SearchInput: "SearchInput" & {
|
|
797
|
+
readonly type?: "SearchInput" | undefined;
|
|
798
|
+
readonly props?: types.SearchInputProps | undefined;
|
|
799
|
+
readonly children?: true | undefined;
|
|
800
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"SearchInput", types.SearchInputProps, true>>;
|
|
801
|
+
/**
|
|
802
|
+
* The `TimeInput` component renders an input field where a user can select a time. Commonly used within the `Form` component.
|
|
803
|
+
*
|
|
804
|
+
* **Links:**
|
|
805
|
+
*
|
|
806
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/time-input Docs}
|
|
807
|
+
*/
|
|
808
|
+
export declare const TimeInput: "TimeInput" & {
|
|
809
|
+
readonly type?: "TimeInput" | undefined;
|
|
810
|
+
readonly props?: types.TimeInputProps | undefined;
|
|
811
|
+
readonly children?: true | undefined;
|
|
812
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"TimeInput", types.TimeInputProps, true>>;
|
|
813
|
+
/**
|
|
814
|
+
* The `CurrencyInput` component renders a currency input field with proper formatting,
|
|
815
|
+
* currency symbols, and locale-specific display patterns. Commonly used within the `Form` component.
|
|
816
|
+
*
|
|
817
|
+
* **Links:**
|
|
818
|
+
*
|
|
819
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/currency-input Docs}
|
|
820
|
+
*/
|
|
821
|
+
export declare const CurrencyInput: "CurrencyInput" & {
|
|
822
|
+
readonly type?: "CurrencyInput" | undefined;
|
|
823
|
+
readonly props?: types.CurrencyInputProps | undefined;
|
|
824
|
+
readonly children?: true | undefined;
|
|
825
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"CurrencyInput", types.CurrencyInputProps, true>>;
|
|
826
|
+
/**
|
|
827
|
+
* The `Inline` component spreads aligns its children horizontally (along the x-axis).
|
|
828
|
+
*
|
|
829
|
+
* **Links:**
|
|
830
|
+
*
|
|
831
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/inline Docs}
|
|
832
|
+
*/ export declare const Inline: "Inline" & {
|
|
833
|
+
readonly type?: "Inline" | undefined;
|
|
834
|
+
readonly props?: types.InlineProps | undefined;
|
|
835
|
+
readonly children?: true | undefined;
|
|
836
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"Inline", types.InlineProps, true>>;
|
|
837
|
+
/**
|
|
838
|
+
* 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.
|
|
839
|
+
*
|
|
840
|
+
* **Links:**
|
|
841
|
+
*
|
|
842
|
+
* - {@link https://developers.hubspot.com/docs/reference/ui-components/standard-components/simple-grid Docs}
|
|
843
|
+
*/
|
|
844
|
+
export declare const AutoGrid: "AutoGrid" & {
|
|
845
|
+
readonly type?: "AutoGrid" | undefined;
|
|
846
|
+
readonly props?: types.AutoGridProps | undefined;
|
|
847
|
+
readonly children?: true | undefined;
|
|
848
|
+
} & import("@remote-ui/react").ReactComponentTypeFromRemoteComponentType<import("@remote-ui/types").RemoteComponentType<"AutoGrid", types.AutoGridProps, true>>;
|