@picteus/extension-sdk 0.18.0 → 0.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/backEndIntents.d.ts +216 -0
- package/dist/generated/backEndIntents.js +12 -0
- package/dist/generated/frontEndIntents.d.ts +1112 -0
- package/dist/generated/frontEndIntents.js +97 -0
- package/dist/generated/intentValidator.d.ts +49 -0
- package/dist/generated/intentValidator.js +363 -0
- package/dist/generated/viewKit.d.ts +1689 -366
- package/dist/generated/viewKit.js +994 -290
- package/dist/index.d.ts +3 -2
- package/dist/index.js +3 -2
- package/dist/picteusExtension.d.ts +13 -4
- package/dist/picteusExtension.js +45 -24
- package/package.json +4 -6
- package/dist/featureViewGrammar.d.ts +0 -2814
- package/dist/featureViewGrammar.js +0 -2612
- package/dist/generated/featureViewGrammar.d.ts +0 -3913
- package/dist/generated/featureViewGrammar.js +0 -4099
- package/dist/intents.d.ts +0 -188
- package/dist/intents.js +0 -26
- package/dist/picteus-ws-client/models/ExtensionActivityKind.d.ts +0 -26
- package/dist/picteus-ws-client/models/ExtensionActivityKind.js +0 -44
- package/dist/picteus-ws-client/models/ExtensionStatus.d.ts +0 -25
- package/dist/picteus-ws-client/models/ExtensionStatus.js +0 -43
- package/dist/picteus-ws-client/models/ImageEmbeddings.d.ts +0 -32
- package/dist/picteus-ws-client/models/ImageEmbeddings.js +0 -43
- package/dist/picteus-ws-client/models/RepositoryStatus.d.ts +0 -27
- package/dist/picteus-ws-client/models/RepositoryStatus.js +0 -45
- package/dist/picteus-ws-client/models/Settings.d.ts +0 -32
- package/dist/picteus-ws-client/models/Settings.js +0 -41
|
@@ -15,95 +15,156 @@ export declare abstract class ViewKitNode<T = unknown> {
|
|
|
15
15
|
}
|
|
16
16
|
/** Typographic stroke weight styling. */
|
|
17
17
|
export declare enum TextWeight {
|
|
18
|
+
/** Thin / light text weight */
|
|
18
19
|
thin = "thin",
|
|
20
|
+
/** Standard text weight */
|
|
19
21
|
normal = "normal",
|
|
22
|
+
/** Heavy / bold text weight */
|
|
20
23
|
heavy = "heavy"
|
|
21
24
|
}
|
|
22
25
|
/** Visual text color intensity and contrast. */
|
|
23
26
|
export declare enum TextIntensity {
|
|
27
|
+
/** Low visual contrast / subdued text color */
|
|
24
28
|
low = "low",
|
|
29
|
+
/** Standard text color */
|
|
25
30
|
medium = "medium",
|
|
31
|
+
/** High visual contrast / intense text color */
|
|
26
32
|
high = "high"
|
|
27
33
|
}
|
|
28
34
|
/** Geometric shape representation for visual containers and indicators. */
|
|
29
35
|
export declare enum Shape {
|
|
36
|
+
/** Circular container shape */
|
|
30
37
|
circle = "circle",
|
|
38
|
+
/** Square container shape */
|
|
31
39
|
square = "square"
|
|
32
40
|
}
|
|
33
41
|
/** Relative sizing scale for visual elements and indicators. */
|
|
34
42
|
export declare enum Size {
|
|
43
|
+
/** Compact small size */
|
|
35
44
|
small = "small",
|
|
45
|
+
/** Standard medium size */
|
|
36
46
|
medium = "medium",
|
|
47
|
+
/** Prominent large size */
|
|
37
48
|
large = "large"
|
|
38
49
|
}
|
|
39
50
|
/** Visual presentation style for string values. */
|
|
40
51
|
export declare enum StringRepresentation {
|
|
52
|
+
/** Standard inline text rendering */
|
|
41
53
|
plain = "plain",
|
|
54
|
+
/** Visual chip / tag pill representation */
|
|
42
55
|
chip = "chip",
|
|
56
|
+
/** Multiline text with preserved whitespace and line breaks */
|
|
43
57
|
multiline = "multiline"
|
|
44
58
|
}
|
|
45
59
|
/** Visual separator rendered between sequential elements or items. */
|
|
46
60
|
export declare enum Separator {
|
|
61
|
+
/** Vertical dividing bar */
|
|
47
62
|
bar = "bar",
|
|
63
|
+
/** Comma separator */
|
|
48
64
|
comma = "comma",
|
|
65
|
+
/** Bullet dot separator */
|
|
49
66
|
dot = "dot",
|
|
67
|
+
/** Forward slash separator */
|
|
50
68
|
slash = "slash",
|
|
69
|
+
/** Dash separator */
|
|
51
70
|
dash = "dash",
|
|
71
|
+
/** Space separator */
|
|
52
72
|
space = "space"
|
|
53
73
|
}
|
|
54
74
|
/** Supported syntax highlighting languages for formatted code blocks. */
|
|
55
75
|
export declare enum CodeLanguage {
|
|
76
|
+
/** XML markup syntax */
|
|
56
77
|
xml = "xml",
|
|
78
|
+
/** JSON format syntax */
|
|
57
79
|
json = "json",
|
|
80
|
+
/** YAML format syntax */
|
|
58
81
|
yaml = "yaml"
|
|
59
82
|
}
|
|
60
83
|
/** Visual presentation style for boolean values. */
|
|
61
84
|
export declare enum BooleanRepresentation {
|
|
85
|
+
/** Standard inline text rendering (e.g. "true" / "false" or custom labels) */
|
|
62
86
|
plain = "plain",
|
|
87
|
+
/** Visual badge pill representation */
|
|
63
88
|
badge = "badge"
|
|
64
89
|
}
|
|
65
90
|
/** Visual color tone variants for badge pill representations. */
|
|
66
91
|
export declare enum BadgeVariant {
|
|
92
|
+
/** Neutral gray tone */
|
|
67
93
|
neutral = "neutral",
|
|
94
|
+
/** Success green tone */
|
|
68
95
|
success = "success",
|
|
96
|
+
/** Warning yellow/orange tone */
|
|
69
97
|
warning = "warning",
|
|
98
|
+
/** Danger red tone */
|
|
70
99
|
danger = "danger"
|
|
71
100
|
}
|
|
72
101
|
/** Presentation format styles for timestamp elements. */
|
|
73
102
|
export declare enum TimestampFormat {
|
|
103
|
+
/** Complete date and time display */
|
|
74
104
|
datetime = "datetime",
|
|
105
|
+
/** Date-only display */
|
|
75
106
|
date = "date",
|
|
107
|
+
/** Time-only display */
|
|
76
108
|
time = "time",
|
|
109
|
+
/** Relative time expression (e.g. "5 minutes ago") */
|
|
77
110
|
relative = "relative"
|
|
78
111
|
}
|
|
79
112
|
/** Visual style variants for interactive button actions. */
|
|
80
113
|
export declare enum ButtonVariant {
|
|
114
|
+
/** Primary emphasis button style for default/recommended actions */
|
|
81
115
|
primary = "primary",
|
|
116
|
+
/** Secondary standard button style */
|
|
82
117
|
secondary = "secondary",
|
|
118
|
+
/** Subtle low-contrast button style */
|
|
83
119
|
subtle = "subtle",
|
|
120
|
+
/** Destructive / dangerous action button style */
|
|
84
121
|
danger = "danger"
|
|
85
122
|
}
|
|
86
|
-
/**
|
|
123
|
+
/**
|
|
124
|
+
* Text horizontal alignment options for table columns.
|
|
125
|
+
*
|
|
126
|
+
* @remarks
|
|
127
|
+
* Horizontal alignment applied within cells of a TableColumn. The alignment is a presentation choice and does not affect the stored cell values.
|
|
128
|
+
*/
|
|
87
129
|
export declare enum TableColumnAlign {
|
|
130
|
+
/** Left-aligned text */
|
|
88
131
|
left = "left",
|
|
132
|
+
/** Center-aligned text */
|
|
89
133
|
center = "center",
|
|
134
|
+
/** Right-aligned text */
|
|
90
135
|
right = "right"
|
|
91
136
|
}
|
|
92
|
-
/**
|
|
137
|
+
/**
|
|
138
|
+
* Width mode for table columns.
|
|
139
|
+
*
|
|
140
|
+
* @remarks
|
|
141
|
+
* Controls how an optional TableColumn width is interpreted by the table renderer.
|
|
142
|
+
*/
|
|
93
143
|
export declare enum TableColumnWidthMode {
|
|
144
|
+
/** Fixed width constraint */
|
|
94
145
|
fixed = "fixed",
|
|
146
|
+
/** Maximum width upper bound constraint */
|
|
95
147
|
maximum = "maximum"
|
|
96
148
|
}
|
|
97
|
-
/**
|
|
149
|
+
/**
|
|
150
|
+
* Visual styling variants for hairline dividers.
|
|
151
|
+
*
|
|
152
|
+
* @remarks
|
|
153
|
+
* Selects the visual stroke treatment used by DividerElement.
|
|
154
|
+
*/
|
|
98
155
|
export declare enum DividerStyle {
|
|
156
|
+
/** Subtle thin hairline border */
|
|
99
157
|
hairline = "hairline",
|
|
158
|
+
/** Solid standard divider line */
|
|
100
159
|
solid = "solid",
|
|
160
|
+
/** Dashed separator line */
|
|
101
161
|
dashed = "dashed"
|
|
102
162
|
}
|
|
103
163
|
/**
|
|
104
|
-
* Polymorphic root
|
|
105
|
-
*
|
|
106
|
-
*
|
|
164
|
+
* Polymorphic root model for visual UI elements.
|
|
165
|
+
*
|
|
166
|
+
* @remarks
|
|
167
|
+
* Every concrete visual element carries a type discriminator whose literal value selects its model and renderer. The @discriminator("type") metadata lets schema emitters and SDK generators represent derived models as a polymorphic hierarchy. Consumers should dispatch on the discriminator and preserve unknown elements when round-tripping data where possible.
|
|
107
168
|
*/
|
|
108
169
|
export interface UiElementBase {
|
|
109
170
|
/** The polymorphic discriminator type tag. */
|
|
@@ -113,11 +174,21 @@ export interface UiElementBase {
|
|
|
113
174
|
export declare abstract class BaseUiElement<T = UiElement> extends ViewKitNode<T> implements UiElementBase {
|
|
114
175
|
abstract readonly type: string;
|
|
115
176
|
}
|
|
116
|
-
/**
|
|
177
|
+
/**
|
|
178
|
+
* Polymorphic base model for interactive actions.
|
|
179
|
+
*
|
|
180
|
+
* @remarks
|
|
181
|
+
* Shared action contract for user-invokable card controls. Concrete action models provide their own discriminator and action-specific destination or command fields.
|
|
182
|
+
*/
|
|
117
183
|
export interface UiActionBase {
|
|
118
184
|
/** The polymorphic discriminator type tag. */
|
|
119
185
|
readonly type: string;
|
|
120
|
-
/**
|
|
186
|
+
/**
|
|
187
|
+
* Display label for the action
|
|
188
|
+
*
|
|
189
|
+
* @remarks
|
|
190
|
+
* User-facing label shown on the control. Keep it short and action-oriented.
|
|
191
|
+
*/
|
|
121
192
|
readonly label: string;
|
|
122
193
|
}
|
|
123
194
|
/** Abstract base class for all `UiAction` models. */
|
|
@@ -125,48 +196,92 @@ export declare abstract class BaseUiAction<T = UiAction> extends ViewKitNode<T>
|
|
|
125
196
|
abstract readonly type: string;
|
|
126
197
|
abstract readonly label: string;
|
|
127
198
|
}
|
|
128
|
-
/**
|
|
199
|
+
/**
|
|
200
|
+
* Truncation configuration for long textual content with optional expand affordance.
|
|
201
|
+
*
|
|
202
|
+
* @remarks
|
|
203
|
+
* Controls how a renderer abbreviates long text. The character limit is a presentation threshold rather than a validation limit; showMore lets the user reveal the remaining text.
|
|
204
|
+
*/
|
|
129
205
|
export interface TruncateOptions {
|
|
130
|
-
/**
|
|
206
|
+
/**
|
|
207
|
+
* Maximum number of characters to display before truncating
|
|
208
|
+
*
|
|
209
|
+
* @remarks
|
|
210
|
+
* Threshold after which the renderer can shorten the displayed text. This does not constrain the stored string or remove its undisplayed content.
|
|
211
|
+
*/
|
|
131
212
|
readonly characterLimit: number;
|
|
132
213
|
/**
|
|
133
214
|
* Whether to render a "Show more" / "Show less" toggle affordance
|
|
134
215
|
*
|
|
216
|
+
* @remarks
|
|
217
|
+
* When true, permits an expand/collapse control for text beyond the truncation threshold. Defaults to true.
|
|
218
|
+
*
|
|
135
219
|
* @defaultValue true
|
|
136
220
|
*/
|
|
137
221
|
readonly showMore?: boolean;
|
|
138
222
|
}
|
|
139
|
-
/**
|
|
223
|
+
/**
|
|
224
|
+
* Base modifier traits for elements that support copy affordance.
|
|
225
|
+
*
|
|
226
|
+
* @remarks
|
|
227
|
+
* Common optional presentation traits shared by primitive values and content renderers. Modifiers affect how content is displayed or copied; they do not transform the source value.
|
|
228
|
+
*/
|
|
140
229
|
export interface BaseModifiers {
|
|
141
|
-
/**
|
|
230
|
+
/**
|
|
231
|
+
* Adds an interactive copy button/action next to the rendered value
|
|
232
|
+
*
|
|
233
|
+
* @remarks
|
|
234
|
+
* When true, exposes a copy affordance for the associated value where supported by the renderer.
|
|
235
|
+
*/
|
|
142
236
|
readonly copyable?: boolean;
|
|
143
237
|
}
|
|
144
|
-
/**
|
|
238
|
+
/**
|
|
239
|
+
* Common modifier traits that can be attached to primitive elements.
|
|
240
|
+
*
|
|
241
|
+
* @remarks
|
|
242
|
+
* Extends BaseModifiers with text styling controls. Defaults provide normal weight, medium intensity, and proportional text unless a feature explicitly overrides them.
|
|
243
|
+
*/
|
|
145
244
|
export interface PrimitiveModifiers extends BaseModifiers {
|
|
146
|
-
/**
|
|
245
|
+
/**
|
|
246
|
+
* Configures character truncation threshold with show-more affordance
|
|
247
|
+
*
|
|
248
|
+
* @remarks
|
|
249
|
+
* Optional text abbreviation behavior. The source text remains unchanged, and the renderer may offer expansion according to showMore.
|
|
250
|
+
*/
|
|
147
251
|
readonly truncate?: TruncateOptions;
|
|
148
252
|
/**
|
|
149
253
|
* Typographic text weight
|
|
150
254
|
*
|
|
255
|
+
* @remarks
|
|
256
|
+
* Relative font weight for textual rendering; defaults to normal.
|
|
257
|
+
*
|
|
151
258
|
* @defaultValue TextWeight.normal
|
|
152
259
|
*/
|
|
153
260
|
readonly weight?: TextWeight;
|
|
154
261
|
/**
|
|
155
262
|
* Visual text color intensity
|
|
156
263
|
*
|
|
264
|
+
* @remarks
|
|
265
|
+
* Relative contrast treatment for the text; defaults to medium.
|
|
266
|
+
*
|
|
157
267
|
* @defaultValue TextIntensity.medium
|
|
158
268
|
*/
|
|
159
269
|
readonly intensity?: TextIntensity;
|
|
160
270
|
/**
|
|
161
271
|
* Whether to use monospace font rendering (for hashes, IDs, codes)
|
|
162
272
|
*
|
|
273
|
+
* @remarks
|
|
274
|
+
* When true, requests a fixed-width font suitable for identifiers and code-like values. Defaults to false.
|
|
275
|
+
*
|
|
163
276
|
* @defaultValue false
|
|
164
277
|
*/
|
|
165
278
|
readonly monospace?: boolean;
|
|
166
279
|
}
|
|
167
280
|
/**
|
|
168
|
-
*
|
|
169
|
-
*
|
|
281
|
+
* Text value primitive with selectable inline, chip, or multiline presentation.
|
|
282
|
+
*
|
|
283
|
+
* @remarks
|
|
284
|
+
* Use this primitive for one textual value when a structured label/value row is unnecessary. Choose multiline for content whose line breaks should remain visible; modifiers apply presentation traits without changing the underlying value.
|
|
170
285
|
*/
|
|
171
286
|
export interface StringElement extends UiElementBase {
|
|
172
287
|
/**
|
|
@@ -175,11 +290,19 @@ export interface StringElement extends UiElementBase {
|
|
|
175
290
|
* @defaultValue "string"
|
|
176
291
|
*/
|
|
177
292
|
readonly type: "string";
|
|
178
|
-
/**
|
|
293
|
+
/**
|
|
294
|
+
* Text value
|
|
295
|
+
*
|
|
296
|
+
* @remarks
|
|
297
|
+
* Text to render. Supply plain text; this field is not a Markdown or HTML document.
|
|
298
|
+
*/
|
|
179
299
|
readonly value: string;
|
|
180
300
|
/**
|
|
181
301
|
* Display representation mode
|
|
182
302
|
*
|
|
303
|
+
* @remarks
|
|
304
|
+
* Selects inline, chip, or multiline rendering. The default is plain, so callers can omit this for ordinary text.
|
|
305
|
+
*
|
|
183
306
|
* @defaultValue StringRepresentation.plain
|
|
184
307
|
*/
|
|
185
308
|
readonly representation?: StringRepresentation;
|
|
@@ -187,8 +310,10 @@ export interface StringElement extends UiElementBase {
|
|
|
187
310
|
readonly modifiers?: PrimitiveModifiers;
|
|
188
311
|
}
|
|
189
312
|
/**
|
|
190
|
-
* Collection of textual
|
|
191
|
-
*
|
|
313
|
+
* Collection of textual values rendered as an inline sequence or chips.
|
|
314
|
+
*
|
|
315
|
+
* @remarks
|
|
316
|
+
* Use this primitive when several related strings should be rendered as one compact sequence. The client preserves the array order and inserts the selected separator between values.
|
|
192
317
|
*/
|
|
193
318
|
export interface StringsElement extends UiElementBase {
|
|
194
319
|
/**
|
|
@@ -197,20 +322,38 @@ export interface StringsElement extends UiElementBase {
|
|
|
197
322
|
* @defaultValue "strings"
|
|
198
323
|
*/
|
|
199
324
|
readonly type: "strings";
|
|
200
|
-
/**
|
|
325
|
+
/**
|
|
326
|
+
* Array of string values
|
|
327
|
+
*
|
|
328
|
+
* @remarks
|
|
329
|
+
* Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
|
|
330
|
+
*/
|
|
201
331
|
readonly values: string[];
|
|
202
332
|
/**
|
|
203
333
|
* Display representation mode (plain text or visual chips)
|
|
204
334
|
*
|
|
335
|
+
* @remarks
|
|
336
|
+
* Selects whether values appear as ordinary inline text or as separate visual chips. The default uses the plain representation.
|
|
337
|
+
*
|
|
205
338
|
* @defaultValue StringRepresentation.plain
|
|
206
339
|
*/
|
|
207
340
|
readonly representation?: StringRepresentation;
|
|
208
|
-
/**
|
|
341
|
+
/**
|
|
342
|
+
* Optional visual separator rendered between sequential values
|
|
343
|
+
*
|
|
344
|
+
* @remarks
|
|
345
|
+
* Separator inserted between adjacent values in plain representation. It does not become part of any value.
|
|
346
|
+
*/
|
|
209
347
|
readonly separator?: Separator;
|
|
210
348
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
211
349
|
readonly modifiers?: PrimitiveModifiers;
|
|
212
350
|
}
|
|
213
|
-
/**
|
|
351
|
+
/**
|
|
352
|
+
* Monospace code block or formatted code snippet representation.
|
|
353
|
+
*
|
|
354
|
+
* @remarks
|
|
355
|
+
* Use for source-like or preformatted textual content that should be rendered in a code-oriented style. The language is a presentation hint; the content is not parsed or validated as code by this contract.
|
|
356
|
+
*/
|
|
214
357
|
export interface StringCodeElement extends UiElementBase {
|
|
215
358
|
/**
|
|
216
359
|
* Discriminator type
|
|
@@ -218,14 +361,29 @@ export interface StringCodeElement extends UiElementBase {
|
|
|
218
361
|
* @defaultValue "string-code"
|
|
219
362
|
*/
|
|
220
363
|
readonly type: "string-code";
|
|
221
|
-
/**
|
|
364
|
+
/**
|
|
365
|
+
* Text value
|
|
366
|
+
*
|
|
367
|
+
* @remarks
|
|
368
|
+
* Code or text snippet to display. Include any desired line breaks in this string.
|
|
369
|
+
*/
|
|
222
370
|
readonly value: string;
|
|
223
|
-
/**
|
|
371
|
+
/**
|
|
372
|
+
* Optional syntax highlighting language identifier
|
|
373
|
+
*
|
|
374
|
+
* @remarks
|
|
375
|
+
* Optional syntax hint for the renderer. Supported values describe highlighting modes and do not validate the snippet's syntax.
|
|
376
|
+
*/
|
|
224
377
|
readonly language?: CodeLanguage;
|
|
225
378
|
/** Optional visual modifiers (copyable) */
|
|
226
379
|
readonly modifiers?: BaseModifiers;
|
|
227
380
|
}
|
|
228
|
-
/**
|
|
381
|
+
/**
|
|
382
|
+
* XML markup code block element.
|
|
383
|
+
*
|
|
384
|
+
* @remarks
|
|
385
|
+
* Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
|
|
386
|
+
*/
|
|
229
387
|
export interface XmlElement extends UiElementBase {
|
|
230
388
|
/**
|
|
231
389
|
* Discriminator type
|
|
@@ -233,12 +391,22 @@ export interface XmlElement extends UiElementBase {
|
|
|
233
391
|
* @defaultValue "xml"
|
|
234
392
|
*/
|
|
235
393
|
readonly type: "xml";
|
|
236
|
-
/**
|
|
394
|
+
/**
|
|
395
|
+
* XML content value
|
|
396
|
+
*
|
|
397
|
+
* @remarks
|
|
398
|
+
* XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
|
|
399
|
+
*/
|
|
237
400
|
readonly value: string;
|
|
238
401
|
/** Optional visual modifiers (copyable) */
|
|
239
402
|
readonly modifiers?: BaseModifiers;
|
|
240
403
|
}
|
|
241
|
-
/**
|
|
404
|
+
/**
|
|
405
|
+
* JSON data or structure representation element.
|
|
406
|
+
*
|
|
407
|
+
* @remarks
|
|
408
|
+
* Specialized representation for JSON text. Supply serialized JSON when consumers should display a JSON document; this field is a string and is not structurally validated here.
|
|
409
|
+
*/
|
|
242
410
|
export interface JsonElement extends UiElementBase {
|
|
243
411
|
/**
|
|
244
412
|
* Discriminator type
|
|
@@ -246,12 +414,22 @@ export interface JsonElement extends UiElementBase {
|
|
|
246
414
|
* @defaultValue "json"
|
|
247
415
|
*/
|
|
248
416
|
readonly type: "json";
|
|
249
|
-
/**
|
|
417
|
+
/**
|
|
418
|
+
* JSON content value
|
|
419
|
+
*
|
|
420
|
+
* @remarks
|
|
421
|
+
* Serialized JSON text to render. No parsing or schema validation is implied by this element.
|
|
422
|
+
*/
|
|
250
423
|
readonly value: string;
|
|
251
424
|
/** Optional visual modifiers (copyable) */
|
|
252
425
|
readonly modifiers?: BaseModifiers;
|
|
253
426
|
}
|
|
254
|
-
/**
|
|
427
|
+
/**
|
|
428
|
+
* Hyperlink representation for external or internal URL navigation.
|
|
429
|
+
*
|
|
430
|
+
* @remarks
|
|
431
|
+
* Use this element when displayed text should also behave as a link. Unlike StringElement, the value is a navigation destination and may be paired with a separate human-readable label.
|
|
432
|
+
*/
|
|
255
433
|
export interface StringUrlElement extends UiElementBase {
|
|
256
434
|
/**
|
|
257
435
|
* Discriminator type
|
|
@@ -259,14 +437,24 @@ export interface StringUrlElement extends UiElementBase {
|
|
|
259
437
|
* @defaultValue "string-url"
|
|
260
438
|
*/
|
|
261
439
|
readonly type: "string-url";
|
|
262
|
-
/**
|
|
440
|
+
/**
|
|
441
|
+
* Target URL or navigation destination
|
|
442
|
+
*
|
|
443
|
+
* @remarks
|
|
444
|
+
* Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
|
|
445
|
+
*/
|
|
263
446
|
readonly value: string;
|
|
264
447
|
/** Optional custom anchor text label */
|
|
265
448
|
readonly label?: string;
|
|
266
449
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
267
450
|
readonly modifiers?: PrimitiveModifiers;
|
|
268
451
|
}
|
|
269
|
-
/**
|
|
452
|
+
/**
|
|
453
|
+
* Monospace semantic identifier representation.
|
|
454
|
+
*
|
|
455
|
+
* @remarks
|
|
456
|
+
* Use for identifiers, hashes, and other machine-oriented strings that benefit from monospace styling. The value remains text and is not resolved as a Picteus entity.
|
|
457
|
+
*/
|
|
270
458
|
export interface IdentifierElement extends UiElementBase {
|
|
271
459
|
/**
|
|
272
460
|
* Discriminator type
|
|
@@ -274,12 +462,22 @@ export interface IdentifierElement extends UiElementBase {
|
|
|
274
462
|
* @defaultValue "identifier"
|
|
275
463
|
*/
|
|
276
464
|
readonly type: "identifier";
|
|
277
|
-
/**
|
|
465
|
+
/**
|
|
466
|
+
* Identifier string value
|
|
467
|
+
*
|
|
468
|
+
* @remarks
|
|
469
|
+
* Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
|
|
470
|
+
*/
|
|
278
471
|
readonly value: string;
|
|
279
472
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
280
473
|
readonly modifiers?: PrimitiveModifiers;
|
|
281
474
|
}
|
|
282
|
-
/**
|
|
475
|
+
/**
|
|
476
|
+
* Aspect ratio representation (e.g. "16:9", "4:3", "1:1").
|
|
477
|
+
*
|
|
478
|
+
* @remarks
|
|
479
|
+
* Displays a numeric aspect ratio as a ratio expression. Provide a positive value meaningful to the surrounding content; this type does not encode the source image dimensions.
|
|
480
|
+
*/
|
|
283
481
|
export interface RatioElement extends UiElementBase {
|
|
284
482
|
/**
|
|
285
483
|
* Discriminator type
|
|
@@ -287,12 +485,22 @@ export interface RatioElement extends UiElementBase {
|
|
|
287
485
|
* @defaultValue "ratio"
|
|
288
486
|
*/
|
|
289
487
|
readonly type: "ratio";
|
|
290
|
-
/**
|
|
488
|
+
/**
|
|
489
|
+
* Aspect ratio numerical expression
|
|
490
|
+
*
|
|
491
|
+
* @remarks
|
|
492
|
+
* Numeric ratio value used by the renderer to produce an aspect-ratio display.
|
|
493
|
+
*/
|
|
291
494
|
readonly value: number;
|
|
292
495
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
293
496
|
readonly modifiers?: PrimitiveModifiers;
|
|
294
497
|
}
|
|
295
|
-
/**
|
|
498
|
+
/**
|
|
499
|
+
* Image dimensions representation displaying formatted width and height in pixels.
|
|
500
|
+
*
|
|
501
|
+
* @remarks
|
|
502
|
+
* Displays a width/height pair as image dimensions. Both values are positive pixel counts; together they describe dimensions, not an aspect ratio or a resize request.
|
|
503
|
+
*/
|
|
296
504
|
export interface DimensionsElement extends UiElementBase {
|
|
297
505
|
/**
|
|
298
506
|
* Discriminator type
|
|
@@ -300,14 +508,29 @@ export interface DimensionsElement extends UiElementBase {
|
|
|
300
508
|
* @defaultValue "dimensions"
|
|
301
509
|
*/
|
|
302
510
|
readonly type: "dimensions";
|
|
303
|
-
/**
|
|
511
|
+
/**
|
|
512
|
+
* Width in pixels
|
|
513
|
+
*
|
|
514
|
+
* @remarks
|
|
515
|
+
* Horizontal pixel count. Values below one are rejected by the schema constraint.
|
|
516
|
+
*/
|
|
304
517
|
readonly width: number;
|
|
305
|
-
/**
|
|
518
|
+
/**
|
|
519
|
+
* Height in pixels
|
|
520
|
+
*
|
|
521
|
+
* @remarks
|
|
522
|
+
* Vertical pixel count. Values below one are rejected by the schema constraint.
|
|
523
|
+
*/
|
|
306
524
|
readonly height: number;
|
|
307
525
|
/** Optional visual modifiers (copyable) */
|
|
308
526
|
readonly modifiers?: BaseModifiers;
|
|
309
527
|
}
|
|
310
|
-
/**
|
|
528
|
+
/**
|
|
529
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
530
|
+
*
|
|
531
|
+
* @remarks
|
|
532
|
+
* Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
|
|
533
|
+
*/
|
|
311
534
|
export interface ColourElement extends UiElementBase {
|
|
312
535
|
/**
|
|
313
536
|
* Discriminator type
|
|
@@ -315,32 +538,56 @@ export interface ColourElement extends UiElementBase {
|
|
|
315
538
|
* @defaultValue "color"
|
|
316
539
|
*/
|
|
317
540
|
readonly type: "color";
|
|
318
|
-
/**
|
|
541
|
+
/**
|
|
542
|
+
* Hexadecimal color code
|
|
543
|
+
*
|
|
544
|
+
* @remarks
|
|
545
|
+
* Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
546
|
+
*/
|
|
319
547
|
readonly value: string;
|
|
320
|
-
/**
|
|
548
|
+
/**
|
|
549
|
+
* Optional descriptive color name label
|
|
550
|
+
*
|
|
551
|
+
* @remarks
|
|
552
|
+
* Human-readable color name available to the renderer when text is shown.
|
|
553
|
+
*/
|
|
321
554
|
readonly label?: string;
|
|
322
555
|
/**
|
|
323
556
|
* Whether to display the textual color code or label next to the swatch
|
|
324
557
|
*
|
|
558
|
+
* @remarks
|
|
559
|
+
* When true, allows the renderer to show the color's text label alongside the swatch. The default is true.
|
|
560
|
+
*
|
|
325
561
|
* @defaultValue true
|
|
326
562
|
*/
|
|
327
563
|
readonly showText?: boolean;
|
|
328
564
|
/**
|
|
329
565
|
* Visual shape of the color indicator
|
|
330
566
|
*
|
|
567
|
+
* @remarks
|
|
568
|
+
* Geometry used for the swatch; defaults to a circle.
|
|
569
|
+
*
|
|
331
570
|
* @defaultValue Shape.circle
|
|
332
571
|
*/
|
|
333
572
|
readonly shape?: Shape;
|
|
334
573
|
/**
|
|
335
574
|
* Visual size of the color indicator
|
|
336
575
|
*
|
|
576
|
+
* @remarks
|
|
577
|
+
* Relative size class for the swatch; defaults to medium.
|
|
578
|
+
*
|
|
337
579
|
* @defaultValue Size.medium
|
|
338
580
|
*/
|
|
339
581
|
readonly size?: Size;
|
|
340
582
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
341
583
|
readonly modifiers?: PrimitiveModifiers;
|
|
342
584
|
}
|
|
343
|
-
/**
|
|
585
|
+
/**
|
|
586
|
+
* Plain unbounded numeric value primitive element.
|
|
587
|
+
*
|
|
588
|
+
* @remarks
|
|
589
|
+
* Displays a numeric value without a progress scale or rating interpretation. Use unit to communicate the measurement context; no range is imposed by this model.
|
|
590
|
+
*/
|
|
344
591
|
export interface NumberUnboundedElement extends UiElementBase {
|
|
345
592
|
/**
|
|
346
593
|
* Discriminator type
|
|
@@ -348,14 +595,29 @@ export interface NumberUnboundedElement extends UiElementBase {
|
|
|
348
595
|
* @defaultValue "number-unbounded"
|
|
349
596
|
*/
|
|
350
597
|
readonly type: "number-unbounded";
|
|
351
|
-
/**
|
|
598
|
+
/**
|
|
599
|
+
* Numeric value
|
|
600
|
+
*
|
|
601
|
+
* @remarks
|
|
602
|
+
* Number to display. Its meaning and any valid range are defined by the producing feature.
|
|
603
|
+
*/
|
|
352
604
|
readonly value: number;
|
|
353
|
-
/**
|
|
605
|
+
/**
|
|
606
|
+
* Optional unit suffix (e.g. "px", "ms", "MB")
|
|
607
|
+
*
|
|
608
|
+
* @remarks
|
|
609
|
+
* Short unit label appended or otherwise associated with the displayed value. Include only the unit text, not a second copy of the number.
|
|
610
|
+
*/
|
|
354
611
|
readonly unit?: string;
|
|
355
612
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
356
613
|
readonly modifiers?: PrimitiveModifiers;
|
|
357
614
|
}
|
|
358
|
-
/**
|
|
615
|
+
/**
|
|
616
|
+
* Bounded numeric rating represented as visual stars.
|
|
617
|
+
*
|
|
618
|
+
* @remarks
|
|
619
|
+
* Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
|
|
620
|
+
*/
|
|
359
621
|
export interface NumberBoundedStarsElement extends UiElementBase {
|
|
360
622
|
/**
|
|
361
623
|
* Discriminator type
|
|
@@ -363,14 +625,29 @@ export interface NumberBoundedStarsElement extends UiElementBase {
|
|
|
363
625
|
* @defaultValue "number-stars"
|
|
364
626
|
*/
|
|
365
627
|
readonly type: "number-stars";
|
|
366
|
-
/**
|
|
628
|
+
/**
|
|
629
|
+
* Numeric rating score
|
|
630
|
+
*
|
|
631
|
+
* @remarks
|
|
632
|
+
* Score represented by the filled portion of the star display.
|
|
633
|
+
*/
|
|
367
634
|
readonly value: number;
|
|
368
|
-
/**
|
|
635
|
+
/**
|
|
636
|
+
* Maximum rating scale (defaults to 5)
|
|
637
|
+
*
|
|
638
|
+
* @remarks
|
|
639
|
+
* Upper end of the rating scale. When omitted, the scale is five; value should use the same scale.
|
|
640
|
+
*/
|
|
369
641
|
readonly maximum?: number;
|
|
370
642
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
371
643
|
readonly modifiers?: PrimitiveModifiers;
|
|
372
644
|
}
|
|
373
|
-
/**
|
|
645
|
+
/**
|
|
646
|
+
* Bounded numeric meter representation (read-only progress / score bar).
|
|
647
|
+
*
|
|
648
|
+
* @remarks
|
|
649
|
+
* Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
|
|
650
|
+
*/
|
|
374
651
|
export interface NumberBoundedMeterElement extends UiElementBase {
|
|
375
652
|
/**
|
|
376
653
|
* Discriminator type
|
|
@@ -378,22 +655,49 @@ export interface NumberBoundedMeterElement extends UiElementBase {
|
|
|
378
655
|
* @defaultValue "number-meter"
|
|
379
656
|
*/
|
|
380
657
|
readonly type: "number-meter";
|
|
381
|
-
/**
|
|
658
|
+
/**
|
|
659
|
+
* Numeric value
|
|
660
|
+
*
|
|
661
|
+
* @remarks
|
|
662
|
+
* Current measurement or score represented by the meter.
|
|
663
|
+
*/
|
|
382
664
|
readonly value: number;
|
|
383
|
-
/**
|
|
665
|
+
/**
|
|
666
|
+
* Minimum scale bound (defaults to 0)
|
|
667
|
+
*
|
|
668
|
+
* @remarks
|
|
669
|
+
* Lower end of the meter range. Defaults to zero when omitted.
|
|
670
|
+
*/
|
|
384
671
|
readonly minimum?: number;
|
|
385
|
-
/**
|
|
672
|
+
/**
|
|
673
|
+
* Maximum scale bound (e.g. 100)
|
|
674
|
+
*
|
|
675
|
+
* @remarks
|
|
676
|
+
* Upper end of the meter range. Choose a bound consistent with value and minimum.
|
|
677
|
+
*/
|
|
386
678
|
readonly maximum?: number;
|
|
387
|
-
/**
|
|
679
|
+
/**
|
|
680
|
+
* Optional custom text label override (e.g. "68 / 100")
|
|
681
|
+
*
|
|
682
|
+
* @remarks
|
|
683
|
+
* Optional readout text to use instead of a renderer-generated value and range label.
|
|
684
|
+
*/
|
|
388
685
|
readonly label?: string;
|
|
389
|
-
/**
|
|
686
|
+
/**
|
|
687
|
+
* Optional unit suffix (e.g. "%")
|
|
688
|
+
*
|
|
689
|
+
* @remarks
|
|
690
|
+
* Unit associated with the value, such as a percent sign. This affects display only and does not convert the numeric value.
|
|
691
|
+
*/
|
|
390
692
|
readonly unit?: string;
|
|
391
693
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
392
694
|
readonly modifiers?: PrimitiveModifiers;
|
|
393
695
|
}
|
|
394
696
|
/**
|
|
395
|
-
*
|
|
396
|
-
*
|
|
697
|
+
* Boolean value primitive with text or badge presentation.
|
|
698
|
+
*
|
|
699
|
+
* @remarks
|
|
700
|
+
* Displays a boolean state using text or a badge. The representation determines whether true/false labels or a colored badge are used; configured labels and variant are presentation choices only.
|
|
397
701
|
*/
|
|
398
702
|
export interface BooleanElement extends UiElementBase {
|
|
399
703
|
/**
|
|
@@ -402,36 +706,58 @@ export interface BooleanElement extends UiElementBase {
|
|
|
402
706
|
* @defaultValue "boolean"
|
|
403
707
|
*/
|
|
404
708
|
readonly type: "boolean";
|
|
405
|
-
/**
|
|
709
|
+
/**
|
|
710
|
+
* Boolean state value
|
|
711
|
+
*
|
|
712
|
+
* @remarks
|
|
713
|
+
* State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
|
|
714
|
+
*/
|
|
406
715
|
readonly value: boolean;
|
|
407
716
|
/**
|
|
408
717
|
* Display representation mode
|
|
409
718
|
*
|
|
719
|
+
* @remarks
|
|
720
|
+
* Selects ordinary text or a badge pill. Badge color applies only to badge presentation.
|
|
721
|
+
*
|
|
410
722
|
* @defaultValue BooleanRepresentation.plain
|
|
411
723
|
*/
|
|
412
724
|
readonly representation?: BooleanRepresentation;
|
|
413
725
|
/**
|
|
414
726
|
* Custom display label when true (defaults to "true")
|
|
415
727
|
*
|
|
728
|
+
* @remarks
|
|
729
|
+
* Text used for the true state in plain representation. Defaults to the literal text true.
|
|
730
|
+
*
|
|
416
731
|
* @defaultValue "true"
|
|
417
732
|
*/
|
|
418
733
|
readonly trueLabel?: string;
|
|
419
734
|
/**
|
|
420
735
|
* Custom display label when false (defaults to "false")
|
|
421
736
|
*
|
|
737
|
+
* @remarks
|
|
738
|
+
* Text used for the false state in plain representation. Defaults to the literal text false.
|
|
739
|
+
*
|
|
422
740
|
* @defaultValue "false"
|
|
423
741
|
*/
|
|
424
742
|
readonly falseLabel?: string;
|
|
425
743
|
/**
|
|
426
744
|
* Badge color tone when rendered as badge
|
|
427
745
|
*
|
|
746
|
+
* @remarks
|
|
747
|
+
* Semantic color treatment for badge presentation; it has no effect in plain representation.
|
|
748
|
+
*
|
|
428
749
|
* @defaultValue BadgeVariant.neutral
|
|
429
750
|
*/
|
|
430
751
|
readonly variant?: BadgeVariant;
|
|
431
752
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
432
753
|
readonly modifiers?: PrimitiveModifiers;
|
|
433
754
|
}
|
|
434
|
-
/**
|
|
755
|
+
/**
|
|
756
|
+
* Formatted date and time representation.
|
|
757
|
+
*
|
|
758
|
+
* @remarks
|
|
759
|
+
* Displays an epoch timestamp using a selected date/time format. The input is a count of milliseconds, not seconds; relative formatting is interpreted by the consumer.
|
|
760
|
+
*/
|
|
435
761
|
export interface TimestampElement extends UiElementBase {
|
|
436
762
|
/**
|
|
437
763
|
* Discriminator type
|
|
@@ -439,18 +765,31 @@ export interface TimestampElement extends UiElementBase {
|
|
|
439
765
|
* @defaultValue "timestamp"
|
|
440
766
|
*/
|
|
441
767
|
readonly type: "timestamp";
|
|
442
|
-
/**
|
|
768
|
+
/**
|
|
769
|
+
* The timestamp in milliseconds
|
|
770
|
+
*
|
|
771
|
+
* @remarks
|
|
772
|
+
* Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
|
|
773
|
+
*/
|
|
443
774
|
readonly value: number;
|
|
444
775
|
/**
|
|
445
776
|
* Presentation date/time format
|
|
446
777
|
*
|
|
778
|
+
* @remarks
|
|
779
|
+
* Controls whether the timestamp is shown as date and time, date only, time only, or relative text. The default is datetime.
|
|
780
|
+
*
|
|
447
781
|
* @defaultValue TimestampFormat.datetime
|
|
448
782
|
*/
|
|
449
783
|
readonly format?: TimestampFormat;
|
|
450
784
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
451
785
|
readonly modifiers?: PrimitiveModifiers;
|
|
452
786
|
}
|
|
453
|
-
/**
|
|
787
|
+
/**
|
|
788
|
+
* Thumbnail image reference with placeholder fallback handling.
|
|
789
|
+
*
|
|
790
|
+
* @remarks
|
|
791
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
792
|
+
*/
|
|
454
793
|
export interface ImageReferenceElement extends UiElementBase {
|
|
455
794
|
/**
|
|
456
795
|
* Discriminator type
|
|
@@ -458,20 +797,43 @@ export interface ImageReferenceElement extends UiElementBase {
|
|
|
458
797
|
* @defaultValue "image-ref"
|
|
459
798
|
*/
|
|
460
799
|
readonly type: "image-ref";
|
|
461
|
-
/**
|
|
800
|
+
/**
|
|
801
|
+
* Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
802
|
+
*
|
|
803
|
+
* @remarks
|
|
804
|
+
* Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
|
|
805
|
+
*/
|
|
462
806
|
readonly src: string;
|
|
463
|
-
/**
|
|
807
|
+
/**
|
|
808
|
+
* Accessible alternative description
|
|
809
|
+
*
|
|
810
|
+
* @remarks
|
|
811
|
+
* Alternative text describing the image for assistive technology. Provide meaningful text when the image conveys information; omit it only when it is decorative.
|
|
812
|
+
*/
|
|
464
813
|
readonly alt?: string;
|
|
465
814
|
/**
|
|
466
815
|
* Aspect ratio of the thumbnail container
|
|
467
816
|
*
|
|
817
|
+
* @remarks
|
|
818
|
+
* Preferred ratio of the rendered thumbnail container, expressed as a ratio string such as 1:1. It controls presentation rather than modifying the source image.
|
|
819
|
+
*
|
|
468
820
|
* @defaultValue "1:1"
|
|
469
821
|
*/
|
|
470
822
|
readonly aspectRatio?: string;
|
|
471
|
-
/**
|
|
823
|
+
/**
|
|
824
|
+
* Fallback placeholder image URI
|
|
825
|
+
*
|
|
826
|
+
* @remarks
|
|
827
|
+
* Optional source to display when the primary image cannot be loaded. It follows the same URI conventions as src.
|
|
828
|
+
*/
|
|
472
829
|
readonly placeholder?: string;
|
|
473
830
|
}
|
|
474
|
-
/**
|
|
831
|
+
/**
|
|
832
|
+
* Interactive button action triggering an extension command.
|
|
833
|
+
*
|
|
834
|
+
* @remarks
|
|
835
|
+
* When activated, the client dispatches commandId to the specified extension and may include target and parameters as command input. disabled and variant affect presentation and availability, not the command's authorization.
|
|
836
|
+
*/
|
|
475
837
|
export interface ButtonActionElement extends UiActionBase {
|
|
476
838
|
/**
|
|
477
839
|
* Discriminator type
|
|
@@ -479,28 +841,59 @@ export interface ButtonActionElement extends UiActionBase {
|
|
|
479
841
|
* @defaultValue "button"
|
|
480
842
|
*/
|
|
481
843
|
readonly type: "button";
|
|
482
|
-
/**
|
|
844
|
+
/**
|
|
845
|
+
* Extension identifier owning the target command
|
|
846
|
+
*
|
|
847
|
+
* @remarks
|
|
848
|
+
* Extension that registers commandId. Omit only when the client can resolve the command in the current extension context.
|
|
849
|
+
*/
|
|
483
850
|
readonly extensionId?: string;
|
|
484
|
-
/**
|
|
851
|
+
/**
|
|
852
|
+
* Command identifier to invoke
|
|
853
|
+
*
|
|
854
|
+
* @remarks
|
|
855
|
+
* Identifier of the registered extension command to dispatch when the button is activated.
|
|
856
|
+
*/
|
|
485
857
|
readonly commandId: string;
|
|
486
|
-
/**
|
|
858
|
+
/**
|
|
859
|
+
* Target entity or context identifier
|
|
860
|
+
*
|
|
861
|
+
* @remarks
|
|
862
|
+
* Optional entity or context identifier forwarded to the command handler. Its format is determined by the target extension.
|
|
863
|
+
*/
|
|
487
864
|
readonly target?: string;
|
|
488
|
-
/**
|
|
865
|
+
/**
|
|
866
|
+
* Optional arbitrary parameters payload forwarded to the command handler
|
|
867
|
+
*
|
|
868
|
+
* @remarks
|
|
869
|
+
* JSON-compatible arguments passed to the extension command. Define and validate their shape in the command implementation.
|
|
870
|
+
*/
|
|
489
871
|
readonly parameters?: Record<string, unknown>;
|
|
490
872
|
/**
|
|
491
873
|
* Whether the button is disabled / unavailable
|
|
492
874
|
*
|
|
875
|
+
* @remarks
|
|
876
|
+
* When true, the client renders the action as unavailable and should not dispatch it from user activation.
|
|
877
|
+
*
|
|
493
878
|
* @defaultValue false
|
|
494
879
|
*/
|
|
495
880
|
readonly disabled?: boolean;
|
|
496
881
|
/**
|
|
497
882
|
* Button visual style variant
|
|
498
883
|
*
|
|
884
|
+
* @remarks
|
|
885
|
+
* Selects the button's emphasis style. Use danger for destructive operations and primary for the main recommended action; the variant does not change behavior.
|
|
886
|
+
*
|
|
499
887
|
* @defaultValue ButtonVariant.secondary
|
|
500
888
|
*/
|
|
501
889
|
readonly variant?: ButtonVariant;
|
|
502
890
|
}
|
|
503
|
-
/**
|
|
891
|
+
/**
|
|
892
|
+
* External link action distinct from inline URL text values.
|
|
893
|
+
*
|
|
894
|
+
* @remarks
|
|
895
|
+
* Renders a user-invokable action that opens a destination externally. Use StringUrlElement for a link embedded in content rather than an action control.
|
|
896
|
+
*/
|
|
504
897
|
export interface ExternalLinkActionElement extends UiActionBase {
|
|
505
898
|
/**
|
|
506
899
|
* Discriminator type
|
|
@@ -508,10 +901,20 @@ export interface ExternalLinkActionElement extends UiActionBase {
|
|
|
508
901
|
* @defaultValue "external-link"
|
|
509
902
|
*/
|
|
510
903
|
readonly type: "external-link";
|
|
511
|
-
/**
|
|
904
|
+
/**
|
|
905
|
+
* Target URL destination
|
|
906
|
+
*
|
|
907
|
+
* @remarks
|
|
908
|
+
* External destination opened when the user activates the link action. The client controls how external navigation is handed to the platform.
|
|
909
|
+
*/
|
|
512
910
|
readonly url: string;
|
|
513
911
|
}
|
|
514
|
-
/**
|
|
912
|
+
/**
|
|
913
|
+
* Full Markdown fallback block rendered with core typographic hierarchy, spacing, and styling.
|
|
914
|
+
*
|
|
915
|
+
* @remarks
|
|
916
|
+
* Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
|
|
917
|
+
*/
|
|
515
918
|
export interface MarkdownBlockElement extends UiElementBase {
|
|
516
919
|
/**
|
|
517
920
|
* Discriminator type
|
|
@@ -519,12 +922,22 @@ export interface MarkdownBlockElement extends UiElementBase {
|
|
|
519
922
|
* @defaultValue "markdown"
|
|
520
923
|
*/
|
|
521
924
|
readonly type: "markdown";
|
|
522
|
-
/**
|
|
925
|
+
/**
|
|
926
|
+
* Raw Markdown markup content
|
|
927
|
+
*
|
|
928
|
+
* @remarks
|
|
929
|
+
* Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
930
|
+
*/
|
|
523
931
|
readonly content: string;
|
|
524
932
|
/** Optional visual modifiers (copyable) */
|
|
525
933
|
readonly modifiers?: BaseModifiers;
|
|
526
934
|
}
|
|
527
|
-
/**
|
|
935
|
+
/**
|
|
936
|
+
* Sandboxed HTML rendering escape hatch.
|
|
937
|
+
*
|
|
938
|
+
* @remarks
|
|
939
|
+
* Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
|
|
940
|
+
*/
|
|
528
941
|
export interface HtmlBlockElement extends UiElementBase {
|
|
529
942
|
/**
|
|
530
943
|
* Discriminator type
|
|
@@ -532,21 +945,51 @@ export interface HtmlBlockElement extends UiElementBase {
|
|
|
532
945
|
* @defaultValue "html"
|
|
533
946
|
*/
|
|
534
947
|
readonly type: "html";
|
|
535
|
-
/**
|
|
948
|
+
/**
|
|
949
|
+
* Raw HTML markup content
|
|
950
|
+
*
|
|
951
|
+
* @remarks
|
|
952
|
+
* HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
953
|
+
*/
|
|
536
954
|
readonly content: string;
|
|
537
955
|
/** Optional visual modifiers (copyable) */
|
|
538
956
|
readonly modifiers?: BaseModifiers;
|
|
539
957
|
}
|
|
540
|
-
/**
|
|
958
|
+
/**
|
|
959
|
+
* Single slot within a multi-slot horizontal row layout.
|
|
960
|
+
*
|
|
961
|
+
* @remarks
|
|
962
|
+
* A slot combines an optional label, a relative width, and one visual child. Slot widths are percentages of the row and should be chosen so the full row's widths form a usable layout.
|
|
963
|
+
*/
|
|
541
964
|
export interface Slot {
|
|
542
|
-
/**
|
|
965
|
+
/**
|
|
966
|
+
* Optional slot label (e.g. "Slot A")
|
|
967
|
+
*
|
|
968
|
+
* @remarks
|
|
969
|
+
* Short text identifying this region of the row. It is independent of the rendered content.
|
|
970
|
+
*/
|
|
543
971
|
readonly label?: string;
|
|
544
|
-
/**
|
|
972
|
+
/**
|
|
973
|
+
* Width percentage (1-100)
|
|
974
|
+
*
|
|
975
|
+
* @remarks
|
|
976
|
+
* Relative share of the row width. The schema constrains explicit values to the inclusive range 1 through 100.
|
|
977
|
+
*/
|
|
545
978
|
readonly width?: number;
|
|
546
|
-
/**
|
|
979
|
+
/**
|
|
980
|
+
* Rendered content inside the slot
|
|
981
|
+
*
|
|
982
|
+
* @remarks
|
|
983
|
+
* One visual element displayed in this slot. Use a nested layout element when the slot itself needs multiple children.
|
|
984
|
+
*/
|
|
547
985
|
readonly content: UiElement;
|
|
548
986
|
}
|
|
549
|
-
/**
|
|
987
|
+
/**
|
|
988
|
+
* Horizontal row layout with individually sized slots.
|
|
989
|
+
*
|
|
990
|
+
* @remarks
|
|
991
|
+
* Use this layout when a row needs explicit regions with independently controlled widths. Each slot contains one child element; unlike FlowingElement, the layout does not automatically wrap a sequence of children.
|
|
992
|
+
*/
|
|
550
993
|
export interface MultiSlotElement extends UiElementBase {
|
|
551
994
|
/**
|
|
552
995
|
* Discriminator type
|
|
@@ -554,12 +997,19 @@ export interface MultiSlotElement extends UiElementBase {
|
|
|
554
997
|
* @defaultValue "multi-slot"
|
|
555
998
|
*/
|
|
556
999
|
readonly type: "multi-slot";
|
|
557
|
-
/**
|
|
1000
|
+
/**
|
|
1001
|
+
* List of slots comprising the row
|
|
1002
|
+
*
|
|
1003
|
+
* @remarks
|
|
1004
|
+
* Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
|
|
1005
|
+
*/
|
|
558
1006
|
readonly slots: Slot[];
|
|
559
1007
|
}
|
|
560
1008
|
/**
|
|
561
|
-
*
|
|
562
|
-
*
|
|
1009
|
+
* Inline layout container that wraps child elements.
|
|
1010
|
+
*
|
|
1011
|
+
* @remarks
|
|
1012
|
+
* Use for compact related values that should flow horizontally and wrap naturally at the available width. Child order is preserved; an optional separator is placed between neighboring children.
|
|
563
1013
|
*/
|
|
564
1014
|
export interface FlowingElement extends UiElementBase {
|
|
565
1015
|
/**
|
|
@@ -568,14 +1018,26 @@ export interface FlowingElement extends UiElementBase {
|
|
|
568
1018
|
* @defaultValue "flowing"
|
|
569
1019
|
*/
|
|
570
1020
|
readonly type: "flowing";
|
|
571
|
-
/**
|
|
1021
|
+
/**
|
|
1022
|
+
* Optional visual separator rendered between sequential child elements
|
|
1023
|
+
*
|
|
1024
|
+
* @remarks
|
|
1025
|
+
* Separator placed between adjacent elements. Omit it when spacing or the child renderers already provide sufficient separation.
|
|
1026
|
+
*/
|
|
572
1027
|
readonly separator?: Separator;
|
|
573
|
-
/**
|
|
1028
|
+
/**
|
|
1029
|
+
* List of child elements rendered sequentially with line wrapping
|
|
1030
|
+
*
|
|
1031
|
+
* @remarks
|
|
1032
|
+
* Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
|
|
1033
|
+
*/
|
|
574
1034
|
readonly elements: UiElement[];
|
|
575
1035
|
}
|
|
576
1036
|
/**
|
|
577
|
-
*
|
|
578
|
-
*
|
|
1037
|
+
* Label and value row with an optional divider.
|
|
1038
|
+
*
|
|
1039
|
+
* @remarks
|
|
1040
|
+
* Represents one named value with a muted left-hand label and a right-hand visual element. Use it for a single field; use TableElement for repeated rows or column-aligned data.
|
|
579
1041
|
*/
|
|
580
1042
|
export interface LabelValueElement extends UiElementBase {
|
|
581
1043
|
/**
|
|
@@ -584,44 +1046,90 @@ export interface LabelValueElement extends UiElementBase {
|
|
|
584
1046
|
* @defaultValue "label-value"
|
|
585
1047
|
*/
|
|
586
1048
|
readonly type: "label-value";
|
|
587
|
-
/**
|
|
1049
|
+
/**
|
|
1050
|
+
* Key or descriptive label displayed muted on the left
|
|
1051
|
+
*
|
|
1052
|
+
* @remarks
|
|
1053
|
+
* Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
|
|
1054
|
+
*/
|
|
588
1055
|
readonly label: string;
|
|
589
|
-
/**
|
|
1056
|
+
/**
|
|
1057
|
+
* Rendered value element on the right
|
|
1058
|
+
*
|
|
1059
|
+
* @remarks
|
|
1060
|
+
* Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
|
|
1061
|
+
*/
|
|
590
1062
|
readonly value: UiElement;
|
|
591
1063
|
/**
|
|
592
1064
|
* Whether to render a bottom border/hairline divider
|
|
593
1065
|
*
|
|
1066
|
+
* @remarks
|
|
1067
|
+
* Enables a horizontal separator beneath this row when true. Defaults to false.
|
|
1068
|
+
*
|
|
594
1069
|
* @defaultValue false
|
|
595
1070
|
*/
|
|
596
1071
|
readonly withDivider?: boolean;
|
|
597
1072
|
}
|
|
598
|
-
/**
|
|
1073
|
+
/**
|
|
1074
|
+
* Column definition for structured tables.
|
|
1075
|
+
*
|
|
1076
|
+
* @remarks
|
|
1077
|
+
* Describes one table column and its visual sizing. When columns are supplied, their order corresponds to the position of each cell in a row.
|
|
1078
|
+
*/
|
|
599
1079
|
export interface TableColumn {
|
|
600
|
-
/**
|
|
1080
|
+
/**
|
|
1081
|
+
* Display header text
|
|
1082
|
+
*
|
|
1083
|
+
* @remarks
|
|
1084
|
+
* Optional header shown above values in this column. Omit when the table has no header row.
|
|
1085
|
+
*/
|
|
601
1086
|
readonly header?: string;
|
|
602
1087
|
/**
|
|
603
1088
|
* Text horizontal alignment
|
|
604
1089
|
*
|
|
1090
|
+
* @remarks
|
|
1091
|
+
* Horizontal alignment applied to cell content in the column. Defaults to left.
|
|
1092
|
+
*
|
|
605
1093
|
* @defaultValue TableColumnAlign.left
|
|
606
1094
|
*/
|
|
607
1095
|
readonly align?: TableColumnAlign;
|
|
608
|
-
/**
|
|
1096
|
+
/**
|
|
1097
|
+
* Width percentage (1-100)
|
|
1098
|
+
*
|
|
1099
|
+
* @remarks
|
|
1100
|
+
* Column width percentage used with widthMode. Explicit values are constrained to 1 through 100.
|
|
1101
|
+
*/
|
|
609
1102
|
readonly width?: number;
|
|
610
1103
|
/**
|
|
611
1104
|
* Sizing mode for the provided width
|
|
612
1105
|
*
|
|
1106
|
+
* @remarks
|
|
1107
|
+
* Determines whether width is a fixed percentage allocation or an upper bound. Defaults to fixed.
|
|
1108
|
+
*
|
|
613
1109
|
* @defaultValue TableColumnWidthMode.fixed
|
|
614
1110
|
*/
|
|
615
1111
|
readonly widthMode?: TableColumnWidthMode;
|
|
616
1112
|
}
|
|
617
|
-
/**
|
|
1113
|
+
/**
|
|
1114
|
+
* Single table row containing an array of cell values.
|
|
1115
|
+
*
|
|
1116
|
+
* @remarks
|
|
1117
|
+
* A row's cell array is positional: cell at each index corresponds to the column at that index. Keep row lengths aligned with the table's explicit column definitions when present.
|
|
1118
|
+
*/
|
|
618
1119
|
export interface TableRow {
|
|
619
|
-
/**
|
|
1120
|
+
/**
|
|
1121
|
+
* Array of cell values corresponding to table columns
|
|
1122
|
+
*
|
|
1123
|
+
* @remarks
|
|
1124
|
+
* Ordered contents for this row. Each cell is a UiElement so values can use the same primitive and layout renderers as other ViewKit content.
|
|
1125
|
+
*/
|
|
620
1126
|
readonly cells: UiElement[];
|
|
621
1127
|
}
|
|
622
1128
|
/**
|
|
623
|
-
* Structured tabular data
|
|
624
|
-
*
|
|
1129
|
+
* Structured tabular data with optional columns and separators.
|
|
1130
|
+
*
|
|
1131
|
+
* @remarks
|
|
1132
|
+
* Use for data that benefits from aligned rows and columns, including key/value and multi-column tables. Supply rows in display order; explicit columns are optional, and divider/striping flags independently control visual separators and alternating backgrounds.
|
|
625
1133
|
*/
|
|
626
1134
|
export interface TableElement extends UiElementBase {
|
|
627
1135
|
/**
|
|
@@ -633,36 +1141,80 @@ export interface TableElement extends UiElementBase {
|
|
|
633
1141
|
/**
|
|
634
1142
|
* Whether to render alternating row background colors
|
|
635
1143
|
*
|
|
1144
|
+
* @remarks
|
|
1145
|
+
* Enables alternating backgrounds across successive rows to improve scanability. Defaults to false.
|
|
1146
|
+
*
|
|
636
1147
|
* @defaultValue false
|
|
637
1148
|
*/
|
|
638
1149
|
readonly isStriped?: boolean;
|
|
639
1150
|
/**
|
|
640
1151
|
* Whether to render vertical column separators
|
|
641
1152
|
*
|
|
1153
|
+
* @remarks
|
|
1154
|
+
* Adds vertical dividers between columns when true. Defaults to false.
|
|
1155
|
+
*
|
|
642
1156
|
* @defaultValue false
|
|
643
1157
|
*/
|
|
644
1158
|
readonly withColumnSeparators?: boolean;
|
|
645
1159
|
/**
|
|
646
1160
|
* Whether to render horizontal row separators
|
|
647
1161
|
*
|
|
1162
|
+
* @remarks
|
|
1163
|
+
* Adds horizontal dividers between rows when true. Defaults to false.
|
|
1164
|
+
*
|
|
648
1165
|
* @defaultValue false
|
|
649
1166
|
*/
|
|
650
1167
|
readonly withRowSeparators?: boolean;
|
|
651
|
-
/**
|
|
1168
|
+
/**
|
|
1169
|
+
* Optional explicit column definitions
|
|
1170
|
+
*
|
|
1171
|
+
* @remarks
|
|
1172
|
+
* Optional ordered column metadata defining headers, alignment, and width. When omitted, the renderer may infer a basic layout from row cells.
|
|
1173
|
+
*/
|
|
652
1174
|
readonly columns?: TableColumn[];
|
|
653
|
-
/**
|
|
1175
|
+
/**
|
|
1176
|
+
* Tabular data rows
|
|
1177
|
+
*
|
|
1178
|
+
* @remarks
|
|
1179
|
+
* Ordered table rows. Each row's cells correspond positionally to the declared columns.
|
|
1180
|
+
*/
|
|
654
1181
|
readonly rows: TableRow[];
|
|
655
1182
|
}
|
|
656
|
-
/**
|
|
1183
|
+
/**
|
|
1184
|
+
* Single entry within a repeating group.
|
|
1185
|
+
*
|
|
1186
|
+
* @remarks
|
|
1187
|
+
* A repeating entry carries a stable display label and either one primary value or a list of nested elements, depending on the shape needed by the feature.
|
|
1188
|
+
*/
|
|
657
1189
|
export interface RepeatingGroupEntry {
|
|
658
|
-
/**
|
|
1190
|
+
/**
|
|
1191
|
+
* Entry label
|
|
1192
|
+
*
|
|
1193
|
+
* @remarks
|
|
1194
|
+
* Short label identifying this entry within the repeated group.
|
|
1195
|
+
*/
|
|
659
1196
|
readonly label: string;
|
|
660
|
-
/**
|
|
1197
|
+
/**
|
|
1198
|
+
* Primary entry value or nested elements
|
|
1199
|
+
*
|
|
1200
|
+
* @remarks
|
|
1201
|
+
* Optional primary visual value for a compact entry. Use elements for a multi-part structured entry.
|
|
1202
|
+
*/
|
|
661
1203
|
readonly value?: UiElement;
|
|
662
|
-
/**
|
|
1204
|
+
/**
|
|
1205
|
+
* Nested elements for structured entries
|
|
1206
|
+
*
|
|
1207
|
+
* @remarks
|
|
1208
|
+
* Optional ordered content for entries that require more than one value element.
|
|
1209
|
+
*/
|
|
663
1210
|
readonly elements?: UiElement[];
|
|
664
1211
|
}
|
|
665
|
-
/**
|
|
1212
|
+
/**
|
|
1213
|
+
* Repeating group container where entries share uniform structure and retain per-entry labels.
|
|
1214
|
+
*
|
|
1215
|
+
* @remarks
|
|
1216
|
+
* Groups a sequence of labeled entries under one optional section title. Use it when records have the same general presentation but need their own labels.
|
|
1217
|
+
*/
|
|
666
1218
|
export interface RepeatingGroupElement extends UiElementBase {
|
|
667
1219
|
/**
|
|
668
1220
|
* Discriminator type
|
|
@@ -670,12 +1222,27 @@ export interface RepeatingGroupElement extends UiElementBase {
|
|
|
670
1222
|
* @defaultValue "repeating-group"
|
|
671
1223
|
*/
|
|
672
1224
|
readonly type: "repeating-group";
|
|
673
|
-
/**
|
|
1225
|
+
/**
|
|
1226
|
+
* Optional section header for the group
|
|
1227
|
+
*
|
|
1228
|
+
* @remarks
|
|
1229
|
+
* Heading displayed for the repeated section, separate from the labels of individual entries.
|
|
1230
|
+
*/
|
|
674
1231
|
readonly title?: string;
|
|
675
|
-
/**
|
|
1232
|
+
/**
|
|
1233
|
+
* List of repeated entry records
|
|
1234
|
+
*
|
|
1235
|
+
* @remarks
|
|
1236
|
+
* Entries in display order. Each entry supplies its own label and content.
|
|
1237
|
+
*/
|
|
676
1238
|
readonly entries: RepeatingGroupEntry[];
|
|
677
1239
|
}
|
|
678
|
-
/**
|
|
1240
|
+
/**
|
|
1241
|
+
* Collapsible disclosure container (accordion) with summary badge.
|
|
1242
|
+
*
|
|
1243
|
+
* @remarks
|
|
1244
|
+
* Groups nested content behind a disclosure control. The title names the group, summary can provide a compact status indicator, and defaultExpanded controls only the initial state.
|
|
1245
|
+
*/
|
|
679
1246
|
export interface CollapsibleGroupElement extends UiElementBase {
|
|
680
1247
|
/**
|
|
681
1248
|
* Discriminator type
|
|
@@ -683,20 +1250,43 @@ export interface CollapsibleGroupElement extends UiElementBase {
|
|
|
683
1250
|
* @defaultValue "collapsible-group"
|
|
684
1251
|
*/
|
|
685
1252
|
readonly type: "collapsible-group";
|
|
686
|
-
/**
|
|
1253
|
+
/**
|
|
1254
|
+
* Group title (e.g. "Show specimen details")
|
|
1255
|
+
*
|
|
1256
|
+
* @remarks
|
|
1257
|
+
* Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
|
|
1258
|
+
*/
|
|
687
1259
|
readonly title: string;
|
|
688
|
-
/**
|
|
1260
|
+
/**
|
|
1261
|
+
* Secondary summary indicator (e.g. "2 neutral values")
|
|
1262
|
+
*
|
|
1263
|
+
* @remarks
|
|
1264
|
+
* Compact contextual text shown alongside the title while the group is collapsed or expanded. It does not replace the nested content.
|
|
1265
|
+
*/
|
|
689
1266
|
readonly summary?: string;
|
|
690
1267
|
/**
|
|
691
1268
|
* Whether the disclosure is open/expanded by default
|
|
692
1269
|
*
|
|
1270
|
+
* @remarks
|
|
1271
|
+
* Initial expanded state requested by the data. Defaults to false; subsequent interaction is managed by the client.
|
|
1272
|
+
*
|
|
693
1273
|
* @defaultValue false
|
|
694
1274
|
*/
|
|
695
1275
|
readonly defaultExpanded?: boolean;
|
|
696
|
-
/**
|
|
1276
|
+
/**
|
|
1277
|
+
* Nested content elements revealed when expanded
|
|
1278
|
+
*
|
|
1279
|
+
* @remarks
|
|
1280
|
+
* Ordered child elements made visible by expanding the group.
|
|
1281
|
+
*/
|
|
697
1282
|
readonly elements: UiElement[];
|
|
698
1283
|
}
|
|
699
|
-
/**
|
|
1284
|
+
/**
|
|
1285
|
+
* Visual hairline separator separating sections or element groups.
|
|
1286
|
+
*
|
|
1287
|
+
* @remarks
|
|
1288
|
+
* A standalone visual separator for dividing adjacent sections or element groups. Use the divider flags on tables or rows when the separator is part of that structure.
|
|
1289
|
+
*/
|
|
700
1290
|
export interface DividerElement extends UiElementBase {
|
|
701
1291
|
/**
|
|
702
1292
|
* Discriminator type
|
|
@@ -707,56 +1297,108 @@ export interface DividerElement extends UiElementBase {
|
|
|
707
1297
|
/**
|
|
708
1298
|
* Line styling
|
|
709
1299
|
*
|
|
1300
|
+
* @remarks
|
|
1301
|
+
* Visual stroke treatment for the separator. Defaults to a subtle hairline.
|
|
1302
|
+
*
|
|
710
1303
|
* @defaultValue DividerStyle.hairline
|
|
711
1304
|
*/
|
|
712
1305
|
readonly style?: DividerStyle;
|
|
713
1306
|
}
|
|
714
|
-
/**
|
|
1307
|
+
/**
|
|
1308
|
+
* Base envelope containing the schema version.
|
|
1309
|
+
*
|
|
1310
|
+
* @remarks
|
|
1311
|
+
* All root ViewKit documents extend this envelope so consumers can identify the schema contract version before processing the root content.
|
|
1312
|
+
*/
|
|
715
1313
|
export interface Envelop {
|
|
716
1314
|
/**
|
|
717
1315
|
* Schema specification version
|
|
718
1316
|
*
|
|
1317
|
+
* @remarks
|
|
1318
|
+
* Version of the ViewKit envelope contract. It is a literal value and should be preserved when serializing or forwarding a document.
|
|
1319
|
+
*
|
|
719
1320
|
* @defaultValue "1.0"
|
|
720
1321
|
*/
|
|
721
1322
|
readonly schemaVersion: "1.0";
|
|
722
1323
|
}
|
|
723
|
-
/**
|
|
1324
|
+
/**
|
|
1325
|
+
* Root container holding an ordered list of visual elements.
|
|
1326
|
+
*
|
|
1327
|
+
* @remarks
|
|
1328
|
+
* Provides the shared root content collection inherited by cards and other root models. The order of elements is significant and is preserved by the renderer.
|
|
1329
|
+
*/
|
|
724
1330
|
export interface UiContainer extends Envelop {
|
|
725
|
-
/**
|
|
1331
|
+
/**
|
|
1332
|
+
* Ordered list of visual elements, structures, and content
|
|
1333
|
+
*
|
|
1334
|
+
* @remarks
|
|
1335
|
+
* Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
|
|
1336
|
+
*/
|
|
726
1337
|
readonly elements: UiElement[];
|
|
727
1338
|
}
|
|
728
1339
|
/**
|
|
729
|
-
* Root
|
|
730
|
-
*
|
|
1340
|
+
* Root container for a complete feature card.
|
|
1341
|
+
*
|
|
1342
|
+
* @remarks
|
|
1343
|
+
* A complete card has a required title and ordered content inherited from UiContainer. It is designed for the feature-card surface; description and actions supplement the content, with action controls rendered separately from the element list.
|
|
731
1344
|
*/
|
|
732
1345
|
export interface UiCard extends UiContainer {
|
|
733
|
-
/**
|
|
1346
|
+
/**
|
|
1347
|
+
* Human-readable feature title displayed in the card header
|
|
1348
|
+
*
|
|
1349
|
+
* @remarks
|
|
1350
|
+
* Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
|
|
1351
|
+
*/
|
|
734
1352
|
readonly title: string;
|
|
735
|
-
/**
|
|
1353
|
+
/**
|
|
1354
|
+
* Optional neutral subtitle / description for the feature
|
|
1355
|
+
*
|
|
1356
|
+
* @remarks
|
|
1357
|
+
* Brief secondary context shown with the title. Use the content elements for detailed information rather than placing an entire report in this field.
|
|
1358
|
+
*/
|
|
736
1359
|
readonly description?: string;
|
|
737
|
-
/**
|
|
1360
|
+
/**
|
|
1361
|
+
* Optional card action buttons rendered at the base of the feature card
|
|
1362
|
+
*
|
|
1363
|
+
* @remarks
|
|
1364
|
+
* Optional user-invokable actions shown after the card content. Their order is preserved and each action's own fields define its command or link behavior.
|
|
1365
|
+
*/
|
|
738
1366
|
readonly actions?: UiAction[];
|
|
739
1367
|
}
|
|
740
1368
|
/**
|
|
741
|
-
* Polymorphic root
|
|
742
|
-
*
|
|
743
|
-
*
|
|
1369
|
+
* Polymorphic root model for visual UI elements.
|
|
1370
|
+
*
|
|
1371
|
+
* @remarks
|
|
1372
|
+
* Every concrete visual element carries a type discriminator whose literal value selects its model and renderer. The @discriminator("type") metadata lets schema emitters and SDK generators represent derived models as a polymorphic hierarchy. Consumers should dispatch on the discriminator and preserve unknown elements when round-tripping data where possible.
|
|
744
1373
|
*/
|
|
745
1374
|
export type UiElement = StringElement | StringsElement | StringCodeElement | XmlElement | JsonElement | StringUrlElement | IdentifierElement | RatioElement | DimensionsElement | ColourElement | NumberUnboundedElement | NumberBoundedStarsElement | NumberBoundedMeterElement | BooleanElement | TimestampElement | ImageReferenceElement | MarkdownBlockElement | HtmlBlockElement | MultiSlotElement | FlowingElement | LabelValueElement | TableElement | RepeatingGroupElement | CollapsibleGroupElement | DividerElement;
|
|
746
|
-
/**
|
|
1375
|
+
/**
|
|
1376
|
+
* Polymorphic base model for interactive actions.
|
|
1377
|
+
*
|
|
1378
|
+
* @remarks
|
|
1379
|
+
* Shared action contract for user-invokable card controls. Concrete action models provide their own discriminator and action-specific destination or command fields.
|
|
1380
|
+
*/
|
|
747
1381
|
export type UiAction = ButtonActionElement | ExternalLinkActionElement;
|
|
748
1382
|
/**
|
|
749
1383
|
* Class implementation of the `TruncateOptions` interface.
|
|
750
1384
|
*
|
|
751
1385
|
* @remarks
|
|
752
|
-
*
|
|
1386
|
+
* Controls how a renderer abbreviates long text. The character limit is a presentation threshold rather than a validation limit; showMore lets the user reveal the remaining text.
|
|
753
1387
|
*/
|
|
754
1388
|
export declare class TruncateOptionsClass extends ViewKitNode<TruncateOptions> implements TruncateOptions {
|
|
755
|
-
/**
|
|
1389
|
+
/**
|
|
1390
|
+
* Maximum number of characters to display before truncating
|
|
1391
|
+
*
|
|
1392
|
+
* @remarks
|
|
1393
|
+
* Threshold after which the renderer can shorten the displayed text. This does not constrain the stored string or remove its undisplayed content.
|
|
1394
|
+
*/
|
|
756
1395
|
readonly characterLimit: number;
|
|
757
1396
|
/**
|
|
758
1397
|
* Whether to render a "Show more" / "Show less" toggle affordance
|
|
759
1398
|
*
|
|
1399
|
+
* @remarks
|
|
1400
|
+
* When true, permits an expand/collapse control for text beyond the truncation threshold. Defaults to true.
|
|
1401
|
+
*
|
|
760
1402
|
* @defaultValue true
|
|
761
1403
|
*/
|
|
762
1404
|
readonly showMore?: boolean;
|
|
@@ -764,6 +1406,8 @@ export declare class TruncateOptionsClass extends ViewKitNode<TruncateOptions> i
|
|
|
764
1406
|
* Constructs a new `TruncateOptionsClass` instance.
|
|
765
1407
|
*
|
|
766
1408
|
* @param characterLimit - Maximum number of characters to display before truncating
|
|
1409
|
+
|
|
1410
|
+
Threshold after which the renderer can shorten the displayed text. This does not constrain the stored string or remove its undisplayed content.
|
|
767
1411
|
* @param options - Optional component settings. (showMore (defaults to `true`)).
|
|
768
1412
|
*/
|
|
769
1413
|
constructor(characterLimit: number, options?: {
|
|
@@ -774,10 +1418,15 @@ export declare class TruncateOptionsClass extends ViewKitNode<TruncateOptions> i
|
|
|
774
1418
|
* Class implementation of the `BaseModifiers` interface.
|
|
775
1419
|
*
|
|
776
1420
|
* @remarks
|
|
777
|
-
*
|
|
1421
|
+
* Common optional presentation traits shared by primitive values and content renderers. Modifiers affect how content is displayed or copied; they do not transform the source value.
|
|
778
1422
|
*/
|
|
779
1423
|
export declare class BaseModifiersClass extends ViewKitNode<BaseModifiers> implements BaseModifiers {
|
|
780
|
-
/**
|
|
1424
|
+
/**
|
|
1425
|
+
* Adds an interactive copy button/action next to the rendered value
|
|
1426
|
+
*
|
|
1427
|
+
* @remarks
|
|
1428
|
+
* When true, exposes a copy affordance for the associated value where supported by the renderer.
|
|
1429
|
+
*/
|
|
781
1430
|
readonly copyable?: boolean;
|
|
782
1431
|
/**
|
|
783
1432
|
* Constructs a new `BaseModifiersClass` instance.
|
|
@@ -792,30 +1441,49 @@ export declare class BaseModifiersClass extends ViewKitNode<BaseModifiers> imple
|
|
|
792
1441
|
* Class implementation of the `PrimitiveModifiers` interface.
|
|
793
1442
|
*
|
|
794
1443
|
* @remarks
|
|
795
|
-
*
|
|
1444
|
+
* Extends BaseModifiers with text styling controls. Defaults provide normal weight, medium intensity, and proportional text unless a feature explicitly overrides them.
|
|
796
1445
|
*/
|
|
797
1446
|
export declare class PrimitiveModifiersClass extends ViewKitNode<PrimitiveModifiers> implements PrimitiveModifiers {
|
|
798
|
-
/**
|
|
1447
|
+
/**
|
|
1448
|
+
* Configures character truncation threshold with show-more affordance
|
|
1449
|
+
*
|
|
1450
|
+
* @remarks
|
|
1451
|
+
* Optional text abbreviation behavior. The source text remains unchanged, and the renderer may offer expansion according to showMore.
|
|
1452
|
+
*/
|
|
799
1453
|
readonly truncate?: TruncateOptions;
|
|
800
1454
|
/**
|
|
801
1455
|
* Typographic text weight
|
|
802
1456
|
*
|
|
1457
|
+
* @remarks
|
|
1458
|
+
* Relative font weight for textual rendering; defaults to normal.
|
|
1459
|
+
*
|
|
803
1460
|
* @defaultValue TextWeight.normal
|
|
804
1461
|
*/
|
|
805
1462
|
readonly weight?: TextWeight;
|
|
806
1463
|
/**
|
|
807
1464
|
* Visual text color intensity
|
|
808
1465
|
*
|
|
1466
|
+
* @remarks
|
|
1467
|
+
* Relative contrast treatment for the text; defaults to medium.
|
|
1468
|
+
*
|
|
809
1469
|
* @defaultValue TextIntensity.medium
|
|
810
1470
|
*/
|
|
811
1471
|
readonly intensity?: TextIntensity;
|
|
812
1472
|
/**
|
|
813
1473
|
* Whether to use monospace font rendering (for hashes, IDs, codes)
|
|
814
1474
|
*
|
|
1475
|
+
* @remarks
|
|
1476
|
+
* When true, requests a fixed-width font suitable for identifiers and code-like values. Defaults to false.
|
|
1477
|
+
*
|
|
815
1478
|
* @defaultValue false
|
|
816
1479
|
*/
|
|
817
1480
|
readonly monospace?: boolean;
|
|
818
|
-
/**
|
|
1481
|
+
/**
|
|
1482
|
+
* Adds an interactive copy button/action next to the rendered value
|
|
1483
|
+
*
|
|
1484
|
+
* @remarks
|
|
1485
|
+
* When true, exposes a copy affordance for the associated value where supported by the renderer.
|
|
1486
|
+
*/
|
|
819
1487
|
readonly copyable?: boolean;
|
|
820
1488
|
/**
|
|
821
1489
|
* Constructs a new `PrimitiveModifiersClass` instance.
|
|
@@ -834,8 +1502,7 @@ export declare class PrimitiveModifiersClass extends ViewKitNode<PrimitiveModifi
|
|
|
834
1502
|
* Class implementation of the `StringElement` interface.
|
|
835
1503
|
*
|
|
836
1504
|
* @remarks
|
|
837
|
-
*
|
|
838
|
-
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
1505
|
+
* Use this primitive for one textual value when a structured label/value row is unnecessary. Choose multiline for content whose line breaks should remain visible; modifiers apply presentation traits without changing the underlying value.
|
|
839
1506
|
*/
|
|
840
1507
|
export declare class StringElementClass extends BaseUiElement<StringElement> implements StringElement {
|
|
841
1508
|
/**
|
|
@@ -844,11 +1511,19 @@ export declare class StringElementClass extends BaseUiElement<StringElement> imp
|
|
|
844
1511
|
* @defaultValue "string"
|
|
845
1512
|
*/
|
|
846
1513
|
readonly type = "string";
|
|
847
|
-
/**
|
|
1514
|
+
/**
|
|
1515
|
+
* Text value
|
|
1516
|
+
*
|
|
1517
|
+
* @remarks
|
|
1518
|
+
* Text to render. Supply plain text; this field is not a Markdown or HTML document.
|
|
1519
|
+
*/
|
|
848
1520
|
readonly value: string;
|
|
849
1521
|
/**
|
|
850
1522
|
* Display representation mode
|
|
851
1523
|
*
|
|
1524
|
+
* @remarks
|
|
1525
|
+
* Selects inline, chip, or multiline rendering. The default is plain, so callers can omit this for ordinary text.
|
|
1526
|
+
*
|
|
852
1527
|
* @defaultValue StringRepresentation.plain
|
|
853
1528
|
*/
|
|
854
1529
|
readonly representation?: StringRepresentation;
|
|
@@ -858,6 +1533,8 @@ export declare class StringElementClass extends BaseUiElement<StringElement> imp
|
|
|
858
1533
|
* Constructs a new `StringElementClass` instance.
|
|
859
1534
|
*
|
|
860
1535
|
* @param value - Text value
|
|
1536
|
+
|
|
1537
|
+
Text to render. Supply plain text; this field is not a Markdown or HTML document.
|
|
861
1538
|
* @param options - Optional component settings. (representation (defaults to `plain`), modifiers).
|
|
862
1539
|
*/
|
|
863
1540
|
constructor(value: string, options?: {
|
|
@@ -869,8 +1546,7 @@ export declare class StringElementClass extends BaseUiElement<StringElement> imp
|
|
|
869
1546
|
* Class implementation of the `StringsElement` interface.
|
|
870
1547
|
*
|
|
871
1548
|
* @remarks
|
|
872
|
-
*
|
|
873
|
-
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
1549
|
+
* Use this primitive when several related strings should be rendered as one compact sequence. The client preserves the array order and inserts the selected separator between values.
|
|
874
1550
|
*/
|
|
875
1551
|
export declare class StringsElementClass extends BaseUiElement<StringsElement> implements StringsElement {
|
|
876
1552
|
/**
|
|
@@ -879,15 +1555,28 @@ export declare class StringsElementClass extends BaseUiElement<StringsElement> i
|
|
|
879
1555
|
* @defaultValue "strings"
|
|
880
1556
|
*/
|
|
881
1557
|
readonly type = "strings";
|
|
882
|
-
/**
|
|
1558
|
+
/**
|
|
1559
|
+
* Array of string values
|
|
1560
|
+
*
|
|
1561
|
+
* @remarks
|
|
1562
|
+
* Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
|
|
1563
|
+
*/
|
|
883
1564
|
readonly values: string[];
|
|
884
1565
|
/**
|
|
885
1566
|
* Display representation mode (plain text or visual chips)
|
|
886
1567
|
*
|
|
1568
|
+
* @remarks
|
|
1569
|
+
* Selects whether values appear as ordinary inline text or as separate visual chips. The default uses the plain representation.
|
|
1570
|
+
*
|
|
887
1571
|
* @defaultValue StringRepresentation.plain
|
|
888
1572
|
*/
|
|
889
1573
|
readonly representation?: StringRepresentation;
|
|
890
|
-
/**
|
|
1574
|
+
/**
|
|
1575
|
+
* Optional visual separator rendered between sequential values
|
|
1576
|
+
*
|
|
1577
|
+
* @remarks
|
|
1578
|
+
* Separator inserted between adjacent values in plain representation. It does not become part of any value.
|
|
1579
|
+
*/
|
|
891
1580
|
readonly separator?: Separator;
|
|
892
1581
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
893
1582
|
readonly modifiers?: PrimitiveModifiers;
|
|
@@ -895,6 +1584,8 @@ export declare class StringsElementClass extends BaseUiElement<StringsElement> i
|
|
|
895
1584
|
* Constructs a new `StringsElementClass` instance.
|
|
896
1585
|
*
|
|
897
1586
|
* @param values - Array of string values
|
|
1587
|
+
|
|
1588
|
+
Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
|
|
898
1589
|
* @param options - Optional component settings. (representation (defaults to `plain`), separator, modifiers).
|
|
899
1590
|
*/
|
|
900
1591
|
constructor(values: string[], options?: {
|
|
@@ -907,7 +1598,7 @@ export declare class StringsElementClass extends BaseUiElement<StringsElement> i
|
|
|
907
1598
|
* Class implementation of the `StringCodeElement` interface.
|
|
908
1599
|
*
|
|
909
1600
|
* @remarks
|
|
910
|
-
*
|
|
1601
|
+
* Use for source-like or preformatted textual content that should be rendered in a code-oriented style. The language is a presentation hint; the content is not parsed or validated as code by this contract.
|
|
911
1602
|
*/
|
|
912
1603
|
export declare class StringCodeElementClass extends BaseUiElement<StringCodeElement> implements StringCodeElement {
|
|
913
1604
|
/**
|
|
@@ -916,9 +1607,19 @@ export declare class StringCodeElementClass extends BaseUiElement<StringCodeElem
|
|
|
916
1607
|
* @defaultValue "string-code"
|
|
917
1608
|
*/
|
|
918
1609
|
readonly type = "string-code";
|
|
919
|
-
/**
|
|
1610
|
+
/**
|
|
1611
|
+
* Text value
|
|
1612
|
+
*
|
|
1613
|
+
* @remarks
|
|
1614
|
+
* Code or text snippet to display. Include any desired line breaks in this string.
|
|
1615
|
+
*/
|
|
920
1616
|
readonly value: string;
|
|
921
|
-
/**
|
|
1617
|
+
/**
|
|
1618
|
+
* Optional syntax highlighting language identifier
|
|
1619
|
+
*
|
|
1620
|
+
* @remarks
|
|
1621
|
+
* Optional syntax hint for the renderer. Supported values describe highlighting modes and do not validate the snippet's syntax.
|
|
1622
|
+
*/
|
|
922
1623
|
readonly language?: CodeLanguage;
|
|
923
1624
|
/** Optional visual modifiers (copyable) */
|
|
924
1625
|
readonly modifiers?: BaseModifiers;
|
|
@@ -926,6 +1627,8 @@ export declare class StringCodeElementClass extends BaseUiElement<StringCodeElem
|
|
|
926
1627
|
* Constructs a new `StringCodeElementClass` instance.
|
|
927
1628
|
*
|
|
928
1629
|
* @param value - Text value
|
|
1630
|
+
|
|
1631
|
+
Code or text snippet to display. Include any desired line breaks in this string.
|
|
929
1632
|
* @param options - Optional component settings. (language, modifiers).
|
|
930
1633
|
*/
|
|
931
1634
|
constructor(value: string, options?: {
|
|
@@ -937,7 +1640,7 @@ export declare class StringCodeElementClass extends BaseUiElement<StringCodeElem
|
|
|
937
1640
|
* Class implementation of the `XmlElement` interface.
|
|
938
1641
|
*
|
|
939
1642
|
* @remarks
|
|
940
|
-
* XML
|
|
1643
|
+
* Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
|
|
941
1644
|
*/
|
|
942
1645
|
export declare class XmlElementClass extends BaseUiElement<XmlElement> implements XmlElement {
|
|
943
1646
|
/**
|
|
@@ -946,7 +1649,12 @@ export declare class XmlElementClass extends BaseUiElement<XmlElement> implement
|
|
|
946
1649
|
* @defaultValue "xml"
|
|
947
1650
|
*/
|
|
948
1651
|
readonly type = "xml";
|
|
949
|
-
/**
|
|
1652
|
+
/**
|
|
1653
|
+
* XML content value
|
|
1654
|
+
*
|
|
1655
|
+
* @remarks
|
|
1656
|
+
* XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
|
|
1657
|
+
*/
|
|
950
1658
|
readonly value: string;
|
|
951
1659
|
/** Optional visual modifiers (copyable) */
|
|
952
1660
|
readonly modifiers?: BaseModifiers;
|
|
@@ -954,6 +1662,8 @@ export declare class XmlElementClass extends BaseUiElement<XmlElement> implement
|
|
|
954
1662
|
* Constructs a new `XmlElementClass` instance.
|
|
955
1663
|
*
|
|
956
1664
|
* @param value - XML content value
|
|
1665
|
+
|
|
1666
|
+
XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
|
|
957
1667
|
* @param options - Optional component settings. (modifiers).
|
|
958
1668
|
*/
|
|
959
1669
|
constructor(value: string, options?: {
|
|
@@ -964,7 +1674,7 @@ export declare class XmlElementClass extends BaseUiElement<XmlElement> implement
|
|
|
964
1674
|
* Class implementation of the `JsonElement` interface.
|
|
965
1675
|
*
|
|
966
1676
|
* @remarks
|
|
967
|
-
* JSON
|
|
1677
|
+
* Specialized representation for JSON text. Supply serialized JSON when consumers should display a JSON document; this field is a string and is not structurally validated here.
|
|
968
1678
|
*/
|
|
969
1679
|
export declare class JsonElementClass extends BaseUiElement<JsonElement> implements JsonElement {
|
|
970
1680
|
/**
|
|
@@ -973,7 +1683,12 @@ export declare class JsonElementClass extends BaseUiElement<JsonElement> impleme
|
|
|
973
1683
|
* @defaultValue "json"
|
|
974
1684
|
*/
|
|
975
1685
|
readonly type = "json";
|
|
976
|
-
/**
|
|
1686
|
+
/**
|
|
1687
|
+
* JSON content value
|
|
1688
|
+
*
|
|
1689
|
+
* @remarks
|
|
1690
|
+
* Serialized JSON text to render. No parsing or schema validation is implied by this element.
|
|
1691
|
+
*/
|
|
977
1692
|
readonly value: string;
|
|
978
1693
|
/** Optional visual modifiers (copyable) */
|
|
979
1694
|
readonly modifiers?: BaseModifiers;
|
|
@@ -981,6 +1696,8 @@ export declare class JsonElementClass extends BaseUiElement<JsonElement> impleme
|
|
|
981
1696
|
* Constructs a new `JsonElementClass` instance.
|
|
982
1697
|
*
|
|
983
1698
|
* @param value - JSON content value
|
|
1699
|
+
|
|
1700
|
+
Serialized JSON text to render. No parsing or schema validation is implied by this element.
|
|
984
1701
|
* @param options - Optional component settings. (modifiers).
|
|
985
1702
|
*/
|
|
986
1703
|
constructor(value: string, options?: {
|
|
@@ -991,7 +1708,7 @@ export declare class JsonElementClass extends BaseUiElement<JsonElement> impleme
|
|
|
991
1708
|
* Class implementation of the `StringUrlElement` interface.
|
|
992
1709
|
*
|
|
993
1710
|
* @remarks
|
|
994
|
-
*
|
|
1711
|
+
* Use this element when displayed text should also behave as a link. Unlike StringElement, the value is a navigation destination and may be paired with a separate human-readable label.
|
|
995
1712
|
*/
|
|
996
1713
|
export declare class StringUrlElementClass extends BaseUiElement<StringUrlElement> implements StringUrlElement {
|
|
997
1714
|
/**
|
|
@@ -1000,7 +1717,12 @@ export declare class StringUrlElementClass extends BaseUiElement<StringUrlElemen
|
|
|
1000
1717
|
* @defaultValue "string-url"
|
|
1001
1718
|
*/
|
|
1002
1719
|
readonly type = "string-url";
|
|
1003
|
-
/**
|
|
1720
|
+
/**
|
|
1721
|
+
* Target URL or navigation destination
|
|
1722
|
+
*
|
|
1723
|
+
* @remarks
|
|
1724
|
+
* Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
|
|
1725
|
+
*/
|
|
1004
1726
|
readonly value: string;
|
|
1005
1727
|
/** Optional custom anchor text label */
|
|
1006
1728
|
readonly label?: string;
|
|
@@ -1010,6 +1732,8 @@ export declare class StringUrlElementClass extends BaseUiElement<StringUrlElemen
|
|
|
1010
1732
|
* Constructs a new `StringUrlElementClass` instance.
|
|
1011
1733
|
*
|
|
1012
1734
|
* @param value - Target URL or navigation destination
|
|
1735
|
+
|
|
1736
|
+
Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
|
|
1013
1737
|
* @param options - Optional component settings. (label, modifiers).
|
|
1014
1738
|
*/
|
|
1015
1739
|
constructor(value: string, options?: {
|
|
@@ -1021,7 +1745,7 @@ export declare class StringUrlElementClass extends BaseUiElement<StringUrlElemen
|
|
|
1021
1745
|
* Class implementation of the `IdentifierElement` interface.
|
|
1022
1746
|
*
|
|
1023
1747
|
* @remarks
|
|
1024
|
-
*
|
|
1748
|
+
* Use for identifiers, hashes, and other machine-oriented strings that benefit from monospace styling. The value remains text and is not resolved as a Picteus entity.
|
|
1025
1749
|
*/
|
|
1026
1750
|
export declare class IdentifierElementClass extends BaseUiElement<IdentifierElement> implements IdentifierElement {
|
|
1027
1751
|
/**
|
|
@@ -1030,7 +1754,12 @@ export declare class IdentifierElementClass extends BaseUiElement<IdentifierElem
|
|
|
1030
1754
|
* @defaultValue "identifier"
|
|
1031
1755
|
*/
|
|
1032
1756
|
readonly type = "identifier";
|
|
1033
|
-
/**
|
|
1757
|
+
/**
|
|
1758
|
+
* Identifier string value
|
|
1759
|
+
*
|
|
1760
|
+
* @remarks
|
|
1761
|
+
* Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
|
|
1762
|
+
*/
|
|
1034
1763
|
readonly value: string;
|
|
1035
1764
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
1036
1765
|
readonly modifiers?: PrimitiveModifiers;
|
|
@@ -1038,6 +1767,8 @@ export declare class IdentifierElementClass extends BaseUiElement<IdentifierElem
|
|
|
1038
1767
|
* Constructs a new `IdentifierElementClass` instance.
|
|
1039
1768
|
*
|
|
1040
1769
|
* @param value - Identifier string value
|
|
1770
|
+
|
|
1771
|
+
Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
|
|
1041
1772
|
* @param options - Optional component settings. (modifiers).
|
|
1042
1773
|
*/
|
|
1043
1774
|
constructor(value: string, options?: {
|
|
@@ -1048,7 +1779,7 @@ export declare class IdentifierElementClass extends BaseUiElement<IdentifierElem
|
|
|
1048
1779
|
* Class implementation of the `RatioElement` interface.
|
|
1049
1780
|
*
|
|
1050
1781
|
* @remarks
|
|
1051
|
-
*
|
|
1782
|
+
* Displays a numeric aspect ratio as a ratio expression. Provide a positive value meaningful to the surrounding content; this type does not encode the source image dimensions.
|
|
1052
1783
|
*/
|
|
1053
1784
|
export declare class RatioElementClass extends BaseUiElement<RatioElement> implements RatioElement {
|
|
1054
1785
|
/**
|
|
@@ -1057,7 +1788,12 @@ export declare class RatioElementClass extends BaseUiElement<RatioElement> imple
|
|
|
1057
1788
|
* @defaultValue "ratio"
|
|
1058
1789
|
*/
|
|
1059
1790
|
readonly type = "ratio";
|
|
1060
|
-
/**
|
|
1791
|
+
/**
|
|
1792
|
+
* Aspect ratio numerical expression
|
|
1793
|
+
*
|
|
1794
|
+
* @remarks
|
|
1795
|
+
* Numeric ratio value used by the renderer to produce an aspect-ratio display.
|
|
1796
|
+
*/
|
|
1061
1797
|
readonly value: number;
|
|
1062
1798
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
1063
1799
|
readonly modifiers?: PrimitiveModifiers;
|
|
@@ -1065,6 +1801,8 @@ export declare class RatioElementClass extends BaseUiElement<RatioElement> imple
|
|
|
1065
1801
|
* Constructs a new `RatioElementClass` instance.
|
|
1066
1802
|
*
|
|
1067
1803
|
* @param value - Aspect ratio numerical expression
|
|
1804
|
+
|
|
1805
|
+
Numeric ratio value used by the renderer to produce an aspect-ratio display.
|
|
1068
1806
|
* @param options - Optional component settings. (modifiers).
|
|
1069
1807
|
*/
|
|
1070
1808
|
constructor(value: number, options?: {
|
|
@@ -1075,7 +1813,7 @@ export declare class RatioElementClass extends BaseUiElement<RatioElement> imple
|
|
|
1075
1813
|
* Class implementation of the `DimensionsElement` interface.
|
|
1076
1814
|
*
|
|
1077
1815
|
* @remarks
|
|
1078
|
-
*
|
|
1816
|
+
* Displays a width/height pair as image dimensions. Both values are positive pixel counts; together they describe dimensions, not an aspect ratio or a resize request.
|
|
1079
1817
|
*/
|
|
1080
1818
|
export declare class DimensionsElementClass extends BaseUiElement<DimensionsElement> implements DimensionsElement {
|
|
1081
1819
|
/**
|
|
@@ -1084,9 +1822,19 @@ export declare class DimensionsElementClass extends BaseUiElement<DimensionsElem
|
|
|
1084
1822
|
* @defaultValue "dimensions"
|
|
1085
1823
|
*/
|
|
1086
1824
|
readonly type = "dimensions";
|
|
1087
|
-
/**
|
|
1825
|
+
/**
|
|
1826
|
+
* Width in pixels
|
|
1827
|
+
*
|
|
1828
|
+
* @remarks
|
|
1829
|
+
* Horizontal pixel count. Values below one are rejected by the schema constraint.
|
|
1830
|
+
*/
|
|
1088
1831
|
readonly width: number;
|
|
1089
|
-
/**
|
|
1832
|
+
/**
|
|
1833
|
+
* Height in pixels
|
|
1834
|
+
*
|
|
1835
|
+
* @remarks
|
|
1836
|
+
* Vertical pixel count. Values below one are rejected by the schema constraint.
|
|
1837
|
+
*/
|
|
1090
1838
|
readonly height: number;
|
|
1091
1839
|
/** Optional visual modifiers (copyable) */
|
|
1092
1840
|
readonly modifiers?: BaseModifiers;
|
|
@@ -1094,7 +1842,11 @@ export declare class DimensionsElementClass extends BaseUiElement<DimensionsElem
|
|
|
1094
1842
|
* Constructs a new `DimensionsElementClass` instance.
|
|
1095
1843
|
*
|
|
1096
1844
|
* @param width - Width in pixels
|
|
1845
|
+
|
|
1846
|
+
Horizontal pixel count. Values below one are rejected by the schema constraint.
|
|
1097
1847
|
* @param height - Height in pixels
|
|
1848
|
+
|
|
1849
|
+
Vertical pixel count. Values below one are rejected by the schema constraint.
|
|
1098
1850
|
* @param options - Optional component settings. (modifiers).
|
|
1099
1851
|
*/
|
|
1100
1852
|
constructor(width: number, height: number, options?: {
|
|
@@ -1105,7 +1857,7 @@ export declare class DimensionsElementClass extends BaseUiElement<DimensionsElem
|
|
|
1105
1857
|
* Class implementation of the `ColourElement` interface.
|
|
1106
1858
|
*
|
|
1107
1859
|
* @remarks
|
|
1108
|
-
*
|
|
1860
|
+
* Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
|
|
1109
1861
|
*/
|
|
1110
1862
|
export declare class ColourElementClass extends BaseUiElement<ColourElement> implements ColourElement {
|
|
1111
1863
|
/**
|
|
@@ -1114,25 +1866,44 @@ export declare class ColourElementClass extends BaseUiElement<ColourElement> imp
|
|
|
1114
1866
|
* @defaultValue "color"
|
|
1115
1867
|
*/
|
|
1116
1868
|
readonly type = "color";
|
|
1117
|
-
/**
|
|
1869
|
+
/**
|
|
1870
|
+
* Hexadecimal color code
|
|
1871
|
+
*
|
|
1872
|
+
* @remarks
|
|
1873
|
+
* Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
1874
|
+
*/
|
|
1118
1875
|
readonly value: string;
|
|
1119
|
-
/**
|
|
1876
|
+
/**
|
|
1877
|
+
* Optional descriptive color name label
|
|
1878
|
+
*
|
|
1879
|
+
* @remarks
|
|
1880
|
+
* Human-readable color name available to the renderer when text is shown.
|
|
1881
|
+
*/
|
|
1120
1882
|
readonly label?: string;
|
|
1121
1883
|
/**
|
|
1122
1884
|
* Whether to display the textual color code or label next to the swatch
|
|
1123
1885
|
*
|
|
1886
|
+
* @remarks
|
|
1887
|
+
* When true, allows the renderer to show the color's text label alongside the swatch. The default is true.
|
|
1888
|
+
*
|
|
1124
1889
|
* @defaultValue true
|
|
1125
1890
|
*/
|
|
1126
1891
|
readonly showText?: boolean;
|
|
1127
1892
|
/**
|
|
1128
1893
|
* Visual shape of the color indicator
|
|
1129
1894
|
*
|
|
1895
|
+
* @remarks
|
|
1896
|
+
* Geometry used for the swatch; defaults to a circle.
|
|
1897
|
+
*
|
|
1130
1898
|
* @defaultValue Shape.circle
|
|
1131
1899
|
*/
|
|
1132
1900
|
readonly shape?: Shape;
|
|
1133
1901
|
/**
|
|
1134
1902
|
* Visual size of the color indicator
|
|
1135
1903
|
*
|
|
1904
|
+
* @remarks
|
|
1905
|
+
* Relative size class for the swatch; defaults to medium.
|
|
1906
|
+
*
|
|
1136
1907
|
* @defaultValue Size.medium
|
|
1137
1908
|
*/
|
|
1138
1909
|
readonly size?: Size;
|
|
@@ -1142,6 +1913,8 @@ export declare class ColourElementClass extends BaseUiElement<ColourElement> imp
|
|
|
1142
1913
|
* Constructs a new `ColourElementClass` instance.
|
|
1143
1914
|
*
|
|
1144
1915
|
* @param value - Hexadecimal color code
|
|
1916
|
+
|
|
1917
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
1145
1918
|
* @param options - Optional component settings. (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
1146
1919
|
*/
|
|
1147
1920
|
constructor(value: string, options?: {
|
|
@@ -1156,7 +1929,7 @@ export declare class ColourElementClass extends BaseUiElement<ColourElement> imp
|
|
|
1156
1929
|
* Class implementation of the `NumberUnboundedElement` interface.
|
|
1157
1930
|
*
|
|
1158
1931
|
* @remarks
|
|
1159
|
-
*
|
|
1932
|
+
* Displays a numeric value without a progress scale or rating interpretation. Use unit to communicate the measurement context; no range is imposed by this model.
|
|
1160
1933
|
*/
|
|
1161
1934
|
export declare class NumberUnboundedElementClass extends BaseUiElement<NumberUnboundedElement> implements NumberUnboundedElement {
|
|
1162
1935
|
/**
|
|
@@ -1165,9 +1938,19 @@ export declare class NumberUnboundedElementClass extends BaseUiElement<NumberUnb
|
|
|
1165
1938
|
* @defaultValue "number-unbounded"
|
|
1166
1939
|
*/
|
|
1167
1940
|
readonly type = "number-unbounded";
|
|
1168
|
-
/**
|
|
1941
|
+
/**
|
|
1942
|
+
* Numeric value
|
|
1943
|
+
*
|
|
1944
|
+
* @remarks
|
|
1945
|
+
* Number to display. Its meaning and any valid range are defined by the producing feature.
|
|
1946
|
+
*/
|
|
1169
1947
|
readonly value: number;
|
|
1170
|
-
/**
|
|
1948
|
+
/**
|
|
1949
|
+
* Optional unit suffix (e.g. "px", "ms", "MB")
|
|
1950
|
+
*
|
|
1951
|
+
* @remarks
|
|
1952
|
+
* Short unit label appended or otherwise associated with the displayed value. Include only the unit text, not a second copy of the number.
|
|
1953
|
+
*/
|
|
1171
1954
|
readonly unit?: string;
|
|
1172
1955
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
1173
1956
|
readonly modifiers?: PrimitiveModifiers;
|
|
@@ -1175,6 +1958,8 @@ export declare class NumberUnboundedElementClass extends BaseUiElement<NumberUnb
|
|
|
1175
1958
|
* Constructs a new `NumberUnboundedElementClass` instance.
|
|
1176
1959
|
*
|
|
1177
1960
|
* @param value - Numeric value
|
|
1961
|
+
|
|
1962
|
+
Number to display. Its meaning and any valid range are defined by the producing feature.
|
|
1178
1963
|
* @param options - Optional component settings. (unit, modifiers).
|
|
1179
1964
|
*/
|
|
1180
1965
|
constructor(value: number, options?: {
|
|
@@ -1186,7 +1971,7 @@ export declare class NumberUnboundedElementClass extends BaseUiElement<NumberUnb
|
|
|
1186
1971
|
* Class implementation of the `NumberBoundedStarsElement` interface.
|
|
1187
1972
|
*
|
|
1188
1973
|
* @remarks
|
|
1189
|
-
*
|
|
1974
|
+
* Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
|
|
1190
1975
|
*/
|
|
1191
1976
|
export declare class NumberBoundedStarsElementClass extends BaseUiElement<NumberBoundedStarsElement> implements NumberBoundedStarsElement {
|
|
1192
1977
|
/**
|
|
@@ -1195,9 +1980,19 @@ export declare class NumberBoundedStarsElementClass extends BaseUiElement<Number
|
|
|
1195
1980
|
* @defaultValue "number-stars"
|
|
1196
1981
|
*/
|
|
1197
1982
|
readonly type = "number-stars";
|
|
1198
|
-
/**
|
|
1983
|
+
/**
|
|
1984
|
+
* Numeric rating score
|
|
1985
|
+
*
|
|
1986
|
+
* @remarks
|
|
1987
|
+
* Score represented by the filled portion of the star display.
|
|
1988
|
+
*/
|
|
1199
1989
|
readonly value: number;
|
|
1200
|
-
/**
|
|
1990
|
+
/**
|
|
1991
|
+
* Maximum rating scale (defaults to 5)
|
|
1992
|
+
*
|
|
1993
|
+
* @remarks
|
|
1994
|
+
* Upper end of the rating scale. When omitted, the scale is five; value should use the same scale.
|
|
1995
|
+
*/
|
|
1201
1996
|
readonly maximum?: number;
|
|
1202
1997
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
1203
1998
|
readonly modifiers?: PrimitiveModifiers;
|
|
@@ -1205,6 +2000,8 @@ export declare class NumberBoundedStarsElementClass extends BaseUiElement<Number
|
|
|
1205
2000
|
* Constructs a new `NumberBoundedStarsElementClass` instance.
|
|
1206
2001
|
*
|
|
1207
2002
|
* @param value - Numeric rating score
|
|
2003
|
+
|
|
2004
|
+
Score represented by the filled portion of the star display.
|
|
1208
2005
|
* @param options - Optional component settings. (maximum, modifiers).
|
|
1209
2006
|
*/
|
|
1210
2007
|
constructor(value: number, options?: {
|
|
@@ -1216,24 +2013,49 @@ export declare class NumberBoundedStarsElementClass extends BaseUiElement<Number
|
|
|
1216
2013
|
* Class implementation of the `NumberBoundedMeterElement` interface.
|
|
1217
2014
|
*
|
|
1218
2015
|
* @remarks
|
|
1219
|
-
*
|
|
2016
|
+
* Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
|
|
1220
2017
|
*/
|
|
1221
2018
|
export declare class NumberBoundedMeterElementClass extends BaseUiElement<NumberBoundedMeterElement> implements NumberBoundedMeterElement {
|
|
1222
2019
|
/**
|
|
1223
|
-
* Discriminator identifier for `NumberBoundedMeterElement`.
|
|
2020
|
+
* Discriminator identifier for `NumberBoundedMeterElement`.
|
|
2021
|
+
*
|
|
2022
|
+
* @defaultValue "number-meter"
|
|
2023
|
+
*/
|
|
2024
|
+
readonly type = "number-meter";
|
|
2025
|
+
/**
|
|
2026
|
+
* Numeric value
|
|
2027
|
+
*
|
|
2028
|
+
* @remarks
|
|
2029
|
+
* Current measurement or score represented by the meter.
|
|
2030
|
+
*/
|
|
2031
|
+
readonly value: number;
|
|
2032
|
+
/**
|
|
2033
|
+
* Minimum scale bound (defaults to 0)
|
|
2034
|
+
*
|
|
2035
|
+
* @remarks
|
|
2036
|
+
* Lower end of the meter range. Defaults to zero when omitted.
|
|
2037
|
+
*/
|
|
2038
|
+
readonly minimum?: number;
|
|
2039
|
+
/**
|
|
2040
|
+
* Maximum scale bound (e.g. 100)
|
|
2041
|
+
*
|
|
2042
|
+
* @remarks
|
|
2043
|
+
* Upper end of the meter range. Choose a bound consistent with value and minimum.
|
|
2044
|
+
*/
|
|
2045
|
+
readonly maximum?: number;
|
|
2046
|
+
/**
|
|
2047
|
+
* Optional custom text label override (e.g. "68 / 100")
|
|
1224
2048
|
*
|
|
1225
|
-
* @
|
|
2049
|
+
* @remarks
|
|
2050
|
+
* Optional readout text to use instead of a renderer-generated value and range label.
|
|
1226
2051
|
*/
|
|
1227
|
-
readonly type = "number-meter";
|
|
1228
|
-
/** Numeric value */
|
|
1229
|
-
readonly value: number;
|
|
1230
|
-
/** Minimum scale bound (defaults to 0) */
|
|
1231
|
-
readonly minimum?: number;
|
|
1232
|
-
/** Maximum scale bound (e.g. 100) */
|
|
1233
|
-
readonly maximum?: number;
|
|
1234
|
-
/** Optional custom text label override (e.g. "68 / 100") */
|
|
1235
2052
|
readonly label?: string;
|
|
1236
|
-
/**
|
|
2053
|
+
/**
|
|
2054
|
+
* Optional unit suffix (e.g. "%")
|
|
2055
|
+
*
|
|
2056
|
+
* @remarks
|
|
2057
|
+
* Unit associated with the value, such as a percent sign. This affects display only and does not convert the numeric value.
|
|
2058
|
+
*/
|
|
1237
2059
|
readonly unit?: string;
|
|
1238
2060
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
1239
2061
|
readonly modifiers?: PrimitiveModifiers;
|
|
@@ -1241,6 +2063,8 @@ export declare class NumberBoundedMeterElementClass extends BaseUiElement<Number
|
|
|
1241
2063
|
* Constructs a new `NumberBoundedMeterElementClass` instance.
|
|
1242
2064
|
*
|
|
1243
2065
|
* @param value - Numeric value
|
|
2066
|
+
|
|
2067
|
+
Current measurement or score represented by the meter.
|
|
1244
2068
|
* @param options - Optional component settings. (minimum, maximum, label, unit, modifiers).
|
|
1245
2069
|
*/
|
|
1246
2070
|
constructor(value: number, options?: {
|
|
@@ -1255,8 +2079,7 @@ export declare class NumberBoundedMeterElementClass extends BaseUiElement<Number
|
|
|
1255
2079
|
* Class implementation of the `BooleanElement` interface.
|
|
1256
2080
|
*
|
|
1257
2081
|
* @remarks
|
|
1258
|
-
*
|
|
1259
|
-
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
2082
|
+
* Displays a boolean state using text or a badge. The representation determines whether true/false labels or a colored badge are used; configured labels and variant are presentation choices only.
|
|
1260
2083
|
*/
|
|
1261
2084
|
export declare class BooleanElementClass extends BaseUiElement<BooleanElement> implements BooleanElement {
|
|
1262
2085
|
/**
|
|
@@ -1265,29 +2088,46 @@ export declare class BooleanElementClass extends BaseUiElement<BooleanElement> i
|
|
|
1265
2088
|
* @defaultValue "boolean"
|
|
1266
2089
|
*/
|
|
1267
2090
|
readonly type = "boolean";
|
|
1268
|
-
/**
|
|
2091
|
+
/**
|
|
2092
|
+
* Boolean state value
|
|
2093
|
+
*
|
|
2094
|
+
* @remarks
|
|
2095
|
+
* State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
|
|
2096
|
+
*/
|
|
1269
2097
|
readonly value: boolean;
|
|
1270
2098
|
/**
|
|
1271
2099
|
* Display representation mode
|
|
1272
2100
|
*
|
|
2101
|
+
* @remarks
|
|
2102
|
+
* Selects ordinary text or a badge pill. Badge color applies only to badge presentation.
|
|
2103
|
+
*
|
|
1273
2104
|
* @defaultValue BooleanRepresentation.plain
|
|
1274
2105
|
*/
|
|
1275
2106
|
readonly representation?: BooleanRepresentation;
|
|
1276
2107
|
/**
|
|
1277
2108
|
* Custom display label when true (defaults to "true")
|
|
1278
2109
|
*
|
|
2110
|
+
* @remarks
|
|
2111
|
+
* Text used for the true state in plain representation. Defaults to the literal text true.
|
|
2112
|
+
*
|
|
1279
2113
|
* @defaultValue "true"
|
|
1280
2114
|
*/
|
|
1281
2115
|
readonly trueLabel?: string;
|
|
1282
2116
|
/**
|
|
1283
2117
|
* Custom display label when false (defaults to "false")
|
|
1284
2118
|
*
|
|
2119
|
+
* @remarks
|
|
2120
|
+
* Text used for the false state in plain representation. Defaults to the literal text false.
|
|
2121
|
+
*
|
|
1285
2122
|
* @defaultValue "false"
|
|
1286
2123
|
*/
|
|
1287
2124
|
readonly falseLabel?: string;
|
|
1288
2125
|
/**
|
|
1289
2126
|
* Badge color tone when rendered as badge
|
|
1290
2127
|
*
|
|
2128
|
+
* @remarks
|
|
2129
|
+
* Semantic color treatment for badge presentation; it has no effect in plain representation.
|
|
2130
|
+
*
|
|
1291
2131
|
* @defaultValue BadgeVariant.neutral
|
|
1292
2132
|
*/
|
|
1293
2133
|
readonly variant?: BadgeVariant;
|
|
@@ -1297,6 +2137,8 @@ export declare class BooleanElementClass extends BaseUiElement<BooleanElement> i
|
|
|
1297
2137
|
* Constructs a new `BooleanElementClass` instance.
|
|
1298
2138
|
*
|
|
1299
2139
|
* @param value - Boolean state value
|
|
2140
|
+
|
|
2141
|
+
State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
|
|
1300
2142
|
* @param options - Optional component settings. (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
1301
2143
|
*/
|
|
1302
2144
|
constructor(value: boolean, options?: {
|
|
@@ -1311,7 +2153,7 @@ export declare class BooleanElementClass extends BaseUiElement<BooleanElement> i
|
|
|
1311
2153
|
* Class implementation of the `TimestampElement` interface.
|
|
1312
2154
|
*
|
|
1313
2155
|
* @remarks
|
|
1314
|
-
*
|
|
2156
|
+
* Displays an epoch timestamp using a selected date/time format. The input is a count of milliseconds, not seconds; relative formatting is interpreted by the consumer.
|
|
1315
2157
|
*/
|
|
1316
2158
|
export declare class TimestampElementClass extends BaseUiElement<TimestampElement> implements TimestampElement {
|
|
1317
2159
|
/**
|
|
@@ -1320,11 +2162,19 @@ export declare class TimestampElementClass extends BaseUiElement<TimestampElemen
|
|
|
1320
2162
|
* @defaultValue "timestamp"
|
|
1321
2163
|
*/
|
|
1322
2164
|
readonly type = "timestamp";
|
|
1323
|
-
/**
|
|
2165
|
+
/**
|
|
2166
|
+
* The timestamp in milliseconds
|
|
2167
|
+
*
|
|
2168
|
+
* @remarks
|
|
2169
|
+
* Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
|
|
2170
|
+
*/
|
|
1324
2171
|
readonly value: number;
|
|
1325
2172
|
/**
|
|
1326
2173
|
* Presentation date/time format
|
|
1327
2174
|
*
|
|
2175
|
+
* @remarks
|
|
2176
|
+
* Controls whether the timestamp is shown as date and time, date only, time only, or relative text. The default is datetime.
|
|
2177
|
+
*
|
|
1328
2178
|
* @defaultValue TimestampFormat.datetime
|
|
1329
2179
|
*/
|
|
1330
2180
|
readonly format?: TimestampFormat;
|
|
@@ -1334,6 +2184,8 @@ export declare class TimestampElementClass extends BaseUiElement<TimestampElemen
|
|
|
1334
2184
|
* Constructs a new `TimestampElementClass` instance.
|
|
1335
2185
|
*
|
|
1336
2186
|
* @param value - The timestamp in milliseconds
|
|
2187
|
+
|
|
2188
|
+
Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
|
|
1337
2189
|
* @param options - Optional component settings. (format (defaults to `datetime`), modifiers).
|
|
1338
2190
|
*/
|
|
1339
2191
|
constructor(value: number, options?: {
|
|
@@ -1345,7 +2197,7 @@ export declare class TimestampElementClass extends BaseUiElement<TimestampElemen
|
|
|
1345
2197
|
* Class implementation of the `ImageReferenceElement` interface.
|
|
1346
2198
|
*
|
|
1347
2199
|
* @remarks
|
|
1348
|
-
*
|
|
2200
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
1349
2201
|
*/
|
|
1350
2202
|
export declare class ImageReferenceElementClass extends BaseUiElement<ImageReferenceElement> implements ImageReferenceElement {
|
|
1351
2203
|
/**
|
|
@@ -1354,22 +2206,42 @@ export declare class ImageReferenceElementClass extends BaseUiElement<ImageRefer
|
|
|
1354
2206
|
* @defaultValue "image-ref"
|
|
1355
2207
|
*/
|
|
1356
2208
|
readonly type = "image-ref";
|
|
1357
|
-
/**
|
|
2209
|
+
/**
|
|
2210
|
+
* Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
2211
|
+
*
|
|
2212
|
+
* @remarks
|
|
2213
|
+
* Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
|
|
2214
|
+
*/
|
|
1358
2215
|
readonly src: string;
|
|
1359
|
-
/**
|
|
2216
|
+
/**
|
|
2217
|
+
* Accessible alternative description
|
|
2218
|
+
*
|
|
2219
|
+
* @remarks
|
|
2220
|
+
* Alternative text describing the image for assistive technology. Provide meaningful text when the image conveys information; omit it only when it is decorative.
|
|
2221
|
+
*/
|
|
1360
2222
|
readonly alt?: string;
|
|
1361
2223
|
/**
|
|
1362
2224
|
* Aspect ratio of the thumbnail container
|
|
1363
2225
|
*
|
|
2226
|
+
* @remarks
|
|
2227
|
+
* Preferred ratio of the rendered thumbnail container, expressed as a ratio string such as 1:1. It controls presentation rather than modifying the source image.
|
|
2228
|
+
*
|
|
1364
2229
|
* @defaultValue "1:1"
|
|
1365
2230
|
*/
|
|
1366
2231
|
readonly aspectRatio?: string;
|
|
1367
|
-
/**
|
|
2232
|
+
/**
|
|
2233
|
+
* Fallback placeholder image URI
|
|
2234
|
+
*
|
|
2235
|
+
* @remarks
|
|
2236
|
+
* Optional source to display when the primary image cannot be loaded. It follows the same URI conventions as src.
|
|
2237
|
+
*/
|
|
1368
2238
|
readonly placeholder?: string;
|
|
1369
2239
|
/**
|
|
1370
2240
|
* Constructs a new `ImageReferenceElementClass` instance.
|
|
1371
2241
|
*
|
|
1372
2242
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
2243
|
+
|
|
2244
|
+
Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
|
|
1373
2245
|
* @param options - Optional component settings. (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
1374
2246
|
*/
|
|
1375
2247
|
constructor(src: string, options?: {
|
|
@@ -1382,7 +2254,7 @@ export declare class ImageReferenceElementClass extends BaseUiElement<ImageRefer
|
|
|
1382
2254
|
* Class implementation of the `ButtonActionElement` interface.
|
|
1383
2255
|
*
|
|
1384
2256
|
* @remarks
|
|
1385
|
-
*
|
|
2257
|
+
* When activated, the client dispatches commandId to the specified extension and may include target and parameters as command input. disabled and variant affect presentation and availability, not the command's authorization.
|
|
1386
2258
|
*/
|
|
1387
2259
|
export declare class ButtonActionElementClass extends BaseUiAction<ButtonActionElement> implements ButtonActionElement {
|
|
1388
2260
|
/**
|
|
@@ -1391,25 +2263,56 @@ export declare class ButtonActionElementClass extends BaseUiAction<ButtonActionE
|
|
|
1391
2263
|
* @defaultValue "button"
|
|
1392
2264
|
*/
|
|
1393
2265
|
readonly type = "button";
|
|
1394
|
-
/**
|
|
2266
|
+
/**
|
|
2267
|
+
* Command identifier to invoke
|
|
2268
|
+
*
|
|
2269
|
+
* @remarks
|
|
2270
|
+
* Identifier of the registered extension command to dispatch when the button is activated.
|
|
2271
|
+
*/
|
|
1395
2272
|
readonly commandId: string;
|
|
1396
|
-
/**
|
|
2273
|
+
/**
|
|
2274
|
+
* Display label for the action
|
|
2275
|
+
*
|
|
2276
|
+
* @remarks
|
|
2277
|
+
* User-facing label shown on the control. Keep it short and action-oriented.
|
|
2278
|
+
*/
|
|
1397
2279
|
readonly label: string;
|
|
1398
|
-
/**
|
|
2280
|
+
/**
|
|
2281
|
+
* Extension identifier owning the target command
|
|
2282
|
+
*
|
|
2283
|
+
* @remarks
|
|
2284
|
+
* Extension that registers commandId. Omit only when the client can resolve the command in the current extension context.
|
|
2285
|
+
*/
|
|
1399
2286
|
readonly extensionId?: string;
|
|
1400
|
-
/**
|
|
2287
|
+
/**
|
|
2288
|
+
* Target entity or context identifier
|
|
2289
|
+
*
|
|
2290
|
+
* @remarks
|
|
2291
|
+
* Optional entity or context identifier forwarded to the command handler. Its format is determined by the target extension.
|
|
2292
|
+
*/
|
|
1401
2293
|
readonly target?: string;
|
|
1402
|
-
/**
|
|
2294
|
+
/**
|
|
2295
|
+
* Optional arbitrary parameters payload forwarded to the command handler
|
|
2296
|
+
*
|
|
2297
|
+
* @remarks
|
|
2298
|
+
* JSON-compatible arguments passed to the extension command. Define and validate their shape in the command implementation.
|
|
2299
|
+
*/
|
|
1403
2300
|
readonly parameters?: Record<string, unknown>;
|
|
1404
2301
|
/**
|
|
1405
2302
|
* Whether the button is disabled / unavailable
|
|
1406
2303
|
*
|
|
2304
|
+
* @remarks
|
|
2305
|
+
* When true, the client renders the action as unavailable and should not dispatch it from user activation.
|
|
2306
|
+
*
|
|
1407
2307
|
* @defaultValue false
|
|
1408
2308
|
*/
|
|
1409
2309
|
readonly disabled?: boolean;
|
|
1410
2310
|
/**
|
|
1411
2311
|
* Button visual style variant
|
|
1412
2312
|
*
|
|
2313
|
+
* @remarks
|
|
2314
|
+
* Selects the button's emphasis style. Use danger for destructive operations and primary for the main recommended action; the variant does not change behavior.
|
|
2315
|
+
*
|
|
1413
2316
|
* @defaultValue ButtonVariant.secondary
|
|
1414
2317
|
*/
|
|
1415
2318
|
readonly variant?: ButtonVariant;
|
|
@@ -1417,7 +2320,11 @@ export declare class ButtonActionElementClass extends BaseUiAction<ButtonActionE
|
|
|
1417
2320
|
* Constructs a new `ButtonActionElementClass` instance.
|
|
1418
2321
|
*
|
|
1419
2322
|
* @param commandId - Command identifier to invoke
|
|
2323
|
+
|
|
2324
|
+
Identifier of the registered extension command to dispatch when the button is activated.
|
|
1420
2325
|
* @param label - Display label for the action
|
|
2326
|
+
|
|
2327
|
+
User-facing label shown on the control. Keep it short and action-oriented.
|
|
1421
2328
|
* @param options - Optional component settings. (extensionId, target, parameters, disabled (defaults to `false`), variant (defaults to `secondary`)).
|
|
1422
2329
|
*/
|
|
1423
2330
|
constructor(commandId: string, label: string, options?: {
|
|
@@ -1432,7 +2339,7 @@ export declare class ButtonActionElementClass extends BaseUiAction<ButtonActionE
|
|
|
1432
2339
|
* Class implementation of the `ExternalLinkActionElement` interface.
|
|
1433
2340
|
*
|
|
1434
2341
|
* @remarks
|
|
1435
|
-
*
|
|
2342
|
+
* Renders a user-invokable action that opens a destination externally. Use StringUrlElement for a link embedded in content rather than an action control.
|
|
1436
2343
|
*/
|
|
1437
2344
|
export declare class ExternalLinkActionElementClass extends BaseUiAction<ExternalLinkActionElement> implements ExternalLinkActionElement {
|
|
1438
2345
|
/**
|
|
@@ -1441,15 +2348,29 @@ export declare class ExternalLinkActionElementClass extends BaseUiAction<Externa
|
|
|
1441
2348
|
* @defaultValue "external-link"
|
|
1442
2349
|
*/
|
|
1443
2350
|
readonly type = "external-link";
|
|
1444
|
-
/**
|
|
2351
|
+
/**
|
|
2352
|
+
* Target URL destination
|
|
2353
|
+
*
|
|
2354
|
+
* @remarks
|
|
2355
|
+
* External destination opened when the user activates the link action. The client controls how external navigation is handed to the platform.
|
|
2356
|
+
*/
|
|
1445
2357
|
readonly url: string;
|
|
1446
|
-
/**
|
|
2358
|
+
/**
|
|
2359
|
+
* Display label for the action
|
|
2360
|
+
*
|
|
2361
|
+
* @remarks
|
|
2362
|
+
* User-facing label shown on the control. Keep it short and action-oriented.
|
|
2363
|
+
*/
|
|
1447
2364
|
readonly label: string;
|
|
1448
2365
|
/**
|
|
1449
2366
|
* Constructs a new `ExternalLinkActionElementClass` instance.
|
|
1450
2367
|
*
|
|
1451
2368
|
* @param url - Target URL destination
|
|
2369
|
+
|
|
2370
|
+
External destination opened when the user activates the link action. The client controls how external navigation is handed to the platform.
|
|
1452
2371
|
* @param label - Display label for the action
|
|
2372
|
+
|
|
2373
|
+
User-facing label shown on the control. Keep it short and action-oriented.
|
|
1453
2374
|
*/
|
|
1454
2375
|
constructor(url: string, label: string);
|
|
1455
2376
|
}
|
|
@@ -1457,7 +2378,7 @@ export declare class ExternalLinkActionElementClass extends BaseUiAction<Externa
|
|
|
1457
2378
|
* Class implementation of the `MarkdownBlockElement` interface.
|
|
1458
2379
|
*
|
|
1459
2380
|
* @remarks
|
|
1460
|
-
*
|
|
2381
|
+
* Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
|
|
1461
2382
|
*/
|
|
1462
2383
|
export declare class MarkdownBlockElementClass extends BaseUiElement<MarkdownBlockElement> implements MarkdownBlockElement {
|
|
1463
2384
|
/**
|
|
@@ -1466,7 +2387,12 @@ export declare class MarkdownBlockElementClass extends BaseUiElement<MarkdownBlo
|
|
|
1466
2387
|
* @defaultValue "markdown"
|
|
1467
2388
|
*/
|
|
1468
2389
|
readonly type = "markdown";
|
|
1469
|
-
/**
|
|
2390
|
+
/**
|
|
2391
|
+
* Raw Markdown markup content
|
|
2392
|
+
*
|
|
2393
|
+
* @remarks
|
|
2394
|
+
* Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
2395
|
+
*/
|
|
1470
2396
|
readonly content: string;
|
|
1471
2397
|
/** Optional visual modifiers (copyable) */
|
|
1472
2398
|
readonly modifiers?: BaseModifiers;
|
|
@@ -1474,6 +2400,8 @@ export declare class MarkdownBlockElementClass extends BaseUiElement<MarkdownBlo
|
|
|
1474
2400
|
* Constructs a new `MarkdownBlockElementClass` instance.
|
|
1475
2401
|
*
|
|
1476
2402
|
* @param content - Raw Markdown markup content
|
|
2403
|
+
|
|
2404
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
1477
2405
|
* @param options - Optional component settings. (modifiers).
|
|
1478
2406
|
*/
|
|
1479
2407
|
constructor(content: string, options?: {
|
|
@@ -1484,7 +2412,7 @@ export declare class MarkdownBlockElementClass extends BaseUiElement<MarkdownBlo
|
|
|
1484
2412
|
* Class implementation of the `HtmlBlockElement` interface.
|
|
1485
2413
|
*
|
|
1486
2414
|
* @remarks
|
|
1487
|
-
*
|
|
2415
|
+
* Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
|
|
1488
2416
|
*/
|
|
1489
2417
|
export declare class HtmlBlockElementClass extends BaseUiElement<HtmlBlockElement> implements HtmlBlockElement {
|
|
1490
2418
|
/**
|
|
@@ -1493,7 +2421,12 @@ export declare class HtmlBlockElementClass extends BaseUiElement<HtmlBlockElemen
|
|
|
1493
2421
|
* @defaultValue "html"
|
|
1494
2422
|
*/
|
|
1495
2423
|
readonly type = "html";
|
|
1496
|
-
/**
|
|
2424
|
+
/**
|
|
2425
|
+
* Raw HTML markup content
|
|
2426
|
+
*
|
|
2427
|
+
* @remarks
|
|
2428
|
+
* HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
2429
|
+
*/
|
|
1497
2430
|
readonly content: string;
|
|
1498
2431
|
/** Optional visual modifiers (copyable) */
|
|
1499
2432
|
readonly modifiers?: BaseModifiers;
|
|
@@ -1501,6 +2434,8 @@ export declare class HtmlBlockElementClass extends BaseUiElement<HtmlBlockElemen
|
|
|
1501
2434
|
* Constructs a new `HtmlBlockElementClass` instance.
|
|
1502
2435
|
*
|
|
1503
2436
|
* @param content - Raw HTML markup content
|
|
2437
|
+
|
|
2438
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
1504
2439
|
* @param options - Optional component settings. (modifiers).
|
|
1505
2440
|
*/
|
|
1506
2441
|
constructor(content: string, options?: {
|
|
@@ -1511,19 +2446,36 @@ export declare class HtmlBlockElementClass extends BaseUiElement<HtmlBlockElemen
|
|
|
1511
2446
|
* Class implementation of the `Slot` interface.
|
|
1512
2447
|
*
|
|
1513
2448
|
* @remarks
|
|
1514
|
-
*
|
|
2449
|
+
* A slot combines an optional label, a relative width, and one visual child. Slot widths are percentages of the row and should be chosen so the full row's widths form a usable layout.
|
|
1515
2450
|
*/
|
|
1516
2451
|
export declare class SlotClass extends ViewKitNode<Slot> implements Slot {
|
|
1517
|
-
/**
|
|
2452
|
+
/**
|
|
2453
|
+
* Rendered content inside the slot
|
|
2454
|
+
*
|
|
2455
|
+
* @remarks
|
|
2456
|
+
* One visual element displayed in this slot. Use a nested layout element when the slot itself needs multiple children.
|
|
2457
|
+
*/
|
|
1518
2458
|
readonly content: UiElement;
|
|
1519
|
-
/**
|
|
2459
|
+
/**
|
|
2460
|
+
* Optional slot label (e.g. "Slot A")
|
|
2461
|
+
*
|
|
2462
|
+
* @remarks
|
|
2463
|
+
* Short text identifying this region of the row. It is independent of the rendered content.
|
|
2464
|
+
*/
|
|
1520
2465
|
readonly label?: string;
|
|
1521
|
-
/**
|
|
2466
|
+
/**
|
|
2467
|
+
* Width percentage (1-100)
|
|
2468
|
+
*
|
|
2469
|
+
* @remarks
|
|
2470
|
+
* Relative share of the row width. The schema constrains explicit values to the inclusive range 1 through 100.
|
|
2471
|
+
*/
|
|
1522
2472
|
readonly width?: number;
|
|
1523
2473
|
/**
|
|
1524
2474
|
* Constructs a new `SlotClass` instance.
|
|
1525
2475
|
*
|
|
1526
2476
|
* @param content - Rendered content inside the slot
|
|
2477
|
+
|
|
2478
|
+
One visual element displayed in this slot. Use a nested layout element when the slot itself needs multiple children.
|
|
1527
2479
|
* @param options - Optional component settings. (label, width).
|
|
1528
2480
|
*/
|
|
1529
2481
|
constructor(content: UiElement, options?: {
|
|
@@ -1535,7 +2487,7 @@ export declare class SlotClass extends ViewKitNode<Slot> implements Slot {
|
|
|
1535
2487
|
* Class implementation of the `MultiSlotElement` interface.
|
|
1536
2488
|
*
|
|
1537
2489
|
* @remarks
|
|
1538
|
-
*
|
|
2490
|
+
* Use this layout when a row needs explicit regions with independently controlled widths. Each slot contains one child element; unlike FlowingElement, the layout does not automatically wrap a sequence of children.
|
|
1539
2491
|
*/
|
|
1540
2492
|
export declare class MultiSlotElementClass extends BaseUiElement<MultiSlotElement> implements MultiSlotElement {
|
|
1541
2493
|
/**
|
|
@@ -1544,12 +2496,19 @@ export declare class MultiSlotElementClass extends BaseUiElement<MultiSlotElemen
|
|
|
1544
2496
|
* @defaultValue "multi-slot"
|
|
1545
2497
|
*/
|
|
1546
2498
|
readonly type = "multi-slot";
|
|
1547
|
-
/**
|
|
2499
|
+
/**
|
|
2500
|
+
* List of slots comprising the row
|
|
2501
|
+
*
|
|
2502
|
+
* @remarks
|
|
2503
|
+
* Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
|
|
2504
|
+
*/
|
|
1548
2505
|
readonly slots: Slot[];
|
|
1549
2506
|
/**
|
|
1550
2507
|
* Constructs a new `MultiSlotElementClass` instance.
|
|
1551
2508
|
*
|
|
1552
2509
|
* @param slots - List of slots comprising the row
|
|
2510
|
+
|
|
2511
|
+
Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
|
|
1553
2512
|
*/
|
|
1554
2513
|
constructor(slots: Slot[]);
|
|
1555
2514
|
}
|
|
@@ -1557,8 +2516,7 @@ export declare class MultiSlotElementClass extends BaseUiElement<MultiSlotElemen
|
|
|
1557
2516
|
* Class implementation of the `FlowingElement` interface.
|
|
1558
2517
|
*
|
|
1559
2518
|
* @remarks
|
|
1560
|
-
*
|
|
1561
|
-
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
2519
|
+
* Use for compact related values that should flow horizontally and wrap naturally at the available width. Child order is preserved; an optional separator is placed between neighboring children.
|
|
1562
2520
|
*/
|
|
1563
2521
|
export declare class FlowingElementClass extends BaseUiElement<FlowingElement> implements FlowingElement {
|
|
1564
2522
|
/**
|
|
@@ -1567,14 +2525,26 @@ export declare class FlowingElementClass extends BaseUiElement<FlowingElement> i
|
|
|
1567
2525
|
* @defaultValue "flowing"
|
|
1568
2526
|
*/
|
|
1569
2527
|
readonly type = "flowing";
|
|
1570
|
-
/**
|
|
2528
|
+
/**
|
|
2529
|
+
* List of child elements rendered sequentially with line wrapping
|
|
2530
|
+
*
|
|
2531
|
+
* @remarks
|
|
2532
|
+
* Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
|
|
2533
|
+
*/
|
|
1571
2534
|
readonly elements: UiElement[];
|
|
1572
|
-
/**
|
|
2535
|
+
/**
|
|
2536
|
+
* Optional visual separator rendered between sequential child elements
|
|
2537
|
+
*
|
|
2538
|
+
* @remarks
|
|
2539
|
+
* Separator placed between adjacent elements. Omit it when spacing or the child renderers already provide sufficient separation.
|
|
2540
|
+
*/
|
|
1573
2541
|
readonly separator?: Separator;
|
|
1574
2542
|
/**
|
|
1575
2543
|
* Constructs a new `FlowingElementClass` instance.
|
|
1576
2544
|
*
|
|
1577
2545
|
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
2546
|
+
|
|
2547
|
+
Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
|
|
1578
2548
|
* @param options - Optional component settings. (separator).
|
|
1579
2549
|
*/
|
|
1580
2550
|
constructor(elements: UiElement[], options?: {
|
|
@@ -1585,8 +2555,7 @@ export declare class FlowingElementClass extends BaseUiElement<FlowingElement> i
|
|
|
1585
2555
|
* Class implementation of the `LabelValueElement` interface.
|
|
1586
2556
|
*
|
|
1587
2557
|
* @remarks
|
|
1588
|
-
*
|
|
1589
|
-
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
2558
|
+
* Represents one named value with a muted left-hand label and a right-hand visual element. Use it for a single field; use TableElement for repeated rows or column-aligned data.
|
|
1590
2559
|
*/
|
|
1591
2560
|
export declare class LabelValueElementClass extends BaseUiElement<LabelValueElement> implements LabelValueElement {
|
|
1592
2561
|
/**
|
|
@@ -1595,13 +2564,26 @@ export declare class LabelValueElementClass extends BaseUiElement<LabelValueElem
|
|
|
1595
2564
|
* @defaultValue "label-value"
|
|
1596
2565
|
*/
|
|
1597
2566
|
readonly type = "label-value";
|
|
1598
|
-
/**
|
|
2567
|
+
/**
|
|
2568
|
+
* Key or descriptive label displayed muted on the left
|
|
2569
|
+
*
|
|
2570
|
+
* @remarks
|
|
2571
|
+
* Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
|
|
2572
|
+
*/
|
|
1599
2573
|
readonly label: string;
|
|
1600
|
-
/**
|
|
2574
|
+
/**
|
|
2575
|
+
* Rendered value element on the right
|
|
2576
|
+
*
|
|
2577
|
+
* @remarks
|
|
2578
|
+
* Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
|
|
2579
|
+
*/
|
|
1601
2580
|
readonly value: UiElement;
|
|
1602
2581
|
/**
|
|
1603
2582
|
* Whether to render a bottom border/hairline divider
|
|
1604
2583
|
*
|
|
2584
|
+
* @remarks
|
|
2585
|
+
* Enables a horizontal separator beneath this row when true. Defaults to false.
|
|
2586
|
+
*
|
|
1605
2587
|
* @defaultValue false
|
|
1606
2588
|
*/
|
|
1607
2589
|
readonly withDivider?: boolean;
|
|
@@ -1609,7 +2591,11 @@ export declare class LabelValueElementClass extends BaseUiElement<LabelValueElem
|
|
|
1609
2591
|
* Constructs a new `LabelValueElementClass` instance.
|
|
1610
2592
|
*
|
|
1611
2593
|
* @param label - Key or descriptive label displayed muted on the left
|
|
2594
|
+
|
|
2595
|
+
Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
|
|
1612
2596
|
* @param value - Rendered value element on the right
|
|
2597
|
+
|
|
2598
|
+
Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
|
|
1613
2599
|
* @param options - Optional component settings. (withDivider (defaults to `false`)).
|
|
1614
2600
|
*/
|
|
1615
2601
|
constructor(label: string, value: UiElement, options?: {
|
|
@@ -1620,22 +2606,38 @@ export declare class LabelValueElementClass extends BaseUiElement<LabelValueElem
|
|
|
1620
2606
|
* Class implementation of the `TableColumn` interface.
|
|
1621
2607
|
*
|
|
1622
2608
|
* @remarks
|
|
1623
|
-
*
|
|
2609
|
+
* Describes one table column and its visual sizing. When columns are supplied, their order corresponds to the position of each cell in a row.
|
|
1624
2610
|
*/
|
|
1625
2611
|
export declare class TableColumnClass extends ViewKitNode<TableColumn> implements TableColumn {
|
|
1626
|
-
/**
|
|
2612
|
+
/**
|
|
2613
|
+
* Display header text
|
|
2614
|
+
*
|
|
2615
|
+
* @remarks
|
|
2616
|
+
* Optional header shown above values in this column. Omit when the table has no header row.
|
|
2617
|
+
*/
|
|
1627
2618
|
readonly header?: string;
|
|
1628
2619
|
/**
|
|
1629
2620
|
* Text horizontal alignment
|
|
1630
2621
|
*
|
|
2622
|
+
* @remarks
|
|
2623
|
+
* Horizontal alignment applied to cell content in the column. Defaults to left.
|
|
2624
|
+
*
|
|
1631
2625
|
* @defaultValue TableColumnAlign.left
|
|
1632
2626
|
*/
|
|
1633
2627
|
readonly align?: TableColumnAlign;
|
|
1634
|
-
/**
|
|
2628
|
+
/**
|
|
2629
|
+
* Width percentage (1-100)
|
|
2630
|
+
*
|
|
2631
|
+
* @remarks
|
|
2632
|
+
* Column width percentage used with widthMode. Explicit values are constrained to 1 through 100.
|
|
2633
|
+
*/
|
|
1635
2634
|
readonly width?: number;
|
|
1636
2635
|
/**
|
|
1637
2636
|
* Sizing mode for the provided width
|
|
1638
2637
|
*
|
|
2638
|
+
* @remarks
|
|
2639
|
+
* Determines whether width is a fixed percentage allocation or an upper bound. Defaults to fixed.
|
|
2640
|
+
*
|
|
1639
2641
|
* @defaultValue TableColumnWidthMode.fixed
|
|
1640
2642
|
*/
|
|
1641
2643
|
readonly widthMode?: TableColumnWidthMode;
|
|
@@ -1655,15 +2657,22 @@ export declare class TableColumnClass extends ViewKitNode<TableColumn> implement
|
|
|
1655
2657
|
* Class implementation of the `TableRow` interface.
|
|
1656
2658
|
*
|
|
1657
2659
|
* @remarks
|
|
1658
|
-
*
|
|
2660
|
+
* A row's cell array is positional: cell at each index corresponds to the column at that index. Keep row lengths aligned with the table's explicit column definitions when present.
|
|
1659
2661
|
*/
|
|
1660
2662
|
export declare class TableRowClass extends ViewKitNode<TableRow> implements TableRow {
|
|
1661
|
-
/**
|
|
2663
|
+
/**
|
|
2664
|
+
* Array of cell values corresponding to table columns
|
|
2665
|
+
*
|
|
2666
|
+
* @remarks
|
|
2667
|
+
* Ordered contents for this row. Each cell is a UiElement so values can use the same primitive and layout renderers as other ViewKit content.
|
|
2668
|
+
*/
|
|
1662
2669
|
readonly cells: UiElement[];
|
|
1663
2670
|
/**
|
|
1664
2671
|
* Constructs a new `TableRowClass` instance.
|
|
1665
2672
|
*
|
|
1666
2673
|
* @param cells - Array of cell values corresponding to table columns
|
|
2674
|
+
|
|
2675
|
+
Ordered contents for this row. Each cell is a UiElement so values can use the same primitive and layout renderers as other ViewKit content.
|
|
1667
2676
|
*/
|
|
1668
2677
|
constructor(cells: UiElement[]);
|
|
1669
2678
|
}
|
|
@@ -1671,8 +2680,7 @@ export declare class TableRowClass extends ViewKitNode<TableRow> implements Tabl
|
|
|
1671
2680
|
* Class implementation of the `TableElement` interface.
|
|
1672
2681
|
*
|
|
1673
2682
|
* @remarks
|
|
1674
|
-
*
|
|
1675
|
-
* Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
|
|
2683
|
+
* Use for data that benefits from aligned rows and columns, including key/value and multi-column tables. Supply rows in display order; explicit columns are optional, and divider/striping flags independently control visual separators and alternating backgrounds.
|
|
1676
2684
|
*/
|
|
1677
2685
|
export declare class TableElementClass extends BaseUiElement<TableElement> implements TableElement {
|
|
1678
2686
|
/**
|
|
@@ -1681,32 +2689,53 @@ export declare class TableElementClass extends BaseUiElement<TableElement> imple
|
|
|
1681
2689
|
* @defaultValue "table"
|
|
1682
2690
|
*/
|
|
1683
2691
|
readonly type = "table";
|
|
1684
|
-
/**
|
|
2692
|
+
/**
|
|
2693
|
+
* Tabular data rows
|
|
2694
|
+
*
|
|
2695
|
+
* @remarks
|
|
2696
|
+
* Ordered table rows. Each row's cells correspond positionally to the declared columns.
|
|
2697
|
+
*/
|
|
1685
2698
|
readonly rows: TableRow[];
|
|
1686
2699
|
/**
|
|
1687
2700
|
* Whether to render alternating row background colors
|
|
1688
2701
|
*
|
|
2702
|
+
* @remarks
|
|
2703
|
+
* Enables alternating backgrounds across successive rows to improve scanability. Defaults to false.
|
|
2704
|
+
*
|
|
1689
2705
|
* @defaultValue false
|
|
1690
2706
|
*/
|
|
1691
2707
|
readonly isStriped?: boolean;
|
|
1692
2708
|
/**
|
|
1693
2709
|
* Whether to render vertical column separators
|
|
1694
2710
|
*
|
|
2711
|
+
* @remarks
|
|
2712
|
+
* Adds vertical dividers between columns when true. Defaults to false.
|
|
2713
|
+
*
|
|
1695
2714
|
* @defaultValue false
|
|
1696
2715
|
*/
|
|
1697
2716
|
readonly withColumnSeparators?: boolean;
|
|
1698
2717
|
/**
|
|
1699
2718
|
* Whether to render horizontal row separators
|
|
1700
2719
|
*
|
|
2720
|
+
* @remarks
|
|
2721
|
+
* Adds horizontal dividers between rows when true. Defaults to false.
|
|
2722
|
+
*
|
|
1701
2723
|
* @defaultValue false
|
|
1702
2724
|
*/
|
|
1703
2725
|
readonly withRowSeparators?: boolean;
|
|
1704
|
-
/**
|
|
2726
|
+
/**
|
|
2727
|
+
* Optional explicit column definitions
|
|
2728
|
+
*
|
|
2729
|
+
* @remarks
|
|
2730
|
+
* Optional ordered column metadata defining headers, alignment, and width. When omitted, the renderer may infer a basic layout from row cells.
|
|
2731
|
+
*/
|
|
1705
2732
|
readonly columns?: TableColumn[];
|
|
1706
2733
|
/**
|
|
1707
2734
|
* Constructs a new `TableElementClass` instance.
|
|
1708
2735
|
*
|
|
1709
2736
|
* @param rows - Tabular data rows
|
|
2737
|
+
|
|
2738
|
+
Ordered table rows. Each row's cells correspond positionally to the declared columns.
|
|
1710
2739
|
* @param options - Optional component settings. (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
|
|
1711
2740
|
*/
|
|
1712
2741
|
constructor(rows: TableRow[], options?: {
|
|
@@ -1720,19 +2749,36 @@ export declare class TableElementClass extends BaseUiElement<TableElement> imple
|
|
|
1720
2749
|
* Class implementation of the `RepeatingGroupEntry` interface.
|
|
1721
2750
|
*
|
|
1722
2751
|
* @remarks
|
|
1723
|
-
*
|
|
2752
|
+
* A repeating entry carries a stable display label and either one primary value or a list of nested elements, depending on the shape needed by the feature.
|
|
1724
2753
|
*/
|
|
1725
2754
|
export declare class RepeatingGroupEntryClass extends ViewKitNode<RepeatingGroupEntry> implements RepeatingGroupEntry {
|
|
1726
|
-
/**
|
|
2755
|
+
/**
|
|
2756
|
+
* Entry label
|
|
2757
|
+
*
|
|
2758
|
+
* @remarks
|
|
2759
|
+
* Short label identifying this entry within the repeated group.
|
|
2760
|
+
*/
|
|
1727
2761
|
readonly label: string;
|
|
1728
|
-
/**
|
|
2762
|
+
/**
|
|
2763
|
+
* Primary entry value or nested elements
|
|
2764
|
+
*
|
|
2765
|
+
* @remarks
|
|
2766
|
+
* Optional primary visual value for a compact entry. Use elements for a multi-part structured entry.
|
|
2767
|
+
*/
|
|
1729
2768
|
readonly value?: UiElement;
|
|
1730
|
-
/**
|
|
2769
|
+
/**
|
|
2770
|
+
* Nested elements for structured entries
|
|
2771
|
+
*
|
|
2772
|
+
* @remarks
|
|
2773
|
+
* Optional ordered content for entries that require more than one value element.
|
|
2774
|
+
*/
|
|
1731
2775
|
readonly elements?: UiElement[];
|
|
1732
2776
|
/**
|
|
1733
2777
|
* Constructs a new `RepeatingGroupEntryClass` instance.
|
|
1734
2778
|
*
|
|
1735
2779
|
* @param label - Entry label
|
|
2780
|
+
|
|
2781
|
+
Short label identifying this entry within the repeated group.
|
|
1736
2782
|
* @param options - Optional component settings. (value, elements).
|
|
1737
2783
|
*/
|
|
1738
2784
|
constructor(label: string, options?: {
|
|
@@ -1744,7 +2790,7 @@ export declare class RepeatingGroupEntryClass extends ViewKitNode<RepeatingGroup
|
|
|
1744
2790
|
* Class implementation of the `RepeatingGroupElement` interface.
|
|
1745
2791
|
*
|
|
1746
2792
|
* @remarks
|
|
1747
|
-
*
|
|
2793
|
+
* Groups a sequence of labeled entries under one optional section title. Use it when records have the same general presentation but need their own labels.
|
|
1748
2794
|
*/
|
|
1749
2795
|
export declare class RepeatingGroupElementClass extends BaseUiElement<RepeatingGroupElement> implements RepeatingGroupElement {
|
|
1750
2796
|
/**
|
|
@@ -1753,14 +2799,26 @@ export declare class RepeatingGroupElementClass extends BaseUiElement<RepeatingG
|
|
|
1753
2799
|
* @defaultValue "repeating-group"
|
|
1754
2800
|
*/
|
|
1755
2801
|
readonly type = "repeating-group";
|
|
1756
|
-
/**
|
|
2802
|
+
/**
|
|
2803
|
+
* List of repeated entry records
|
|
2804
|
+
*
|
|
2805
|
+
* @remarks
|
|
2806
|
+
* Entries in display order. Each entry supplies its own label and content.
|
|
2807
|
+
*/
|
|
1757
2808
|
readonly entries: RepeatingGroupEntry[];
|
|
1758
|
-
/**
|
|
2809
|
+
/**
|
|
2810
|
+
* Optional section header for the group
|
|
2811
|
+
*
|
|
2812
|
+
* @remarks
|
|
2813
|
+
* Heading displayed for the repeated section, separate from the labels of individual entries.
|
|
2814
|
+
*/
|
|
1759
2815
|
readonly title?: string;
|
|
1760
2816
|
/**
|
|
1761
2817
|
* Constructs a new `RepeatingGroupElementClass` instance.
|
|
1762
2818
|
*
|
|
1763
2819
|
* @param entries - List of repeated entry records
|
|
2820
|
+
|
|
2821
|
+
Entries in display order. Each entry supplies its own label and content.
|
|
1764
2822
|
* @param options - Optional component settings. (title).
|
|
1765
2823
|
*/
|
|
1766
2824
|
constructor(entries: RepeatingGroupEntry[], options?: {
|
|
@@ -1771,7 +2829,7 @@ export declare class RepeatingGroupElementClass extends BaseUiElement<RepeatingG
|
|
|
1771
2829
|
* Class implementation of the `CollapsibleGroupElement` interface.
|
|
1772
2830
|
*
|
|
1773
2831
|
* @remarks
|
|
1774
|
-
*
|
|
2832
|
+
* Groups nested content behind a disclosure control. The title names the group, summary can provide a compact status indicator, and defaultExpanded controls only the initial state.
|
|
1775
2833
|
*/
|
|
1776
2834
|
export declare class CollapsibleGroupElementClass extends BaseUiElement<CollapsibleGroupElement> implements CollapsibleGroupElement {
|
|
1777
2835
|
/**
|
|
@@ -1780,15 +2838,33 @@ export declare class CollapsibleGroupElementClass extends BaseUiElement<Collapsi
|
|
|
1780
2838
|
* @defaultValue "collapsible-group"
|
|
1781
2839
|
*/
|
|
1782
2840
|
readonly type = "collapsible-group";
|
|
1783
|
-
/**
|
|
2841
|
+
/**
|
|
2842
|
+
* Group title (e.g. "Show specimen details")
|
|
2843
|
+
*
|
|
2844
|
+
* @remarks
|
|
2845
|
+
* Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
|
|
2846
|
+
*/
|
|
1784
2847
|
readonly title: string;
|
|
1785
|
-
/**
|
|
2848
|
+
/**
|
|
2849
|
+
* Nested content elements revealed when expanded
|
|
2850
|
+
*
|
|
2851
|
+
* @remarks
|
|
2852
|
+
* Ordered child elements made visible by expanding the group.
|
|
2853
|
+
*/
|
|
1786
2854
|
readonly elements: UiElement[];
|
|
1787
|
-
/**
|
|
2855
|
+
/**
|
|
2856
|
+
* Secondary summary indicator (e.g. "2 neutral values")
|
|
2857
|
+
*
|
|
2858
|
+
* @remarks
|
|
2859
|
+
* Compact contextual text shown alongside the title while the group is collapsed or expanded. It does not replace the nested content.
|
|
2860
|
+
*/
|
|
1788
2861
|
readonly summary?: string;
|
|
1789
2862
|
/**
|
|
1790
2863
|
* Whether the disclosure is open/expanded by default
|
|
1791
2864
|
*
|
|
2865
|
+
* @remarks
|
|
2866
|
+
* Initial expanded state requested by the data. Defaults to false; subsequent interaction is managed by the client.
|
|
2867
|
+
*
|
|
1792
2868
|
* @defaultValue false
|
|
1793
2869
|
*/
|
|
1794
2870
|
readonly defaultExpanded?: boolean;
|
|
@@ -1796,7 +2872,11 @@ export declare class CollapsibleGroupElementClass extends BaseUiElement<Collapsi
|
|
|
1796
2872
|
* Constructs a new `CollapsibleGroupElementClass` instance.
|
|
1797
2873
|
*
|
|
1798
2874
|
* @param title - Group title (e.g. "Show specimen details")
|
|
2875
|
+
|
|
2876
|
+
Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
|
|
1799
2877
|
* @param elements - Nested content elements revealed when expanded
|
|
2878
|
+
|
|
2879
|
+
Ordered child elements made visible by expanding the group.
|
|
1800
2880
|
* @param options - Optional component settings. (summary, defaultExpanded (defaults to `false`)).
|
|
1801
2881
|
*/
|
|
1802
2882
|
constructor(title: string, elements: UiElement[], options?: {
|
|
@@ -1808,7 +2888,7 @@ export declare class CollapsibleGroupElementClass extends BaseUiElement<Collapsi
|
|
|
1808
2888
|
* Class implementation of the `DividerElement` interface.
|
|
1809
2889
|
*
|
|
1810
2890
|
* @remarks
|
|
1811
|
-
*
|
|
2891
|
+
* A standalone visual separator for dividing adjacent sections or element groups. Use the divider flags on tables or rows when the separator is part of that structure.
|
|
1812
2892
|
*/
|
|
1813
2893
|
export declare class DividerElementClass extends BaseUiElement<DividerElement> implements DividerElement {
|
|
1814
2894
|
/**
|
|
@@ -1820,6 +2900,9 @@ export declare class DividerElementClass extends BaseUiElement<DividerElement> i
|
|
|
1820
2900
|
/**
|
|
1821
2901
|
* Line styling
|
|
1822
2902
|
*
|
|
2903
|
+
* @remarks
|
|
2904
|
+
* Visual stroke treatment for the separator. Defaults to a subtle hairline.
|
|
2905
|
+
*
|
|
1823
2906
|
* @defaultValue DividerStyle.hairline
|
|
1824
2907
|
*/
|
|
1825
2908
|
readonly style?: DividerStyle;
|
|
@@ -1836,12 +2919,15 @@ export declare class DividerElementClass extends BaseUiElement<DividerElement> i
|
|
|
1836
2919
|
* Class implementation of the `Envelop` interface.
|
|
1837
2920
|
*
|
|
1838
2921
|
* @remarks
|
|
1839
|
-
*
|
|
2922
|
+
* All root ViewKit documents extend this envelope so consumers can identify the schema contract version before processing the root content.
|
|
1840
2923
|
*/
|
|
1841
2924
|
export declare class EnvelopClass extends ViewKitNode<Envelop> implements Envelop {
|
|
1842
2925
|
/**
|
|
1843
2926
|
* Schema specification version
|
|
1844
2927
|
*
|
|
2928
|
+
* @remarks
|
|
2929
|
+
* Version of the ViewKit envelope contract. It is a literal value and should be preserved when serializing or forwarding a document.
|
|
2930
|
+
*
|
|
1845
2931
|
* @defaultValue "1.0"
|
|
1846
2932
|
*/
|
|
1847
2933
|
readonly schemaVersion: "1.0";
|
|
@@ -1858,14 +2944,22 @@ export declare class EnvelopClass extends ViewKitNode<Envelop> implements Envelo
|
|
|
1858
2944
|
* Class implementation of the `UiContainer` interface.
|
|
1859
2945
|
*
|
|
1860
2946
|
* @remarks
|
|
1861
|
-
*
|
|
2947
|
+
* Provides the shared root content collection inherited by cards and other root models. The order of elements is significant and is preserved by the renderer.
|
|
1862
2948
|
*/
|
|
1863
2949
|
export declare class UiContainerClass extends ViewKitNode<UiContainer> implements UiContainer {
|
|
1864
|
-
/**
|
|
2950
|
+
/**
|
|
2951
|
+
* Ordered list of visual elements, structures, and content
|
|
2952
|
+
*
|
|
2953
|
+
* @remarks
|
|
2954
|
+
* Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
|
|
2955
|
+
*/
|
|
1865
2956
|
readonly elements: UiElement[];
|
|
1866
2957
|
/**
|
|
1867
2958
|
* Schema specification version
|
|
1868
2959
|
*
|
|
2960
|
+
* @remarks
|
|
2961
|
+
* Version of the ViewKit envelope contract. It is a literal value and should be preserved when serializing or forwarding a document.
|
|
2962
|
+
*
|
|
1869
2963
|
* @defaultValue "1.0"
|
|
1870
2964
|
*/
|
|
1871
2965
|
readonly schemaVersion: "1.0";
|
|
@@ -1873,6 +2967,8 @@ export declare class UiContainerClass extends ViewKitNode<UiContainer> implement
|
|
|
1873
2967
|
* Constructs a new `UiContainerClass` instance.
|
|
1874
2968
|
*
|
|
1875
2969
|
* @param elements - Ordered list of visual elements, structures, and content
|
|
2970
|
+
|
|
2971
|
+
Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
|
|
1876
2972
|
* @param options - Optional component settings. (schemaVersion (defaults to `1.0`)).
|
|
1877
2973
|
*/
|
|
1878
2974
|
constructor(elements: UiElement[], options?: {
|
|
@@ -1883,21 +2979,43 @@ export declare class UiContainerClass extends ViewKitNode<UiContainer> implement
|
|
|
1883
2979
|
* Class implementation of the `UiCard` interface.
|
|
1884
2980
|
*
|
|
1885
2981
|
* @remarks
|
|
1886
|
-
*
|
|
1887
|
-
* Represents a complete feature card rendered inside the 360px panel.
|
|
2982
|
+
* A complete card has a required title and ordered content inherited from UiContainer. It is designed for the feature-card surface; description and actions supplement the content, with action controls rendered separately from the element list.
|
|
1888
2983
|
*/
|
|
1889
2984
|
export declare class UiCardClass extends ViewKitNode<UiCard> implements UiCard {
|
|
1890
|
-
/**
|
|
2985
|
+
/**
|
|
2986
|
+
* Human-readable feature title displayed in the card header
|
|
2987
|
+
*
|
|
2988
|
+
* @remarks
|
|
2989
|
+
* Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
|
|
2990
|
+
*/
|
|
1891
2991
|
readonly title: string;
|
|
1892
|
-
/**
|
|
2992
|
+
/**
|
|
2993
|
+
* Ordered list of visual elements, structures, and content
|
|
2994
|
+
*
|
|
2995
|
+
* @remarks
|
|
2996
|
+
* Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
|
|
2997
|
+
*/
|
|
1893
2998
|
readonly elements: UiElement[];
|
|
1894
|
-
/**
|
|
2999
|
+
/**
|
|
3000
|
+
* Optional neutral subtitle / description for the feature
|
|
3001
|
+
*
|
|
3002
|
+
* @remarks
|
|
3003
|
+
* Brief secondary context shown with the title. Use the content elements for detailed information rather than placing an entire report in this field.
|
|
3004
|
+
*/
|
|
1895
3005
|
readonly description?: string;
|
|
1896
|
-
/**
|
|
3006
|
+
/**
|
|
3007
|
+
* Optional card action buttons rendered at the base of the feature card
|
|
3008
|
+
*
|
|
3009
|
+
* @remarks
|
|
3010
|
+
* Optional user-invokable actions shown after the card content. Their order is preserved and each action's own fields define its command or link behavior.
|
|
3011
|
+
*/
|
|
1897
3012
|
readonly actions?: UiAction[];
|
|
1898
3013
|
/**
|
|
1899
3014
|
* Schema specification version
|
|
1900
3015
|
*
|
|
3016
|
+
* @remarks
|
|
3017
|
+
* Version of the ViewKit envelope contract. It is a literal value and should be preserved when serializing or forwarding a document.
|
|
3018
|
+
*
|
|
1901
3019
|
* @defaultValue "1.0"
|
|
1902
3020
|
*/
|
|
1903
3021
|
readonly schemaVersion: "1.0";
|
|
@@ -1905,7 +3023,11 @@ export declare class UiCardClass extends ViewKitNode<UiCard> implements UiCard {
|
|
|
1905
3023
|
* Constructs a new `UiCardClass` instance.
|
|
1906
3024
|
*
|
|
1907
3025
|
* @param title - Human-readable feature title displayed in the card header
|
|
3026
|
+
|
|
3027
|
+
Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
|
|
1908
3028
|
* @param elements - Ordered list of visual elements, structures, and content
|
|
3029
|
+
|
|
3030
|
+
Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
|
|
1909
3031
|
* @param options - Optional component settings. (description, actions, schemaVersion (defaults to `1.0`)).
|
|
1910
3032
|
*/
|
|
1911
3033
|
constructor(title: string, elements: UiElement[], options?: {
|
|
@@ -1918,7 +3040,7 @@ export declare class UiCardClass extends ViewKitNode<UiCard> implements UiCard {
|
|
|
1918
3040
|
* Fluent builder for constructing strongly-typed `UiContainer` instances.
|
|
1919
3041
|
*
|
|
1920
3042
|
* @remarks
|
|
1921
|
-
*
|
|
3043
|
+
* Provides the shared root content collection inherited by cards and other root models. The order of elements is significant and is preserved by the renderer.
|
|
1922
3044
|
*/
|
|
1923
3045
|
export declare class UiContainerBuilder {
|
|
1924
3046
|
private readonly _elements;
|
|
@@ -1942,10 +3064,11 @@ export declare class UiContainerBuilder {
|
|
|
1942
3064
|
* Appends a `StringElement` component.
|
|
1943
3065
|
*
|
|
1944
3066
|
* @remarks
|
|
1945
|
-
*
|
|
1946
|
-
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
3067
|
+
* Use this primitive for one textual value when a structured label/value row is unnecessary. Choose multiline for content whose line breaks should remain visible; modifiers apply presentation traits without changing the underlying value.
|
|
1947
3068
|
*
|
|
1948
3069
|
* @param value - Text value
|
|
3070
|
+
|
|
3071
|
+
Text to render. Supply plain text; this field is not a Markdown or HTML document.
|
|
1949
3072
|
* @param options - Optional component settings (representation (defaults to `plain`), modifiers).
|
|
1950
3073
|
* @returns This builder instance for method chaining.
|
|
1951
3074
|
*/
|
|
@@ -1957,10 +3080,11 @@ export declare class UiContainerBuilder {
|
|
|
1957
3080
|
* Appends a `StringsElement` component.
|
|
1958
3081
|
*
|
|
1959
3082
|
* @remarks
|
|
1960
|
-
*
|
|
1961
|
-
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
3083
|
+
* Use this primitive when several related strings should be rendered as one compact sequence. The client preserves the array order and inserts the selected separator between values.
|
|
1962
3084
|
*
|
|
1963
3085
|
* @param values - Array of string values
|
|
3086
|
+
|
|
3087
|
+
Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
|
|
1964
3088
|
* @param options - Optional component settings (representation (defaults to `plain`), separator, modifiers).
|
|
1965
3089
|
* @returns This builder instance for method chaining.
|
|
1966
3090
|
*/
|
|
@@ -1973,9 +3097,11 @@ export declare class UiContainerBuilder {
|
|
|
1973
3097
|
* Appends a `StringCodeElement` component.
|
|
1974
3098
|
*
|
|
1975
3099
|
* @remarks
|
|
1976
|
-
*
|
|
3100
|
+
* Use for source-like or preformatted textual content that should be rendered in a code-oriented style. The language is a presentation hint; the content is not parsed or validated as code by this contract.
|
|
1977
3101
|
*
|
|
1978
3102
|
* @param value - Text value
|
|
3103
|
+
|
|
3104
|
+
Code or text snippet to display. Include any desired line breaks in this string.
|
|
1979
3105
|
* @param options - Optional component settings (language, modifiers).
|
|
1980
3106
|
* @returns This builder instance for method chaining.
|
|
1981
3107
|
*/
|
|
@@ -1987,9 +3113,11 @@ export declare class UiContainerBuilder {
|
|
|
1987
3113
|
* Appends a `XmlElement` component.
|
|
1988
3114
|
*
|
|
1989
3115
|
* @remarks
|
|
1990
|
-
* XML
|
|
3116
|
+
* Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
|
|
1991
3117
|
*
|
|
1992
3118
|
* @param value - XML content value
|
|
3119
|
+
|
|
3120
|
+
XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
|
|
1993
3121
|
* @param options - Optional component settings (modifiers).
|
|
1994
3122
|
* @returns This builder instance for method chaining.
|
|
1995
3123
|
*/
|
|
@@ -2000,9 +3128,11 @@ export declare class UiContainerBuilder {
|
|
|
2000
3128
|
* Appends a `JsonElement` component.
|
|
2001
3129
|
*
|
|
2002
3130
|
* @remarks
|
|
2003
|
-
* JSON
|
|
3131
|
+
* Specialized representation for JSON text. Supply serialized JSON when consumers should display a JSON document; this field is a string and is not structurally validated here.
|
|
2004
3132
|
*
|
|
2005
3133
|
* @param value - JSON content value
|
|
3134
|
+
|
|
3135
|
+
Serialized JSON text to render. No parsing or schema validation is implied by this element.
|
|
2006
3136
|
* @param options - Optional component settings (modifiers).
|
|
2007
3137
|
* @returns This builder instance for method chaining.
|
|
2008
3138
|
*/
|
|
@@ -2013,9 +3143,11 @@ export declare class UiContainerBuilder {
|
|
|
2013
3143
|
* Appends a `StringUrlElement` component.
|
|
2014
3144
|
*
|
|
2015
3145
|
* @remarks
|
|
2016
|
-
*
|
|
3146
|
+
* Use this element when displayed text should also behave as a link. Unlike StringElement, the value is a navigation destination and may be paired with a separate human-readable label.
|
|
2017
3147
|
*
|
|
2018
3148
|
* @param value - Target URL or navigation destination
|
|
3149
|
+
|
|
3150
|
+
Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
|
|
2019
3151
|
* @param options - Optional component settings (label, modifiers).
|
|
2020
3152
|
* @returns This builder instance for method chaining.
|
|
2021
3153
|
*/
|
|
@@ -2027,9 +3159,11 @@ export declare class UiContainerBuilder {
|
|
|
2027
3159
|
* Appends a `IdentifierElement` component.
|
|
2028
3160
|
*
|
|
2029
3161
|
* @remarks
|
|
2030
|
-
*
|
|
3162
|
+
* Use for identifiers, hashes, and other machine-oriented strings that benefit from monospace styling. The value remains text and is not resolved as a Picteus entity.
|
|
2031
3163
|
*
|
|
2032
3164
|
* @param value - Identifier string value
|
|
3165
|
+
|
|
3166
|
+
Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
|
|
2033
3167
|
* @param options - Optional component settings (modifiers).
|
|
2034
3168
|
* @returns This builder instance for method chaining.
|
|
2035
3169
|
*/
|
|
@@ -2040,9 +3174,11 @@ export declare class UiContainerBuilder {
|
|
|
2040
3174
|
* Appends a `RatioElement` component.
|
|
2041
3175
|
*
|
|
2042
3176
|
* @remarks
|
|
2043
|
-
*
|
|
3177
|
+
* Displays a numeric aspect ratio as a ratio expression. Provide a positive value meaningful to the surrounding content; this type does not encode the source image dimensions.
|
|
2044
3178
|
*
|
|
2045
3179
|
* @param value - Aspect ratio numerical expression
|
|
3180
|
+
|
|
3181
|
+
Numeric ratio value used by the renderer to produce an aspect-ratio display.
|
|
2046
3182
|
* @param options - Optional component settings (modifiers).
|
|
2047
3183
|
* @returns This builder instance for method chaining.
|
|
2048
3184
|
*/
|
|
@@ -2053,10 +3189,14 @@ export declare class UiContainerBuilder {
|
|
|
2053
3189
|
* Appends a `DimensionsElement` component.
|
|
2054
3190
|
*
|
|
2055
3191
|
* @remarks
|
|
2056
|
-
*
|
|
3192
|
+
* Displays a width/height pair as image dimensions. Both values are positive pixel counts; together they describe dimensions, not an aspect ratio or a resize request.
|
|
2057
3193
|
*
|
|
2058
3194
|
* @param width - Width in pixels
|
|
3195
|
+
|
|
3196
|
+
Horizontal pixel count. Values below one are rejected by the schema constraint.
|
|
2059
3197
|
* @param height - Height in pixels
|
|
3198
|
+
|
|
3199
|
+
Vertical pixel count. Values below one are rejected by the schema constraint.
|
|
2060
3200
|
* @param options - Optional component settings (modifiers).
|
|
2061
3201
|
* @returns This builder instance for method chaining.
|
|
2062
3202
|
*/
|
|
@@ -2067,9 +3207,11 @@ export declare class UiContainerBuilder {
|
|
|
2067
3207
|
* Appends a `ColourElement` component.
|
|
2068
3208
|
*
|
|
2069
3209
|
* @remarks
|
|
2070
|
-
*
|
|
3210
|
+
* Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
|
|
2071
3211
|
*
|
|
2072
3212
|
* @param value - Hexadecimal color code
|
|
3213
|
+
|
|
3214
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
2073
3215
|
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
2074
3216
|
* @returns This builder instance for method chaining.
|
|
2075
3217
|
*/
|
|
@@ -2084,9 +3226,11 @@ export declare class UiContainerBuilder {
|
|
|
2084
3226
|
* Appends a `ColourElement` component.
|
|
2085
3227
|
*
|
|
2086
3228
|
* @remarks
|
|
2087
|
-
*
|
|
3229
|
+
* Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
|
|
2088
3230
|
*
|
|
2089
3231
|
* @param value - Hexadecimal color code
|
|
3232
|
+
|
|
3233
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
2090
3234
|
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
2091
3235
|
* @returns This builder instance for method chaining.
|
|
2092
3236
|
*/
|
|
@@ -2101,9 +3245,11 @@ export declare class UiContainerBuilder {
|
|
|
2101
3245
|
* Appends a `NumberUnboundedElement` component.
|
|
2102
3246
|
*
|
|
2103
3247
|
* @remarks
|
|
2104
|
-
*
|
|
3248
|
+
* Displays a numeric value without a progress scale or rating interpretation. Use unit to communicate the measurement context; no range is imposed by this model.
|
|
2105
3249
|
*
|
|
2106
3250
|
* @param value - Numeric value
|
|
3251
|
+
|
|
3252
|
+
Number to display. Its meaning and any valid range are defined by the producing feature.
|
|
2107
3253
|
* @param options - Optional component settings (unit, modifiers).
|
|
2108
3254
|
* @returns This builder instance for method chaining.
|
|
2109
3255
|
*/
|
|
@@ -2115,9 +3261,11 @@ export declare class UiContainerBuilder {
|
|
|
2115
3261
|
* Appends a `NumberBoundedStarsElement` component.
|
|
2116
3262
|
*
|
|
2117
3263
|
* @remarks
|
|
2118
|
-
*
|
|
3264
|
+
* Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
|
|
2119
3265
|
*
|
|
2120
3266
|
* @param value - Numeric rating score
|
|
3267
|
+
|
|
3268
|
+
Score represented by the filled portion of the star display.
|
|
2121
3269
|
* @param options - Optional component settings (maximum, modifiers).
|
|
2122
3270
|
* @returns This builder instance for method chaining.
|
|
2123
3271
|
*/
|
|
@@ -2129,9 +3277,11 @@ export declare class UiContainerBuilder {
|
|
|
2129
3277
|
* Appends a `NumberBoundedStarsElement` component.
|
|
2130
3278
|
*
|
|
2131
3279
|
* @remarks
|
|
2132
|
-
*
|
|
3280
|
+
* Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
|
|
2133
3281
|
*
|
|
2134
3282
|
* @param value - Numeric rating score
|
|
3283
|
+
|
|
3284
|
+
Score represented by the filled portion of the star display.
|
|
2135
3285
|
* @param options - Optional component settings (maximum, modifiers).
|
|
2136
3286
|
* @returns This builder instance for method chaining.
|
|
2137
3287
|
*/
|
|
@@ -2143,9 +3293,11 @@ export declare class UiContainerBuilder {
|
|
|
2143
3293
|
* Appends a `NumberBoundedMeterElement` component.
|
|
2144
3294
|
*
|
|
2145
3295
|
* @remarks
|
|
2146
|
-
*
|
|
3296
|
+
* Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
|
|
2147
3297
|
*
|
|
2148
3298
|
* @param value - Numeric value
|
|
3299
|
+
|
|
3300
|
+
Current measurement or score represented by the meter.
|
|
2149
3301
|
* @param options - Optional component settings (minimum, maximum, label, unit, modifiers).
|
|
2150
3302
|
* @returns This builder instance for method chaining.
|
|
2151
3303
|
*/
|
|
@@ -2160,9 +3312,11 @@ export declare class UiContainerBuilder {
|
|
|
2160
3312
|
* Appends a `NumberBoundedMeterElement` component.
|
|
2161
3313
|
*
|
|
2162
3314
|
* @remarks
|
|
2163
|
-
*
|
|
3315
|
+
* Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
|
|
2164
3316
|
*
|
|
2165
3317
|
* @param value - Numeric value
|
|
3318
|
+
|
|
3319
|
+
Current measurement or score represented by the meter.
|
|
2166
3320
|
* @param options - Optional component settings (minimum, maximum, label, unit, modifiers).
|
|
2167
3321
|
* @returns This builder instance for method chaining.
|
|
2168
3322
|
*/
|
|
@@ -2177,10 +3331,11 @@ export declare class UiContainerBuilder {
|
|
|
2177
3331
|
* Appends a `BooleanElement` component.
|
|
2178
3332
|
*
|
|
2179
3333
|
* @remarks
|
|
2180
|
-
*
|
|
2181
|
-
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
3334
|
+
* Displays a boolean state using text or a badge. The representation determines whether true/false labels or a colored badge are used; configured labels and variant are presentation choices only.
|
|
2182
3335
|
*
|
|
2183
3336
|
* @param value - Boolean state value
|
|
3337
|
+
|
|
3338
|
+
State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
|
|
2184
3339
|
* @param options - Optional component settings (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
2185
3340
|
* @returns This builder instance for method chaining.
|
|
2186
3341
|
*/
|
|
@@ -2195,9 +3350,11 @@ export declare class UiContainerBuilder {
|
|
|
2195
3350
|
* Appends a `TimestampElement` component.
|
|
2196
3351
|
*
|
|
2197
3352
|
* @remarks
|
|
2198
|
-
*
|
|
3353
|
+
* Displays an epoch timestamp using a selected date/time format. The input is a count of milliseconds, not seconds; relative formatting is interpreted by the consumer.
|
|
2199
3354
|
*
|
|
2200
3355
|
* @param value - The timestamp in milliseconds
|
|
3356
|
+
|
|
3357
|
+
Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
|
|
2201
3358
|
* @param options - Optional component settings (format (defaults to `datetime`), modifiers).
|
|
2202
3359
|
* @returns This builder instance for method chaining.
|
|
2203
3360
|
*/
|
|
@@ -2209,9 +3366,11 @@ export declare class UiContainerBuilder {
|
|
|
2209
3366
|
* Appends a `ImageReferenceElement` component.
|
|
2210
3367
|
*
|
|
2211
3368
|
* @remarks
|
|
2212
|
-
*
|
|
3369
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
2213
3370
|
*
|
|
2214
3371
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
3372
|
+
|
|
3373
|
+
Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
|
|
2215
3374
|
* @param options - Optional component settings (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
2216
3375
|
* @returns This builder instance for method chaining.
|
|
2217
3376
|
*/
|
|
@@ -2224,9 +3383,11 @@ export declare class UiContainerBuilder {
|
|
|
2224
3383
|
* Appends a `ImageReferenceElement` component.
|
|
2225
3384
|
*
|
|
2226
3385
|
* @remarks
|
|
2227
|
-
*
|
|
3386
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
2228
3387
|
*
|
|
2229
3388
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
3389
|
+
|
|
3390
|
+
Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
|
|
2230
3391
|
* @param options - Optional component settings (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
2231
3392
|
* @returns This builder instance for method chaining.
|
|
2232
3393
|
*/
|
|
@@ -2239,9 +3400,11 @@ export declare class UiContainerBuilder {
|
|
|
2239
3400
|
* Appends a `MarkdownBlockElement` component.
|
|
2240
3401
|
*
|
|
2241
3402
|
* @remarks
|
|
2242
|
-
*
|
|
3403
|
+
* Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
|
|
2243
3404
|
*
|
|
2244
3405
|
* @param content - Raw Markdown markup content
|
|
3406
|
+
|
|
3407
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
2245
3408
|
* @param options - Optional component settings (modifiers).
|
|
2246
3409
|
* @returns This builder instance for method chaining.
|
|
2247
3410
|
*/
|
|
@@ -2252,9 +3415,11 @@ export declare class UiContainerBuilder {
|
|
|
2252
3415
|
* Appends a `MarkdownBlockElement` component.
|
|
2253
3416
|
*
|
|
2254
3417
|
* @remarks
|
|
2255
|
-
*
|
|
3418
|
+
* Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
|
|
2256
3419
|
*
|
|
2257
3420
|
* @param content - Raw Markdown markup content
|
|
3421
|
+
|
|
3422
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
2258
3423
|
* @param options - Optional component settings (modifiers).
|
|
2259
3424
|
* @returns This builder instance for method chaining.
|
|
2260
3425
|
*/
|
|
@@ -2265,9 +3430,11 @@ export declare class UiContainerBuilder {
|
|
|
2265
3430
|
* Appends a `HtmlBlockElement` component.
|
|
2266
3431
|
*
|
|
2267
3432
|
* @remarks
|
|
2268
|
-
*
|
|
3433
|
+
* Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
|
|
2269
3434
|
*
|
|
2270
3435
|
* @param content - Raw HTML markup content
|
|
3436
|
+
|
|
3437
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
2271
3438
|
* @param options - Optional component settings (modifiers).
|
|
2272
3439
|
* @returns This builder instance for method chaining.
|
|
2273
3440
|
*/
|
|
@@ -2278,9 +3445,11 @@ export declare class UiContainerBuilder {
|
|
|
2278
3445
|
* Appends a `HtmlBlockElement` component.
|
|
2279
3446
|
*
|
|
2280
3447
|
* @remarks
|
|
2281
|
-
*
|
|
3448
|
+
* Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
|
|
2282
3449
|
*
|
|
2283
3450
|
* @param content - Raw HTML markup content
|
|
3451
|
+
|
|
3452
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
2284
3453
|
* @param options - Optional component settings (modifiers).
|
|
2285
3454
|
* @returns This builder instance for method chaining.
|
|
2286
3455
|
*/
|
|
@@ -2291,9 +3460,11 @@ export declare class UiContainerBuilder {
|
|
|
2291
3460
|
* Appends a `MultiSlotElement` component.
|
|
2292
3461
|
*
|
|
2293
3462
|
* @remarks
|
|
2294
|
-
*
|
|
3463
|
+
* Use this layout when a row needs explicit regions with independently controlled widths. Each slot contains one child element; unlike FlowingElement, the layout does not automatically wrap a sequence of children.
|
|
2295
3464
|
*
|
|
2296
3465
|
* @param slots - List of slots comprising the row
|
|
3466
|
+
|
|
3467
|
+
Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
|
|
2297
3468
|
* @returns This builder instance for method chaining.
|
|
2298
3469
|
*/
|
|
2299
3470
|
addMultiSlot(slots: Slot[]): this;
|
|
@@ -2301,10 +3472,11 @@ export declare class UiContainerBuilder {
|
|
|
2301
3472
|
* Appends a `FlowingElement` component.
|
|
2302
3473
|
*
|
|
2303
3474
|
* @remarks
|
|
2304
|
-
*
|
|
2305
|
-
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
3475
|
+
* Use for compact related values that should flow horizontally and wrap naturally at the available width. Child order is preserved; an optional separator is placed between neighboring children.
|
|
2306
3476
|
*
|
|
2307
3477
|
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
3478
|
+
|
|
3479
|
+
Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
|
|
2308
3480
|
* @param options - Optional component settings (separator).
|
|
2309
3481
|
* @returns This builder instance for method chaining.
|
|
2310
3482
|
*/
|
|
@@ -2315,11 +3487,14 @@ export declare class UiContainerBuilder {
|
|
|
2315
3487
|
* Appends a `LabelValueElement` component.
|
|
2316
3488
|
*
|
|
2317
3489
|
* @remarks
|
|
2318
|
-
*
|
|
2319
|
-
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
3490
|
+
* Represents one named value with a muted left-hand label and a right-hand visual element. Use it for a single field; use TableElement for repeated rows or column-aligned data.
|
|
2320
3491
|
*
|
|
2321
3492
|
* @param label - Key or descriptive label displayed muted on the left
|
|
3493
|
+
|
|
3494
|
+
Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
|
|
2322
3495
|
* @param value - Rendered value element on the right
|
|
3496
|
+
|
|
3497
|
+
Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
|
|
2323
3498
|
* @param options - Optional component settings (withDivider (defaults to `false`)).
|
|
2324
3499
|
* @returns This builder instance for method chaining.
|
|
2325
3500
|
*/
|
|
@@ -2330,10 +3505,11 @@ export declare class UiContainerBuilder {
|
|
|
2330
3505
|
* Appends a `TableElement` component.
|
|
2331
3506
|
*
|
|
2332
3507
|
* @remarks
|
|
2333
|
-
*
|
|
2334
|
-
* Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
|
|
3508
|
+
* Use for data that benefits from aligned rows and columns, including key/value and multi-column tables. Supply rows in display order; explicit columns are optional, and divider/striping flags independently control visual separators and alternating backgrounds.
|
|
2335
3509
|
*
|
|
2336
3510
|
* @param rows - Tabular data rows
|
|
3511
|
+
|
|
3512
|
+
Ordered table rows. Each row's cells correspond positionally to the declared columns.
|
|
2337
3513
|
* @param options - Optional component settings (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
|
|
2338
3514
|
* @returns This builder instance for method chaining.
|
|
2339
3515
|
*/
|
|
@@ -2347,9 +3523,11 @@ export declare class UiContainerBuilder {
|
|
|
2347
3523
|
* Appends a `RepeatingGroupElement` component.
|
|
2348
3524
|
*
|
|
2349
3525
|
* @remarks
|
|
2350
|
-
*
|
|
3526
|
+
* Groups a sequence of labeled entries under one optional section title. Use it when records have the same general presentation but need their own labels.
|
|
2351
3527
|
*
|
|
2352
3528
|
* @param entries - List of repeated entry records
|
|
3529
|
+
|
|
3530
|
+
Entries in display order. Each entry supplies its own label and content.
|
|
2353
3531
|
* @param options - Optional component settings (title).
|
|
2354
3532
|
* @returns This builder instance for method chaining.
|
|
2355
3533
|
*/
|
|
@@ -2360,10 +3538,14 @@ export declare class UiContainerBuilder {
|
|
|
2360
3538
|
* Appends a `CollapsibleGroupElement` component.
|
|
2361
3539
|
*
|
|
2362
3540
|
* @remarks
|
|
2363
|
-
*
|
|
3541
|
+
* Groups nested content behind a disclosure control. The title names the group, summary can provide a compact status indicator, and defaultExpanded controls only the initial state.
|
|
2364
3542
|
*
|
|
2365
3543
|
* @param title - Group title (e.g. "Show specimen details")
|
|
3544
|
+
|
|
3545
|
+
Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
|
|
2366
3546
|
* @param elements - Nested content elements revealed when expanded
|
|
3547
|
+
|
|
3548
|
+
Ordered child elements made visible by expanding the group.
|
|
2367
3549
|
* @param options - Optional component settings (summary, defaultExpanded (defaults to `false`)).
|
|
2368
3550
|
* @returns This builder instance for method chaining.
|
|
2369
3551
|
*/
|
|
@@ -2375,7 +3557,7 @@ export declare class UiContainerBuilder {
|
|
|
2375
3557
|
* Appends a `DividerElement` component.
|
|
2376
3558
|
*
|
|
2377
3559
|
* @remarks
|
|
2378
|
-
*
|
|
3560
|
+
* A standalone visual separator for dividing adjacent sections or element groups. Use the divider flags on tables or rows when the separator is part of that structure.
|
|
2379
3561
|
*
|
|
2380
3562
|
* @param options - Optional component settings (style (defaults to `hairline`)).
|
|
2381
3563
|
* @returns This builder instance for method chaining.
|
|
@@ -2435,7 +3617,7 @@ export declare const UiContainer: {
|
|
|
2435
3617
|
* Functional helper to create a `UiContainerClass` instance directly.
|
|
2436
3618
|
*
|
|
2437
3619
|
* @remarks
|
|
2438
|
-
*
|
|
3620
|
+
* Provides the shared root content collection inherited by cards and other root models. The order of elements is significant and is preserved by the renderer.
|
|
2439
3621
|
*
|
|
2440
3622
|
* @param options - Optional configuration properties.
|
|
2441
3623
|
* @returns A strongly-typed `UiContainerClass` instance.
|
|
@@ -2447,7 +3629,7 @@ export declare function createUiContainer(options?: {
|
|
|
2447
3629
|
* Parses a JSON string or raw object into a validated `UiContainerClass` instance.
|
|
2448
3630
|
*
|
|
2449
3631
|
* @remarks
|
|
2450
|
-
*
|
|
3632
|
+
* Provides the shared root content collection inherited by cards and other root models. The order of elements is significant and is preserved by the renderer.
|
|
2451
3633
|
*
|
|
2452
3634
|
* @param json - JSON string or parsed JavaScript object to validate and hydrate.
|
|
2453
3635
|
* @param withDeepValidation - Whether to recursively validate all nested child entities.
|
|
@@ -2458,8 +3640,7 @@ export declare function parseUiContainer(json: string | unknown, withDeepValidat
|
|
|
2458
3640
|
* Fluent builder for constructing strongly-typed `UiCard` instances.
|
|
2459
3641
|
*
|
|
2460
3642
|
* @remarks
|
|
2461
|
-
*
|
|
2462
|
-
* Represents a complete feature card rendered inside the 360px panel.
|
|
3643
|
+
* A complete card has a required title and ordered content inherited from UiContainer. It is designed for the feature-card surface; description and actions supplement the content, with action controls rendered separately from the element list.
|
|
2463
3644
|
*/
|
|
2464
3645
|
export declare class UiCardBuilder {
|
|
2465
3646
|
private readonly _title;
|
|
@@ -2470,12 +3651,16 @@ export declare class UiCardBuilder {
|
|
|
2470
3651
|
* Initializes a new `UiCardBuilder`.
|
|
2471
3652
|
*
|
|
2472
3653
|
* @param title - Human-readable feature title displayed in the card header
|
|
3654
|
+
|
|
3655
|
+
Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
|
|
2473
3656
|
*/
|
|
2474
3657
|
constructor(title: string);
|
|
2475
3658
|
/**
|
|
2476
3659
|
* Sets the `description` property on this builder.
|
|
2477
3660
|
*
|
|
2478
3661
|
* @param description - Optional neutral subtitle / description for the feature
|
|
3662
|
+
|
|
3663
|
+
Brief secondary context shown with the title. Use the content elements for detailed information rather than placing an entire report in this field.
|
|
2479
3664
|
* @returns This builder instance for method chaining.
|
|
2480
3665
|
*/
|
|
2481
3666
|
description(description: string): this;
|
|
@@ -2511,10 +3696,11 @@ export declare class UiCardBuilder {
|
|
|
2511
3696
|
* Appends a `StringElement` component.
|
|
2512
3697
|
*
|
|
2513
3698
|
* @remarks
|
|
2514
|
-
*
|
|
2515
|
-
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
3699
|
+
* Use this primitive for one textual value when a structured label/value row is unnecessary. Choose multiline for content whose line breaks should remain visible; modifiers apply presentation traits without changing the underlying value.
|
|
2516
3700
|
*
|
|
2517
3701
|
* @param value - Text value
|
|
3702
|
+
|
|
3703
|
+
Text to render. Supply plain text; this field is not a Markdown or HTML document.
|
|
2518
3704
|
* @param options - Optional component settings (representation (defaults to `plain`), modifiers).
|
|
2519
3705
|
* @returns This builder instance for method chaining.
|
|
2520
3706
|
*/
|
|
@@ -2526,10 +3712,11 @@ export declare class UiCardBuilder {
|
|
|
2526
3712
|
* Appends a `StringsElement` component.
|
|
2527
3713
|
*
|
|
2528
3714
|
* @remarks
|
|
2529
|
-
*
|
|
2530
|
-
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
3715
|
+
* Use this primitive when several related strings should be rendered as one compact sequence. The client preserves the array order and inserts the selected separator between values.
|
|
2531
3716
|
*
|
|
2532
3717
|
* @param values - Array of string values
|
|
3718
|
+
|
|
3719
|
+
Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
|
|
2533
3720
|
* @param options - Optional component settings (representation (defaults to `plain`), separator, modifiers).
|
|
2534
3721
|
* @returns This builder instance for method chaining.
|
|
2535
3722
|
*/
|
|
@@ -2542,9 +3729,11 @@ export declare class UiCardBuilder {
|
|
|
2542
3729
|
* Appends a `StringCodeElement` component.
|
|
2543
3730
|
*
|
|
2544
3731
|
* @remarks
|
|
2545
|
-
*
|
|
3732
|
+
* Use for source-like or preformatted textual content that should be rendered in a code-oriented style. The language is a presentation hint; the content is not parsed or validated as code by this contract.
|
|
2546
3733
|
*
|
|
2547
3734
|
* @param value - Text value
|
|
3735
|
+
|
|
3736
|
+
Code or text snippet to display. Include any desired line breaks in this string.
|
|
2548
3737
|
* @param options - Optional component settings (language, modifiers).
|
|
2549
3738
|
* @returns This builder instance for method chaining.
|
|
2550
3739
|
*/
|
|
@@ -2556,9 +3745,11 @@ export declare class UiCardBuilder {
|
|
|
2556
3745
|
* Appends a `XmlElement` component.
|
|
2557
3746
|
*
|
|
2558
3747
|
* @remarks
|
|
2559
|
-
* XML
|
|
3748
|
+
* Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
|
|
2560
3749
|
*
|
|
2561
3750
|
* @param value - XML content value
|
|
3751
|
+
|
|
3752
|
+
XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
|
|
2562
3753
|
* @param options - Optional component settings (modifiers).
|
|
2563
3754
|
* @returns This builder instance for method chaining.
|
|
2564
3755
|
*/
|
|
@@ -2569,9 +3760,11 @@ export declare class UiCardBuilder {
|
|
|
2569
3760
|
* Appends a `JsonElement` component.
|
|
2570
3761
|
*
|
|
2571
3762
|
* @remarks
|
|
2572
|
-
* JSON
|
|
3763
|
+
* Specialized representation for JSON text. Supply serialized JSON when consumers should display a JSON document; this field is a string and is not structurally validated here.
|
|
2573
3764
|
*
|
|
2574
3765
|
* @param value - JSON content value
|
|
3766
|
+
|
|
3767
|
+
Serialized JSON text to render. No parsing or schema validation is implied by this element.
|
|
2575
3768
|
* @param options - Optional component settings (modifiers).
|
|
2576
3769
|
* @returns This builder instance for method chaining.
|
|
2577
3770
|
*/
|
|
@@ -2582,9 +3775,11 @@ export declare class UiCardBuilder {
|
|
|
2582
3775
|
* Appends a `StringUrlElement` component.
|
|
2583
3776
|
*
|
|
2584
3777
|
* @remarks
|
|
2585
|
-
*
|
|
3778
|
+
* Use this element when displayed text should also behave as a link. Unlike StringElement, the value is a navigation destination and may be paired with a separate human-readable label.
|
|
2586
3779
|
*
|
|
2587
3780
|
* @param value - Target URL or navigation destination
|
|
3781
|
+
|
|
3782
|
+
Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
|
|
2588
3783
|
* @param options - Optional component settings (label, modifiers).
|
|
2589
3784
|
* @returns This builder instance for method chaining.
|
|
2590
3785
|
*/
|
|
@@ -2596,9 +3791,11 @@ export declare class UiCardBuilder {
|
|
|
2596
3791
|
* Appends a `IdentifierElement` component.
|
|
2597
3792
|
*
|
|
2598
3793
|
* @remarks
|
|
2599
|
-
*
|
|
3794
|
+
* Use for identifiers, hashes, and other machine-oriented strings that benefit from monospace styling. The value remains text and is not resolved as a Picteus entity.
|
|
2600
3795
|
*
|
|
2601
3796
|
* @param value - Identifier string value
|
|
3797
|
+
|
|
3798
|
+
Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
|
|
2602
3799
|
* @param options - Optional component settings (modifiers).
|
|
2603
3800
|
* @returns This builder instance for method chaining.
|
|
2604
3801
|
*/
|
|
@@ -2609,9 +3806,11 @@ export declare class UiCardBuilder {
|
|
|
2609
3806
|
* Appends a `RatioElement` component.
|
|
2610
3807
|
*
|
|
2611
3808
|
* @remarks
|
|
2612
|
-
*
|
|
3809
|
+
* Displays a numeric aspect ratio as a ratio expression. Provide a positive value meaningful to the surrounding content; this type does not encode the source image dimensions.
|
|
2613
3810
|
*
|
|
2614
3811
|
* @param value - Aspect ratio numerical expression
|
|
3812
|
+
|
|
3813
|
+
Numeric ratio value used by the renderer to produce an aspect-ratio display.
|
|
2615
3814
|
* @param options - Optional component settings (modifiers).
|
|
2616
3815
|
* @returns This builder instance for method chaining.
|
|
2617
3816
|
*/
|
|
@@ -2622,10 +3821,14 @@ export declare class UiCardBuilder {
|
|
|
2622
3821
|
* Appends a `DimensionsElement` component.
|
|
2623
3822
|
*
|
|
2624
3823
|
* @remarks
|
|
2625
|
-
*
|
|
3824
|
+
* Displays a width/height pair as image dimensions. Both values are positive pixel counts; together they describe dimensions, not an aspect ratio or a resize request.
|
|
2626
3825
|
*
|
|
2627
3826
|
* @param width - Width in pixels
|
|
3827
|
+
|
|
3828
|
+
Horizontal pixel count. Values below one are rejected by the schema constraint.
|
|
2628
3829
|
* @param height - Height in pixels
|
|
3830
|
+
|
|
3831
|
+
Vertical pixel count. Values below one are rejected by the schema constraint.
|
|
2629
3832
|
* @param options - Optional component settings (modifiers).
|
|
2630
3833
|
* @returns This builder instance for method chaining.
|
|
2631
3834
|
*/
|
|
@@ -2636,9 +3839,11 @@ export declare class UiCardBuilder {
|
|
|
2636
3839
|
* Appends a `ColourElement` component.
|
|
2637
3840
|
*
|
|
2638
3841
|
* @remarks
|
|
2639
|
-
*
|
|
3842
|
+
* Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
|
|
2640
3843
|
*
|
|
2641
3844
|
* @param value - Hexadecimal color code
|
|
3845
|
+
|
|
3846
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
2642
3847
|
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
2643
3848
|
* @returns This builder instance for method chaining.
|
|
2644
3849
|
*/
|
|
@@ -2653,9 +3858,11 @@ export declare class UiCardBuilder {
|
|
|
2653
3858
|
* Appends a `ColourElement` component.
|
|
2654
3859
|
*
|
|
2655
3860
|
* @remarks
|
|
2656
|
-
*
|
|
3861
|
+
* Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
|
|
2657
3862
|
*
|
|
2658
3863
|
* @param value - Hexadecimal color code
|
|
3864
|
+
|
|
3865
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
2659
3866
|
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
2660
3867
|
* @returns This builder instance for method chaining.
|
|
2661
3868
|
*/
|
|
@@ -2670,9 +3877,11 @@ export declare class UiCardBuilder {
|
|
|
2670
3877
|
* Appends a `NumberUnboundedElement` component.
|
|
2671
3878
|
*
|
|
2672
3879
|
* @remarks
|
|
2673
|
-
*
|
|
3880
|
+
* Displays a numeric value without a progress scale or rating interpretation. Use unit to communicate the measurement context; no range is imposed by this model.
|
|
2674
3881
|
*
|
|
2675
3882
|
* @param value - Numeric value
|
|
3883
|
+
|
|
3884
|
+
Number to display. Its meaning and any valid range are defined by the producing feature.
|
|
2676
3885
|
* @param options - Optional component settings (unit, modifiers).
|
|
2677
3886
|
* @returns This builder instance for method chaining.
|
|
2678
3887
|
*/
|
|
@@ -2684,9 +3893,11 @@ export declare class UiCardBuilder {
|
|
|
2684
3893
|
* Appends a `NumberBoundedStarsElement` component.
|
|
2685
3894
|
*
|
|
2686
3895
|
* @remarks
|
|
2687
|
-
*
|
|
3896
|
+
* Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
|
|
2688
3897
|
*
|
|
2689
3898
|
* @param value - Numeric rating score
|
|
3899
|
+
|
|
3900
|
+
Score represented by the filled portion of the star display.
|
|
2690
3901
|
* @param options - Optional component settings (maximum, modifiers).
|
|
2691
3902
|
* @returns This builder instance for method chaining.
|
|
2692
3903
|
*/
|
|
@@ -2698,9 +3909,11 @@ export declare class UiCardBuilder {
|
|
|
2698
3909
|
* Appends a `NumberBoundedStarsElement` component.
|
|
2699
3910
|
*
|
|
2700
3911
|
* @remarks
|
|
2701
|
-
*
|
|
3912
|
+
* Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
|
|
2702
3913
|
*
|
|
2703
3914
|
* @param value - Numeric rating score
|
|
3915
|
+
|
|
3916
|
+
Score represented by the filled portion of the star display.
|
|
2704
3917
|
* @param options - Optional component settings (maximum, modifiers).
|
|
2705
3918
|
* @returns This builder instance for method chaining.
|
|
2706
3919
|
*/
|
|
@@ -2712,9 +3925,11 @@ export declare class UiCardBuilder {
|
|
|
2712
3925
|
* Appends a `NumberBoundedMeterElement` component.
|
|
2713
3926
|
*
|
|
2714
3927
|
* @remarks
|
|
2715
|
-
*
|
|
3928
|
+
* Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
|
|
2716
3929
|
*
|
|
2717
3930
|
* @param value - Numeric value
|
|
3931
|
+
|
|
3932
|
+
Current measurement or score represented by the meter.
|
|
2718
3933
|
* @param options - Optional component settings (minimum, maximum, label, unit, modifiers).
|
|
2719
3934
|
* @returns This builder instance for method chaining.
|
|
2720
3935
|
*/
|
|
@@ -2729,9 +3944,11 @@ export declare class UiCardBuilder {
|
|
|
2729
3944
|
* Appends a `NumberBoundedMeterElement` component.
|
|
2730
3945
|
*
|
|
2731
3946
|
* @remarks
|
|
2732
|
-
*
|
|
3947
|
+
* Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
|
|
2733
3948
|
*
|
|
2734
3949
|
* @param value - Numeric value
|
|
3950
|
+
|
|
3951
|
+
Current measurement or score represented by the meter.
|
|
2735
3952
|
* @param options - Optional component settings (minimum, maximum, label, unit, modifiers).
|
|
2736
3953
|
* @returns This builder instance for method chaining.
|
|
2737
3954
|
*/
|
|
@@ -2746,10 +3963,11 @@ export declare class UiCardBuilder {
|
|
|
2746
3963
|
* Appends a `BooleanElement` component.
|
|
2747
3964
|
*
|
|
2748
3965
|
* @remarks
|
|
2749
|
-
*
|
|
2750
|
-
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
3966
|
+
* Displays a boolean state using text or a badge. The representation determines whether true/false labels or a colored badge are used; configured labels and variant are presentation choices only.
|
|
2751
3967
|
*
|
|
2752
3968
|
* @param value - Boolean state value
|
|
3969
|
+
|
|
3970
|
+
State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
|
|
2753
3971
|
* @param options - Optional component settings (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
2754
3972
|
* @returns This builder instance for method chaining.
|
|
2755
3973
|
*/
|
|
@@ -2764,9 +3982,11 @@ export declare class UiCardBuilder {
|
|
|
2764
3982
|
* Appends a `TimestampElement` component.
|
|
2765
3983
|
*
|
|
2766
3984
|
* @remarks
|
|
2767
|
-
*
|
|
3985
|
+
* Displays an epoch timestamp using a selected date/time format. The input is a count of milliseconds, not seconds; relative formatting is interpreted by the consumer.
|
|
2768
3986
|
*
|
|
2769
3987
|
* @param value - The timestamp in milliseconds
|
|
3988
|
+
|
|
3989
|
+
Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
|
|
2770
3990
|
* @param options - Optional component settings (format (defaults to `datetime`), modifiers).
|
|
2771
3991
|
* @returns This builder instance for method chaining.
|
|
2772
3992
|
*/
|
|
@@ -2778,9 +3998,11 @@ export declare class UiCardBuilder {
|
|
|
2778
3998
|
* Appends a `ImageReferenceElement` component.
|
|
2779
3999
|
*
|
|
2780
4000
|
* @remarks
|
|
2781
|
-
*
|
|
4001
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
2782
4002
|
*
|
|
2783
4003
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
4004
|
+
|
|
4005
|
+
Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
|
|
2784
4006
|
* @param options - Optional component settings (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
2785
4007
|
* @returns This builder instance for method chaining.
|
|
2786
4008
|
*/
|
|
@@ -2793,9 +4015,11 @@ export declare class UiCardBuilder {
|
|
|
2793
4015
|
* Appends a `ImageReferenceElement` component.
|
|
2794
4016
|
*
|
|
2795
4017
|
* @remarks
|
|
2796
|
-
*
|
|
4018
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
2797
4019
|
*
|
|
2798
4020
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
4021
|
+
|
|
4022
|
+
Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
|
|
2799
4023
|
* @param options - Optional component settings (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
2800
4024
|
* @returns This builder instance for method chaining.
|
|
2801
4025
|
*/
|
|
@@ -2808,9 +4032,11 @@ export declare class UiCardBuilder {
|
|
|
2808
4032
|
* Appends a `MarkdownBlockElement` component.
|
|
2809
4033
|
*
|
|
2810
4034
|
* @remarks
|
|
2811
|
-
*
|
|
4035
|
+
* Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
|
|
2812
4036
|
*
|
|
2813
4037
|
* @param content - Raw Markdown markup content
|
|
4038
|
+
|
|
4039
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
2814
4040
|
* @param options - Optional component settings (modifiers).
|
|
2815
4041
|
* @returns This builder instance for method chaining.
|
|
2816
4042
|
*/
|
|
@@ -2821,9 +4047,11 @@ export declare class UiCardBuilder {
|
|
|
2821
4047
|
* Appends a `MarkdownBlockElement` component.
|
|
2822
4048
|
*
|
|
2823
4049
|
* @remarks
|
|
2824
|
-
*
|
|
4050
|
+
* Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
|
|
2825
4051
|
*
|
|
2826
4052
|
* @param content - Raw Markdown markup content
|
|
4053
|
+
|
|
4054
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
2827
4055
|
* @param options - Optional component settings (modifiers).
|
|
2828
4056
|
* @returns This builder instance for method chaining.
|
|
2829
4057
|
*/
|
|
@@ -2834,9 +4062,11 @@ export declare class UiCardBuilder {
|
|
|
2834
4062
|
* Appends a `HtmlBlockElement` component.
|
|
2835
4063
|
*
|
|
2836
4064
|
* @remarks
|
|
2837
|
-
*
|
|
4065
|
+
* Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
|
|
2838
4066
|
*
|
|
2839
4067
|
* @param content - Raw HTML markup content
|
|
4068
|
+
|
|
4069
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
2840
4070
|
* @param options - Optional component settings (modifiers).
|
|
2841
4071
|
* @returns This builder instance for method chaining.
|
|
2842
4072
|
*/
|
|
@@ -2847,9 +4077,11 @@ export declare class UiCardBuilder {
|
|
|
2847
4077
|
* Appends a `HtmlBlockElement` component.
|
|
2848
4078
|
*
|
|
2849
4079
|
* @remarks
|
|
2850
|
-
*
|
|
4080
|
+
* Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
|
|
2851
4081
|
*
|
|
2852
4082
|
* @param content - Raw HTML markup content
|
|
4083
|
+
|
|
4084
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
2853
4085
|
* @param options - Optional component settings (modifiers).
|
|
2854
4086
|
* @returns This builder instance for method chaining.
|
|
2855
4087
|
*/
|
|
@@ -2860,9 +4092,11 @@ export declare class UiCardBuilder {
|
|
|
2860
4092
|
* Appends a `MultiSlotElement` component.
|
|
2861
4093
|
*
|
|
2862
4094
|
* @remarks
|
|
2863
|
-
*
|
|
4095
|
+
* Use this layout when a row needs explicit regions with independently controlled widths. Each slot contains one child element; unlike FlowingElement, the layout does not automatically wrap a sequence of children.
|
|
2864
4096
|
*
|
|
2865
4097
|
* @param slots - List of slots comprising the row
|
|
4098
|
+
|
|
4099
|
+
Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
|
|
2866
4100
|
* @returns This builder instance for method chaining.
|
|
2867
4101
|
*/
|
|
2868
4102
|
addMultiSlot(slots: Slot[]): this;
|
|
@@ -2870,10 +4104,11 @@ export declare class UiCardBuilder {
|
|
|
2870
4104
|
* Appends a `FlowingElement` component.
|
|
2871
4105
|
*
|
|
2872
4106
|
* @remarks
|
|
2873
|
-
*
|
|
2874
|
-
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
4107
|
+
* Use for compact related values that should flow horizontally and wrap naturally at the available width. Child order is preserved; an optional separator is placed between neighboring children.
|
|
2875
4108
|
*
|
|
2876
4109
|
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
4110
|
+
|
|
4111
|
+
Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
|
|
2877
4112
|
* @param options - Optional component settings (separator).
|
|
2878
4113
|
* @returns This builder instance for method chaining.
|
|
2879
4114
|
*/
|
|
@@ -2884,11 +4119,14 @@ export declare class UiCardBuilder {
|
|
|
2884
4119
|
* Appends a `LabelValueElement` component.
|
|
2885
4120
|
*
|
|
2886
4121
|
* @remarks
|
|
2887
|
-
*
|
|
2888
|
-
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
4122
|
+
* Represents one named value with a muted left-hand label and a right-hand visual element. Use it for a single field; use TableElement for repeated rows or column-aligned data.
|
|
2889
4123
|
*
|
|
2890
4124
|
* @param label - Key or descriptive label displayed muted on the left
|
|
4125
|
+
|
|
4126
|
+
Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
|
|
2891
4127
|
* @param value - Rendered value element on the right
|
|
4128
|
+
|
|
4129
|
+
Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
|
|
2892
4130
|
* @param options - Optional component settings (withDivider (defaults to `false`)).
|
|
2893
4131
|
* @returns This builder instance for method chaining.
|
|
2894
4132
|
*/
|
|
@@ -2899,10 +4137,11 @@ export declare class UiCardBuilder {
|
|
|
2899
4137
|
* Appends a `TableElement` component.
|
|
2900
4138
|
*
|
|
2901
4139
|
* @remarks
|
|
2902
|
-
*
|
|
2903
|
-
* Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
|
|
4140
|
+
* Use for data that benefits from aligned rows and columns, including key/value and multi-column tables. Supply rows in display order; explicit columns are optional, and divider/striping flags independently control visual separators and alternating backgrounds.
|
|
2904
4141
|
*
|
|
2905
4142
|
* @param rows - Tabular data rows
|
|
4143
|
+
|
|
4144
|
+
Ordered table rows. Each row's cells correspond positionally to the declared columns.
|
|
2906
4145
|
* @param options - Optional component settings (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
|
|
2907
4146
|
* @returns This builder instance for method chaining.
|
|
2908
4147
|
*/
|
|
@@ -2916,9 +4155,11 @@ export declare class UiCardBuilder {
|
|
|
2916
4155
|
* Appends a `RepeatingGroupElement` component.
|
|
2917
4156
|
*
|
|
2918
4157
|
* @remarks
|
|
2919
|
-
*
|
|
4158
|
+
* Groups a sequence of labeled entries under one optional section title. Use it when records have the same general presentation but need their own labels.
|
|
2920
4159
|
*
|
|
2921
4160
|
* @param entries - List of repeated entry records
|
|
4161
|
+
|
|
4162
|
+
Entries in display order. Each entry supplies its own label and content.
|
|
2922
4163
|
* @param options - Optional component settings (title).
|
|
2923
4164
|
* @returns This builder instance for method chaining.
|
|
2924
4165
|
*/
|
|
@@ -2929,10 +4170,14 @@ export declare class UiCardBuilder {
|
|
|
2929
4170
|
* Appends a `CollapsibleGroupElement` component.
|
|
2930
4171
|
*
|
|
2931
4172
|
* @remarks
|
|
2932
|
-
*
|
|
4173
|
+
* Groups nested content behind a disclosure control. The title names the group, summary can provide a compact status indicator, and defaultExpanded controls only the initial state.
|
|
2933
4174
|
*
|
|
2934
4175
|
* @param title - Group title (e.g. "Show specimen details")
|
|
4176
|
+
|
|
4177
|
+
Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
|
|
2935
4178
|
* @param elements - Nested content elements revealed when expanded
|
|
4179
|
+
|
|
4180
|
+
Ordered child elements made visible by expanding the group.
|
|
2936
4181
|
* @param options - Optional component settings (summary, defaultExpanded (defaults to `false`)).
|
|
2937
4182
|
* @returns This builder instance for method chaining.
|
|
2938
4183
|
*/
|
|
@@ -2944,7 +4189,7 @@ export declare class UiCardBuilder {
|
|
|
2944
4189
|
* Appends a `DividerElement` component.
|
|
2945
4190
|
*
|
|
2946
4191
|
* @remarks
|
|
2947
|
-
*
|
|
4192
|
+
* A standalone visual separator for dividing adjacent sections or element groups. Use the divider flags on tables or rows when the separator is part of that structure.
|
|
2948
4193
|
*
|
|
2949
4194
|
* @param options - Optional component settings (style (defaults to `hairline`)).
|
|
2950
4195
|
* @returns This builder instance for method chaining.
|
|
@@ -2977,6 +4222,8 @@ export declare const UiCard: {
|
|
|
2977
4222
|
* Creates a new fluent builder for constructing a `UiCard`.
|
|
2978
4223
|
*
|
|
2979
4224
|
* @param title - Human-readable feature title displayed in the card header
|
|
4225
|
+
|
|
4226
|
+
Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
|
|
2980
4227
|
* @returns A new `UiCardBuilder` instance.
|
|
2981
4228
|
*/
|
|
2982
4229
|
builder(title: string): UiCardBuilder;
|
|
@@ -3008,10 +4255,11 @@ export declare const UiCard: {
|
|
|
3008
4255
|
* Functional helper to create a `UiCardClass` instance directly.
|
|
3009
4256
|
*
|
|
3010
4257
|
* @remarks
|
|
3011
|
-
*
|
|
3012
|
-
* Represents a complete feature card rendered inside the 360px panel.
|
|
4258
|
+
* A complete card has a required title and ordered content inherited from UiContainer. It is designed for the feature-card surface; description and actions supplement the content, with action controls rendered separately from the element list.
|
|
3013
4259
|
*
|
|
3014
4260
|
* @param title - Human-readable feature title displayed in the card header
|
|
4261
|
+
|
|
4262
|
+
Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
|
|
3015
4263
|
* @param options - Optional configuration properties.
|
|
3016
4264
|
* @returns A strongly-typed `UiCardClass` instance.
|
|
3017
4265
|
*/
|
|
@@ -3024,8 +4272,7 @@ export declare function createUiCard(title: string, options?: {
|
|
|
3024
4272
|
* Parses a JSON string or raw object into a validated `UiCardClass` instance.
|
|
3025
4273
|
*
|
|
3026
4274
|
* @remarks
|
|
3027
|
-
*
|
|
3028
|
-
* Represents a complete feature card rendered inside the 360px panel.
|
|
4275
|
+
* A complete card has a required title and ordered content inherited from UiContainer. It is designed for the feature-card surface; description and actions supplement the content, with action controls rendered separately from the element list.
|
|
3029
4276
|
*
|
|
3030
4277
|
* @param json - JSON string or parsed JavaScript object to validate and hydrate.
|
|
3031
4278
|
* @param withDeepValidation - Whether to recursively validate all nested child entities.
|
|
@@ -3036,9 +4283,11 @@ export declare function parseUiCard(json: string | unknown, withDeepValidation?:
|
|
|
3036
4283
|
* Creates a `TruncateOptions` component instance.
|
|
3037
4284
|
*
|
|
3038
4285
|
* @remarks
|
|
3039
|
-
*
|
|
4286
|
+
* Controls how a renderer abbreviates long text. The character limit is a presentation threshold rather than a validation limit; showMore lets the user reveal the remaining text.
|
|
3040
4287
|
*
|
|
3041
4288
|
* @param characterLimit - Maximum number of characters to display before truncating
|
|
4289
|
+
|
|
4290
|
+
Threshold after which the renderer can shorten the displayed text. This does not constrain the stored string or remove its undisplayed content.
|
|
3042
4291
|
* @param options - Optional settings (showMore (defaults to `true`)).
|
|
3043
4292
|
* @returns A strongly-typed `TruncateOptions` object.
|
|
3044
4293
|
*/
|
|
@@ -3049,7 +4298,7 @@ export declare function truncateOptions(characterLimit: number, options?: {
|
|
|
3049
4298
|
* Creates a `BaseModifiers` component instance.
|
|
3050
4299
|
*
|
|
3051
4300
|
* @remarks
|
|
3052
|
-
*
|
|
4301
|
+
* Common optional presentation traits shared by primitive values and content renderers. Modifiers affect how content is displayed or copied; they do not transform the source value.
|
|
3053
4302
|
*
|
|
3054
4303
|
* @param options - Optional settings (copyable).
|
|
3055
4304
|
* @returns A strongly-typed `BaseModifiers` object.
|
|
@@ -3061,7 +4310,7 @@ export declare function baseModifiers(options?: {
|
|
|
3061
4310
|
* Creates a `PrimitiveModifiers` component instance.
|
|
3062
4311
|
*
|
|
3063
4312
|
* @remarks
|
|
3064
|
-
*
|
|
4313
|
+
* Extends BaseModifiers with text styling controls. Defaults provide normal weight, medium intensity, and proportional text unless a feature explicitly overrides them.
|
|
3065
4314
|
*
|
|
3066
4315
|
* @param options - Optional settings (truncate, weight (defaults to `normal`), intensity (defaults to `medium`), monospace (defaults to `false`), copyable).
|
|
3067
4316
|
* @returns A strongly-typed `PrimitiveModifiers` object.
|
|
@@ -3077,10 +4326,11 @@ export declare function primitiveModifiers(options?: {
|
|
|
3077
4326
|
* Creates a `StringElement` component instance.
|
|
3078
4327
|
*
|
|
3079
4328
|
* @remarks
|
|
3080
|
-
*
|
|
3081
|
-
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
4329
|
+
* Use this primitive for one textual value when a structured label/value row is unnecessary. Choose multiline for content whose line breaks should remain visible; modifiers apply presentation traits without changing the underlying value.
|
|
3082
4330
|
*
|
|
3083
4331
|
* @param value - Text value
|
|
4332
|
+
|
|
4333
|
+
Text to render. Supply plain text; this field is not a Markdown or HTML document.
|
|
3084
4334
|
* @param options - Optional settings (representation (defaults to `plain`), modifiers).
|
|
3085
4335
|
* @returns A strongly-typed `StringElement` object.
|
|
3086
4336
|
*/
|
|
@@ -3092,10 +4342,11 @@ export declare function string(value: string, options?: {
|
|
|
3092
4342
|
* Creates a `StringsElement` component instance.
|
|
3093
4343
|
*
|
|
3094
4344
|
* @remarks
|
|
3095
|
-
*
|
|
3096
|
-
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
4345
|
+
* Use this primitive when several related strings should be rendered as one compact sequence. The client preserves the array order and inserts the selected separator between values.
|
|
3097
4346
|
*
|
|
3098
4347
|
* @param values - Array of string values
|
|
4348
|
+
|
|
4349
|
+
Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
|
|
3099
4350
|
* @param options - Optional settings (representation (defaults to `plain`), separator, modifiers).
|
|
3100
4351
|
* @returns A strongly-typed `StringsElement` object.
|
|
3101
4352
|
*/
|
|
@@ -3108,9 +4359,11 @@ export declare function strings(values: string[], options?: {
|
|
|
3108
4359
|
* Creates a `StringCodeElement` component instance.
|
|
3109
4360
|
*
|
|
3110
4361
|
* @remarks
|
|
3111
|
-
*
|
|
4362
|
+
* Use for source-like or preformatted textual content that should be rendered in a code-oriented style. The language is a presentation hint; the content is not parsed or validated as code by this contract.
|
|
3112
4363
|
*
|
|
3113
4364
|
* @param value - Text value
|
|
4365
|
+
|
|
4366
|
+
Code or text snippet to display. Include any desired line breaks in this string.
|
|
3114
4367
|
* @param options - Optional settings (language, modifiers).
|
|
3115
4368
|
* @returns A strongly-typed `StringCodeElement` object.
|
|
3116
4369
|
*/
|
|
@@ -3122,9 +4375,11 @@ export declare function stringCode(value: string, options?: {
|
|
|
3122
4375
|
* Creates a `XmlElement` component instance.
|
|
3123
4376
|
*
|
|
3124
4377
|
* @remarks
|
|
3125
|
-
* XML
|
|
4378
|
+
* Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
|
|
3126
4379
|
*
|
|
3127
4380
|
* @param value - XML content value
|
|
4381
|
+
|
|
4382
|
+
XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
|
|
3128
4383
|
* @param options - Optional settings (modifiers).
|
|
3129
4384
|
* @returns A strongly-typed `XmlElement` object.
|
|
3130
4385
|
*/
|
|
@@ -3135,9 +4390,11 @@ export declare function xml(value: string, options?: {
|
|
|
3135
4390
|
* Creates a `JsonElement` component instance.
|
|
3136
4391
|
*
|
|
3137
4392
|
* @remarks
|
|
3138
|
-
* JSON
|
|
4393
|
+
* Specialized representation for JSON text. Supply serialized JSON when consumers should display a JSON document; this field is a string and is not structurally validated here.
|
|
3139
4394
|
*
|
|
3140
4395
|
* @param value - JSON content value
|
|
4396
|
+
|
|
4397
|
+
Serialized JSON text to render. No parsing or schema validation is implied by this element.
|
|
3141
4398
|
* @param options - Optional settings (modifiers).
|
|
3142
4399
|
* @returns A strongly-typed `JsonElement` object.
|
|
3143
4400
|
*/
|
|
@@ -3148,9 +4405,11 @@ export declare function json(value: string, options?: {
|
|
|
3148
4405
|
* Creates a `StringUrlElement` component instance.
|
|
3149
4406
|
*
|
|
3150
4407
|
* @remarks
|
|
3151
|
-
*
|
|
4408
|
+
* Use this element when displayed text should also behave as a link. Unlike StringElement, the value is a navigation destination and may be paired with a separate human-readable label.
|
|
3152
4409
|
*
|
|
3153
4410
|
* @param value - Target URL or navigation destination
|
|
4411
|
+
|
|
4412
|
+
Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
|
|
3154
4413
|
* @param options - Optional settings (label, modifiers).
|
|
3155
4414
|
* @returns A strongly-typed `StringUrlElement` object.
|
|
3156
4415
|
*/
|
|
@@ -3162,9 +4421,11 @@ export declare function stringUrl(value: string, options?: {
|
|
|
3162
4421
|
* Creates a `IdentifierElement` component instance.
|
|
3163
4422
|
*
|
|
3164
4423
|
* @remarks
|
|
3165
|
-
*
|
|
4424
|
+
* Use for identifiers, hashes, and other machine-oriented strings that benefit from monospace styling. The value remains text and is not resolved as a Picteus entity.
|
|
3166
4425
|
*
|
|
3167
4426
|
* @param value - Identifier string value
|
|
4427
|
+
|
|
4428
|
+
Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
|
|
3168
4429
|
* @param options - Optional settings (modifiers).
|
|
3169
4430
|
* @returns A strongly-typed `IdentifierElement` object.
|
|
3170
4431
|
*/
|
|
@@ -3175,9 +4436,11 @@ export declare function identifier(value: string, options?: {
|
|
|
3175
4436
|
* Creates a `RatioElement` component instance.
|
|
3176
4437
|
*
|
|
3177
4438
|
* @remarks
|
|
3178
|
-
*
|
|
4439
|
+
* Displays a numeric aspect ratio as a ratio expression. Provide a positive value meaningful to the surrounding content; this type does not encode the source image dimensions.
|
|
3179
4440
|
*
|
|
3180
4441
|
* @param value - Aspect ratio numerical expression
|
|
4442
|
+
|
|
4443
|
+
Numeric ratio value used by the renderer to produce an aspect-ratio display.
|
|
3181
4444
|
* @param options - Optional settings (modifiers).
|
|
3182
4445
|
* @returns A strongly-typed `RatioElement` object.
|
|
3183
4446
|
*/
|
|
@@ -3188,10 +4451,14 @@ export declare function ratio(value: number, options?: {
|
|
|
3188
4451
|
* Creates a `DimensionsElement` component instance.
|
|
3189
4452
|
*
|
|
3190
4453
|
* @remarks
|
|
3191
|
-
*
|
|
4454
|
+
* Displays a width/height pair as image dimensions. Both values are positive pixel counts; together they describe dimensions, not an aspect ratio or a resize request.
|
|
3192
4455
|
*
|
|
3193
4456
|
* @param width - Width in pixels
|
|
4457
|
+
|
|
4458
|
+
Horizontal pixel count. Values below one are rejected by the schema constraint.
|
|
3194
4459
|
* @param height - Height in pixels
|
|
4460
|
+
|
|
4461
|
+
Vertical pixel count. Values below one are rejected by the schema constraint.
|
|
3195
4462
|
* @param options - Optional settings (modifiers).
|
|
3196
4463
|
* @returns A strongly-typed `DimensionsElement` object.
|
|
3197
4464
|
*/
|
|
@@ -3202,9 +4469,11 @@ export declare function dimensions(width: number, height: number, options?: {
|
|
|
3202
4469
|
* Creates a `ColourElement` component instance.
|
|
3203
4470
|
*
|
|
3204
4471
|
* @remarks
|
|
3205
|
-
*
|
|
4472
|
+
* Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
|
|
3206
4473
|
*
|
|
3207
4474
|
* @param value - Hexadecimal color code
|
|
4475
|
+
|
|
4476
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
3208
4477
|
* @param options - Optional settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
3209
4478
|
* @returns A strongly-typed `ColourElement` object.
|
|
3210
4479
|
*/
|
|
@@ -3219,9 +4488,11 @@ export declare function colour(value: string, options?: {
|
|
|
3219
4488
|
* Creates a `ColourElement` component instance.
|
|
3220
4489
|
*
|
|
3221
4490
|
* @remarks
|
|
3222
|
-
*
|
|
4491
|
+
* Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
|
|
3223
4492
|
*
|
|
3224
4493
|
* @param value - Hexadecimal color code
|
|
4494
|
+
|
|
4495
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
3225
4496
|
* @param options - Optional settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
3226
4497
|
* @returns A strongly-typed `ColourElement` object.
|
|
3227
4498
|
*/
|
|
@@ -3236,9 +4507,11 @@ export declare function color(value: string, options?: {
|
|
|
3236
4507
|
* Creates a `NumberUnboundedElement` component instance.
|
|
3237
4508
|
*
|
|
3238
4509
|
* @remarks
|
|
3239
|
-
*
|
|
4510
|
+
* Displays a numeric value without a progress scale or rating interpretation. Use unit to communicate the measurement context; no range is imposed by this model.
|
|
3240
4511
|
*
|
|
3241
4512
|
* @param value - Numeric value
|
|
4513
|
+
|
|
4514
|
+
Number to display. Its meaning and any valid range are defined by the producing feature.
|
|
3242
4515
|
* @param options - Optional settings (unit, modifiers).
|
|
3243
4516
|
* @returns A strongly-typed `NumberUnboundedElement` object.
|
|
3244
4517
|
*/
|
|
@@ -3250,9 +4523,11 @@ export declare function numberUnbounded(value: number, options?: {
|
|
|
3250
4523
|
* Creates a `NumberBoundedStarsElement` component instance.
|
|
3251
4524
|
*
|
|
3252
4525
|
* @remarks
|
|
3253
|
-
*
|
|
4526
|
+
* Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
|
|
3254
4527
|
*
|
|
3255
4528
|
* @param value - Numeric rating score
|
|
4529
|
+
|
|
4530
|
+
Score represented by the filled portion of the star display.
|
|
3256
4531
|
* @param options - Optional settings (maximum, modifiers).
|
|
3257
4532
|
* @returns A strongly-typed `NumberBoundedStarsElement` object.
|
|
3258
4533
|
*/
|
|
@@ -3264,9 +4539,11 @@ export declare function numberBoundedStars(value: number, options?: {
|
|
|
3264
4539
|
* Creates a `NumberBoundedStarsElement` component instance.
|
|
3265
4540
|
*
|
|
3266
4541
|
* @remarks
|
|
3267
|
-
*
|
|
4542
|
+
* Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
|
|
3268
4543
|
*
|
|
3269
4544
|
* @param value - Numeric rating score
|
|
4545
|
+
|
|
4546
|
+
Score represented by the filled portion of the star display.
|
|
3270
4547
|
* @param options - Optional settings (maximum, modifiers).
|
|
3271
4548
|
* @returns A strongly-typed `NumberBoundedStarsElement` object.
|
|
3272
4549
|
*/
|
|
@@ -3278,9 +4555,11 @@ export declare function numberStars(value: number, options?: {
|
|
|
3278
4555
|
* Creates a `NumberBoundedMeterElement` component instance.
|
|
3279
4556
|
*
|
|
3280
4557
|
* @remarks
|
|
3281
|
-
*
|
|
4558
|
+
* Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
|
|
3282
4559
|
*
|
|
3283
4560
|
* @param value - Numeric value
|
|
4561
|
+
|
|
4562
|
+
Current measurement or score represented by the meter.
|
|
3284
4563
|
* @param options - Optional settings (minimum, maximum, label, unit, modifiers).
|
|
3285
4564
|
* @returns A strongly-typed `NumberBoundedMeterElement` object.
|
|
3286
4565
|
*/
|
|
@@ -3295,9 +4574,11 @@ export declare function numberBoundedMeter(value: number, options?: {
|
|
|
3295
4574
|
* Creates a `NumberBoundedMeterElement` component instance.
|
|
3296
4575
|
*
|
|
3297
4576
|
* @remarks
|
|
3298
|
-
*
|
|
4577
|
+
* Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
|
|
3299
4578
|
*
|
|
3300
4579
|
* @param value - Numeric value
|
|
4580
|
+
|
|
4581
|
+
Current measurement or score represented by the meter.
|
|
3301
4582
|
* @param options - Optional settings (minimum, maximum, label, unit, modifiers).
|
|
3302
4583
|
* @returns A strongly-typed `NumberBoundedMeterElement` object.
|
|
3303
4584
|
*/
|
|
@@ -3312,10 +4593,11 @@ export declare function numberMeter(value: number, options?: {
|
|
|
3312
4593
|
* Creates a `BooleanElement` component instance.
|
|
3313
4594
|
*
|
|
3314
4595
|
* @remarks
|
|
3315
|
-
*
|
|
3316
|
-
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
4596
|
+
* Displays a boolean state using text or a badge. The representation determines whether true/false labels or a colored badge are used; configured labels and variant are presentation choices only.
|
|
3317
4597
|
*
|
|
3318
4598
|
* @param value - Boolean state value
|
|
4599
|
+
|
|
4600
|
+
State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
|
|
3319
4601
|
* @param options - Optional settings (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
3320
4602
|
* @returns A strongly-typed `BooleanElement` object.
|
|
3321
4603
|
*/
|
|
@@ -3330,9 +4612,11 @@ export declare function boolean(value: boolean, options?: {
|
|
|
3330
4612
|
* Creates a `TimestampElement` component instance.
|
|
3331
4613
|
*
|
|
3332
4614
|
* @remarks
|
|
3333
|
-
*
|
|
4615
|
+
* Displays an epoch timestamp using a selected date/time format. The input is a count of milliseconds, not seconds; relative formatting is interpreted by the consumer.
|
|
3334
4616
|
*
|
|
3335
4617
|
* @param value - The timestamp in milliseconds
|
|
4618
|
+
|
|
4619
|
+
Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
|
|
3336
4620
|
* @param options - Optional settings (format (defaults to `datetime`), modifiers).
|
|
3337
4621
|
* @returns A strongly-typed `TimestampElement` object.
|
|
3338
4622
|
*/
|
|
@@ -3344,9 +4628,11 @@ export declare function timestamp(value: number, options?: {
|
|
|
3344
4628
|
* Creates a `ImageReferenceElement` component instance.
|
|
3345
4629
|
*
|
|
3346
4630
|
* @remarks
|
|
3347
|
-
*
|
|
4631
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
3348
4632
|
*
|
|
3349
4633
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
4634
|
+
|
|
4635
|
+
Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
|
|
3350
4636
|
* @param options - Optional settings (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
3351
4637
|
* @returns A strongly-typed `ImageReferenceElement` object.
|
|
3352
4638
|
*/
|
|
@@ -3359,9 +4645,11 @@ export declare function imageReference(src: string, options?: {
|
|
|
3359
4645
|
* Creates a `ImageReferenceElement` component instance.
|
|
3360
4646
|
*
|
|
3361
4647
|
* @remarks
|
|
3362
|
-
*
|
|
4648
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
3363
4649
|
*
|
|
3364
4650
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
4651
|
+
|
|
4652
|
+
Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
|
|
3365
4653
|
* @param options - Optional settings (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
3366
4654
|
* @returns A strongly-typed `ImageReferenceElement` object.
|
|
3367
4655
|
*/
|
|
@@ -3374,10 +4662,14 @@ export declare function imageRef(src: string, options?: {
|
|
|
3374
4662
|
* Creates a `ButtonActionElement` component instance.
|
|
3375
4663
|
*
|
|
3376
4664
|
* @remarks
|
|
3377
|
-
*
|
|
4665
|
+
* When activated, the client dispatches commandId to the specified extension and may include target and parameters as command input. disabled and variant affect presentation and availability, not the command's authorization.
|
|
3378
4666
|
*
|
|
3379
4667
|
* @param commandId - Command identifier to invoke
|
|
4668
|
+
|
|
4669
|
+
Identifier of the registered extension command to dispatch when the button is activated.
|
|
3380
4670
|
* @param label - Display label for the action
|
|
4671
|
+
|
|
4672
|
+
User-facing label shown on the control. Keep it short and action-oriented.
|
|
3381
4673
|
* @param options - Optional settings (extensionId, target, parameters, disabled (defaults to `false`), variant (defaults to `secondary`)).
|
|
3382
4674
|
* @returns A strongly-typed `ButtonActionElement` object.
|
|
3383
4675
|
*/
|
|
@@ -3392,10 +4684,14 @@ export declare function buttonAction(commandId: string, label: string, options?:
|
|
|
3392
4684
|
* Creates a `ExternalLinkActionElement` component instance.
|
|
3393
4685
|
*
|
|
3394
4686
|
* @remarks
|
|
3395
|
-
*
|
|
4687
|
+
* Renders a user-invokable action that opens a destination externally. Use StringUrlElement for a link embedded in content rather than an action control.
|
|
3396
4688
|
*
|
|
3397
4689
|
* @param url - Target URL destination
|
|
4690
|
+
|
|
4691
|
+
External destination opened when the user activates the link action. The client controls how external navigation is handed to the platform.
|
|
3398
4692
|
* @param label - Display label for the action
|
|
4693
|
+
|
|
4694
|
+
User-facing label shown on the control. Keep it short and action-oriented.
|
|
3399
4695
|
* @returns A strongly-typed `ExternalLinkActionElement` object.
|
|
3400
4696
|
*/
|
|
3401
4697
|
export declare function externalLinkAction(url: string, label: string): ExternalLinkActionElement;
|
|
@@ -3403,9 +4699,11 @@ export declare function externalLinkAction(url: string, label: string): External
|
|
|
3403
4699
|
* Creates a `MarkdownBlockElement` component instance.
|
|
3404
4700
|
*
|
|
3405
4701
|
* @remarks
|
|
3406
|
-
*
|
|
4702
|
+
* Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
|
|
3407
4703
|
*
|
|
3408
4704
|
* @param content - Raw Markdown markup content
|
|
4705
|
+
|
|
4706
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
3409
4707
|
* @param options - Optional settings (modifiers).
|
|
3410
4708
|
* @returns A strongly-typed `MarkdownBlockElement` object.
|
|
3411
4709
|
*/
|
|
@@ -3416,9 +4714,11 @@ export declare function markdownBlock(content: string, options?: {
|
|
|
3416
4714
|
* Creates a `MarkdownBlockElement` component instance.
|
|
3417
4715
|
*
|
|
3418
4716
|
* @remarks
|
|
3419
|
-
*
|
|
4717
|
+
* Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
|
|
3420
4718
|
*
|
|
3421
4719
|
* @param content - Raw Markdown markup content
|
|
4720
|
+
|
|
4721
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
3422
4722
|
* @param options - Optional settings (modifiers).
|
|
3423
4723
|
* @returns A strongly-typed `MarkdownBlockElement` object.
|
|
3424
4724
|
*/
|
|
@@ -3429,9 +4729,11 @@ export declare function markdown(content: string, options?: {
|
|
|
3429
4729
|
* Creates a `HtmlBlockElement` component instance.
|
|
3430
4730
|
*
|
|
3431
4731
|
* @remarks
|
|
3432
|
-
*
|
|
4732
|
+
* Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
|
|
3433
4733
|
*
|
|
3434
4734
|
* @param content - Raw HTML markup content
|
|
4735
|
+
|
|
4736
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
3435
4737
|
* @param options - Optional settings (modifiers).
|
|
3436
4738
|
* @returns A strongly-typed `HtmlBlockElement` object.
|
|
3437
4739
|
*/
|
|
@@ -3442,9 +4744,11 @@ export declare function htmlBlock(content: string, options?: {
|
|
|
3442
4744
|
* Creates a `HtmlBlockElement` component instance.
|
|
3443
4745
|
*
|
|
3444
4746
|
* @remarks
|
|
3445
|
-
*
|
|
4747
|
+
* Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
|
|
3446
4748
|
*
|
|
3447
4749
|
* @param content - Raw HTML markup content
|
|
4750
|
+
|
|
4751
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
3448
4752
|
* @param options - Optional settings (modifiers).
|
|
3449
4753
|
* @returns A strongly-typed `HtmlBlockElement` object.
|
|
3450
4754
|
*/
|
|
@@ -3455,9 +4759,11 @@ export declare function html(content: string, options?: {
|
|
|
3455
4759
|
* Creates a `Slot` component instance.
|
|
3456
4760
|
*
|
|
3457
4761
|
* @remarks
|
|
3458
|
-
*
|
|
4762
|
+
* A slot combines an optional label, a relative width, and one visual child. Slot widths are percentages of the row and should be chosen so the full row's widths form a usable layout.
|
|
3459
4763
|
*
|
|
3460
4764
|
* @param content - Rendered content inside the slot
|
|
4765
|
+
|
|
4766
|
+
One visual element displayed in this slot. Use a nested layout element when the slot itself needs multiple children.
|
|
3461
4767
|
* @param options - Optional settings (label, width).
|
|
3462
4768
|
* @returns A strongly-typed `Slot` object.
|
|
3463
4769
|
*/
|
|
@@ -3469,9 +4775,11 @@ export declare function slot(content: UiElement, options?: {
|
|
|
3469
4775
|
* Creates a `MultiSlotElement` component instance.
|
|
3470
4776
|
*
|
|
3471
4777
|
* @remarks
|
|
3472
|
-
*
|
|
4778
|
+
* Use this layout when a row needs explicit regions with independently controlled widths. Each slot contains one child element; unlike FlowingElement, the layout does not automatically wrap a sequence of children.
|
|
3473
4779
|
*
|
|
3474
4780
|
* @param slots - List of slots comprising the row
|
|
4781
|
+
|
|
4782
|
+
Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
|
|
3475
4783
|
* @returns A strongly-typed `MultiSlotElement` object.
|
|
3476
4784
|
*/
|
|
3477
4785
|
export declare function multiSlot(slots: Slot[]): MultiSlotElement;
|
|
@@ -3479,10 +4787,11 @@ export declare function multiSlot(slots: Slot[]): MultiSlotElement;
|
|
|
3479
4787
|
* Creates a `FlowingElement` component instance.
|
|
3480
4788
|
*
|
|
3481
4789
|
* @remarks
|
|
3482
|
-
*
|
|
3483
|
-
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
4790
|
+
* Use for compact related values that should flow horizontally and wrap naturally at the available width. Child order is preserved; an optional separator is placed between neighboring children.
|
|
3484
4791
|
*
|
|
3485
4792
|
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
4793
|
+
|
|
4794
|
+
Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
|
|
3486
4795
|
* @param options - Optional settings (separator).
|
|
3487
4796
|
* @returns A strongly-typed `FlowingElement` object.
|
|
3488
4797
|
*/
|
|
@@ -3493,11 +4802,14 @@ export declare function flowing(elements: UiElement[], options?: {
|
|
|
3493
4802
|
* Creates a `LabelValueElement` component instance.
|
|
3494
4803
|
*
|
|
3495
4804
|
* @remarks
|
|
3496
|
-
*
|
|
3497
|
-
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
4805
|
+
* Represents one named value with a muted left-hand label and a right-hand visual element. Use it for a single field; use TableElement for repeated rows or column-aligned data.
|
|
3498
4806
|
*
|
|
3499
4807
|
* @param label - Key or descriptive label displayed muted on the left
|
|
4808
|
+
|
|
4809
|
+
Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
|
|
3500
4810
|
* @param value - Rendered value element on the right
|
|
4811
|
+
|
|
4812
|
+
Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
|
|
3501
4813
|
* @param options - Optional settings (withDivider (defaults to `false`)).
|
|
3502
4814
|
* @returns A strongly-typed `LabelValueElement` object.
|
|
3503
4815
|
*/
|
|
@@ -3508,7 +4820,7 @@ export declare function labelValue(label: string, value: UiElement, options?: {
|
|
|
3508
4820
|
* Creates a `TableColumn` component instance.
|
|
3509
4821
|
*
|
|
3510
4822
|
* @remarks
|
|
3511
|
-
*
|
|
4823
|
+
* Describes one table column and its visual sizing. When columns are supplied, their order corresponds to the position of each cell in a row.
|
|
3512
4824
|
*
|
|
3513
4825
|
* @param options - Optional settings (header, align (defaults to `left`), width, widthMode (defaults to `fixed`)).
|
|
3514
4826
|
* @returns A strongly-typed `TableColumn` object.
|
|
@@ -3523,9 +4835,11 @@ export declare function tableColumn(options?: {
|
|
|
3523
4835
|
* Creates a `TableRow` component instance.
|
|
3524
4836
|
*
|
|
3525
4837
|
* @remarks
|
|
3526
|
-
*
|
|
4838
|
+
* A row's cell array is positional: cell at each index corresponds to the column at that index. Keep row lengths aligned with the table's explicit column definitions when present.
|
|
3527
4839
|
*
|
|
3528
4840
|
* @param cells - Array of cell values corresponding to table columns
|
|
4841
|
+
|
|
4842
|
+
Ordered contents for this row. Each cell is a UiElement so values can use the same primitive and layout renderers as other ViewKit content.
|
|
3529
4843
|
* @returns A strongly-typed `TableRow` object.
|
|
3530
4844
|
*/
|
|
3531
4845
|
export declare function tableRow(cells: UiElement[]): TableRow;
|
|
@@ -3533,10 +4847,11 @@ export declare function tableRow(cells: UiElement[]): TableRow;
|
|
|
3533
4847
|
* Creates a `TableElement` component instance.
|
|
3534
4848
|
*
|
|
3535
4849
|
* @remarks
|
|
3536
|
-
*
|
|
3537
|
-
* Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
|
|
4850
|
+
* Use for data that benefits from aligned rows and columns, including key/value and multi-column tables. Supply rows in display order; explicit columns are optional, and divider/striping flags independently control visual separators and alternating backgrounds.
|
|
3538
4851
|
*
|
|
3539
4852
|
* @param rows - Tabular data rows
|
|
4853
|
+
|
|
4854
|
+
Ordered table rows. Each row's cells correspond positionally to the declared columns.
|
|
3540
4855
|
* @param options - Optional settings (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
|
|
3541
4856
|
* @returns A strongly-typed `TableElement` object.
|
|
3542
4857
|
*/
|
|
@@ -3550,9 +4865,11 @@ export declare function table(rows: TableRow[], options?: {
|
|
|
3550
4865
|
* Creates a `RepeatingGroupEntry` component instance.
|
|
3551
4866
|
*
|
|
3552
4867
|
* @remarks
|
|
3553
|
-
*
|
|
4868
|
+
* A repeating entry carries a stable display label and either one primary value or a list of nested elements, depending on the shape needed by the feature.
|
|
3554
4869
|
*
|
|
3555
4870
|
* @param label - Entry label
|
|
4871
|
+
|
|
4872
|
+
Short label identifying this entry within the repeated group.
|
|
3556
4873
|
* @param options - Optional settings (value, elements).
|
|
3557
4874
|
* @returns A strongly-typed `RepeatingGroupEntry` object.
|
|
3558
4875
|
*/
|
|
@@ -3564,9 +4881,11 @@ export declare function repeatingGroupEntry(label: string, options?: {
|
|
|
3564
4881
|
* Creates a `RepeatingGroupElement` component instance.
|
|
3565
4882
|
*
|
|
3566
4883
|
* @remarks
|
|
3567
|
-
*
|
|
4884
|
+
* Groups a sequence of labeled entries under one optional section title. Use it when records have the same general presentation but need their own labels.
|
|
3568
4885
|
*
|
|
3569
4886
|
* @param entries - List of repeated entry records
|
|
4887
|
+
|
|
4888
|
+
Entries in display order. Each entry supplies its own label and content.
|
|
3570
4889
|
* @param options - Optional settings (title).
|
|
3571
4890
|
* @returns A strongly-typed `RepeatingGroupElement` object.
|
|
3572
4891
|
*/
|
|
@@ -3577,10 +4896,14 @@ export declare function repeatingGroup(entries: RepeatingGroupEntry[], options?:
|
|
|
3577
4896
|
* Creates a `CollapsibleGroupElement` component instance.
|
|
3578
4897
|
*
|
|
3579
4898
|
* @remarks
|
|
3580
|
-
*
|
|
4899
|
+
* Groups nested content behind a disclosure control. The title names the group, summary can provide a compact status indicator, and defaultExpanded controls only the initial state.
|
|
3581
4900
|
*
|
|
3582
4901
|
* @param title - Group title (e.g. "Show specimen details")
|
|
4902
|
+
|
|
4903
|
+
Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
|
|
3583
4904
|
* @param elements - Nested content elements revealed when expanded
|
|
4905
|
+
|
|
4906
|
+
Ordered child elements made visible by expanding the group.
|
|
3584
4907
|
* @param options - Optional settings (summary, defaultExpanded (defaults to `false`)).
|
|
3585
4908
|
* @returns A strongly-typed `CollapsibleGroupElement` object.
|
|
3586
4909
|
*/
|
|
@@ -3592,7 +4915,7 @@ export declare function collapsibleGroup(title: string, elements: UiElement[], o
|
|
|
3592
4915
|
* Creates a `DividerElement` component instance.
|
|
3593
4916
|
*
|
|
3594
4917
|
* @remarks
|
|
3595
|
-
*
|
|
4918
|
+
* A standalone visual separator for dividing adjacent sections or element groups. Use the divider flags on tables or rows when the separator is part of that structure.
|
|
3596
4919
|
*
|
|
3597
4920
|
* @param options - Optional settings (style (defaults to `hairline`)).
|
|
3598
4921
|
* @returns A strongly-typed `DividerElement` object.
|
|
@@ -3604,7 +4927,7 @@ export declare function divider(options?: {
|
|
|
3604
4927
|
* Creates a `Envelop` component instance.
|
|
3605
4928
|
*
|
|
3606
4929
|
* @remarks
|
|
3607
|
-
*
|
|
4930
|
+
* All root ViewKit documents extend this envelope so consumers can identify the schema contract version before processing the root content.
|
|
3608
4931
|
*
|
|
3609
4932
|
* @param options - Optional settings (schemaVersion (defaults to `1.0`)).
|
|
3610
4933
|
* @returns A strongly-typed `Envelop` object.
|