@rippling/rippling-sdk 0.2.0-alpha.49 → 0.2.0-alpha.50
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/lib/manifest/custom-object-page-layout.d.mts +148 -34
- package/lib/manifest/custom-object-page-layout.d.mts.map +1 -1
- package/lib/manifest/custom-object-page-layout.d.ts +148 -34
- package/lib/manifest/custom-object-page-layout.d.ts.map +1 -1
- package/lib/manifest/custom-object-page-layout.js +61 -18
- package/lib/manifest/custom-object-page-layout.js.map +1 -1
- package/lib/manifest/custom-object-page-layout.mjs +61 -18
- package/lib/manifest/custom-object-page-layout.mjs.map +1 -1
- package/lib/manifest/custom-object.d.mts +1 -1
- package/lib/manifest/custom-object.d.ts +1 -1
- package/lib/manifest/custom-object.js +1 -1
- package/lib/manifest/custom-object.mjs +1 -1
- package/lib/manifest/field.d.mts +3 -3
- package/lib/manifest/field.d.ts +3 -3
- package/lib/manifest/field.js +2 -2
- package/lib/manifest/field.mjs +2 -2
- package/lib/manifest/index.d.mts +1 -1
- package/lib/manifest/index.d.mts.map +1 -1
- package/lib/manifest/index.d.ts +1 -1
- package/lib/manifest/index.d.ts.map +1 -1
- package/lib/manifest/index.js.map +1 -1
- package/lib/manifest/index.mjs.map +1 -1
- package/lib/sdui/components.d.mts +100 -211
- package/lib/sdui/components.d.mts.map +1 -1
- package/lib/sdui/components.d.ts +100 -211
- package/lib/sdui/components.d.ts.map +1 -1
- package/lib/sdui/components.js +96 -182
- package/lib/sdui/components.js.map +1 -1
- package/lib/sdui/components.mjs +93 -178
- package/lib/sdui/components.mjs.map +1 -1
- package/lib/sdui/index.d.mts +12 -52
- package/lib/sdui/index.d.mts.map +1 -1
- package/lib/sdui/index.d.ts +12 -52
- package/lib/sdui/index.d.ts.map +1 -1
- package/lib/sdui/index.js +10 -50
- package/lib/sdui/index.js.map +1 -1
- package/lib/sdui/index.mjs +5 -25
- package/lib/sdui/index.mjs.map +1 -1
- package/lib/sdui/propTypes.d.mts +3156 -3515
- package/lib/sdui/propTypes.d.mts.map +1 -1
- package/lib/sdui/propTypes.d.ts +3156 -3515
- package/lib/sdui/propTypes.d.ts.map +1 -1
- package/lib/sdui/propTypes.js +1 -1
- package/lib/sdui/propTypes.mjs +1 -1
- package/package.json +1 -1
- package/src/lib/manifest/custom-object-page-layout.ts +294 -79
- package/src/lib/manifest/custom-object.ts +1 -1
- package/src/lib/manifest/field.ts +3 -3
- package/src/lib/manifest/index.ts +27 -0
- package/src/lib/sdui/components.ts +181 -332
- package/src/lib/sdui/index.ts +13 -93
- package/src/lib/sdui/propTypes.ts +3509 -3892
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* AUTO-GENERATED from catalog-schema.json
|
|
3
|
-
* Components:
|
|
3
|
+
* Components: 134
|
|
4
4
|
*
|
|
5
5
|
* Do not edit manually. Run: node tools/sdui/builder/build.js
|
|
6
6
|
*/
|
|
@@ -8,7 +8,7 @@ import type { ActionBinding } from "./actions.mjs";
|
|
|
8
8
|
import type { StateRef, BindStateRef } from "./state.mjs";
|
|
9
9
|
import type { CondRef, TemplateRef } from "./props.mjs";
|
|
10
10
|
import type { ItemRef, BindItemRef } from "./directives.mjs";
|
|
11
|
-
import type { ActionCardCatalogProps, AiIconCatalogProps, AlertCatalogProps, AnimationCatalogProps, ApiErrorCatalogProps, AppGroupLoaderCatalogProps, AppGroupSelectCatalogProps, AppNavBarCatalogProps, AtomsSeparatorCatalogProps, AvatarCatalogProps, AvatarListCatalogProps, BadgeCatalogProps, BoxCatalogProps, BreadcrumbCatalogProps, ButtonCatalogProps, ButtonGroupCatalogProps, CardCatalogProps, CardGroupCatalogProps, CarouselCatalogProps, ChartLoaderCatalogProps, CheckListCatalogProps, CheckboxCatalogProps, CheckboxGroupCatalogProps, ChipCatalogProps, ChipGroupCatalogProps, CircleCatalogProps, ColorPickerCatalogProps, ContentLoaderCatalogProps, CountDownCatalogProps, CountryCatalogProps, CurrencyCatalogProps, DateCatalogProps, DateInlineMultiCatalogProps, DateRangeCatalogProps, DaySelectorCatalogProps, DistributionBarCatalogProps, DividerCatalogProps, DraggableListCatalogProps, DrawerCatalogProps, DropdownCatalogProps, EmailCatalogProps, ExpansionPanelCatalogProps, ExpansionPanelGroupCatalogProps, FieldCatalogProps, FileCatalogProps, FileDropCatalogProps, FloatingButtonCatalogProps, GridCatalogProps, HStackCatalogProps, HeadingCatalogProps, IconCatalogProps, IconButtonCatalogProps, ImageCatalogProps, ImageViewerCatalogProps, InputGroupCatalogProps, ItemNavigatorCatalogProps, LabelCatalogProps, LabelGroupCatalogProps, LayoutCatalogProps, LayoutCardCatalogProps, LinkCatalogProps, ListItemCatalogProps, LoaderCardCatalogProps, LocationCardCatalogProps, MaskerCatalogProps, MenuListCatalogProps, ModalCatalogProps, ModalCloseButtonCatalogProps, ModalFooterCatalogProps, NestedListCatalogProps, NumberCatalogProps, ObjectUICatalogProps, ObjectUIContentCatalogProps, ObjectUIHeaderCatalogProps, ObjectUIStatsCatalogProps, ObjectUITemplateCatalogProps, PageAppLogoCatalogProps, PageContentCatalogProps, PageFooterCatalogProps, PageHeaderCatalogProps, PaginateCatalogProps, PaneCatalogProps, PasswordCatalogProps, PercentageCatalogProps, PhoneCatalogProps, ProgressBarCatalogProps, ProgressStepsCatalogProps, RadioCatalogProps, RangeSliderCatalogProps, ReportLoaderCatalogProps, ReportShareLoaderCatalogProps, ReportViewerLoaderCatalogProps, ResponsiveCatalogProps, SegmentedControlCatalogProps, SelectCatalogProps, SelectableGroupCatalogProps, SelectableMenuCatalogProps, SettingsLoaderCatalogProps, ShowMoreCatalogProps, SignatureCatalogProps, SinCatalogProps, SkeletonCatalogProps, SliderCatalogProps, SnackBarCatalogProps, SpinnerCatalogProps, SplitButtonCatalogProps, SplitPaneCatalogProps, SsnCatalogProps, StatusCatalogProps, StepperCatalogProps, SurveyCatalogProps, SwitchCatalogProps, TabCatalogProps, TableBasicCatalogProps, TextCatalogProps, TextAutoSuggestCatalogProps, TextClipCatalogProps, TextInputCatalogProps, TextSnippetCatalogProps, TextareaCatalogProps, TimeCatalogProps, TimeRangeCatalogProps, TimezoneCatalogProps, TipCatalogProps, TitleCaptionCatalogProps, ToggleableArrowCatalogProps, TreeCatalogProps, TreeSelectCatalogProps, VStackCatalogProps, VideoCatalogProps, WorkEmailCatalogProps
|
|
11
|
+
import type { ActionCardCatalogProps, AiIconCatalogProps, AlertCatalogProps, AnimationCatalogProps, ApiErrorCatalogProps, AppGroupLoaderCatalogProps, AppGroupSelectCatalogProps, AppNavBarCatalogProps, AtomsSeparatorCatalogProps, AvatarCatalogProps, AvatarListCatalogProps, BadgeCatalogProps, BoxCatalogProps, BreadcrumbCatalogProps, ButtonCatalogProps, ButtonGroupCatalogProps, CardCatalogProps, CardGroupCatalogProps, CarouselCatalogProps, ChartLoaderCatalogProps, CheckListCatalogProps, CheckboxCatalogProps, CheckboxGroupCatalogProps, ChipCatalogProps, ChipGroupCatalogProps, CircleCatalogProps, ColorPickerCatalogProps, ContentLoaderCatalogProps, CountDownCatalogProps, CountryCatalogProps, CurrencyCatalogProps, CustomObjectGridCatalogProps, DateCatalogProps, DateInlineMultiCatalogProps, DateRangeCatalogProps, DaySelectorCatalogProps, DistributionBarCatalogProps, DividerCatalogProps, DraggableListCatalogProps, DrawerCatalogProps, DropdownCatalogProps, EmailCatalogProps, ExpansionPanelCatalogProps, ExpansionPanelGroupCatalogProps, FieldCatalogProps, FileCatalogProps, FileDropCatalogProps, FloatingButtonCatalogProps, GridCatalogProps, HStackCatalogProps, HeadingCatalogProps, IconCatalogProps, IconButtonCatalogProps, ImageCatalogProps, ImageViewerCatalogProps, InputGroupCatalogProps, ItemNavigatorCatalogProps, LabelCatalogProps, LabelGroupCatalogProps, LayoutCatalogProps, LayoutCardCatalogProps, LinkCatalogProps, ListItemCatalogProps, LoaderCardCatalogProps, LocationCardCatalogProps, MaskerCatalogProps, MenuListCatalogProps, ModalCatalogProps, ModalCloseButtonCatalogProps, ModalFooterCatalogProps, NestedListCatalogProps, NumberCatalogProps, ObjectListViewCatalogProps, ObjectUICatalogProps, ObjectUIContentCatalogProps, ObjectUIHeaderCatalogProps, ObjectUIStatsCatalogProps, ObjectUITemplateCatalogProps, PageAppLogoCatalogProps, PageContentCatalogProps, PageFooterCatalogProps, PageHeaderCatalogProps, PaginateCatalogProps, PaneCatalogProps, PasswordCatalogProps, PercentageCatalogProps, PhoneCatalogProps, ProgressBarCatalogProps, ProgressStepsCatalogProps, RadioCatalogProps, RangeSliderCatalogProps, ReportLoaderCatalogProps, ReportShareLoaderCatalogProps, ReportViewerLoaderCatalogProps, ResizableBoardCatalogProps, ResponsiveCatalogProps, SegmentedControlCatalogProps, SelectCatalogProps, SelectableGroupCatalogProps, SelectableMenuCatalogProps, SettingsLoaderCatalogProps, ShowMoreCatalogProps, SignatureCatalogProps, SinCatalogProps, SkeletonCatalogProps, SliderCatalogProps, SnackBarCatalogProps, SpinnerCatalogProps, SplitButtonCatalogProps, SplitPaneCatalogProps, SsnCatalogProps, StatusCatalogProps, StepperCatalogProps, SurveyCatalogProps, SwitchCatalogProps, TabCatalogProps, TableBasicCatalogProps, TextCatalogProps, TextAutoSuggestCatalogProps, TextClipCatalogProps, TextInputCatalogProps, TextSnippetCatalogProps, TextareaCatalogProps, TimeCatalogProps, TimeRangeCatalogProps, TimezoneCatalogProps, TipCatalogProps, TitleCaptionCatalogProps, ToggleableArrowCatalogProps, TreeCatalogProps, TreeSelectCatalogProps, VStackCatalogProps, VideoCatalogProps, WorkEmailCatalogProps } from "./propTypes.mjs";
|
|
12
12
|
export interface SpecNode {
|
|
13
13
|
type: string;
|
|
14
14
|
props: Record<string, unknown>;
|
|
@@ -54,9 +54,9 @@ export type AiIconProps = Bindable<AiIconCatalogProps> & ComponentDirectives;
|
|
|
54
54
|
*/
|
|
55
55
|
export declare const AiIcon: (props?: AiIconProps | undefined) => SpecNode;
|
|
56
56
|
export type AlertProps = Bindable<AlertCatalogProps> & {
|
|
57
|
+
onDismiss?: ActionBinding | ActionBinding[];
|
|
57
58
|
onPressPrimary?: ActionBinding | ActionBinding[];
|
|
58
59
|
onPressSecondary?: ActionBinding | ActionBinding[];
|
|
59
|
-
onDismiss?: ActionBinding | ActionBinding[];
|
|
60
60
|
} & ComponentDirectives;
|
|
61
61
|
/**
|
|
62
62
|
* A persistent, high-priority notice that conveys critical information (errors, warnings, success confirmations, or informational messages) and guides users to proceed or resolve issues. Appears with page content and remains visible until dismissed or resolved. Use for system-level or page-level messaging, not for ephemeral feedback (use SnackBar instead) or for interruptions requiring immediate input (use Modal instead).
|
|
@@ -78,19 +78,19 @@ export type AppGroupLoaderProps = Bindable<AppGroupLoaderCatalogProps> & Compone
|
|
|
78
78
|
*/
|
|
79
79
|
export declare const AppGroupLoader: (props?: AppGroupLoaderProps | undefined) => SpecNode;
|
|
80
80
|
export type AppGroupSelectProps = Bindable<AppGroupSelectCatalogProps> & {
|
|
81
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
82
81
|
onBlur?: ActionBinding | ActionBinding[];
|
|
82
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
83
83
|
onFocus?: ActionBinding | ActionBinding[];
|
|
84
|
-
onPaste?: ActionBinding | ActionBinding[];
|
|
85
84
|
onMenuToggle?: ActionBinding | ActionBinding[];
|
|
85
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
86
86
|
} & ComponentDirectives;
|
|
87
87
|
/**
|
|
88
88
|
* A multi-select dropdown for choosing multiple options from grouped categories, with app-group styling. Use when users need to pick several items organized into labeled groups (e.g. apps by category). For single selection or ungrouped options, use Select instead.
|
|
89
89
|
*/
|
|
90
90
|
export declare const AppGroupSelect: (props?: AppGroupSelectProps | undefined) => SpecNode;
|
|
91
91
|
export type AppNavBarProps = Bindable<AppNavBarCatalogProps> & {
|
|
92
|
-
onNavigate?: ActionBinding | ActionBinding[];
|
|
93
92
|
onAction?: ActionBinding | ActionBinding[];
|
|
93
|
+
onNavigate?: ActionBinding | ActionBinding[];
|
|
94
94
|
} & ComponentDirectives & {
|
|
95
95
|
children?: SpecNode | SpecNode[];
|
|
96
96
|
};
|
|
@@ -135,10 +135,10 @@ export type BreadcrumbProps = Bindable<BreadcrumbCatalogProps> & {
|
|
|
135
135
|
*/
|
|
136
136
|
export declare const Breadcrumb: (props: BreadcrumbProps) => SpecNode;
|
|
137
137
|
export type ButtonProps = Bindable<ButtonCatalogProps> & {
|
|
138
|
-
onPress?: ActionBinding | ActionBinding[];
|
|
139
|
-
onPressWhileDisabled?: ActionBinding | ActionBinding[];
|
|
140
138
|
onMouseEnter?: ActionBinding | ActionBinding[];
|
|
141
139
|
onMouseLeave?: ActionBinding | ActionBinding[];
|
|
140
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
141
|
+
onPressWhileDisabled?: ActionBinding | ActionBinding[];
|
|
142
142
|
} & ComponentDirectives;
|
|
143
143
|
/**
|
|
144
144
|
* An interactive element that allows users to trigger actions or events with a single click. Use for actions, not navigation — use links for navigation. Use IconButton when space is limited and the action is not critical.
|
|
@@ -152,11 +152,11 @@ export type ButtonGroupProps = Bindable<ButtonGroupCatalogProps> & ComponentDire
|
|
|
152
152
|
*/
|
|
153
153
|
export declare const ButtonGroup: (props?: ButtonGroupProps | undefined) => SpecNode;
|
|
154
154
|
export type CardProps = Bindable<CardCatalogProps> & {
|
|
155
|
-
|
|
156
|
-
onDelete?: ActionBinding | ActionBinding[];
|
|
155
|
+
onAction?: ActionBinding | ActionBinding[];
|
|
157
156
|
onAdd?: ActionBinding | ActionBinding[];
|
|
158
157
|
onClick?: ActionBinding | ActionBinding[];
|
|
159
|
-
|
|
158
|
+
onDelete?: ActionBinding | ActionBinding[];
|
|
159
|
+
onEdit?: ActionBinding | ActionBinding[];
|
|
160
160
|
} & ComponentDirectives & {
|
|
161
161
|
children?: SpecNode | SpecNode[];
|
|
162
162
|
};
|
|
@@ -178,15 +178,11 @@ export type CarouselProps = Bindable<CarouselCatalogProps> & {
|
|
|
178
178
|
* A step-through image carousel for onboarding flows and guided walkthroughs. Each slide has a heading and image, with built-in navigation controls. Emits a done event when the user advances past the last slide.
|
|
179
179
|
*/
|
|
180
180
|
export declare const Carousel: (props: CarouselProps) => SpecNode;
|
|
181
|
-
export type ChartLoaderProps = Bindable<ChartLoaderCatalogProps> &
|
|
182
|
-
onLoad?: ActionBinding | ActionBinding[];
|
|
183
|
-
} & ComponentDirectives & {
|
|
184
|
-
children?: SpecNode | SpecNode[];
|
|
185
|
-
};
|
|
181
|
+
export type ChartLoaderProps = Bindable<ChartLoaderCatalogProps> & ComponentDirectives;
|
|
186
182
|
/**
|
|
187
|
-
*
|
|
183
|
+
* A skeleton placeholder shown while chart or graph content is loading. Use when the content area will contain a chart and you want to reduce perceived loading time and prevent layout shift.
|
|
188
184
|
*/
|
|
189
|
-
export declare const ChartLoader: (props
|
|
185
|
+
export declare const ChartLoader: (props?: ChartLoaderProps | undefined) => SpecNode;
|
|
190
186
|
export type CheckListProps = Bindable<CheckListCatalogProps> & {
|
|
191
187
|
onChange?: ActionBinding | ActionBinding[];
|
|
192
188
|
} & ComponentDirectives;
|
|
@@ -195,16 +191,16 @@ export type CheckListProps = Bindable<CheckListCatalogProps> & {
|
|
|
195
191
|
*/
|
|
196
192
|
export declare const CheckList: (props: CheckListProps) => SpecNode;
|
|
197
193
|
export type CheckboxProps = Bindable<CheckboxCatalogProps> & {
|
|
198
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
199
194
|
onBlur?: ActionBinding | ActionBinding[];
|
|
195
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
200
196
|
} & ComponentDirectives;
|
|
201
197
|
/**
|
|
202
198
|
* A checkbox that lets users select or unselect an option. Use for toggling a single boolean (e.g. "I agree") or selecting multiple items from a list. Use Radio for mutually exclusive choices; use Toggle when the change takes effect immediately.
|
|
203
199
|
*/
|
|
204
200
|
export declare const Checkbox: (props?: CheckboxProps | undefined) => SpecNode;
|
|
205
201
|
export type CheckboxGroupProps = Bindable<CheckboxGroupCatalogProps> & {
|
|
206
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
207
202
|
onBlur?: ActionBinding | ActionBinding[];
|
|
203
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
208
204
|
} & ComponentDirectives;
|
|
209
205
|
/**
|
|
210
206
|
* A group of checkboxes that lets users select multiple options from a predefined list. Use when users can choose all, some, or none of the options. Use Radio instead for mutually exclusive single selection, or Toggle for immediate on/off activation.
|
|
@@ -233,8 +229,8 @@ export type CircleProps = Bindable<CircleCatalogProps> & ComponentDirectives;
|
|
|
233
229
|
*/
|
|
234
230
|
export declare const Circle: (props?: CircleProps | undefined) => SpecNode;
|
|
235
231
|
export type ColorPickerProps = Bindable<ColorPickerCatalogProps> & {
|
|
236
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
237
232
|
onBlur?: ActionBinding | ActionBinding[];
|
|
233
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
238
234
|
} & ComponentDirectives;
|
|
239
235
|
/**
|
|
240
236
|
* A form input for selecting a color from a predefined palette or entering a custom hex value. Use for brand color selection, theme customization, or any setting where users choose a specific color.
|
|
@@ -256,32 +252,37 @@ export type CountryProps = Bindable<CountryCatalogProps> & ComponentDirectives;
|
|
|
256
252
|
*/
|
|
257
253
|
export declare const Country: (props: CountryProps) => SpecNode;
|
|
258
254
|
export type CurrencyProps = Bindable<CurrencyCatalogProps> & {
|
|
259
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
260
255
|
onBlur?: ActionBinding | ActionBinding[];
|
|
256
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
261
257
|
} & ComponentDirectives;
|
|
262
258
|
/**
|
|
263
259
|
* Specialized input for entering monetary amounts with currency symbol/code prefix and locale-aware number formatting. Supports arithmetic expression evaluation, currency type selection via dropdown, and decimal precision control.
|
|
264
260
|
*/
|
|
265
261
|
export declare const Currency: (props?: CurrencyProps | undefined) => SpecNode;
|
|
262
|
+
export type CustomObjectGridProps = Bindable<CustomObjectGridCatalogProps> & ComponentDirectives;
|
|
263
|
+
/**
|
|
264
|
+
* Auto-fetching grid for Rippling Custom Objects. Provide objectApiName and fieldApiNames to display records with auto-generated columns, pagination, sorting, and field-type formatting. Increment refreshKey to force a data refresh after mutations.
|
|
265
|
+
*/
|
|
266
|
+
export declare const CustomObjectGrid: (props: CustomObjectGridProps) => SpecNode;
|
|
266
267
|
export type DateProps = Bindable<DateCatalogProps> & {
|
|
267
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
268
268
|
onBlur?: ActionBinding | ActionBinding[];
|
|
269
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
269
270
|
} & ComponentDirectives;
|
|
270
271
|
/**
|
|
271
272
|
* A date input that lets users select a single date via calendar or keyboard entry. Use for collecting exact, approximate, or memorable dates (e.g. birth date, start date) and for scheduling. Optionally includes time selection with timezone support. Use DateRange for start/end date pairs; use DateInlineMulti for selecting multiple individual dates without an input field.
|
|
272
273
|
*/
|
|
273
274
|
export declare const Date: (props?: DateProps | undefined) => SpecNode;
|
|
274
275
|
export type DateInlineMultiProps = Bindable<DateInlineMultiCatalogProps> & {
|
|
275
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
276
276
|
onBlur?: ActionBinding | ActionBinding[];
|
|
277
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
277
278
|
} & ComponentDirectives;
|
|
278
279
|
/**
|
|
279
280
|
* An always-visible inline calendar for selecting multiple individual dates without an input field. Use when users need to pick several non-contiguous dates (e.g. holidays, blocked days). Use Date for single-date entry with an input field, or DateRange for start/end date pairs.
|
|
280
281
|
*/
|
|
281
282
|
export declare const DateInlineMulti: (props?: DateInlineMultiProps | undefined) => SpecNode;
|
|
282
283
|
export type DateRangeProps = Bindable<DateRangeCatalogProps> & {
|
|
283
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
284
284
|
onBlur?: ActionBinding | ActionBinding[];
|
|
285
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
285
286
|
} & ComponentDirectives;
|
|
286
287
|
/**
|
|
287
288
|
* A date range picker for selecting a start date and end date pair, such as travel dates, leave periods, or reporting intervals. Use Date instead when only a single date is needed.
|
|
@@ -305,10 +306,10 @@ export type DividerProps = Bindable<DividerCatalogProps> & ComponentDirectives;
|
|
|
305
306
|
*/
|
|
306
307
|
export declare const Divider: (props?: DividerProps | undefined) => SpecNode;
|
|
307
308
|
export type DraggableListProps = Bindable<DraggableListCatalogProps> & {
|
|
308
|
-
onUpdate?: ActionBinding | ActionBinding[];
|
|
309
|
-
onRemove?: ActionBinding | ActionBinding[];
|
|
310
|
-
onDragStart?: ActionBinding | ActionBinding[];
|
|
311
309
|
onDragEnd?: ActionBinding | ActionBinding[];
|
|
310
|
+
onDragStart?: ActionBinding | ActionBinding[];
|
|
311
|
+
onRemove?: ActionBinding | ActionBinding[];
|
|
312
|
+
onUpdate?: ActionBinding | ActionBinding[];
|
|
312
313
|
} & ComponentDirectives;
|
|
313
314
|
/**
|
|
314
315
|
* A reorderable drag-and-drop list for dynamically rearranging items. Supports vertical and horizontal layouts; use when item order flexibility is crucial to the user experience.
|
|
@@ -331,15 +332,15 @@ export type DropdownProps = Bindable<DropdownCatalogProps> & {
|
|
|
331
332
|
*/
|
|
332
333
|
export declare const Dropdown: (props: DropdownProps) => SpecNode;
|
|
333
334
|
export type EmailProps = Bindable<EmailCatalogProps> & {
|
|
334
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
335
335
|
onBlur?: ActionBinding | ActionBinding[];
|
|
336
|
-
|
|
336
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
337
337
|
onClick?: ActionBinding | ActionBinding[];
|
|
338
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
338
339
|
onKeydown?: ActionBinding | ActionBinding[];
|
|
339
340
|
onKeyup?: ActionBinding | ActionBinding[];
|
|
340
|
-
onPaste?: ActionBinding | ActionBinding[];
|
|
341
341
|
onMouseenter?: ActionBinding | ActionBinding[];
|
|
342
342
|
onMouseleave?: ActionBinding | ActionBinding[];
|
|
343
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
343
344
|
} & ComponentDirectives;
|
|
344
345
|
/**
|
|
345
346
|
* A form input field for collecting email addresses with built-in format validation. Use for registration, login, subscriptions, and any context requiring a valid email. Do not use for non-email text like phone numbers or usernames — use Text instead.
|
|
@@ -377,27 +378,27 @@ export type FileProps = Bindable<FileCatalogProps> & {
|
|
|
377
378
|
*/
|
|
378
379
|
export declare const File: (props?: FileProps | undefined) => SpecNode;
|
|
379
380
|
export type FileDropProps = Bindable<FileDropCatalogProps> & {
|
|
380
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
381
381
|
onBlur?: ActionBinding | ActionBinding[];
|
|
382
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
382
383
|
} & ComponentDirectives;
|
|
383
384
|
/**
|
|
384
385
|
* A file upload input that allows users to drag and drop files into a drop zone or click to browse. Supports single or multiple file uploads with configurable file type restrictions, size limits, and optional image cropping.
|
|
385
386
|
*/
|
|
386
387
|
export declare const FileDrop: (props?: FileDropProps | undefined) => SpecNode;
|
|
387
388
|
export type FloatingButtonProps = Bindable<FloatingButtonCatalogProps> & {
|
|
388
|
-
onPress?: ActionBinding | ActionBinding[];
|
|
389
|
-
onPressWhileDisabled?: ActionBinding | ActionBinding[];
|
|
390
389
|
onMouseEnter?: ActionBinding | ActionBinding[];
|
|
391
390
|
onMouseLeave?: ActionBinding | ActionBinding[];
|
|
391
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
392
|
+
onPressWhileDisabled?: ActionBinding | ActionBinding[];
|
|
392
393
|
} & ComponentDirectives;
|
|
393
394
|
/**
|
|
394
395
|
* A floating action button (FAB) that highlights the primary action on a screen, staying visible above other content. Uses an icon only (no text label) and typically appears once per screen for key tasks like creating, favoriting, or sharing.
|
|
395
396
|
*/
|
|
396
397
|
export declare const FloatingButton: (props: FloatingButtonProps) => SpecNode;
|
|
397
398
|
export type GridProps = Bindable<GridCatalogProps> & {
|
|
398
|
-
onRowClick?: ActionBinding | ActionBinding[];
|
|
399
|
-
onRowAction?: ActionBinding | ActionBinding[];
|
|
400
399
|
onHeaderAction?: ActionBinding | ActionBinding[];
|
|
400
|
+
onRowAction?: ActionBinding | ActionBinding[];
|
|
401
|
+
onRowClick?: ActionBinding | ActionBinding[];
|
|
401
402
|
} & ComponentDirectives;
|
|
402
403
|
/**
|
|
403
404
|
* Data grid for displaying tabular data. Each column defines a header, data key path, and cell type. Use $bindState on selectedRow to capture clicked row data. Data is an array of row objects with _key as unique identifier.
|
|
@@ -423,19 +424,19 @@ export type IconProps = Bindable<IconCatalogProps> & {
|
|
|
423
424
|
*/
|
|
424
425
|
export declare const Icon: (props: IconProps) => SpecNode;
|
|
425
426
|
export type IconButtonProps = Bindable<IconButtonCatalogProps> & {
|
|
426
|
-
onPress?: ActionBinding | ActionBinding[];
|
|
427
|
-
onPressWhileDisabled?: ActionBinding | ActionBinding[];
|
|
428
427
|
onMouseEnter?: ActionBinding | ActionBinding[];
|
|
429
428
|
onMouseLeave?: ActionBinding | ActionBinding[];
|
|
429
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
430
|
+
onPressWhileDisabled?: ActionBinding | ActionBinding[];
|
|
430
431
|
} & ComponentDirectives;
|
|
431
432
|
/**
|
|
432
433
|
* An icon-only button for repeated, common, or persistent actions when screen real estate is limited. Use for well-known actions like search, refresh, edit, or navigation — use a regular Button with text when the action is critical or requires more context.
|
|
433
434
|
*/
|
|
434
435
|
export declare const IconButton: (props: IconButtonProps) => SpecNode;
|
|
435
436
|
export type ImageProps = Bindable<ImageCatalogProps> & {
|
|
436
|
-
onPress?: ActionBinding | ActionBinding[];
|
|
437
|
-
onLoad?: ActionBinding | ActionBinding[];
|
|
438
437
|
onError?: ActionBinding | ActionBinding[];
|
|
438
|
+
onLoad?: ActionBinding | ActionBinding[];
|
|
439
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
439
440
|
} & ComponentDirectives;
|
|
440
441
|
/**
|
|
441
442
|
* Displays an image with optional theme-aware light/dark sources, lazy loading, and click interaction. Use for static or decorative images — use Avatar for user profile pictures, Icon for symbolic glyphs, or ImageViewer for zoomable image galleries.
|
|
@@ -507,18 +508,18 @@ export type LoaderCardProps = Bindable<LoaderCardCatalogProps> & ComponentDirect
|
|
|
507
508
|
*/
|
|
508
509
|
export declare const LoaderCard: (props?: LoaderCardProps | undefined) => SpecNode;
|
|
509
510
|
export type LocationCardProps = Bindable<LocationCardCatalogProps> & {
|
|
510
|
-
onEdit?: ActionBinding | ActionBinding[];
|
|
511
|
-
onDelete?: ActionBinding | ActionBinding[];
|
|
512
|
-
onClick?: ActionBinding | ActionBinding[];
|
|
513
511
|
onAction?: ActionBinding | ActionBinding[];
|
|
512
|
+
onClick?: ActionBinding | ActionBinding[];
|
|
513
|
+
onDelete?: ActionBinding | ActionBinding[];
|
|
514
|
+
onEdit?: ActionBinding | ActionBinding[];
|
|
514
515
|
} & ComponentDirectives;
|
|
515
516
|
/**
|
|
516
517
|
* A specialized card for displaying a physical location with its nickname and formatted address. Supports edit/delete actions, custom dropdown actions, and navigation links to location details.
|
|
517
518
|
*/
|
|
518
519
|
export declare const LocationCard: (props: LocationCardProps) => SpecNode;
|
|
519
520
|
export type MaskerProps = Bindable<MaskerCatalogProps> & {
|
|
520
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
521
521
|
onBlur?: ActionBinding | ActionBinding[];
|
|
522
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
522
523
|
} & ComponentDirectives;
|
|
523
524
|
/**
|
|
524
525
|
* A text input that enforces a specific format pattern using mask characters (e.g. phone numbers, SSNs, postal codes). Use when the input value must conform to a known fixed-length pattern with digit, letter, or mixed character slots.
|
|
@@ -553,23 +554,28 @@ export type ModalFooterProps = Bindable<ModalFooterCatalogProps> & ComponentDire
|
|
|
553
554
|
*/
|
|
554
555
|
export declare const ModalFooter: (props?: ModalFooterProps | undefined) => SpecNode;
|
|
555
556
|
export type NestedListProps = Bindable<NestedListCatalogProps> & {
|
|
556
|
-
onToggle?: ActionBinding | ActionBinding[];
|
|
557
557
|
onSelect?: ActionBinding | ActionBinding[];
|
|
558
|
+
onToggle?: ActionBinding | ActionBinding[];
|
|
558
559
|
} & ComponentDirectives;
|
|
559
560
|
/**
|
|
560
561
|
* A hierarchical nested list for displaying complex data structures like categories and subcategories, supporting up to four levels of expandable/collapsible nesting. Use for organizing large amounts of nested information such as organizational structures or department lists.
|
|
561
562
|
*/
|
|
562
563
|
export declare const NestedList: (props: NestedListProps) => SpecNode;
|
|
563
564
|
export type NumberProps = Bindable<NumberCatalogProps> & {
|
|
564
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
565
565
|
onBlur?: ActionBinding | ActionBinding[];
|
|
566
|
-
|
|
566
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
567
567
|
onChangeCalculationState?: ActionBinding | ActionBinding[];
|
|
568
|
+
onChangeRaw?: ActionBinding | ActionBinding[];
|
|
568
569
|
} & ComponentDirectives;
|
|
569
570
|
/**
|
|
570
571
|
* A general-purpose numeric input for entering whole or decimal numbers. Supports min/max range constraints, step increments, locale-aware formatting, and inline arithmetic evaluation. Use for quantities, counts, measurements, or any plain number entry — use Currency for monetary amounts, Percentage for percent values, or Slider/RangeSlider for visual range selection.
|
|
571
572
|
*/
|
|
572
573
|
export declare const Number: (props?: NumberProps | undefined) => SpecNode;
|
|
574
|
+
export type ObjectListViewProps = Bindable<ObjectListViewCatalogProps> & ComponentDirectives;
|
|
575
|
+
/**
|
|
576
|
+
* Full-featured object list page with list view management. Supports multiple list views, view switching, inline editing, bulk actions, and record management. Use objectApiName to specify the object. Optionally set defaultListViewId to pre-select a specific list view.
|
|
577
|
+
*/
|
|
578
|
+
export declare const ObjectListView: (props: ObjectListViewProps) => SpecNode;
|
|
573
579
|
export type ObjectUIProps = Bindable<ObjectUICatalogProps> & ComponentDirectives & {
|
|
574
580
|
children?: SpecNode | SpecNode[];
|
|
575
581
|
};
|
|
@@ -648,15 +654,15 @@ export type PaneProps = Bindable<PaneCatalogProps> & {
|
|
|
648
654
|
*/
|
|
649
655
|
export declare const Pane: (props: PaneProps) => SpecNode;
|
|
650
656
|
export type PasswordProps = Bindable<PasswordCatalogProps> & {
|
|
651
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
652
657
|
onBlur?: ActionBinding | ActionBinding[];
|
|
653
|
-
|
|
658
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
654
659
|
onClick?: ActionBinding | ActionBinding[];
|
|
660
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
655
661
|
onKeydown?: ActionBinding | ActionBinding[];
|
|
656
662
|
onKeyup?: ActionBinding | ActionBinding[];
|
|
657
|
-
onPaste?: ActionBinding | ActionBinding[];
|
|
658
663
|
onMouseenter?: ActionBinding | ActionBinding[];
|
|
659
664
|
onMouseleave?: ActionBinding | ActionBinding[];
|
|
665
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
660
666
|
onReveal?: ActionBinding | ActionBinding[];
|
|
661
667
|
} & ComponentDirectives;
|
|
662
668
|
/**
|
|
@@ -664,24 +670,24 @@ export type PasswordProps = Bindable<PasswordCatalogProps> & {
|
|
|
664
670
|
*/
|
|
665
671
|
export declare const Password: (props?: PasswordProps | undefined) => SpecNode;
|
|
666
672
|
export type PercentageProps = Bindable<PercentageCatalogProps> & {
|
|
667
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
668
673
|
onBlur?: ActionBinding | ActionBinding[];
|
|
674
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
669
675
|
} & ComponentDirectives;
|
|
670
676
|
/**
|
|
671
677
|
* A numeric input for entering and editing percentage values. Automatically appends a % suffix, supports decimal precision, negative values, and upper/lower bounds. Use for financial calculations, progress indicators, or statistical entries requiring percentage values.
|
|
672
678
|
*/
|
|
673
679
|
export declare const Percentage: (props?: PercentageProps | undefined) => SpecNode;
|
|
674
680
|
export type PhoneProps = Bindable<PhoneCatalogProps> & {
|
|
675
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
676
681
|
onBlur?: ActionBinding | ActionBinding[];
|
|
677
|
-
|
|
682
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
678
683
|
onClick?: ActionBinding | ActionBinding[];
|
|
684
|
+
onCountryCodeChange?: ActionBinding | ActionBinding[];
|
|
685
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
679
686
|
onKeydown?: ActionBinding | ActionBinding[];
|
|
680
687
|
onKeyup?: ActionBinding | ActionBinding[];
|
|
681
|
-
onPaste?: ActionBinding | ActionBinding[];
|
|
682
688
|
onMouseenter?: ActionBinding | ActionBinding[];
|
|
683
689
|
onMouseleave?: ActionBinding | ActionBinding[];
|
|
684
|
-
|
|
690
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
685
691
|
} & ComponentDirectives;
|
|
686
692
|
/**
|
|
687
693
|
* A specialized input for entering and editing phone numbers with automatic region-based formatting, international support, and an optional country code dropdown selector.
|
|
@@ -698,8 +704,8 @@ export type ProgressStepsProps = Bindable<ProgressStepsCatalogProps> & Component
|
|
|
698
704
|
*/
|
|
699
705
|
export declare const ProgressSteps: (props: ProgressStepsProps) => SpecNode;
|
|
700
706
|
export type RadioProps = Bindable<RadioCatalogProps> & {
|
|
701
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
702
707
|
onBlur?: ActionBinding | ActionBinding[];
|
|
708
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
703
709
|
onMouseenter?: ActionBinding | ActionBinding[];
|
|
704
710
|
onMouseleave?: ActionBinding | ActionBinding[];
|
|
705
711
|
} & ComponentDirectives;
|
|
@@ -708,10 +714,10 @@ export type RadioProps = Bindable<RadioCatalogProps> & {
|
|
|
708
714
|
*/
|
|
709
715
|
export declare const Radio: (props?: RadioProps | undefined) => SpecNode;
|
|
710
716
|
export type RangeSliderProps = Bindable<RangeSliderCatalogProps> & {
|
|
711
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
712
|
-
onBeforeChange?: ActionBinding | ActionBinding[];
|
|
713
717
|
onAfterChange?: ActionBinding | ActionBinding[];
|
|
718
|
+
onBeforeChange?: ActionBinding | ActionBinding[];
|
|
714
719
|
onBlur?: ActionBinding | ActionBinding[];
|
|
720
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
715
721
|
} & ComponentDirectives;
|
|
716
722
|
/**
|
|
717
723
|
* A two-handle slider for selecting a numeric range within a track. Use for defining min/max boundaries such as price filters or value ranges.
|
|
@@ -732,6 +738,20 @@ export type ReportViewerLoaderProps = Bindable<ReportViewerLoaderCatalogProps> &
|
|
|
732
738
|
* A skeleton placeholder shown while report viewer content is loading. Use when the content area will contain a report viewer with sidebar navigation and a main report content area, and you want to reduce perceived loading time and prevent layout shift.
|
|
733
739
|
*/
|
|
734
740
|
export declare const ReportViewerLoader: (props?: ReportViewerLoaderProps | undefined) => SpecNode;
|
|
741
|
+
export type ResizableBoardProps = Bindable<ResizableBoardCatalogProps> & {
|
|
742
|
+
onBreakpointChange?: ActionBinding | ActionBinding[];
|
|
743
|
+
onDragStart?: ActionBinding | ActionBinding[];
|
|
744
|
+
onDragStop?: ActionBinding | ActionBinding[];
|
|
745
|
+
onLayoutChange?: ActionBinding | ActionBinding[];
|
|
746
|
+
onResizeStart?: ActionBinding | ActionBinding[];
|
|
747
|
+
onResizeStop?: ActionBinding | ActionBinding[];
|
|
748
|
+
} & ComponentDirectives & {
|
|
749
|
+
children?: SpecNode | SpecNode[];
|
|
750
|
+
};
|
|
751
|
+
/**
|
|
752
|
+
* A responsive 12-column grid for dashboard widgets that supports drag-to-rearrange and resize-from-any-corner. Use for user-curated dashboards where end-users decide which tiles appear where and how large they are. Each direct child element's spec id must match a `layouts[].identifier`; that layout entry controls the child's size and per-block styling.
|
|
753
|
+
*/
|
|
754
|
+
export declare const ResizableBoard: (props: ResizableBoardProps) => SpecNode;
|
|
735
755
|
export type ResponsiveProps = Bindable<ResponsiveCatalogProps> & ComponentDirectives & {
|
|
736
756
|
children?: SpecNode | SpecNode[];
|
|
737
757
|
};
|
|
@@ -740,19 +760,19 @@ export type ResponsiveProps = Bindable<ResponsiveCatalogProps> & ComponentDirect
|
|
|
740
760
|
*/
|
|
741
761
|
export declare const Responsive: (props?: ResponsiveProps | undefined) => SpecNode;
|
|
742
762
|
export type SegmentedControlProps = Bindable<SegmentedControlCatalogProps> & {
|
|
743
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
744
763
|
onBlur?: ActionBinding | ActionBinding[];
|
|
764
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
745
765
|
} & ComponentDirectives;
|
|
746
766
|
/**
|
|
747
767
|
* A linear set of buttons for toggling between closely related choices (2-5 short-label options) and instantly applying a selection. Supports single, multi, and range selection modes. NOT suitable for binary (2-option) choices — use Toggle or ToggleButton instead. Prefer over Radio when options are short labels needing a compact inline layout; use Radio for longer phrases, Tabs for content navigation.
|
|
748
768
|
*/
|
|
749
769
|
export declare const SegmentedControl: (props: SegmentedControlProps) => SpecNode;
|
|
750
770
|
export type SelectProps = Bindable<SelectCatalogProps> & {
|
|
751
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
752
771
|
onBlur?: ActionBinding | ActionBinding[];
|
|
772
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
753
773
|
onFocus?: ActionBinding | ActionBinding[];
|
|
754
|
-
onPaste?: ActionBinding | ActionBinding[];
|
|
755
774
|
onMenuToggle?: ActionBinding | ActionBinding[];
|
|
775
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
756
776
|
} & ComponentDirectives;
|
|
757
777
|
/**
|
|
758
778
|
* A dropdown input that lets users choose one or more options from a predefined list. Use for long lists, searchable lists, or constrained spaces. Use Radio or Checkbox cards instead when there are few options and the selection is a key part of the flow.
|
|
@@ -792,8 +812,8 @@ export type SignatureProps = Bindable<SignatureCatalogProps> & {
|
|
|
792
812
|
*/
|
|
793
813
|
export declare const Signature: (props?: SignatureProps | undefined) => SpecNode;
|
|
794
814
|
export type SinProps = Bindable<SinCatalogProps> & {
|
|
795
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
796
815
|
onBlur?: ActionBinding | ActionBinding[];
|
|
816
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
797
817
|
} & ComponentDirectives;
|
|
798
818
|
/**
|
|
799
819
|
* A specialized masked input for entering Canadian Social Insurance Numbers (SIN). Automatically formats the 9-digit value as "XXX XXX XXX" while storing the unmasked digits. Use for Canadian employee or tax forms requiring a SIN — use Ssn for US Social Security Numbers, or Masker for other custom-format masked inputs.
|
|
@@ -805,10 +825,10 @@ export type SkeletonProps = Bindable<SkeletonCatalogProps> & ComponentDirectives
|
|
|
805
825
|
*/
|
|
806
826
|
export declare const Skeleton: (props?: SkeletonProps | undefined) => SpecNode;
|
|
807
827
|
export type SliderProps = Bindable<SliderCatalogProps> & {
|
|
808
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
809
|
-
onBlur?: ActionBinding | ActionBinding[];
|
|
810
|
-
onBeforeChange?: ActionBinding | ActionBinding[];
|
|
811
828
|
onAfterChange?: ActionBinding | ActionBinding[];
|
|
829
|
+
onBeforeChange?: ActionBinding | ActionBinding[];
|
|
830
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
831
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
812
832
|
} & ComponentDirectives;
|
|
813
833
|
/**
|
|
814
834
|
* An interactive control for selecting a single numeric value within a defined range by dragging a handle along a horizontal track. Use for numeric ranges like 0–100; do not use for extremely large ranges (e.g. 1–1000) or non-numeric values.
|
|
@@ -827,8 +847,8 @@ export type SpinnerProps = Bindable<SpinnerCatalogProps> & ComponentDirectives;
|
|
|
827
847
|
*/
|
|
828
848
|
export declare const Spinner: (props?: SpinnerProps | undefined) => SpecNode;
|
|
829
849
|
export type SplitButtonProps = Bindable<SplitButtonCatalogProps> & {
|
|
830
|
-
onPress?: ActionBinding | ActionBinding[];
|
|
831
850
|
onDropdownChange?: ActionBinding | ActionBinding[];
|
|
851
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
832
852
|
} & ComponentDirectives;
|
|
833
853
|
/**
|
|
834
854
|
* A compound button that combines a primary action with a secondary trailing button, typically opening a dropdown of alternative actions. Use when the user has a main action with related alternatives (e.g. "Save" with "Save as draft", "Save and publish").
|
|
@@ -842,8 +862,8 @@ export type SplitPaneProps = Bindable<SplitPaneCatalogProps> & ComponentDirectiv
|
|
|
842
862
|
*/
|
|
843
863
|
export declare const SplitPane: (props?: SplitPaneProps | undefined) => SpecNode;
|
|
844
864
|
export type SsnProps = Bindable<SsnCatalogProps> & {
|
|
845
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
846
865
|
onBlur?: ActionBinding | ActionBinding[];
|
|
866
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
847
867
|
} & ComponentDirectives;
|
|
848
868
|
/**
|
|
849
869
|
* A specialized masked input for collecting US Social Security Numbers (SSN). Automatically formats display as XXX-XX-XXXX while storing the raw 9-digit value. Use for any form field that requires an SSN; use Text for general text or Password for secret credentials.
|
|
@@ -869,8 +889,8 @@ export type SurveyProps = Bindable<SurveyCatalogProps> & {
|
|
|
869
889
|
*/
|
|
870
890
|
export declare const Survey: (props: SurveyProps) => SpecNode;
|
|
871
891
|
export type SwitchProps = Bindable<SwitchCatalogProps> & {
|
|
872
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
873
892
|
onBlur?: ActionBinding | ActionBinding[];
|
|
893
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
874
894
|
} & ComponentDirectives;
|
|
875
895
|
/**
|
|
876
896
|
* A toggle that lets users switch instantly between on and off states. Use for activation settings that take effect immediately; use Checkbox instead for selection or agreement scenarios that require submission.
|
|
@@ -894,10 +914,10 @@ export type TextProps = Bindable<TextCatalogProps> & ComponentDirectives;
|
|
|
894
914
|
*/
|
|
895
915
|
export declare const Text: (props?: TextProps | undefined) => SpecNode;
|
|
896
916
|
export type TextAutoSuggestProps = Bindable<TextAutoSuggestCatalogProps> & {
|
|
897
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
898
917
|
onBlur?: ActionBinding | ActionBinding[];
|
|
899
|
-
|
|
918
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
900
919
|
onClick?: ActionBinding | ActionBinding[];
|
|
920
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
901
921
|
} & ComponentDirectives;
|
|
902
922
|
/**
|
|
903
923
|
* An autocomplete input that offers text suggestions in a dropdown menu as the user types. Unlike Select, users can either manually type free-form text or pick from the suggestions list.
|
|
@@ -911,15 +931,15 @@ export type TextClipProps = Bindable<TextClipCatalogProps> & ComponentDirectives
|
|
|
911
931
|
*/
|
|
912
932
|
export declare const TextClip: (props: TextClipProps) => SpecNode;
|
|
913
933
|
export type TextInputProps = Bindable<TextInputCatalogProps> & {
|
|
914
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
915
934
|
onBlur?: ActionBinding | ActionBinding[];
|
|
916
|
-
|
|
935
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
917
936
|
onClick?: ActionBinding | ActionBinding[];
|
|
937
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
918
938
|
onKeydown?: ActionBinding | ActionBinding[];
|
|
919
939
|
onKeyup?: ActionBinding | ActionBinding[];
|
|
920
|
-
onPaste?: ActionBinding | ActionBinding[];
|
|
921
940
|
onMouseenter?: ActionBinding | ActionBinding[];
|
|
922
941
|
onMouseleave?: ActionBinding | ActionBinding[];
|
|
942
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
923
943
|
} & ComponentDirectives;
|
|
924
944
|
/**
|
|
925
945
|
* A single-line text input for collecting short-form text data such as names, emails, URLs, or search queries. Use TextArea for multi-line content or Number for numeric-only values.
|
|
@@ -931,8 +951,8 @@ export type TextSnippetProps = Bindable<TextSnippetCatalogProps> & ComponentDire
|
|
|
931
951
|
*/
|
|
932
952
|
export declare const TextSnippet: (props: TextSnippetProps) => SpecNode;
|
|
933
953
|
export type TextareaProps = Bindable<TextareaCatalogProps> & {
|
|
934
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
935
954
|
onBlur?: ActionBinding | ActionBinding[];
|
|
955
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
936
956
|
onFocus?: ActionBinding | ActionBinding[];
|
|
937
957
|
} & ComponentDirectives;
|
|
938
958
|
/**
|
|
@@ -940,24 +960,24 @@ export type TextareaProps = Bindable<TextareaCatalogProps> & {
|
|
|
940
960
|
*/
|
|
941
961
|
export declare const Textarea: (props?: TextareaProps | undefined) => SpecNode;
|
|
942
962
|
export type TimeProps = Bindable<TimeCatalogProps> & {
|
|
943
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
944
963
|
onBlur?: ActionBinding | ActionBinding[];
|
|
964
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
945
965
|
} & ComponentDirectives;
|
|
946
966
|
/**
|
|
947
967
|
* A form input for entering or selecting a specific time of day. Supports typed entry, optional dropdown time selection, timezone display, and locale-aware formatting.
|
|
948
968
|
*/
|
|
949
969
|
export declare const Time: (props?: TimeProps | undefined) => SpecNode;
|
|
950
970
|
export type TimeRangeProps = Bindable<TimeRangeCatalogProps> & {
|
|
951
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
952
971
|
onBlur?: ActionBinding | ActionBinding[];
|
|
972
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
953
973
|
} & ComponentDirectives;
|
|
954
974
|
/**
|
|
955
975
|
* A time range input for selecting a start and end time pair, such as work schedules, shifts, or availability windows. Stores a [startTime, endTime] tuple of ISO 8601 strings. Supports timezone display and next-day span detection.
|
|
956
976
|
*/
|
|
957
977
|
export declare const TimeRange: (props?: TimeRangeProps | undefined) => SpecNode;
|
|
958
978
|
export type TimezoneProps = Bindable<TimezoneCatalogProps> & {
|
|
959
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
960
979
|
onBlur?: ActionBinding | ActionBinding[];
|
|
980
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
961
981
|
onFocus?: ActionBinding | ActionBinding[];
|
|
962
982
|
} & ComponentDirectives;
|
|
963
983
|
/**
|
|
@@ -1009,150 +1029,19 @@ export type VideoProps = Bindable<VideoCatalogProps> & ComponentDirectives;
|
|
|
1009
1029
|
*/
|
|
1010
1030
|
export declare const Video: (props: VideoProps) => SpecNode;
|
|
1011
1031
|
export type WorkEmailProps = Bindable<WorkEmailCatalogProps> & {
|
|
1012
|
-
onChange?: ActionBinding | ActionBinding[];
|
|
1013
1032
|
onBlur?: ActionBinding | ActionBinding[];
|
|
1014
|
-
|
|
1033
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
1015
1034
|
onClick?: ActionBinding | ActionBinding[];
|
|
1035
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
1016
1036
|
onKeydown?: ActionBinding | ActionBinding[];
|
|
1017
1037
|
onKeyup?: ActionBinding | ActionBinding[];
|
|
1018
|
-
onPaste?: ActionBinding | ActionBinding[];
|
|
1019
1038
|
onMouseenter?: ActionBinding | ActionBinding[];
|
|
1020
1039
|
onMouseleave?: ActionBinding | ActionBinding[];
|
|
1040
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
1021
1041
|
} & ComponentDirectives;
|
|
1022
1042
|
/**
|
|
1023
1043
|
* A specialized email input for entering work email addresses, featuring a domain suffix dropdown selector so users type only the username while choosing from a predefined list of company domains
|
|
1024
1044
|
*/
|
|
1025
1045
|
export declare const WorkEmail: (props?: WorkEmailProps | undefined) => SpecNode;
|
|
1026
|
-
export type AnalyticsCardProps = Bindable<AnalyticsCardCatalogProps> & {
|
|
1027
|
-
onConfigure?: ActionBinding | ActionBinding[];
|
|
1028
|
-
} & ComponentDirectives & {
|
|
1029
|
-
children?: SpecNode | SpecNode[];
|
|
1030
|
-
};
|
|
1031
|
-
/**
|
|
1032
|
-
* Dashboard tile chrome with a fixed header (start: heading + sub-heading; end: optional configure button) and a children body. The header renders immediately when the spec lands so the chrome is visible while the body subtree resolves its run_query data through a WithSpinner. Use this instead of the legacy Card for every dashboard tile (KPI, visual chart, grid).
|
|
1033
|
-
*/
|
|
1034
|
-
export declare const AnalyticsCard: (props: AnalyticsCardProps) => SpecNode;
|
|
1035
|
-
export type ResizableBoardProps = Bindable<ResizableBoardCatalogProps> & ComponentDirectives & {
|
|
1036
|
-
children?: SpecNode | SpecNode[];
|
|
1037
|
-
};
|
|
1038
|
-
/**
|
|
1039
|
-
* Resizable dashboard board for AI widget layouts. Wraps each child in a Pebble ResizableBoard block.
|
|
1040
|
-
*/
|
|
1041
|
-
export declare const ResizableBoard: (props: ResizableBoardProps) => SpecNode;
|
|
1042
|
-
export type EChartProps = Bindable<EChartCatalogProps> & {
|
|
1043
|
-
onClick?: ActionBinding | ActionBinding[];
|
|
1044
|
-
onLegendChange?: ActionBinding | ActionBinding[];
|
|
1045
|
-
onDataZoomChange?: ActionBinding | ActionBinding[];
|
|
1046
|
-
} & ComponentDirectives;
|
|
1047
|
-
/**
|
|
1048
|
-
* Raw ECharts renderer for SDUI. Provide a JSON-safe ECharts option object. It fills its parent card by default and keeps a usable minimum height when no fixed parent height exists; optional height/width can override sizing.
|
|
1049
|
-
*/
|
|
1050
|
-
export declare const EChart: (props: EChartProps) => SpecNode;
|
|
1051
|
-
export type RichTextProps = Bindable<RichTextCatalogProps> & ComponentDirectives;
|
|
1052
|
-
/**
|
|
1053
|
-
* Read-only HTML content rendered with the shared RichTextEditor (non-editable). Generic SDUI building block for narrative or explanatory copy in any product layout.
|
|
1054
|
-
*/
|
|
1055
|
-
export declare const RichText: (props: RichTextProps) => SpecNode;
|
|
1056
|
-
export type DashboardRichTextProps = Bindable<DashboardRichTextCatalogProps> & ComponentDirectives;
|
|
1057
|
-
/**
|
|
1058
|
-
* Deprecated alias for RichText. Same props; prefer type `RichText` in new specs.
|
|
1059
|
-
*/
|
|
1060
|
-
export declare const DashboardRichText: (props: DashboardRichTextProps) => SpecNode;
|
|
1061
|
-
export type CustomObjectGridProps = Bindable<CustomObjectGridCatalogProps> & ComponentDirectives;
|
|
1062
|
-
/**
|
|
1063
|
-
* Auto-fetching grid for Rippling Custom Objects. Provide objectApiName and fieldApiNames to display records with auto-generated columns, pagination, sorting, and field-type formatting. Increment refreshKey to force a data refresh after mutations.
|
|
1064
|
-
*/
|
|
1065
|
-
export declare const CustomObjectGrid: (props: CustomObjectGridProps) => SpecNode;
|
|
1066
|
-
export type ObjectListViewProps = Bindable<ObjectListViewCatalogProps> & ComponentDirectives;
|
|
1067
|
-
/**
|
|
1068
|
-
* Full-featured object list page with list view management. Supports multiple list views, view switching, inline editing, bulk actions, and record management. Use objectApiName to specify the object. Optionally set defaultListViewId to pre-select a specific list view.
|
|
1069
|
-
*/
|
|
1070
|
-
export declare const ObjectListView: (props: ObjectListViewProps) => SpecNode;
|
|
1071
|
-
export type BarChartProps = Bindable<BarChartCatalogProps> & {
|
|
1072
|
-
onBarClick?: ActionBinding | ActionBinding[];
|
|
1073
|
-
} & ComponentDirectives;
|
|
1074
|
-
/**
|
|
1075
|
-
* Vertical bar chart powered by ECharts. Provide series (name + data array) and optional categories for the x-axis. Use showStackedPercent for 100%-stacked bars, showBarLabel to render values on bars, and showLegend to display a series legend. Use $bindState on selected to capture the clicked bar.
|
|
1076
|
-
*/
|
|
1077
|
-
export declare const BarChart: (props: BarChartProps) => SpecNode;
|
|
1078
|
-
export type LineChartProps = Bindable<LineChartCatalogProps> & ComponentDirectives;
|
|
1079
|
-
/**
|
|
1080
|
-
* Line chart powered by ECharts. Provide series (name + data array) and optional categories for the x-axis. Use connectNulls to bridge null gaps, showAreaPercent for 100%-stacked area, and showLegend to display a series legend.
|
|
1081
|
-
*/
|
|
1082
|
-
export declare const LineChart: (props: LineChartProps) => SpecNode;
|
|
1083
|
-
export type HorizontalBarChartProps = Bindable<HorizontalBarChartCatalogProps> & ComponentDirectives;
|
|
1084
|
-
/**
|
|
1085
|
-
* Horizontal bar chart powered by ECharts. Same data shape as BarChart but renders bars horizontally. Categories appear on the y-axis and values on the x-axis.
|
|
1086
|
-
*/
|
|
1087
|
-
export declare const HorizontalBarChart: (props: HorizontalBarChartProps) => SpecNode;
|
|
1088
|
-
export type CombinationChartProps = Bindable<CombinationChartCatalogProps> & ComponentDirectives;
|
|
1089
|
-
/**
|
|
1090
|
-
* Combination chart with bars and lines on dual Y-axes. Bars use the left Y-axis by default; lines can use the right Y-axis via yAxisIndex: 1.
|
|
1091
|
-
*/
|
|
1092
|
-
export declare const CombinationChart: (props: CombinationChartProps) => SpecNode;
|
|
1093
|
-
export type PieChartProps = Bindable<PieChartCatalogProps> & ComponentDirectives;
|
|
1094
|
-
/**
|
|
1095
|
-
* Pie / donut chart. Each series entry has a data array of {name, value} pairs. Use radius: ["50%", "70%"] for a donut hole.
|
|
1096
|
-
*/
|
|
1097
|
-
export declare const PieChart: (props: PieChartProps) => SpecNode;
|
|
1098
|
-
export type ScatterChartProps = Bindable<ScatterChartCatalogProps> & ComponentDirectives;
|
|
1099
|
-
/**
|
|
1100
|
-
* Scatter plot. Each series contains [x, y] data pairs plotted as individual points.
|
|
1101
|
-
*/
|
|
1102
|
-
export declare const ScatterChart: (props: ScatterChartProps) => SpecNode;
|
|
1103
|
-
export type FunnelChartProps = Bindable<FunnelChartCatalogProps> & ComponentDirectives;
|
|
1104
|
-
/**
|
|
1105
|
-
* Funnel chart for conversion or stage-based data. Data items are ordered by value (largest at top).
|
|
1106
|
-
*/
|
|
1107
|
-
export declare const FunnelChart: (props: FunnelChartProps) => SpecNode;
|
|
1108
|
-
export type GaugeChartProps = Bindable<GaugeChartCatalogProps> & ComponentDirectives;
|
|
1109
|
-
/**
|
|
1110
|
-
* Gauge (speedometer) chart. Displays a single numeric value against colored segments. Segments define the scale breakpoints and their colors.
|
|
1111
|
-
*/
|
|
1112
|
-
export declare const GaugeChart: (props: GaugeChartProps) => SpecNode;
|
|
1113
|
-
export type SunburstChartProps = Bindable<SunburstChartCatalogProps> & ComponentDirectives;
|
|
1114
|
-
/**
|
|
1115
|
-
* Sunburst (multi-level pie) chart for hierarchical data. Each node has a name, optional value, and optional children array.
|
|
1116
|
-
*/
|
|
1117
|
-
export declare const SunburstChart: (props: SunburstChartProps) => SpecNode;
|
|
1118
|
-
export type WithSpinnerProps = Bindable<WithSpinnerCatalogProps> & {
|
|
1119
|
-
onLoad?: ActionBinding | ActionBinding[];
|
|
1120
|
-
} & ComponentDirectives & {
|
|
1121
|
-
children?: SpecNode | SpecNode[];
|
|
1122
|
-
};
|
|
1123
|
-
/**
|
|
1124
|
-
* Wrapper that shows a spinner while loading. Emits `load` once on mount so a handler can start fetching data. Renders children only when `isLoading` is false.
|
|
1125
|
-
*/
|
|
1126
|
-
export declare const WithSpinner: (props: WithSpinnerProps) => SpecNode;
|
|
1127
|
-
export type RadarChartProps = Bindable<RadarChartCatalogProps> & ComponentDirectives;
|
|
1128
|
-
/**
|
|
1129
|
-
* Radar (spider) chart for comparing multiple variables across categories. Each indicator defines a spoke axis. Provide radarIndicators (axis definitions) and radarOptions (series data).
|
|
1130
|
-
*/
|
|
1131
|
-
export declare const RadarChart: (props: RadarChartProps) => SpecNode;
|
|
1132
|
-
export type RadarFilledChartProps = Bindable<RadarFilledChartCatalogProps> & ComponentDirectives;
|
|
1133
|
-
/**
|
|
1134
|
-
* Radar chart with filled area between data points and the center. Same data shape as RadarChart but renders with semi-transparent area fill for each series.
|
|
1135
|
-
*/
|
|
1136
|
-
export declare const RadarFilledChart: (props: RadarFilledChartProps) => SpecNode;
|
|
1137
|
-
export type HeatmapCalendarChartProps = Bindable<HeatmapCalendarChartCatalogProps> & ComponentDirectives;
|
|
1138
|
-
/**
|
|
1139
|
-
* Calendar heatmap chart that renders data points on a calendar grid. Each cell represents a day, colored by value intensity. Provide heatmapOptions with [date, value] data and calendarOptions with a date range.
|
|
1140
|
-
*/
|
|
1141
|
-
export declare const HeatmapCalendarChart: (props: HeatmapCalendarChartProps) => SpecNode;
|
|
1142
|
-
export type HeatmapChartProps = Bindable<HeatmapChartCatalogProps> & ComponentDirectives;
|
|
1143
|
-
/**
|
|
1144
|
-
* Grid-based heatmap chart for showing magnitude across two dimensions. Data format: [[xIndex, yIndex, value], …]. Provide category labels for both axes.
|
|
1145
|
-
*/
|
|
1146
|
-
export declare const HeatmapChart: (props: HeatmapChartProps) => SpecNode;
|
|
1147
|
-
export type TreemapChartProps = Bindable<TreemapChartCatalogProps> & ComponentDirectives;
|
|
1148
|
-
/**
|
|
1149
|
-
* Treemap chart for visualizing hierarchical data as nested rectangles. Each node has a name and either a numeric value (leaf) or children (branch). Rectangle size represents the value.
|
|
1150
|
-
*/
|
|
1151
|
-
export declare const TreemapChart: (props: TreemapChartProps) => SpecNode;
|
|
1152
|
-
export type SqlHighlightProps = Bindable<SqlHighlightCatalogProps> & ComponentDirectives;
|
|
1153
|
-
/**
|
|
1154
|
-
* Read-only SQL syntax highlighter powered by Monaco Editor. Renders a formatted, non-editable SQL block with auto-height based on line count and a max height cap.
|
|
1155
|
-
*/
|
|
1156
|
-
export declare const SqlHighlight: (props: SqlHighlightProps) => SpecNode;
|
|
1157
1046
|
export {};
|
|
1158
1047
|
//# sourceMappingURL=components.d.mts.map
|