@rippling/rippling-sdk 0.2.0-alpha.37 → 0.2.0-alpha.39
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/examples/sdui/sdui-crud-todo/sdui-crud-todo.ts +3 -3
- package/examples/sdui/sdui-showcase/sdui-showcase.ts +6 -11
- package/examples/sdui/sdui-tab-multi-view/sdui-tab-multi-view.ts +14 -24
- package/examples/sdui/vote/vote.ts +7 -11
- package/lib/manifest/app.d.mts +11 -1
- package/lib/manifest/app.d.mts.map +1 -1
- package/lib/manifest/app.d.ts +11 -1
- package/lib/manifest/app.d.ts.map +1 -1
- package/lib/manifest/app.js +42 -1
- package/lib/manifest/app.js.map +1 -1
- package/lib/manifest/app.mjs +42 -1
- package/lib/manifest/app.mjs.map +1 -1
- package/lib/manifest/category.d.mts +14 -3
- package/lib/manifest/category.d.mts.map +1 -1
- package/lib/manifest/category.d.ts +14 -3
- package/lib/manifest/category.d.ts.map +1 -1
- package/lib/manifest/category.js +25 -3
- package/lib/manifest/category.js.map +1 -1
- package/lib/manifest/category.mjs +25 -3
- package/lib/manifest/category.mjs.map +1 -1
- package/lib/manifest/custom-object-field-section.d.mts +13 -0
- package/lib/manifest/custom-object-field-section.d.mts.map +1 -1
- package/lib/manifest/custom-object-field-section.d.ts +13 -0
- package/lib/manifest/custom-object-field-section.d.ts.map +1 -1
- package/lib/manifest/custom-object-field-section.js +22 -1
- package/lib/manifest/custom-object-field-section.js.map +1 -1
- package/lib/manifest/custom-object-field-section.mjs +22 -1
- package/lib/manifest/custom-object-field-section.mjs.map +1 -1
- package/lib/manifest/custom-object-page-layout.d.mts +23 -0
- package/lib/manifest/custom-object-page-layout.d.mts.map +1 -1
- package/lib/manifest/custom-object-page-layout.d.ts +23 -0
- package/lib/manifest/custom-object-page-layout.d.ts.map +1 -1
- package/lib/manifest/custom-object-page-layout.js +45 -2
- package/lib/manifest/custom-object-page-layout.js.map +1 -1
- package/lib/manifest/custom-object-page-layout.mjs +45 -2
- package/lib/manifest/custom-object-page-layout.mjs.map +1 -1
- package/lib/manifest/custom-object.d.mts +41 -2
- package/lib/manifest/custom-object.d.mts.map +1 -1
- package/lib/manifest/custom-object.d.ts +41 -2
- package/lib/manifest/custom-object.d.ts.map +1 -1
- package/lib/manifest/custom-object.js +70 -3
- package/lib/manifest/custom-object.js.map +1 -1
- package/lib/manifest/custom-object.mjs +70 -3
- package/lib/manifest/custom-object.mjs.map +1 -1
- package/lib/manifest/existing-manifest-context.d.mts +87 -0
- package/lib/manifest/existing-manifest-context.d.mts.map +1 -0
- package/lib/manifest/existing-manifest-context.d.ts +87 -0
- package/lib/manifest/existing-manifest-context.d.ts.map +1 -0
- package/lib/manifest/existing-manifest-context.js +511 -0
- package/lib/manifest/existing-manifest-context.js.map +1 -0
- package/lib/manifest/existing-manifest-context.mjs +506 -0
- package/lib/manifest/existing-manifest-context.mjs.map +1 -0
- package/lib/manifest/field.d.mts +44 -2
- package/lib/manifest/field.d.mts.map +1 -1
- package/lib/manifest/field.d.ts +44 -2
- package/lib/manifest/field.d.ts.map +1 -1
- package/lib/manifest/field.js +134 -3
- package/lib/manifest/field.js.map +1 -1
- package/lib/manifest/field.mjs +134 -3
- package/lib/manifest/field.mjs.map +1 -1
- package/lib/manifest/index.d.mts +8 -7
- package/lib/manifest/index.d.mts.map +1 -1
- package/lib/manifest/index.d.ts +8 -7
- package/lib/manifest/index.d.ts.map +1 -1
- package/lib/manifest/index.js +3 -1
- package/lib/manifest/index.js.map +1 -1
- package/lib/manifest/index.mjs +5 -4
- package/lib/manifest/index.mjs.map +1 -1
- package/lib/manifest/list-view.d.mts +17 -0
- package/lib/manifest/list-view.d.mts.map +1 -1
- package/lib/manifest/list-view.d.ts +17 -0
- package/lib/manifest/list-view.d.ts.map +1 -1
- package/lib/manifest/list-view.js +38 -1
- package/lib/manifest/list-view.js.map +1 -1
- package/lib/manifest/list-view.mjs +38 -1
- package/lib/manifest/list-view.mjs.map +1 -1
- package/lib/manifest/manifest-builder.d.mts +60 -7
- package/lib/manifest/manifest-builder.d.mts.map +1 -1
- package/lib/manifest/manifest-builder.d.ts +60 -7
- package/lib/manifest/manifest-builder.d.ts.map +1 -1
- package/lib/manifest/manifest-builder.js +62 -4
- package/lib/manifest/manifest-builder.js.map +1 -1
- package/lib/manifest/manifest-builder.mjs +62 -4
- package/lib/manifest/manifest-builder.mjs.map +1 -1
- package/lib/manifest/manifest-function.d.mts +18 -3
- package/lib/manifest/manifest-function.d.mts.map +1 -1
- package/lib/manifest/manifest-function.d.ts +18 -3
- package/lib/manifest/manifest-function.d.ts.map +1 -1
- package/lib/manifest/manifest-function.js +44 -3
- package/lib/manifest/manifest-function.js.map +1 -1
- package/lib/manifest/manifest-function.mjs +44 -3
- package/lib/manifest/manifest-function.mjs.map +1 -1
- package/lib/manifest/rule.d.mts +17 -0
- package/lib/manifest/rule.d.mts.map +1 -1
- package/lib/manifest/rule.d.ts +17 -0
- package/lib/manifest/rule.d.ts.map +1 -1
- package/lib/manifest/rule.js +45 -1
- package/lib/manifest/rule.js.map +1 -1
- package/lib/manifest/rule.mjs +45 -1
- package/lib/manifest/rule.mjs.map +1 -1
- package/lib/manifest/sdui-page.d.mts +10 -1
- package/lib/manifest/sdui-page.d.mts.map +1 -1
- package/lib/manifest/sdui-page.d.ts +10 -1
- package/lib/manifest/sdui-page.d.ts.map +1 -1
- package/lib/manifest/sdui-page.js +28 -1
- package/lib/manifest/sdui-page.js.map +1 -1
- package/lib/manifest/sdui-page.mjs +28 -1
- package/lib/manifest/sdui-page.mjs.map +1 -1
- package/lib/manifest/validation.d.mts +17 -0
- package/lib/manifest/validation.d.mts.map +1 -1
- package/lib/manifest/validation.d.ts +17 -0
- package/lib/manifest/validation.d.ts.map +1 -1
- package/lib/manifest/validation.js +31 -1
- package/lib/manifest/validation.js.map +1 -1
- package/lib/manifest/validation.mjs +31 -1
- package/lib/manifest/validation.mjs.map +1 -1
- package/lib/sdui/actions.d.mts.map +1 -1
- package/lib/sdui/actions.d.ts.map +1 -1
- package/lib/sdui/actions.js +23 -13
- package/lib/sdui/actions.js.map +1 -1
- package/lib/sdui/actions.mjs +23 -13
- package/lib/sdui/actions.mjs.map +1 -1
- package/lib/sdui/component.d.mts +28 -11
- package/lib/sdui/component.d.mts.map +1 -1
- package/lib/sdui/component.d.ts +28 -11
- package/lib/sdui/component.d.ts.map +1 -1
- package/lib/sdui/component.js +69 -36
- package/lib/sdui/component.js.map +1 -1
- package/lib/sdui/component.mjs +69 -36
- package/lib/sdui/component.mjs.map +1 -1
- package/lib/sdui/components.d.mts +1141 -132
- package/lib/sdui/components.d.mts.map +1 -1
- package/lib/sdui/components.d.ts +1141 -132
- package/lib/sdui/components.d.ts.map +1 -1
- package/lib/sdui/components.js +834 -206
- package/lib/sdui/components.js.map +1 -1
- package/lib/sdui/components.mjs +830 -203
- package/lib/sdui/components.mjs.map +1 -1
- package/lib/sdui/directives.d.mts.map +1 -1
- package/lib/sdui/directives.d.ts.map +1 -1
- package/lib/sdui/directives.js +4 -1
- package/lib/sdui/directives.js.map +1 -1
- package/lib/sdui/directives.mjs +4 -1
- package/lib/sdui/directives.mjs.map +1 -1
- package/lib/sdui/index.d.mts +314 -261
- package/lib/sdui/index.d.mts.map +1 -1
- package/lib/sdui/index.d.ts +314 -261
- package/lib/sdui/index.d.ts.map +1 -1
- package/lib/sdui/index.js +255 -204
- package/lib/sdui/index.js.map +1 -1
- package/lib/sdui/index.mjs +128 -103
- package/lib/sdui/index.mjs.map +1 -1
- package/lib/sdui/propTypes.d.mts +6330 -0
- package/lib/sdui/propTypes.d.mts.map +1 -0
- package/lib/sdui/propTypes.d.ts +6330 -0
- package/lib/sdui/propTypes.d.ts.map +1 -0
- package/lib/sdui/propTypes.js +14 -0
- package/lib/sdui/propTypes.js.map +1 -0
- package/lib/sdui/propTypes.mjs +13 -0
- package/lib/sdui/propTypes.mjs.map +1 -0
- package/lib/sdui/render.d.mts +1 -1
- package/lib/sdui/render.d.mts.map +1 -1
- package/lib/sdui/render.d.ts +1 -1
- package/lib/sdui/render.d.ts.map +1 -1
- package/lib/sdui/render.js +11 -3
- package/lib/sdui/render.js.map +1 -1
- package/lib/sdui/render.mjs +11 -3
- package/lib/sdui/render.mjs.map +1 -1
- package/lib/sdui/state.d.mts.map +1 -1
- package/lib/sdui/state.d.ts.map +1 -1
- package/lib/sdui/state.js +3 -1
- package/lib/sdui/state.js.map +1 -1
- package/lib/sdui/state.mjs +3 -1
- package/lib/sdui/state.mjs.map +1 -1
- package/package.json +1 -1
- package/src/lib/manifest/app.ts +46 -2
- package/src/lib/manifest/category.ts +35 -7
- package/src/lib/manifest/custom-object-field-section.ts +37 -1
- package/src/lib/manifest/custom-object-page-layout.ts +67 -2
- package/src/lib/manifest/custom-object.ts +88 -4
- package/src/lib/manifest/existing-manifest-context.ts +673 -0
- package/src/lib/manifest/field.ts +160 -3
- package/src/lib/manifest/index.ts +39 -4
- package/src/lib/manifest/list-view.ts +50 -1
- package/src/lib/manifest/manifest-builder.ts +115 -5
- package/src/lib/manifest/manifest-function.ts +44 -4
- package/src/lib/manifest/rule.ts +60 -1
- package/src/lib/manifest/sdui-page.ts +37 -2
- package/src/lib/manifest/validation.ts +48 -1
- package/src/lib/sdui/actions.ts +23 -10
- package/src/lib/sdui/component.ts +84 -44
- package/src/lib/sdui/components.ts +1627 -212
- package/src/lib/sdui/directives.ts +4 -1
- package/src/lib/sdui/index.ts +565 -200
- package/src/lib/sdui/propTypes.ts +8470 -0
- package/src/lib/sdui/render.ts +13 -5
- package/src/lib/sdui/state.ts +8 -2
- 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,11 +1,14 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* AUTO-GENERATED from
|
|
3
|
-
*
|
|
4
|
-
* Components: 128
|
|
2
|
+
* AUTO-GENERATED from catalog-schema.json
|
|
3
|
+
* Components: 154
|
|
5
4
|
*
|
|
6
|
-
* Do not edit manually. Run:
|
|
5
|
+
* Do not edit manually. Run: node tools/sdui/builder/build.js
|
|
7
6
|
*/
|
|
8
7
|
import type { ActionBinding } from "./actions.mjs";
|
|
8
|
+
import type { StateRef, BindStateRef } from "./state.mjs";
|
|
9
|
+
import type { CondRef, TemplateRef } from "./props.mjs";
|
|
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, AnalyticsCardCatalogProps, ResizableBoardCatalogProps, EChartCatalogProps, RichTextCatalogProps, DashboardRichTextCatalogProps, CustomObjectGridCatalogProps, ObjectListViewCatalogProps, BarChartCatalogProps, LineChartCatalogProps, HorizontalBarChartCatalogProps, CombinationChartCatalogProps, PieChartCatalogProps, ScatterChartCatalogProps, FunnelChartCatalogProps, GaugeChartCatalogProps, SunburstChartCatalogProps, WithSpinnerCatalogProps, RadarChartCatalogProps, RadarFilledChartCatalogProps, HeatmapCalendarChartCatalogProps, HeatmapChartCatalogProps, TreemapChartCatalogProps, SqlHighlightCatalogProps } from "./propTypes.mjs";
|
|
9
12
|
export interface SpecNode {
|
|
10
13
|
type: string;
|
|
11
14
|
props: Record<string, unknown>;
|
|
@@ -18,132 +21,1138 @@ export interface SpecNode {
|
|
|
18
21
|
key?: string;
|
|
19
22
|
};
|
|
20
23
|
}
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
export
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
export declare const
|
|
48
|
-
export
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
export declare const
|
|
53
|
-
export
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
export declare const Alert: (props?:
|
|
62
|
-
export
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
export declare const
|
|
67
|
-
export
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
export declare const
|
|
72
|
-
export
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
export declare const
|
|
77
|
-
export
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
export declare const
|
|
88
|
-
export
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
export declare const
|
|
98
|
-
export
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
export declare const
|
|
103
|
-
export
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
export declare const
|
|
110
|
-
export
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
export declare const
|
|
115
|
-
export
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
export declare const
|
|
120
|
-
export
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
export declare const
|
|
127
|
-
export
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
export declare const
|
|
134
|
-
export
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
export declare const
|
|
144
|
-
export
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
24
|
+
interface ComponentDirectives {
|
|
25
|
+
visible?: unknown;
|
|
26
|
+
watch?: Record<string, unknown>;
|
|
27
|
+
repeat?: {
|
|
28
|
+
statePath: string;
|
|
29
|
+
key?: string;
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Wrap each prop with the set of runtime refs the renderer accepts in
|
|
34
|
+
* place of a literal value: state reads/binds, conditional/template
|
|
35
|
+
* expressions, and per-row item refs (inside repeat loops). This is what
|
|
36
|
+
* lets callers write `value: state.foo.$bind` or `label: cond(...)`
|
|
37
|
+
* against typed prop interfaces — the renderer dereferences these at
|
|
38
|
+
* runtime.
|
|
39
|
+
*/
|
|
40
|
+
type Bindable<T> = {
|
|
41
|
+
[K in keyof T]: T[K] | StateRef | BindStateRef | CondRef | TemplateRef | ItemRef | BindItemRef;
|
|
42
|
+
};
|
|
43
|
+
export type ActionCardProps = Bindable<ActionCardCatalogProps> & {
|
|
44
|
+
onPressPrimary?: ActionBinding | ActionBinding[];
|
|
45
|
+
onPressSecondary?: ActionBinding | ActionBinding[];
|
|
46
|
+
} & ComponentDirectives;
|
|
47
|
+
/**
|
|
48
|
+
* Placeholder for states like empty, success, error, and loading, featuring animations, icons, text, and action buttons.
|
|
49
|
+
*/
|
|
50
|
+
export declare const ActionCard: (props: ActionCardProps) => SpecNode;
|
|
51
|
+
export type AiIconProps = Bindable<AiIconCatalogProps> & ComponentDirectives;
|
|
52
|
+
/**
|
|
53
|
+
* Branded Rippling AI icon used to indicate AI-powered features or content. Displays the Rippling AI star icon with optional "Rippling AI" label text.
|
|
54
|
+
*/
|
|
55
|
+
export declare const AiIcon: (props?: AiIconProps | undefined) => SpecNode;
|
|
56
|
+
export type AlertProps = Bindable<AlertCatalogProps> & {
|
|
57
|
+
onPressPrimary?: ActionBinding | ActionBinding[];
|
|
58
|
+
onPressSecondary?: ActionBinding | ActionBinding[];
|
|
59
|
+
onDismiss?: ActionBinding | ActionBinding[];
|
|
60
|
+
} & ComponentDirectives;
|
|
61
|
+
/**
|
|
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).
|
|
63
|
+
*/
|
|
64
|
+
export declare const Alert: (props?: AlertProps | undefined) => SpecNode;
|
|
65
|
+
export type AnimationProps = Bindable<AnimationCatalogProps> & ComponentDirectives;
|
|
66
|
+
/**
|
|
67
|
+
* Renders pre-built Lottie animations from a curated library. Each animation type maps to an SVG animation that plays on mount. Use for empty states, onboarding flows, status illustrations, and feature highlights.
|
|
68
|
+
*/
|
|
69
|
+
export declare const Animation: (props: AnimationProps) => SpecNode;
|
|
70
|
+
export type ApiErrorProps = Bindable<ApiErrorCatalogProps> & ComponentDirectives;
|
|
71
|
+
/**
|
|
72
|
+
* A full-screen error state placeholder for API or server failures, displaying an animated exclamation icon and an error message. Use when an API call fails and the entire content area should show an error instead of the expected content.
|
|
73
|
+
*/
|
|
74
|
+
export declare const ApiError: (props?: ApiErrorProps | undefined) => SpecNode;
|
|
75
|
+
export type AppGroupLoaderProps = Bindable<AppGroupLoaderCatalogProps> & ComponentDirectives;
|
|
76
|
+
/**
|
|
77
|
+
* A skeleton placeholder shown while app group content is loading. Use when the layout of the app group area is known and you want to reduce perceived loading time and prevent layout shift.
|
|
78
|
+
*/
|
|
79
|
+
export declare const AppGroupLoader: (props?: AppGroupLoaderProps | undefined) => SpecNode;
|
|
80
|
+
export type AppGroupSelectProps = Bindable<AppGroupSelectCatalogProps> & {
|
|
81
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
82
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
83
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
84
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
85
|
+
onMenuToggle?: ActionBinding | ActionBinding[];
|
|
86
|
+
} & ComponentDirectives;
|
|
87
|
+
/**
|
|
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
|
+
*/
|
|
90
|
+
export declare const AppGroupSelect: (props?: AppGroupSelectProps | undefined) => SpecNode;
|
|
91
|
+
export type AppNavBarProps = Bindable<AppNavBarCatalogProps> & {
|
|
92
|
+
onNavigate?: ActionBinding | ActionBinding[];
|
|
93
|
+
onAction?: ActionBinding | ActionBinding[];
|
|
94
|
+
} & ComponentDirectives & {
|
|
95
|
+
children?: SpecNode | SpecNode[];
|
|
96
|
+
};
|
|
97
|
+
/**
|
|
98
|
+
* Application navigation bar with routing support. Displays a horizontal tab bar or vertical sidebar with links, icons, badges, and optional nested sub-navigation. Use for top-level page navigation.
|
|
99
|
+
*/
|
|
100
|
+
export declare const AppNavBar: (props: AppNavBarProps) => SpecNode;
|
|
101
|
+
export type AtomsSeparatorProps = Bindable<AtomsSeparatorCatalogProps> & ComponentDirectives;
|
|
102
|
+
/**
|
|
103
|
+
* A horizontal rule that visually divides sections of content, with optional centered text (e.g. "OR"). Use for content separation — use Divider for separating individual list items.
|
|
104
|
+
*/
|
|
105
|
+
export declare const AtomsSeparator: (props?: AtomsSeparatorProps | undefined) => SpecNode;
|
|
106
|
+
export type AvatarProps = Bindable<AvatarCatalogProps> & {
|
|
107
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
108
|
+
} & ComponentDirectives;
|
|
109
|
+
/**
|
|
110
|
+
* A visual representation of an entity, such as a user, organization, or product. Use circular shape (isRounded=true) for people and rounded square (isRounded=false) for non-human entities like organizations or brands.
|
|
111
|
+
*/
|
|
112
|
+
export declare const Avatar: (props?: AvatarProps | undefined) => SpecNode;
|
|
113
|
+
export type AvatarListProps = Bindable<AvatarListCatalogProps> & ComponentDirectives;
|
|
114
|
+
/**
|
|
115
|
+
* Displays a list of avatars with a configurable maximum limit that automatically truncates with a number indicating the remaining entities. Use to represent a group of people or organizations.
|
|
116
|
+
*/
|
|
117
|
+
export declare const AvatarList: (props?: AvatarListProps | undefined) => SpecNode;
|
|
118
|
+
export type BadgeProps = Bindable<BadgeCatalogProps> & ComponentDirectives;
|
|
119
|
+
/**
|
|
120
|
+
* A static indicator for displaying notifications, counts, or numerical status information. Use for unread counts, pending items, and quantity metrics — not for categories (use Label) or actions (use Button).
|
|
121
|
+
*/
|
|
122
|
+
export declare const Badge: (props: BadgeProps) => SpecNode;
|
|
123
|
+
export type BoxProps = Bindable<BoxCatalogProps> & ComponentDirectives & {
|
|
124
|
+
children?: SpecNode | SpecNode[];
|
|
125
|
+
};
|
|
126
|
+
/**
|
|
127
|
+
* A general-purpose flexbox layout container with full control over direction, alignment, spacing, dimensions, styling, and responsive direction switching via container queries. Use Box when you need fine-grained CSS control (custom dimensions, borders, backgrounds, positioning, responsive breakpoints) beyond what VStack/HStack provide. Prefer VStack or HStack for simple vertical or horizontal stacking with token-based spacing.
|
|
128
|
+
*/
|
|
129
|
+
export declare const Box: (props?: BoxProps | undefined) => SpecNode;
|
|
130
|
+
export type BreadcrumbProps = Bindable<BreadcrumbCatalogProps> & {
|
|
131
|
+
onSelect?: ActionBinding | ActionBinding[];
|
|
132
|
+
} & ComponentDirectives;
|
|
133
|
+
/**
|
|
134
|
+
* A sequential series of links that mark the nested hierarchy and navigational context for a user's location within an app. Use for complex information architectures where users need a clear path back to higher-level pages.
|
|
135
|
+
*/
|
|
136
|
+
export declare const Breadcrumb: (props: BreadcrumbProps) => SpecNode;
|
|
137
|
+
export type ButtonProps = Bindable<ButtonCatalogProps> & {
|
|
138
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
139
|
+
onPressWhileDisabled?: ActionBinding | ActionBinding[];
|
|
140
|
+
onMouseEnter?: ActionBinding | ActionBinding[];
|
|
141
|
+
onMouseLeave?: ActionBinding | ActionBinding[];
|
|
142
|
+
} & ComponentDirectives;
|
|
143
|
+
/**
|
|
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.
|
|
145
|
+
*/
|
|
146
|
+
export declare const Button: (props?: ButtonProps | undefined) => SpecNode;
|
|
147
|
+
export type ButtonGroupProps = Bindable<ButtonGroupCatalogProps> & ComponentDirectives & {
|
|
148
|
+
children?: SpecNode | SpecNode[];
|
|
149
|
+
};
|
|
150
|
+
/**
|
|
151
|
+
* Layout container for arranging multiple Button elements horizontally or vertically with configurable placement, alignment, gap, and wrapping.
|
|
152
|
+
*/
|
|
153
|
+
export declare const ButtonGroup: (props?: ButtonGroupProps | undefined) => SpecNode;
|
|
154
|
+
export type CardProps = Bindable<CardCatalogProps> & {
|
|
155
|
+
onEdit?: ActionBinding | ActionBinding[];
|
|
156
|
+
onDelete?: ActionBinding | ActionBinding[];
|
|
157
|
+
onAdd?: ActionBinding | ActionBinding[];
|
|
158
|
+
onClick?: ActionBinding | ActionBinding[];
|
|
159
|
+
onAction?: ActionBinding | ActionBinding[];
|
|
160
|
+
} & ComponentDirectives & {
|
|
161
|
+
children?: SpecNode | SpecNode[];
|
|
162
|
+
};
|
|
163
|
+
/**
|
|
164
|
+
* Visually groups related information and components into a contained, interactive card. Use for summarizing content, facilitating comparisons, or guiding users toward specific actions. Renders as a simple layout container when used with children only (no title/content).
|
|
165
|
+
*/
|
|
166
|
+
export declare const Card: (props?: CardProps | undefined) => SpecNode;
|
|
167
|
+
export type CardGroupProps = Bindable<CardGroupCatalogProps> & ComponentDirectives & {
|
|
168
|
+
children?: SpecNode | SpecNode[];
|
|
169
|
+
};
|
|
170
|
+
/**
|
|
171
|
+
* A layout container that arranges Card children (Card, LocationCard, LoaderCard) in an auto-sizing responsive grid. Automatically computes a uniform card width based on available container space.
|
|
172
|
+
*/
|
|
173
|
+
export declare const CardGroup: (props?: CardGroupProps | undefined) => SpecNode;
|
|
174
|
+
export type CarouselProps = Bindable<CarouselCatalogProps> & {
|
|
175
|
+
onDone?: ActionBinding | ActionBinding[];
|
|
176
|
+
} & ComponentDirectives;
|
|
177
|
+
/**
|
|
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
|
+
*/
|
|
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
|
+
};
|
|
186
|
+
/**
|
|
187
|
+
* Chart-specific replacement for `WithSpinner`. While `isLoading` is true and `error` is empty, renders a chart-shaped stencil (the same `ChartVisualizationStencil` bar-chart animation the Analytics Report uses) instead of a generic Pebble spinner. When `error` is non-null/non-false, renders a status-aware `ChartError` fallback that picks an animation + copy variant from the HTTP status (403 forbidden, 404 not found, 400 bad request, 500-or-default), mirroring the Analytics Report `VisualizationErrorFallback`. Otherwise renders children. Emits `load` once on mount so a handler can kick off the data fetch.
|
|
188
|
+
*/
|
|
189
|
+
export declare const ChartLoader: (props: ChartLoaderProps) => SpecNode;
|
|
190
|
+
export type CheckListProps = Bindable<CheckListCatalogProps> & {
|
|
191
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
192
|
+
} & ComponentDirectives;
|
|
193
|
+
/**
|
|
194
|
+
* A flexible multi-select interface with nested lists, allowing users to toggle selections using switches or checkboxes. Use for hierarchical options with parent-child relationships, bulk selection, or settings where multiple configurations can be enabled simultaneously.
|
|
195
|
+
*/
|
|
196
|
+
export declare const CheckList: (props: CheckListProps) => SpecNode;
|
|
197
|
+
export type CheckboxProps = Bindable<CheckboxCatalogProps> & {
|
|
198
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
199
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
200
|
+
} & ComponentDirectives;
|
|
201
|
+
/**
|
|
202
|
+
* 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
|
+
*/
|
|
204
|
+
export declare const Checkbox: (props?: CheckboxProps | undefined) => SpecNode;
|
|
205
|
+
export type CheckboxGroupProps = Bindable<CheckboxGroupCatalogProps> & {
|
|
206
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
207
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
208
|
+
} & ComponentDirectives;
|
|
209
|
+
/**
|
|
210
|
+
* 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.
|
|
211
|
+
*/
|
|
212
|
+
export declare const CheckboxGroup: (props?: CheckboxGroupProps | undefined) => SpecNode;
|
|
213
|
+
export type ChipProps = Bindable<ChipCatalogProps> & {
|
|
214
|
+
onDismiss?: ActionBinding | ActionBinding[];
|
|
215
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
216
|
+
} & ComponentDirectives;
|
|
217
|
+
/**
|
|
218
|
+
* A compact, interactive element for representing entities, attributes, filters, or complex criteria. Use for user-selected tags, filter conditions, or dismissible items. Use Label instead for static semantic color-coded metadata like "New" or "Caution", and Button for calls to action.
|
|
219
|
+
*/
|
|
220
|
+
export declare const Chip: (props?: ChipProps | undefined) => SpecNode;
|
|
221
|
+
export type ChipGroupProps = Bindable<ChipGroupCatalogProps> & {
|
|
222
|
+
onOverflowChange?: ActionBinding | ActionBinding[];
|
|
223
|
+
} & ComponentDirectives & {
|
|
224
|
+
children?: SpecNode | SpecNode[];
|
|
225
|
+
};
|
|
226
|
+
/**
|
|
227
|
+
* A layout container for grouping multiple Chip components (tags, filters, attributes), managing arrangement with configurable gap spacing, overflow behavior that collapses excess chips into a "+N more" modal, and incremental batch rendering for large datasets.
|
|
228
|
+
*/
|
|
229
|
+
export declare const ChipGroup: (props?: ChipGroupProps | undefined) => SpecNode;
|
|
230
|
+
export type CircleProps = Bindable<CircleCatalogProps> & ComponentDirectives;
|
|
231
|
+
/**
|
|
232
|
+
* Circular graphic element for status or decoration
|
|
233
|
+
*/
|
|
234
|
+
export declare const Circle: (props?: CircleProps | undefined) => SpecNode;
|
|
235
|
+
export type ColorPickerProps = Bindable<ColorPickerCatalogProps> & {
|
|
236
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
237
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
238
|
+
} & ComponentDirectives;
|
|
239
|
+
/**
|
|
240
|
+
* 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.
|
|
241
|
+
*/
|
|
242
|
+
export declare const ColorPicker: (props?: ColorPickerProps | undefined) => SpecNode;
|
|
243
|
+
export type ContentLoaderProps = Bindable<ContentLoaderCatalogProps> & ComponentDirectives;
|
|
244
|
+
/**
|
|
245
|
+
* A low-level SVG shimmer placeholder used to indicate loading state. Renders a plain animated rectangle whose dimensions you control. For shaped placeholders (text lines, circles, boxes), use Skeleton instead.
|
|
246
|
+
*/
|
|
247
|
+
export declare const ContentLoader: (props?: ContentLoaderProps | undefined) => SpecNode;
|
|
248
|
+
export type CountDownProps = Bindable<CountDownCatalogProps> & ComponentDirectives;
|
|
249
|
+
/**
|
|
250
|
+
* Countdown timer displaying time remaining until a target date
|
|
251
|
+
*/
|
|
252
|
+
export declare const CountDown: (props: CountDownProps) => SpecNode;
|
|
253
|
+
export type CountryProps = Bindable<CountryCatalogProps> & ComponentDirectives;
|
|
254
|
+
/**
|
|
255
|
+
* Displays a country by its ISO code, showing flag and/or name. Can show both (default), flag only, or name only. Ideal for profiles, address settings, or regional customization contexts where country identification is needed.
|
|
256
|
+
*/
|
|
257
|
+
export declare const Country: (props: CountryProps) => SpecNode;
|
|
258
|
+
export type CurrencyProps = Bindable<CurrencyCatalogProps> & {
|
|
259
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
260
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
261
|
+
} & ComponentDirectives;
|
|
262
|
+
/**
|
|
263
|
+
* 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
|
+
*/
|
|
265
|
+
export declare const Currency: (props?: CurrencyProps | undefined) => SpecNode;
|
|
266
|
+
export type DateProps = Bindable<DateCatalogProps> & {
|
|
267
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
268
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
269
|
+
} & ComponentDirectives;
|
|
270
|
+
/**
|
|
271
|
+
* 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
|
+
export declare const Date: (props?: DateProps | undefined) => SpecNode;
|
|
274
|
+
export type DateInlineMultiProps = Bindable<DateInlineMultiCatalogProps> & {
|
|
275
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
276
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
277
|
+
} & ComponentDirectives;
|
|
278
|
+
/**
|
|
279
|
+
* 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
|
+
export declare const DateInlineMulti: (props?: DateInlineMultiProps | undefined) => SpecNode;
|
|
282
|
+
export type DateRangeProps = Bindable<DateRangeCatalogProps> & {
|
|
283
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
284
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
285
|
+
} & ComponentDirectives;
|
|
286
|
+
/**
|
|
287
|
+
* 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.
|
|
288
|
+
*/
|
|
289
|
+
export declare const DateRange: (props?: DateRangeProps | undefined) => SpecNode;
|
|
290
|
+
export type DaySelectorProps = Bindable<DaySelectorCatalogProps> & {
|
|
291
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
292
|
+
} & ComponentDirectives;
|
|
293
|
+
/**
|
|
294
|
+
* A form input for selecting one or more days of the week (Sunday through Saturday). Use for recurring schedules, availability preferences, or any scenario requiring day-of-week choices.
|
|
295
|
+
*/
|
|
296
|
+
export declare const DaySelector: (props?: DaySelectorProps | undefined) => SpecNode;
|
|
297
|
+
export type DistributionBarProps = Bindable<DistributionBarCatalogProps> & ComponentDirectives;
|
|
298
|
+
/**
|
|
299
|
+
* A horizontal stacked bar that visualizes proportional distribution of values across categories. Use to show how parts contribute to a whole, such as budget allocation, storage usage breakdown, or workforce composition.
|
|
300
|
+
*/
|
|
301
|
+
export declare const DistributionBar: (props: DistributionBarProps) => SpecNode;
|
|
302
|
+
export type DividerProps = Bindable<DividerCatalogProps> & ComponentDirectives;
|
|
303
|
+
/**
|
|
304
|
+
* Horizontal line to visually separate content sections
|
|
305
|
+
*/
|
|
306
|
+
export declare const Divider: (props?: DividerProps | undefined) => SpecNode;
|
|
307
|
+
export type DraggableListProps = Bindable<DraggableListCatalogProps> & {
|
|
308
|
+
onUpdate?: ActionBinding | ActionBinding[];
|
|
309
|
+
onRemove?: ActionBinding | ActionBinding[];
|
|
310
|
+
onDragStart?: ActionBinding | ActionBinding[];
|
|
311
|
+
onDragEnd?: ActionBinding | ActionBinding[];
|
|
312
|
+
} & ComponentDirectives;
|
|
313
|
+
/**
|
|
314
|
+
* 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.
|
|
315
|
+
*/
|
|
316
|
+
export declare const DraggableList: (props: DraggableListProps) => SpecNode;
|
|
317
|
+
export type DrawerProps = Bindable<DrawerCatalogProps> & {
|
|
318
|
+
onClose?: ActionBinding | ActionBinding[];
|
|
319
|
+
} & ComponentDirectives & {
|
|
320
|
+
children?: SpecNode | SpecNode[];
|
|
321
|
+
};
|
|
322
|
+
/**
|
|
323
|
+
* A sliding panel that appears from the edge of the screen, allowing users to access additional information or complete secondary tasks like forms without losing context of their primary workflow. Use instead of Modal when preserving the user's place on the page is important.
|
|
324
|
+
*/
|
|
325
|
+
export declare const Drawer: (props?: DrawerProps | undefined) => SpecNode;
|
|
326
|
+
export type DropdownProps = Bindable<DropdownCatalogProps> & {
|
|
327
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
328
|
+
} & ComponentDirectives;
|
|
329
|
+
/**
|
|
330
|
+
* A popover menu that displays a list of actions or selectable options. Use for 3–15 choices triggered by a button; for form field selection, use Select instead.
|
|
331
|
+
*/
|
|
332
|
+
export declare const Dropdown: (props: DropdownProps) => SpecNode;
|
|
333
|
+
export type EmailProps = Bindable<EmailCatalogProps> & {
|
|
334
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
335
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
336
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
337
|
+
onClick?: ActionBinding | ActionBinding[];
|
|
338
|
+
onKeydown?: ActionBinding | ActionBinding[];
|
|
339
|
+
onKeyup?: ActionBinding | ActionBinding[];
|
|
340
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
341
|
+
onMouseenter?: ActionBinding | ActionBinding[];
|
|
342
|
+
onMouseleave?: ActionBinding | ActionBinding[];
|
|
343
|
+
} & ComponentDirectives;
|
|
344
|
+
/**
|
|
345
|
+
* 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.
|
|
346
|
+
*/
|
|
347
|
+
export declare const Email: (props?: EmailProps | undefined) => SpecNode;
|
|
348
|
+
export type ExpansionPanelProps = Bindable<ExpansionPanelCatalogProps> & {
|
|
349
|
+
onToggle?: ActionBinding | ActionBinding[];
|
|
350
|
+
} & ComponentDirectives & {
|
|
351
|
+
children?: SpecNode | SpecNode[];
|
|
352
|
+
};
|
|
353
|
+
/**
|
|
354
|
+
* A collapsible panel that expands or contracts to reveal additional detailed information. Use to organize related content within limited space, such as FAQs, settings menus, or side panels. Prefer a full scrolling page when users need to read all content.
|
|
355
|
+
*/
|
|
356
|
+
export declare const ExpansionPanel: (props: ExpansionPanelProps) => SpecNode;
|
|
357
|
+
export type ExpansionPanelGroupProps = Bindable<ExpansionPanelGroupCatalogProps> & ComponentDirectives & {
|
|
358
|
+
children?: SpecNode | SpecNode[];
|
|
359
|
+
};
|
|
360
|
+
/**
|
|
361
|
+
* A container that coordinates multiple ExpansionPanel children, optionally enforcing accordion behavior where only one panel can be open at a time. Use to organize related content into collapsible sections within limited space.
|
|
362
|
+
*/
|
|
363
|
+
export declare const ExpansionPanelGroup: (props?: ExpansionPanelGroupProps | undefined) => SpecNode;
|
|
364
|
+
export type FieldProps = Bindable<FieldCatalogProps> & ComponentDirectives & {
|
|
365
|
+
children?: SpecNode | SpecNode[];
|
|
366
|
+
};
|
|
367
|
+
/**
|
|
368
|
+
* A layout wrapper that provides consistent structure around form inputs, including a label, required indicator, helper or error message, tooltip, read-only mode, and inline (side-by-side) layout option. Use Field to wrap any form input component.
|
|
369
|
+
*/
|
|
370
|
+
export declare const Field: (props?: FieldProps | undefined) => SpecNode;
|
|
371
|
+
export type FileProps = Bindable<FileCatalogProps> & {
|
|
372
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
373
|
+
onDelete?: ActionBinding | ActionBinding[];
|
|
374
|
+
} & ComponentDirectives;
|
|
375
|
+
/**
|
|
376
|
+
* A compact file upload input for selecting one or more files via browse or drag-and-drop. Supports file type restrictions, size limits, and upload progress. Use for inline file fields in forms; use FileDrop for larger drag-and-drop zones with labels and validation.
|
|
377
|
+
*/
|
|
378
|
+
export declare const File: (props?: FileProps | undefined) => SpecNode;
|
|
379
|
+
export type FileDropProps = Bindable<FileDropCatalogProps> & {
|
|
380
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
381
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
382
|
+
} & ComponentDirectives;
|
|
383
|
+
/**
|
|
384
|
+
* 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
|
+
export declare const FileDrop: (props?: FileDropProps | undefined) => SpecNode;
|
|
387
|
+
export type FloatingButtonProps = Bindable<FloatingButtonCatalogProps> & {
|
|
388
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
389
|
+
onPressWhileDisabled?: ActionBinding | ActionBinding[];
|
|
390
|
+
onMouseEnter?: ActionBinding | ActionBinding[];
|
|
391
|
+
onMouseLeave?: ActionBinding | ActionBinding[];
|
|
392
|
+
} & ComponentDirectives;
|
|
393
|
+
/**
|
|
394
|
+
* 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
|
+
export declare const FloatingButton: (props: FloatingButtonProps) => SpecNode;
|
|
397
|
+
export type GridProps = Bindable<GridCatalogProps> & {
|
|
398
|
+
onRowClick?: ActionBinding | ActionBinding[];
|
|
399
|
+
onRowAction?: ActionBinding | ActionBinding[];
|
|
400
|
+
onHeaderAction?: ActionBinding | ActionBinding[];
|
|
401
|
+
} & ComponentDirectives;
|
|
402
|
+
/**
|
|
403
|
+
* 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.
|
|
404
|
+
*/
|
|
405
|
+
export declare const Grid: (props: GridProps) => SpecNode;
|
|
406
|
+
export type HStackProps = Bindable<HStackCatalogProps> & ComponentDirectives & {
|
|
407
|
+
children?: SpecNode | SpecNode[];
|
|
408
|
+
};
|
|
409
|
+
/**
|
|
410
|
+
* Horizontal stack layout that arranges children side-by-side in a row with token-based spacing. Use for placing elements next to each other horizontally — e.g. side-by-side form fields, button groups, or inline icon-and-text pairs. Prefer VStack for vertical stacking and Box for complex layouts needing custom dimensions, borders, or backgrounds.
|
|
411
|
+
*/
|
|
412
|
+
export declare const HStack: (props?: HStackProps | undefined) => SpecNode;
|
|
413
|
+
export type HeadingProps = Bindable<HeadingCatalogProps> & ComponentDirectives;
|
|
414
|
+
/**
|
|
415
|
+
* A semantic heading element (h1–h6) for page titles and section headers that establishes document hierarchy. Use for structural headings only — for body text or paragraphs use Paragraph, and for a title paired with a subtitle use TitleCaption.
|
|
416
|
+
*/
|
|
417
|
+
export declare const Heading: (props?: HeadingProps | undefined) => SpecNode;
|
|
418
|
+
export type IconProps = Bindable<IconCatalogProps> & {
|
|
419
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
420
|
+
} & ComponentDirectives;
|
|
421
|
+
/**
|
|
422
|
+
* A standalone icon element from the Pebble icon set. Use for decorative or interactive icon displays — as clickable action triggers, status indicators, or visual accents. Supports tooltips and full ARIA attributes for accessibility.
|
|
423
|
+
*/
|
|
424
|
+
export declare const Icon: (props: IconProps) => SpecNode;
|
|
425
|
+
export type IconButtonProps = Bindable<IconButtonCatalogProps> & {
|
|
426
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
427
|
+
onPressWhileDisabled?: ActionBinding | ActionBinding[];
|
|
428
|
+
onMouseEnter?: ActionBinding | ActionBinding[];
|
|
429
|
+
onMouseLeave?: ActionBinding | ActionBinding[];
|
|
430
|
+
} & ComponentDirectives;
|
|
431
|
+
/**
|
|
432
|
+
* 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
|
+
export declare const IconButton: (props: IconButtonProps) => SpecNode;
|
|
435
|
+
export type ImageProps = Bindable<ImageCatalogProps> & {
|
|
436
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
437
|
+
onLoad?: ActionBinding | ActionBinding[];
|
|
438
|
+
onError?: ActionBinding | ActionBinding[];
|
|
439
|
+
} & ComponentDirectives;
|
|
440
|
+
/**
|
|
441
|
+
* 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.
|
|
442
|
+
*/
|
|
443
|
+
export declare const Image: (props: ImageProps) => SpecNode;
|
|
444
|
+
export type ImageViewerProps = Bindable<ImageViewerCatalogProps> & ComponentDirectives;
|
|
445
|
+
/**
|
|
446
|
+
* Displays an image thumbnail that expands into a full-size overlay with zoom when clicked. Use for previewing images such as uploaded documents, photos, or screenshots where users need to inspect detail.
|
|
447
|
+
*/
|
|
448
|
+
export declare const ImageViewer: (props: ImageViewerProps) => SpecNode;
|
|
449
|
+
export type InputGroupProps = Bindable<InputGroupCatalogProps> & ComponentDirectives;
|
|
450
|
+
/**
|
|
451
|
+
* Combines multiple input fields (e.g. a Select prefix with a Text input) into a single visually unified group with shared sizing, disabled, invalid, and read-only state. Use for composite inputs like currency amount with currency selector, or phone number with country code.
|
|
452
|
+
*/
|
|
453
|
+
export declare const InputGroup: (props: InputGroupProps) => SpecNode;
|
|
454
|
+
export type ItemNavigatorProps = Bindable<ItemNavigatorCatalogProps> & {
|
|
455
|
+
onNext?: ActionBinding | ActionBinding[];
|
|
456
|
+
onPrevious?: ActionBinding | ActionBinding[];
|
|
457
|
+
} & ComponentDirectives;
|
|
458
|
+
/**
|
|
459
|
+
* A compact prev/next control for stepping through items one at a time, displaying "X of Y items" with previous and next buttons. Use for sequential item-by-item navigation such as cycling through detail views of records, search results, or review queues — not for page-based navigation (use Pagination instead).
|
|
460
|
+
*/
|
|
461
|
+
export declare const ItemNavigator: (props: ItemNavigatorProps) => SpecNode;
|
|
462
|
+
export type LabelProps = Bindable<LabelCatalogProps> & ComponentDirectives;
|
|
463
|
+
/**
|
|
464
|
+
* A static, non-interactive identifier representing a status, property, or other highlighted metadata about an item. Use for categorizing or labeling items with short keywords like "New", "Recommended", or "High Priority". For interactive tagging use Chip; for live status updates use Status.
|
|
465
|
+
*/
|
|
466
|
+
export declare const Label: (props: LabelProps) => SpecNode;
|
|
467
|
+
export type LabelGroupProps = Bindable<LabelGroupCatalogProps> & ComponentDirectives & {
|
|
468
|
+
children?: SpecNode | SpecNode[];
|
|
469
|
+
};
|
|
470
|
+
/**
|
|
471
|
+
* A layout container for grouping multiple Label components together, with automatic wrapping and overflow handling. When labels exceed a configured row limit, excess labels collapse into a "+N more" indicator that opens a modal. Use when displaying a set of categorization or metadata labels on an item.
|
|
472
|
+
*/
|
|
473
|
+
export declare const LabelGroup: (props?: LabelGroupProps | undefined) => SpecNode;
|
|
474
|
+
export type LayoutProps = Bindable<LayoutCatalogProps> & ComponentDirectives & {
|
|
475
|
+
children?: SpecNode | SpecNode[];
|
|
476
|
+
};
|
|
477
|
+
/**
|
|
478
|
+
* A flex-based container for arranging child elements with control over direction, alignment, spacing, dimensions, and styling. Use Layout for general-purpose page structure and custom layouts. Prefer VStack or HStack for simple vertical or horizontal stacking.
|
|
479
|
+
*/
|
|
480
|
+
export declare const Layout: (props?: LayoutProps | undefined) => SpecNode;
|
|
481
|
+
export type LayoutCardProps = Bindable<LayoutCardCatalogProps> & {
|
|
482
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
483
|
+
} & ComponentDirectives & {
|
|
484
|
+
children?: SpecNode | SpecNode[];
|
|
485
|
+
};
|
|
486
|
+
/**
|
|
487
|
+
* A standard card container for creating card-based page layouts with configurable padding and an optional selectable theme for selection interfaces.
|
|
488
|
+
*/
|
|
489
|
+
export declare const LayoutCard: (props?: LayoutCardProps | undefined) => SpecNode;
|
|
490
|
+
export type LinkProps = Bindable<LinkCatalogProps> & {
|
|
491
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
492
|
+
} & ComponentDirectives;
|
|
493
|
+
/**
|
|
494
|
+
* A clickable text hyperlink for navigating to URLs or downloading files. Use for inline or standalone text links — use Button for actions that don't navigate, and Breadcrumb for hierarchical navigation trails.
|
|
495
|
+
*/
|
|
496
|
+
export declare const Link: (props: LinkProps) => SpecNode;
|
|
497
|
+
export type ListItemProps = Bindable<ListItemCatalogProps> & {
|
|
498
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
499
|
+
} & ComponentDirectives;
|
|
500
|
+
/**
|
|
501
|
+
* A structured list entry for displaying related entities vertically, with a title and optional caption. Use within grouped lists to present items for scanning, selection, or action.
|
|
502
|
+
*/
|
|
503
|
+
export declare const ListItem: (props?: ListItemProps | undefined) => SpecNode;
|
|
504
|
+
export type LoaderCardProps = Bindable<LoaderCardCatalogProps> & ComponentDirectives;
|
|
505
|
+
/**
|
|
506
|
+
* A skeleton placeholder shaped like a card, shown while card content is loading. Use inside a Card.Group context to match card dimensions and reduce perceived loading time. Set isGridView for grid-based layouts.
|
|
507
|
+
*/
|
|
508
|
+
export declare const LoaderCard: (props?: LoaderCardProps | undefined) => SpecNode;
|
|
509
|
+
export type LocationCardProps = Bindable<LocationCardCatalogProps> & {
|
|
510
|
+
onEdit?: ActionBinding | ActionBinding[];
|
|
511
|
+
onDelete?: ActionBinding | ActionBinding[];
|
|
512
|
+
onClick?: ActionBinding | ActionBinding[];
|
|
513
|
+
onAction?: ActionBinding | ActionBinding[];
|
|
514
|
+
} & ComponentDirectives;
|
|
515
|
+
/**
|
|
516
|
+
* 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
|
+
export declare const LocationCard: (props: LocationCardProps) => SpecNode;
|
|
519
|
+
export type MaskerProps = Bindable<MaskerCatalogProps> & {
|
|
520
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
521
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
522
|
+
} & ComponentDirectives;
|
|
523
|
+
/**
|
|
524
|
+
* 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.
|
|
525
|
+
*/
|
|
526
|
+
export declare const Masker: (props: MaskerProps) => SpecNode;
|
|
527
|
+
export type MenuListProps = Bindable<MenuListCatalogProps> & {
|
|
528
|
+
onSelect?: ActionBinding | ActionBinding[];
|
|
529
|
+
} & ComponentDirectives;
|
|
530
|
+
/**
|
|
531
|
+
* A dropdown menu list that displays selectable actions or options. Use for context menus, action menus, or option pickers where items need to be selected from a list. Items can use WARNING type for cautionary actions or ALERT type for destructive actions like delete.
|
|
532
|
+
*/
|
|
533
|
+
export declare const MenuList: (props: MenuListProps) => SpecNode;
|
|
534
|
+
export type ModalProps = Bindable<ModalCatalogProps> & {
|
|
535
|
+
onClose?: ActionBinding | ActionBinding[];
|
|
536
|
+
} & ComponentDirectives & {
|
|
537
|
+
children?: SpecNode | SpecNode[];
|
|
538
|
+
};
|
|
539
|
+
/**
|
|
540
|
+
* An interactive overlay that demands user attention and input, isolating specific tasks or information above the main page content. Use for confirmations, urgent notifications, or brief focused tasks that require an immediate response.
|
|
541
|
+
*/
|
|
542
|
+
export declare const Modal: (props?: ModalProps | undefined) => SpecNode;
|
|
543
|
+
export type ModalCloseButtonProps = Bindable<ModalCloseButtonCatalogProps> & ComponentDirectives;
|
|
544
|
+
/**
|
|
545
|
+
* A button placed inside a Modal that dismisses the dialog when clicked. Used as the cancel or close action in modal footers, allowing users to exit without completing the modal task.
|
|
546
|
+
*/
|
|
547
|
+
export declare const ModalCloseButton: (props?: ModalCloseButtonProps | undefined) => SpecNode;
|
|
548
|
+
export type ModalFooterProps = Bindable<ModalFooterCatalogProps> & ComponentDirectives & {
|
|
549
|
+
children?: SpecNode | SpecNode[];
|
|
550
|
+
};
|
|
551
|
+
/**
|
|
552
|
+
* Footer section of a Modal that holds primary action buttons for task completion or cancellation. Use inside a Modal as the bottom bar for confirm/cancel actions.
|
|
553
|
+
*/
|
|
554
|
+
export declare const ModalFooter: (props?: ModalFooterProps | undefined) => SpecNode;
|
|
555
|
+
export type NestedListProps = Bindable<NestedListCatalogProps> & {
|
|
556
|
+
onToggle?: ActionBinding | ActionBinding[];
|
|
557
|
+
onSelect?: ActionBinding | ActionBinding[];
|
|
558
|
+
} & ComponentDirectives;
|
|
559
|
+
/**
|
|
560
|
+
* 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
|
+
export declare const NestedList: (props: NestedListProps) => SpecNode;
|
|
563
|
+
export type NumberProps = Bindable<NumberCatalogProps> & {
|
|
564
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
565
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
566
|
+
onChangeRaw?: ActionBinding | ActionBinding[];
|
|
567
|
+
onChangeCalculationState?: ActionBinding | ActionBinding[];
|
|
568
|
+
} & ComponentDirectives;
|
|
569
|
+
/**
|
|
570
|
+
* 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
|
+
export declare const Number: (props?: NumberProps | undefined) => SpecNode;
|
|
573
|
+
export type ObjectUIProps = Bindable<ObjectUICatalogProps> & ComponentDirectives & {
|
|
574
|
+
children?: SpecNode | SpecNode[];
|
|
575
|
+
};
|
|
576
|
+
/**
|
|
577
|
+
* A modular component that presents a high-level overview of an entity (person, organization, device) with an avatar, title, and caption. Typically placed at the top of a detail page below navigation. Use Cards for detailed entity info, Lists for comparing multiple items, or Tables for large sortable datasets.
|
|
578
|
+
*/
|
|
579
|
+
export declare const ObjectUI: (props?: ObjectUIProps | undefined) => SpecNode;
|
|
580
|
+
export type ObjectUIContentProps = Bindable<ObjectUIContentCatalogProps> & ComponentDirectives & {
|
|
581
|
+
children?: SpecNode | SpecNode[];
|
|
582
|
+
};
|
|
583
|
+
/**
|
|
584
|
+
* The main body content area of an ObjectUI entity detail page. Place below ObjectUIHeader (and optionally ObjectUIStats) inside ObjectUITemplate to hold the detailed content for the entity.
|
|
585
|
+
*/
|
|
586
|
+
export declare const ObjectUIContent: (props?: ObjectUIContentProps | undefined) => SpecNode;
|
|
587
|
+
export type ObjectUIHeaderProps = Bindable<ObjectUIHeaderCatalogProps> & ComponentDirectives;
|
|
588
|
+
/**
|
|
589
|
+
* Header section of an entity overview (person, organization, device) displaying an avatar, title, and caption. Used at the top of ObjectUI layouts to identify the entity at a glance.
|
|
590
|
+
*/
|
|
591
|
+
export declare const ObjectUIHeader: (props?: ObjectUIHeaderProps | undefined) => SpecNode;
|
|
592
|
+
export type ObjectUIStatsProps = Bindable<ObjectUIStatsCatalogProps> & {
|
|
593
|
+
onActionClick?: ActionBinding | ActionBinding[];
|
|
594
|
+
} & ComponentDirectives;
|
|
595
|
+
/**
|
|
596
|
+
* A grid section within ObjectUI that displays key-value statistics about an entity (person, organization, device), with optional tooltips on stat labels and icon action buttons.
|
|
597
|
+
*/
|
|
598
|
+
export declare const ObjectUIStats: (props: ObjectUIStatsProps) => SpecNode;
|
|
599
|
+
export type ObjectUITemplateProps = Bindable<ObjectUITemplateCatalogProps> & ComponentDirectives & {
|
|
600
|
+
children?: SpecNode | SpecNode[];
|
|
601
|
+
};
|
|
602
|
+
/**
|
|
603
|
+
* The root container for an ObjectUI entity detail page that presents a high-level overview of an entity (person, organization, device). Place ObjectUIHeader, ObjectUIStats, and ObjectUIContent as children. Use ObjectUITemplate when you need a structured entity overview at the top of a page; use Cards for detailed entity info, Lists for comparing multiple items, or Tables for large sortable datasets.
|
|
604
|
+
*/
|
|
605
|
+
export declare const ObjectUITemplate: (props?: ObjectUITemplateProps | undefined) => SpecNode;
|
|
606
|
+
export type PageAppLogoProps = Bindable<PageAppLogoCatalogProps> & ComponentDirectives;
|
|
607
|
+
/**
|
|
608
|
+
* Branded header for an application or module page, displaying the app logo, title, optional subtitle, and optional help/support link. Use at the top of a page to identify which app the user is in.
|
|
609
|
+
*/
|
|
610
|
+
export declare const PageAppLogo: (props: PageAppLogoProps) => SpecNode;
|
|
611
|
+
export type PageContentProps = Bindable<PageContentCatalogProps> & ComponentDirectives & {
|
|
612
|
+
children?: SpecNode | SpecNode[];
|
|
613
|
+
};
|
|
614
|
+
/**
|
|
615
|
+
* The standard wrapper for a page's main body area. Controls maximum content width (584–1544px or FLUID for edge-to-edge) and horizontal alignment (center, left, right). Use PageContent for every page-level content region, whether constrained to a fixed width or stretched full-width.
|
|
616
|
+
*/
|
|
617
|
+
export declare const PageContent: (props?: PageContentProps | undefined) => SpecNode;
|
|
618
|
+
export type PageFooterProps = Bindable<PageFooterCatalogProps> & {
|
|
619
|
+
onContinue?: ActionBinding | ActionBinding[];
|
|
620
|
+
} & ComponentDirectives & {
|
|
621
|
+
children?: SpecNode | SpecNode[];
|
|
622
|
+
};
|
|
623
|
+
/**
|
|
624
|
+
* A persistent footer bar at the bottom of a page, typically used for primary navigation actions like "Continue" or "Submit". Supports a built-in continue button (via the continue event) or custom child content for more complex footer layouts. Use shouldBeSticky to keep it visible at the bottom of the viewport as the user scrolls.
|
|
625
|
+
*/
|
|
626
|
+
export declare const PageFooter: (props?: PageFooterProps | undefined) => SpecNode;
|
|
627
|
+
export type PageHeaderProps = Bindable<PageHeaderCatalogProps> & ComponentDirectives;
|
|
628
|
+
/**
|
|
629
|
+
* A top-of-page header displaying a title and optional caption, used inside a page layout alongside PageContent and PageFooter. Use size to match the PageContent width.
|
|
630
|
+
*/
|
|
631
|
+
export declare const PageHeader: (props?: PageHeaderProps | undefined) => SpecNode;
|
|
632
|
+
export type PaginateProps = Bindable<PaginateCatalogProps> & {
|
|
633
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
634
|
+
} & ComponentDirectives;
|
|
635
|
+
/**
|
|
636
|
+
* A navigation control that breaks large content into smaller pages, commonly used with data tables and content-rich views. Use when loading all data at once is impractical or when content is too large for a single view.
|
|
637
|
+
*/
|
|
638
|
+
export declare const Paginate: (props: PaginateProps) => SpecNode;
|
|
639
|
+
export type PaneProps = Bindable<PaneCatalogProps> & {
|
|
640
|
+
onCollapsedChange?: ActionBinding | ActionBinding[];
|
|
641
|
+
onDismiss?: ActionBinding | ActionBinding[];
|
|
642
|
+
onResize?: ActionBinding | ActionBinding[];
|
|
643
|
+
} & ComponentDirectives & {
|
|
644
|
+
children?: SpecNode | SpecNode[];
|
|
645
|
+
};
|
|
646
|
+
/**
|
|
647
|
+
* An individual panel within a SplitPane container. Each Pane defines its own size constraints, collapse priority, and resize behavior. Must be a direct child of SplitPane.
|
|
648
|
+
*/
|
|
649
|
+
export declare const Pane: (props: PaneProps) => SpecNode;
|
|
650
|
+
export type PasswordProps = Bindable<PasswordCatalogProps> & {
|
|
651
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
652
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
653
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
654
|
+
onClick?: ActionBinding | ActionBinding[];
|
|
655
|
+
onKeydown?: ActionBinding | ActionBinding[];
|
|
656
|
+
onKeyup?: ActionBinding | ActionBinding[];
|
|
657
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
658
|
+
onMouseenter?: ActionBinding | ActionBinding[];
|
|
659
|
+
onMouseleave?: ActionBinding | ActionBinding[];
|
|
660
|
+
onReveal?: ActionBinding | ActionBinding[];
|
|
661
|
+
} & ComponentDirectives;
|
|
662
|
+
/**
|
|
663
|
+
* A secure input field for entering or creating passwords, with automatic character masking and an optional visibility toggle. Use in login, signup, or verification flows.
|
|
664
|
+
*/
|
|
665
|
+
export declare const Password: (props?: PasswordProps | undefined) => SpecNode;
|
|
666
|
+
export type PercentageProps = Bindable<PercentageCatalogProps> & {
|
|
667
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
668
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
669
|
+
} & ComponentDirectives;
|
|
670
|
+
/**
|
|
671
|
+
* 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
|
+
*/
|
|
673
|
+
export declare const Percentage: (props?: PercentageProps | undefined) => SpecNode;
|
|
674
|
+
export type PhoneProps = Bindable<PhoneCatalogProps> & {
|
|
675
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
676
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
677
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
678
|
+
onClick?: ActionBinding | ActionBinding[];
|
|
679
|
+
onKeydown?: ActionBinding | ActionBinding[];
|
|
680
|
+
onKeyup?: ActionBinding | ActionBinding[];
|
|
681
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
682
|
+
onMouseenter?: ActionBinding | ActionBinding[];
|
|
683
|
+
onMouseleave?: ActionBinding | ActionBinding[];
|
|
684
|
+
onCountryCodeChange?: ActionBinding | ActionBinding[];
|
|
685
|
+
} & ComponentDirectives;
|
|
686
|
+
/**
|
|
687
|
+
* A specialized input for entering and editing phone numbers with automatic region-based formatting, international support, and an optional country code dropdown selector.
|
|
688
|
+
*/
|
|
689
|
+
export declare const Phone: (props?: PhoneProps | undefined) => SpecNode;
|
|
690
|
+
export type ProgressBarProps = Bindable<ProgressBarCatalogProps> & ComponentDirectives;
|
|
691
|
+
/**
|
|
692
|
+
* Communicates the status of an ongoing process, like downloading or uploading files, to inform the user of the remaining wait time. Use determinate mode when progress percentage is known, or indeterminate when wait time cannot be calculated. For multi-step processes requiring user action, use ProgressSteps instead; for a simple busy indicator, use Spinner.
|
|
693
|
+
*/
|
|
694
|
+
export declare const ProgressBar: (props?: ProgressBarProps | undefined) => SpecNode;
|
|
695
|
+
export type ProgressStepsProps = Bindable<ProgressStepsCatalogProps> & ComponentDirectives;
|
|
696
|
+
/**
|
|
697
|
+
* A multi-step progress indicator that visually shows completed, current, and upcoming steps in a sequential workflow. Use for onboarding flows, form wizards, or any multi-part process where users need to see their progress.
|
|
698
|
+
*/
|
|
699
|
+
export declare const ProgressSteps: (props: ProgressStepsProps) => SpecNode;
|
|
700
|
+
export type RadioProps = Bindable<RadioCatalogProps> & {
|
|
701
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
702
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
703
|
+
onMouseenter?: ActionBinding | ActionBinding[];
|
|
704
|
+
onMouseleave?: ActionBinding | ActionBinding[];
|
|
705
|
+
} & ComponentDirectives;
|
|
706
|
+
/**
|
|
707
|
+
* Radio buttons let users choose a single option from two or more mutually exclusive options. Prefer over Select when showing 5 or fewer options that need to be immediately visible. Use Checkbox instead when multiple selections are allowed.
|
|
708
|
+
*/
|
|
709
|
+
export declare const Radio: (props?: RadioProps | undefined) => SpecNode;
|
|
710
|
+
export type RangeSliderProps = Bindable<RangeSliderCatalogProps> & {
|
|
711
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
712
|
+
onBeforeChange?: ActionBinding | ActionBinding[];
|
|
713
|
+
onAfterChange?: ActionBinding | ActionBinding[];
|
|
714
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
715
|
+
} & ComponentDirectives;
|
|
716
|
+
/**
|
|
717
|
+
* 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.
|
|
718
|
+
*/
|
|
719
|
+
export declare const RangeSlider: (props?: RangeSliderProps | undefined) => SpecNode;
|
|
720
|
+
export type ReportLoaderProps = Bindable<ReportLoaderCatalogProps> & ComponentDirectives;
|
|
721
|
+
/**
|
|
722
|
+
* A skeleton placeholder shown while tabular report content is loading. Use when the content area will contain a data report with header and detail rows, and you want to reduce perceived loading time and prevent layout shift.
|
|
723
|
+
*/
|
|
724
|
+
export declare const ReportLoader: (props?: ReportLoaderProps | undefined) => SpecNode;
|
|
725
|
+
export type ReportShareLoaderProps = Bindable<ReportShareLoaderCatalogProps> & ComponentDirectives;
|
|
726
|
+
/**
|
|
727
|
+
* A skeleton placeholder shown while report sharing content is loading. Use when the report share dialog or page layout is known and you want to reduce perceived loading time and prevent layout shift. Renders a header, description, and two side-by-side content blocks (stacking on mobile).
|
|
728
|
+
*/
|
|
729
|
+
export declare const ReportShareLoader: (props?: ReportShareLoaderProps | undefined) => SpecNode;
|
|
730
|
+
export type ReportViewerLoaderProps = Bindable<ReportViewerLoaderCatalogProps> & ComponentDirectives;
|
|
731
|
+
/**
|
|
732
|
+
* 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
|
+
*/
|
|
734
|
+
export declare const ReportViewerLoader: (props?: ReportViewerLoaderProps | undefined) => SpecNode;
|
|
735
|
+
export type ResponsiveProps = Bindable<ResponsiveCatalogProps> & ComponentDirectives & {
|
|
736
|
+
children?: SpecNode | SpecNode[];
|
|
737
|
+
};
|
|
738
|
+
/**
|
|
739
|
+
* Conditionally show or hide content based on container or viewport width breakpoints, enabling responsive layouts that adapt to different screen and panel sizes. Use to hide non-essential UI at narrow widths or show alternative layouts at wider breakpoints.
|
|
740
|
+
*/
|
|
741
|
+
export declare const Responsive: (props?: ResponsiveProps | undefined) => SpecNode;
|
|
742
|
+
export type SegmentedControlProps = Bindable<SegmentedControlCatalogProps> & {
|
|
743
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
744
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
745
|
+
} & ComponentDirectives;
|
|
746
|
+
/**
|
|
747
|
+
* 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
|
+
*/
|
|
749
|
+
export declare const SegmentedControl: (props: SegmentedControlProps) => SpecNode;
|
|
750
|
+
export type SelectProps = Bindable<SelectCatalogProps> & {
|
|
751
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
752
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
753
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
754
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
755
|
+
onMenuToggle?: ActionBinding | ActionBinding[];
|
|
756
|
+
} & ComponentDirectives;
|
|
757
|
+
/**
|
|
758
|
+
* 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.
|
|
759
|
+
*/
|
|
760
|
+
export declare const Select: (props?: SelectProps | undefined) => SpecNode;
|
|
761
|
+
export type SelectableGroupProps = Bindable<SelectableGroupCatalogProps> & {
|
|
762
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
763
|
+
} & ComponentDirectives;
|
|
764
|
+
/**
|
|
765
|
+
* A card-based selection input that renders a group of selectable cards for single or multi-choice picking. Use when users need to choose from a small set of visually rich options displayed as cards (e.g. plans, locations, tiers). Use Radio for simple text-only single choice, or Select for long option lists in a dropdown.
|
|
766
|
+
*/
|
|
767
|
+
export declare const SelectableGroup: (props: SelectableGroupProps) => SpecNode;
|
|
768
|
+
export type SelectableMenuProps = Bindable<SelectableMenuCatalogProps> & {
|
|
769
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
770
|
+
} & ComponentDirectives;
|
|
771
|
+
/**
|
|
772
|
+
* A dropdown menu that displays selectable options, allowing users to choose from a list of actions or settings. Includes a built-in trigger button. Deprecated — prefer Dropdown for new specs.
|
|
773
|
+
*/
|
|
774
|
+
export declare const SelectableMenu: (props: SelectableMenuProps) => SpecNode;
|
|
775
|
+
export type SettingsLoaderProps = Bindable<SettingsLoaderCatalogProps> & ComponentDirectives;
|
|
776
|
+
/**
|
|
777
|
+
* A skeleton placeholder shown while settings page content is loading. Use when the content area will contain a settings form with label/value rows, and you want to reduce perceived loading time and prevent layout shift. Supports optional centering and custom margin.
|
|
778
|
+
*/
|
|
779
|
+
export declare const SettingsLoader: (props?: SettingsLoaderProps | undefined) => SpecNode;
|
|
780
|
+
export type ShowMoreProps = Bindable<ShowMoreCatalogProps> & ComponentDirectives & {
|
|
781
|
+
children?: SpecNode | SpecNode[];
|
|
782
|
+
};
|
|
783
|
+
/**
|
|
784
|
+
* A container that truncates a list of child elements, showing only the first N items with a "Show all" / "Show less" toggle button. Use to reduce visual clutter in long lists while keeping all items accessible on demand.
|
|
785
|
+
*/
|
|
786
|
+
export declare const ShowMore: (props?: ShowMoreProps | undefined) => SpecNode;
|
|
787
|
+
export type SignatureProps = Bindable<SignatureCatalogProps> & {
|
|
788
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
789
|
+
} & ComponentDirectives;
|
|
790
|
+
/**
|
|
791
|
+
* A signature capture input that lets users sign by drawing on a canvas or typing their name. Use for legally binding agreements, contracts, or any workflow requiring a personal signature.
|
|
792
|
+
*/
|
|
793
|
+
export declare const Signature: (props?: SignatureProps | undefined) => SpecNode;
|
|
794
|
+
export type SinProps = Bindable<SinCatalogProps> & {
|
|
795
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
796
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
797
|
+
} & ComponentDirectives;
|
|
798
|
+
/**
|
|
799
|
+
* 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.
|
|
800
|
+
*/
|
|
801
|
+
export declare const Sin: (props?: SinProps | undefined) => SpecNode;
|
|
802
|
+
export type SkeletonProps = Bindable<SkeletonCatalogProps> & ComponentDirectives;
|
|
803
|
+
/**
|
|
804
|
+
* An animated placeholder that mimics the shape of content while it loads, available in text (lines), circle, and box variants.
|
|
805
|
+
*/
|
|
806
|
+
export declare const Skeleton: (props?: SkeletonProps | undefined) => SpecNode;
|
|
807
|
+
export type SliderProps = Bindable<SliderCatalogProps> & {
|
|
808
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
809
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
810
|
+
onBeforeChange?: ActionBinding | ActionBinding[];
|
|
811
|
+
onAfterChange?: ActionBinding | ActionBinding[];
|
|
812
|
+
} & ComponentDirectives;
|
|
813
|
+
/**
|
|
814
|
+
* 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.
|
|
815
|
+
*/
|
|
816
|
+
export declare const Slider: (props?: SliderProps | undefined) => SpecNode;
|
|
817
|
+
export type SnackBarProps = Bindable<SnackBarCatalogProps> & {
|
|
818
|
+
onDismiss?: ActionBinding | ActionBinding[];
|
|
819
|
+
} & ComponentDirectives;
|
|
820
|
+
/**
|
|
821
|
+
* A passive notification that appears at the bottom of the screen to provide quick, at-a-glance feedback on the outcome of an action. Use for non-critical, supplementary messages that do not require user action — for critical messages requiring acknowledgment, use a Modal instead.
|
|
822
|
+
*/
|
|
823
|
+
export declare const SnackBar: (props: SnackBarProps) => SpecNode;
|
|
824
|
+
export type SpinnerProps = Bindable<SpinnerCatalogProps> & ComponentDirectives;
|
|
825
|
+
/**
|
|
826
|
+
* A progress indicator for communicating that a process or task is currently underway without a known completion time. Use ProgressBar instead when the completion percentage is known.
|
|
827
|
+
*/
|
|
828
|
+
export declare const Spinner: (props?: SpinnerProps | undefined) => SpecNode;
|
|
829
|
+
export type SplitButtonProps = Bindable<SplitButtonCatalogProps> & {
|
|
830
|
+
onPress?: ActionBinding | ActionBinding[];
|
|
831
|
+
onDropdownChange?: ActionBinding | ActionBinding[];
|
|
832
|
+
} & ComponentDirectives;
|
|
833
|
+
/**
|
|
834
|
+
* 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").
|
|
835
|
+
*/
|
|
836
|
+
export declare const SplitButton: (props: SplitButtonProps) => SpecNode;
|
|
837
|
+
export type SplitPaneProps = Bindable<SplitPaneCatalogProps> & ComponentDirectives & {
|
|
838
|
+
children?: SpecNode | SpecNode[];
|
|
839
|
+
};
|
|
840
|
+
/**
|
|
841
|
+
* A multi-pane layout container that arranges child Pane components side-by-side with support for resizing, collapsing, and responsive behavior. Use for master-detail views, sidebars, and split-screen interfaces where panels need independent sizing and collapse control.
|
|
842
|
+
*/
|
|
843
|
+
export declare const SplitPane: (props?: SplitPaneProps | undefined) => SpecNode;
|
|
844
|
+
export type SsnProps = Bindable<SsnCatalogProps> & {
|
|
845
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
846
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
847
|
+
} & ComponentDirectives;
|
|
848
|
+
/**
|
|
849
|
+
* 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.
|
|
850
|
+
*/
|
|
851
|
+
export declare const Ssn: (props?: SsnProps | undefined) => SpecNode;
|
|
852
|
+
export type StatusProps = Bindable<StatusCatalogProps> & ComponentDirectives;
|
|
853
|
+
/**
|
|
854
|
+
* A static indicator of real-time state or condition, such as availability, progress, or publication status. Displays a colored dot alongside a text label. Use Label instead for categorizing or organizing items with keywords.
|
|
855
|
+
*/
|
|
856
|
+
export declare const Status: (props: StatusProps) => SpecNode;
|
|
857
|
+
export type StepperProps = Bindable<StepperCatalogProps> & {
|
|
858
|
+
onClick?: ActionBinding | ActionBinding[];
|
|
859
|
+
} & ComponentDirectives;
|
|
860
|
+
/**
|
|
861
|
+
* A progress indicator that guides users through multi-step sequential workflows by displaying completed steps, current position, and upcoming tasks. Best for linear processes with 3-7 steps such as checkout flows, onboarding sequences, or form wizards. Not suitable for non-linear workflows or processes with fewer than three steps.
|
|
862
|
+
*/
|
|
863
|
+
export declare const Stepper: (props: StepperProps) => SpecNode;
|
|
864
|
+
export type SurveyProps = Bindable<SurveyCatalogProps> & {
|
|
865
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
866
|
+
} & ComponentDirectives;
|
|
867
|
+
/**
|
|
868
|
+
* A button-group input for collecting ratings or opinions on a Likert scale (e.g. 1–5 or 1–10). Renders each option as a clickable button with optional range labels for the endpoints. Supports single or multi-select. Use for satisfaction surveys, NPS scores, or opinion scales. Use Radio for mutually exclusive text choices, SegmentedControl for toggling between named options, or Slider for continuous numeric ranges.
|
|
869
|
+
*/
|
|
870
|
+
export declare const Survey: (props: SurveyProps) => SpecNode;
|
|
871
|
+
export type SwitchProps = Bindable<SwitchCatalogProps> & {
|
|
872
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
873
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
874
|
+
} & ComponentDirectives;
|
|
875
|
+
/**
|
|
876
|
+
* 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.
|
|
877
|
+
*/
|
|
878
|
+
export declare const Switch: (props?: SwitchProps | undefined) => SpecNode;
|
|
879
|
+
export type TabProps = Bindable<TabCatalogProps> & {
|
|
880
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
881
|
+
} & ComponentDirectives;
|
|
882
|
+
/**
|
|
883
|
+
* Labeled controls for alternating between related views within the same page or context. Use to organize groups of related content at the same hierarchy level; for selection within a single view, use a segmented control instead.
|
|
884
|
+
*/
|
|
885
|
+
export declare const Tab: (props: TabProps) => SpecNode;
|
|
886
|
+
export type TableBasicProps = Bindable<TableBasicCatalogProps> & ComponentDirectives;
|
|
887
|
+
/**
|
|
888
|
+
* A read-only data table for displaying moderately large amounts of information in rows and columns. Use for structured, text-based data that benefits from systematic organization and easy scanning. For sorting, filtering, or cell-level interaction, use Grid instead; for simple vertical lists without column headings, use ListItem.
|
|
889
|
+
*/
|
|
890
|
+
export declare const TableBasic: (props: TableBasicProps) => SpecNode;
|
|
891
|
+
export type TextProps = Bindable<TextCatalogProps> & ComponentDirectives;
|
|
892
|
+
/**
|
|
893
|
+
* A general-purpose text component for rendering body copy, descriptions, captions, and other non-heading text content. Defaults to a paragraph (<p>) with body-medium typestyle. Use Heading instead for section titles (h1–h6), and TitleCaption for a title paired with a subtitle.
|
|
894
|
+
*/
|
|
895
|
+
export declare const Text: (props?: TextProps | undefined) => SpecNode;
|
|
896
|
+
export type TextAutoSuggestProps = Bindable<TextAutoSuggestCatalogProps> & {
|
|
897
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
898
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
899
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
900
|
+
onClick?: ActionBinding | ActionBinding[];
|
|
901
|
+
} & ComponentDirectives;
|
|
902
|
+
/**
|
|
903
|
+
* 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.
|
|
904
|
+
*/
|
|
905
|
+
export declare const TextAutoSuggest: (props?: TextAutoSuggestProps | undefined) => SpecNode;
|
|
906
|
+
export type TextClipProps = Bindable<TextClipCatalogProps> & ComponentDirectives & {
|
|
907
|
+
children?: SpecNode | SpecNode[];
|
|
908
|
+
};
|
|
909
|
+
/**
|
|
910
|
+
* Displays extensive text or content in a compact area by clipping it at a specified height, with an expand/collapse toggle for full viewing. Use when space is limited but more information is available. Use ExpansionPanel instead for multiple collapsible sections, or Tooltip for brief hover-only content.
|
|
911
|
+
*/
|
|
912
|
+
export declare const TextClip: (props: TextClipProps) => SpecNode;
|
|
913
|
+
export type TextInputProps = Bindable<TextInputCatalogProps> & {
|
|
914
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
915
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
916
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
917
|
+
onClick?: ActionBinding | ActionBinding[];
|
|
918
|
+
onKeydown?: ActionBinding | ActionBinding[];
|
|
919
|
+
onKeyup?: ActionBinding | ActionBinding[];
|
|
920
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
921
|
+
onMouseenter?: ActionBinding | ActionBinding[];
|
|
922
|
+
onMouseleave?: ActionBinding | ActionBinding[];
|
|
923
|
+
} & ComponentDirectives;
|
|
924
|
+
/**
|
|
925
|
+
* 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.
|
|
926
|
+
*/
|
|
927
|
+
export declare const TextInput: (props?: TextInputProps | undefined) => SpecNode;
|
|
928
|
+
export type TextSnippetProps = Bindable<TextSnippetCatalogProps> & ComponentDirectives;
|
|
929
|
+
/**
|
|
930
|
+
* A read-only text block with a one-click action to copy its content to the clipboard or download it as a file. Use for command-line instructions, code snippets, API keys, or any text the user needs to grab verbatim.
|
|
931
|
+
*/
|
|
932
|
+
export declare const TextSnippet: (props: TextSnippetProps) => SpecNode;
|
|
933
|
+
export type TextareaProps = Bindable<TextareaCatalogProps> & {
|
|
934
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
935
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
936
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
937
|
+
} & ComponentDirectives;
|
|
938
|
+
/**
|
|
939
|
+
* A multi-line text input for entering longer free-form text such as comments, descriptions, or paragraphs. Use TextInput instead for short single-line entries.
|
|
940
|
+
*/
|
|
941
|
+
export declare const Textarea: (props?: TextareaProps | undefined) => SpecNode;
|
|
942
|
+
export type TimeProps = Bindable<TimeCatalogProps> & {
|
|
943
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
944
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
945
|
+
} & ComponentDirectives;
|
|
946
|
+
/**
|
|
947
|
+
* 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
|
+
*/
|
|
949
|
+
export declare const Time: (props?: TimeProps | undefined) => SpecNode;
|
|
950
|
+
export type TimeRangeProps = Bindable<TimeRangeCatalogProps> & {
|
|
951
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
952
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
953
|
+
} & ComponentDirectives;
|
|
954
|
+
/**
|
|
955
|
+
* 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
|
+
*/
|
|
957
|
+
export declare const TimeRange: (props?: TimeRangeProps | undefined) => SpecNode;
|
|
958
|
+
export type TimezoneProps = Bindable<TimezoneCatalogProps> & {
|
|
959
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
960
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
961
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
962
|
+
} & ComponentDirectives;
|
|
963
|
+
/**
|
|
964
|
+
* A specialized select component for choosing a timezone. Lists all IANA timezones with search filtering. Use this when the user needs to pick a standalone timezone; use Time with timezone instead when selecting a time together with a timezone.
|
|
965
|
+
*/
|
|
966
|
+
export declare const Timezone: (props?: TimezoneProps | undefined) => SpecNode;
|
|
967
|
+
export type TipProps = Bindable<TipCatalogProps> & ComponentDirectives & {
|
|
968
|
+
children?: SpecNode | SpecNode[];
|
|
969
|
+
};
|
|
970
|
+
/**
|
|
971
|
+
* A supportive floating text box that offers contextual details about an associated element when hovered over or focused. Use for supplementary, non-critical information such as labelling icon buttons or describing ambiguous UI elements.
|
|
972
|
+
*/
|
|
973
|
+
export declare const Tip: (props: TipProps) => SpecNode;
|
|
974
|
+
export type TitleCaptionProps = Bindable<TitleCaptionCatalogProps> & ComponentDirectives;
|
|
975
|
+
/**
|
|
976
|
+
* A compact title-and-caption pair for displaying a primary label with an optional secondary descriptor, such as a person's name with their job title or a heading with a subtitle.
|
|
977
|
+
*/
|
|
978
|
+
export declare const TitleCaption: (props: TitleCaptionProps) => SpecNode;
|
|
979
|
+
export type ToggleableArrowProps = Bindable<ToggleableArrowCatalogProps> & ComponentDirectives;
|
|
980
|
+
/**
|
|
981
|
+
* A chevron arrow indicator that toggles between down (collapsed) and up (expanded) directions. Use as a standalone expand/collapse affordance, such as in custom collapsible sections or tree nodes.
|
|
982
|
+
*/
|
|
983
|
+
export declare const ToggleableArrow: (props?: ToggleableArrowProps | undefined) => SpecNode;
|
|
984
|
+
export type TreeProps = Bindable<TreeCatalogProps> & {
|
|
985
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
986
|
+
onFooterAction?: ActionBinding | ActionBinding[];
|
|
987
|
+
} & ComponentDirectives;
|
|
988
|
+
/**
|
|
989
|
+
* A hierarchical selector for choosing from a tree-structured list of parent-child relationships with expand/collapse navigation. Use for selecting from deeply nested data like org structures, file systems, directories, or classification hierarchies.
|
|
990
|
+
*/
|
|
991
|
+
export declare const Tree: (props: TreeProps) => SpecNode;
|
|
992
|
+
export type TreeSelectProps = Bindable<TreeSelectCatalogProps> & {
|
|
993
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
994
|
+
} & ComponentDirectives;
|
|
995
|
+
/**
|
|
996
|
+
* A dropdown select component with a hierarchical tree structure for choosing from nested parent-child options. Use when users need to pick from deeply nested data like org structures, file systems, or classification hierarchies, but the tree should stay collapsed behind a dropdown trigger. Use Tree instead when the hierarchy should be visible at all times.
|
|
997
|
+
*/
|
|
998
|
+
export declare const TreeSelect: (props: TreeSelectProps) => SpecNode;
|
|
999
|
+
export type VStackProps = Bindable<VStackCatalogProps> & ComponentDirectives & {
|
|
1000
|
+
children?: SpecNode | SpecNode[];
|
|
1001
|
+
};
|
|
1002
|
+
/**
|
|
1003
|
+
* Vertical stack layout that arranges children top-to-bottom in a column with token-based spacing. Use for stacking elements vertically — e.g. form field groups, page sections, or lists of content blocks. Prefer HStack for horizontal side-by-side arrangement and Box for complex layouts needing custom dimensions, borders, or backgrounds.
|
|
1004
|
+
*/
|
|
1005
|
+
export declare const VStack: (props?: VStackProps | undefined) => SpecNode;
|
|
1006
|
+
export type VideoProps = Bindable<VideoCatalogProps> & ComponentDirectives;
|
|
1007
|
+
/**
|
|
1008
|
+
* Embedded video player with 16:9 aspect ratio
|
|
1009
|
+
*/
|
|
1010
|
+
export declare const Video: (props: VideoProps) => SpecNode;
|
|
1011
|
+
export type WorkEmailProps = Bindable<WorkEmailCatalogProps> & {
|
|
1012
|
+
onChange?: ActionBinding | ActionBinding[];
|
|
1013
|
+
onBlur?: ActionBinding | ActionBinding[];
|
|
1014
|
+
onFocus?: ActionBinding | ActionBinding[];
|
|
1015
|
+
onClick?: ActionBinding | ActionBinding[];
|
|
1016
|
+
onKeydown?: ActionBinding | ActionBinding[];
|
|
1017
|
+
onKeyup?: ActionBinding | ActionBinding[];
|
|
1018
|
+
onPaste?: ActionBinding | ActionBinding[];
|
|
1019
|
+
onMouseenter?: ActionBinding | ActionBinding[];
|
|
1020
|
+
onMouseleave?: ActionBinding | ActionBinding[];
|
|
1021
|
+
} & ComponentDirectives;
|
|
1022
|
+
/**
|
|
1023
|
+
* 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
|
+
*/
|
|
1025
|
+
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
|
+
export {};
|
|
149
1158
|
//# sourceMappingURL=components.d.mts.map
|