@picteus/extension-sdk 0.16.0 → 0.18.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/viewKit.d.ts +547 -505
- package/dist/generated/viewKit.js +505 -512
- package/dist/picteus-ws-client/apis/AdministrationApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/AdministrationApi.js +1 -1
- package/dist/picteus-ws-client/apis/ApiSecretApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/ApiSecretApi.js +1 -1
- package/dist/picteus-ws-client/apis/CollectionApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/CollectionApi.js +1 -1
- package/dist/picteus-ws-client/apis/ExtensionApi.d.ts +5 -3
- package/dist/picteus-ws-client/apis/ExtensionApi.js +2 -2
- package/dist/picteus-ws-client/apis/ImageApi.d.ts +40 -5
- package/dist/picteus-ws-client/apis/ImageApi.js +50 -3
- package/dist/picteus-ws-client/apis/ImageAttachmentApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/ImageAttachmentApi.js +1 -1
- package/dist/picteus-ws-client/apis/MiscellaneousApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/MiscellaneousApi.js +1 -1
- package/dist/picteus-ws-client/apis/RepositoryApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/RepositoryApi.js +1 -1
- package/dist/picteus-ws-client/apis/SettingsApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/SettingsApi.js +1 -1
- package/dist/picteus-ws-client/models/ApiSecret.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApiSecret.js +1 -1
- package/dist/picteus-ws-client/models/ApiSecretSummary.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApiSecretSummary.js +1 -1
- package/dist/picteus-ws-client/models/ApiSecretType.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApiSecretType.js +1 -1
- package/dist/picteus-ws-client/models/ApplicationConfiguration.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApplicationConfiguration.js +1 -1
- package/dist/picteus-ws-client/models/ApplicationMetadata.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApplicationMetadata.js +1 -1
- package/dist/picteus-ws-client/models/ApplicationMetadataItem.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApplicationMetadataItem.js +1 -1
- package/dist/picteus-ws-client/models/ApplicationMetadataItemValue.d.ts +4 -2
- package/dist/picteus-ws-client/models/ApplicationMetadataItemValue.js +1 -1
- package/dist/picteus-ws-client/models/ApplicationSettings.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApplicationSettings.js +1 -1
- package/dist/picteus-ws-client/models/Collection.d.ts +1 -1
- package/dist/picteus-ws-client/models/Collection.js +1 -1
- package/dist/picteus-ws-client/models/CommandEntity.d.ts +1 -1
- package/dist/picteus-ws-client/models/CommandEntity.js +1 -1
- package/dist/picteus-ws-client/models/ComputedImageFormat.d.ts +1 -1
- package/dist/picteus-ws-client/models/ComputedImageFormat.js +1 -1
- package/dist/picteus-ws-client/models/ConfigurationCapability.d.ts +1 -1
- package/dist/picteus-ws-client/models/ConfigurationCapability.js +1 -1
- package/dist/picteus-ws-client/models/ConfigurationExtensionCommand.d.ts +1 -1
- package/dist/picteus-ws-client/models/ConfigurationExtensionCommand.js +1 -1
- package/dist/picteus-ws-client/models/ConstantsRegistry.d.ts +1 -1
- package/dist/picteus-ws-client/models/ConstantsRegistry.js +1 -1
- package/dist/picteus-ws-client/models/Dates.d.ts +1 -1
- package/dist/picteus-ws-client/models/Dates.js +1 -1
- package/dist/picteus-ws-client/models/Extension.d.ts +1 -1
- package/dist/picteus-ws-client/models/Extension.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionActivity.d.ts +23 -5
- package/dist/picteus-ws-client/models/ExtensionActivity.js +17 -5
- package/dist/picteus-ws-client/models/ExtensionActivityState.d.ts +25 -0
- package/dist/picteus-ws-client/models/ExtensionActivityState.js +43 -0
- package/dist/picteus-ws-client/models/ExtensionAndManual.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionAndManual.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionCategory.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionCategory.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionGenerationOptions.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionGenerationOptions.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionIdImageEmbeddingName.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionIdImageEmbeddingName.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageEmbeddings.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageEmbeddings.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageFeature.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageFeature.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageFeatureName.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageFeatureName.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageFeaturesAttribute.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageFeaturesAttribute.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageTag.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageTag.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageTagsAttribute.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageTagsAttribute.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionManual.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionManual.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionSettings.d.ts +5 -3
- package/dist/picteus-ws-client/models/ExtensionSettings.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionState.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionState.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionsConfiguration.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionsConfiguration.js +1 -1
- package/dist/picteus-ws-client/models/GenerationRecipe.d.ts +13 -1
- package/dist/picteus-ws-client/models/GenerationRecipe.js +5 -1
- package/dist/picteus-ws-client/models/GenerationRecipePrompt.d.ts +1 -1
- package/dist/picteus-ws-client/models/GenerationRecipePrompt.js +1 -1
- package/dist/picteus-ws-client/models/Image.d.ts +1 -1
- package/dist/picteus-ws-client/models/Image.js +1 -1
- package/dist/picteus-ws-client/models/ImageDimensions.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageDimensions.js +1 -1
- package/dist/picteus-ws-client/models/ImageDistance.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageDistance.js +1 -1
- package/dist/picteus-ws-client/models/ImageEmbedding.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageEmbedding.js +1 -1
- package/dist/picteus-ws-client/models/ImageFeature.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageFeature.js +1 -1
- package/dist/picteus-ws-client/models/ImageFeatureFormat.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageFeatureFormat.js +1 -1
- package/dist/picteus-ws-client/models/ImageFeatureNullValue.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageFeatureNullValue.js +1 -1
- package/dist/picteus-ws-client/models/ImageFeatureType.d.ts +2 -1
- package/dist/picteus-ws-client/models/ImageFeatureType.js +2 -1
- package/dist/picteus-ws-client/models/ImageFeatureValue.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageFeatureValue.js +1 -1
- package/dist/picteus-ws-client/models/ImageFormat.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageFormat.js +1 -1
- package/dist/picteus-ws-client/models/ImageMediaUrl.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageMediaUrl.js +1 -1
- package/dist/picteus-ws-client/models/ImageMetadata.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageMetadata.js +1 -1
- package/dist/picteus-ws-client/models/ImageResizeRender.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageResizeRender.js +1 -1
- package/dist/picteus-ws-client/models/ImageSummary.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageSummary.js +1 -1
- package/dist/picteus-ws-client/models/InstructionsPrompt.d.ts +5 -3
- package/dist/picteus-ws-client/models/InstructionsPrompt.js +1 -1
- package/dist/picteus-ws-client/models/Manifest.d.ts +5 -3
- package/dist/picteus-ws-client/models/Manifest.js +1 -1
- package/dist/picteus-ws-client/models/ManifestCapability.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestCapability.js +1 -1
- package/dist/picteus-ws-client/models/ManifestCapabilityId.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestCapabilityId.js +1 -1
- package/dist/picteus-ws-client/models/ManifestEvent.d.ts +1 -3
- package/dist/picteus-ws-client/models/ManifestEvent.js +1 -3
- package/dist/picteus-ws-client/models/ManifestExecution.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestExecution.js +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommand.d.ts +5 -3
- package/dist/picteus-ws-client/models/ManifestExtensionCommand.js +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommandOn.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommandOn.js +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommandSpecification.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommandSpecification.js +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommandUi.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommandUi.js +1 -1
- package/dist/picteus-ws-client/models/ManifestInstructions.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestInstructions.js +1 -1
- package/dist/picteus-ws-client/models/ManifestInterfaceElement.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestInterfaceElement.js +1 -1
- package/dist/picteus-ws-client/models/ManifestInterfaceElementIntegration.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestInterfaceElementIntegration.js +1 -1
- package/dist/picteus-ws-client/models/ManifestRuntime.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestRuntime.js +1 -1
- package/dist/picteus-ws-client/models/ManifestRuntimeEnvironment.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestRuntimeEnvironment.js +1 -1
- package/dist/picteus-ws-client/models/ManifestThrottlingPolicy.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestThrottlingPolicy.js +1 -1
- package/dist/picteus-ws-client/models/ManifestUserInterface.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestUserInterface.js +1 -1
- package/dist/picteus-ws-client/models/PromptKind.d.ts +1 -1
- package/dist/picteus-ws-client/models/PromptKind.js +1 -1
- package/dist/picteus-ws-client/models/Repository.d.ts +1 -1
- package/dist/picteus-ws-client/models/Repository.js +1 -1
- package/dist/picteus-ws-client/models/RepositoryActivity.d.ts +1 -1
- package/dist/picteus-ws-client/models/RepositoryActivity.js +1 -1
- package/dist/picteus-ws-client/models/RepositoryActivityKind.d.ts +1 -1
- package/dist/picteus-ws-client/models/RepositoryActivityKind.js +1 -1
- package/dist/picteus-ws-client/models/RepositoryLocationType.d.ts +1 -1
- package/dist/picteus-ws-client/models/RepositoryLocationType.js +1 -1
- package/dist/picteus-ws-client/models/RepositoryState.d.ts +1 -1
- package/dist/picteus-ws-client/models/RepositoryState.js +1 -1
- package/dist/picteus-ws-client/models/RunCommandParameters.d.ts +5 -3
- package/dist/picteus-ws-client/models/RunCommandParameters.js +1 -1
- package/dist/picteus-ws-client/models/SearchCriteria.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchCriteria.js +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureComparisonOperator.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureComparisonOperator.js +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureCondition.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureCondition.js +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureConditionValue.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureConditionValue.js +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureLogicalOperator.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureLogicalOperator.js +1 -1
- package/dist/picteus-ws-client/models/SearchFeatures.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFeatures.js +1 -1
- package/dist/picteus-ws-client/models/SearchFeaturesResult.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFeaturesResult.js +1 -1
- package/dist/picteus-ws-client/models/SearchFilter.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFilter.js +1 -1
- package/dist/picteus-ws-client/models/SearchFilterOrigin.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFilterOrigin.js +1 -1
- package/dist/picteus-ws-client/models/SearchImageIdResult.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchImageIdResult.js +1 -1
- package/dist/picteus-ws-client/models/SearchImageResult.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchImageResult.js +1 -1
- package/dist/picteus-ws-client/models/SearchImageSummaryResult.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchImageSummaryResult.js +1 -1
- package/dist/picteus-ws-client/models/SearchImagesOrigin.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchImagesOrigin.js +1 -1
- package/dist/picteus-ws-client/models/SearchKeyword.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchKeyword.js +1 -1
- package/dist/picteus-ws-client/models/SearchMediaUrlResult.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchMediaUrlResult.js +1 -1
- package/dist/picteus-ws-client/models/SearchOriginNature.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchOriginNature.js +1 -1
- package/dist/picteus-ws-client/models/SearchParameters.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchParameters.js +1 -1
- package/dist/picteus-ws-client/models/SearchProperties.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchProperties.js +1 -1
- package/dist/picteus-ws-client/models/SearchPropertyRange.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchPropertyRange.js +1 -1
- package/dist/picteus-ws-client/models/SearchRange.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchRange.js +1 -1
- package/dist/picteus-ws-client/models/SearchRepositoriesOrigin.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchRepositoriesOrigin.js +1 -1
- package/dist/picteus-ws-client/models/SearchSorting.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchSorting.js +1 -1
- package/dist/picteus-ws-client/models/SearchSortingProperty.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchSortingProperty.js +1 -1
- package/dist/picteus-ws-client/models/SearchTags.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchTags.js +1 -1
- package/dist/picteus-ws-client/models/SearchTagsResult.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchTagsResult.js +1 -1
- package/dist/picteus-ws-client/models/Software.d.ts +1 -1
- package/dist/picteus-ws-client/models/Software.js +1 -1
- package/dist/picteus-ws-client/models/TextualPrompt.d.ts +1 -1
- package/dist/picteus-ws-client/models/TextualPrompt.js +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceAnchor.d.ts +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceAnchor.js +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceSidebarIntegration.d.ts +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceSidebarIntegration.js +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceWindowIntegration.d.ts +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceWindowIntegration.js +1 -1
- package/dist/picteus-ws-client/models/index.d.ts +1 -1
- package/dist/picteus-ws-client/models/index.js +1 -1
- package/dist/picteus-ws-client/runtime.d.ts +1 -1
- package/dist/picteus-ws-client/runtime.js +1 -1
- package/dist/picteusExtension.d.ts +1 -1
- package/dist/picteusExtension.js +1 -1
- package/package.json +1 -1
|
@@ -25,10 +25,31 @@ export declare enum TextIntensity {
|
|
|
25
25
|
medium = "medium",
|
|
26
26
|
high = "high"
|
|
27
27
|
}
|
|
28
|
-
/**
|
|
29
|
-
export declare enum
|
|
28
|
+
/** Geometric shape representation for visual containers and indicators. */
|
|
29
|
+
export declare enum Shape {
|
|
30
|
+
circle = "circle",
|
|
31
|
+
square = "square"
|
|
32
|
+
}
|
|
33
|
+
/** Relative sizing scale for visual elements and indicators. */
|
|
34
|
+
export declare enum Size {
|
|
35
|
+
small = "small",
|
|
36
|
+
medium = "medium",
|
|
37
|
+
large = "large"
|
|
38
|
+
}
|
|
39
|
+
/** Visual presentation style for string values. */
|
|
40
|
+
export declare enum StringRepresentation {
|
|
30
41
|
plain = "plain",
|
|
31
|
-
chip = "chip"
|
|
42
|
+
chip = "chip",
|
|
43
|
+
multiline = "multiline"
|
|
44
|
+
}
|
|
45
|
+
/** Visual separator rendered between sequential elements or items. */
|
|
46
|
+
export declare enum Separator {
|
|
47
|
+
bar = "bar",
|
|
48
|
+
comma = "comma",
|
|
49
|
+
dot = "dot",
|
|
50
|
+
slash = "slash",
|
|
51
|
+
dash = "dash",
|
|
52
|
+
space = "space"
|
|
32
53
|
}
|
|
33
54
|
/** Supported syntax highlighting languages for formatted code blocks. */
|
|
34
55
|
export declare enum CodeLanguage {
|
|
@@ -36,6 +57,11 @@ export declare enum CodeLanguage {
|
|
|
36
57
|
json = "json",
|
|
37
58
|
yaml = "yaml"
|
|
38
59
|
}
|
|
60
|
+
/** Visual presentation style for boolean values. */
|
|
61
|
+
export declare enum BooleanRepresentation {
|
|
62
|
+
plain = "plain",
|
|
63
|
+
badge = "badge"
|
|
64
|
+
}
|
|
39
65
|
/** Visual color tone variants for badge pill representations. */
|
|
40
66
|
export declare enum BadgeVariant {
|
|
41
67
|
neutral = "neutral",
|
|
@@ -45,7 +71,7 @@ export declare enum BadgeVariant {
|
|
|
45
71
|
}
|
|
46
72
|
/** Presentation format styles for timestamp elements. */
|
|
47
73
|
export declare enum TimestampFormat {
|
|
48
|
-
|
|
74
|
+
datetime = "datetime",
|
|
49
75
|
date = "date",
|
|
50
76
|
time = "time",
|
|
51
77
|
relative = "relative"
|
|
@@ -63,6 +89,11 @@ export declare enum TableColumnAlign {
|
|
|
63
89
|
center = "center",
|
|
64
90
|
right = "right"
|
|
65
91
|
}
|
|
92
|
+
/** Width mode for table columns. */
|
|
93
|
+
export declare enum TableColumnWidthMode {
|
|
94
|
+
fixed = "fixed",
|
|
95
|
+
maximum = "maximum"
|
|
96
|
+
}
|
|
66
97
|
/** Visual styling variants for hairline dividers. */
|
|
67
98
|
export declare enum DividerStyle {
|
|
68
99
|
hairline = "hairline",
|
|
@@ -134,37 +165,48 @@ export interface PrimitiveModifiers extends BaseModifiers {
|
|
|
134
165
|
readonly monospace?: boolean;
|
|
135
166
|
}
|
|
136
167
|
/**
|
|
137
|
-
*
|
|
138
|
-
* Supports plain text
|
|
168
|
+
* Universal textual string primitive element.
|
|
169
|
+
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
139
170
|
*/
|
|
140
|
-
export interface
|
|
171
|
+
export interface StringElement extends UiElementBase {
|
|
141
172
|
/**
|
|
142
173
|
* Discriminator type
|
|
143
174
|
*
|
|
144
|
-
* @defaultValue "string
|
|
175
|
+
* @defaultValue "string"
|
|
145
176
|
*/
|
|
146
|
-
readonly type: "string
|
|
177
|
+
readonly type: "string";
|
|
147
178
|
/** Text value */
|
|
148
179
|
readonly value: string;
|
|
149
180
|
/**
|
|
150
181
|
* Display representation mode
|
|
151
182
|
*
|
|
152
|
-
* @defaultValue
|
|
183
|
+
* @defaultValue StringRepresentation.plain
|
|
153
184
|
*/
|
|
154
|
-
readonly representation?:
|
|
185
|
+
readonly representation?: StringRepresentation;
|
|
155
186
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
156
187
|
readonly modifiers?: PrimitiveModifiers;
|
|
157
188
|
}
|
|
158
|
-
/**
|
|
159
|
-
|
|
189
|
+
/**
|
|
190
|
+
* Collection of textual string values rendered as a sequence of inline items or chips.
|
|
191
|
+
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
192
|
+
*/
|
|
193
|
+
export interface StringsElement extends UiElementBase {
|
|
160
194
|
/**
|
|
161
195
|
* Discriminator type
|
|
162
196
|
*
|
|
163
|
-
* @defaultValue "
|
|
197
|
+
* @defaultValue "strings"
|
|
164
198
|
*/
|
|
165
|
-
readonly type: "
|
|
166
|
-
/**
|
|
167
|
-
readonly
|
|
199
|
+
readonly type: "strings";
|
|
200
|
+
/** Array of string values */
|
|
201
|
+
readonly values: string[];
|
|
202
|
+
/**
|
|
203
|
+
* Display representation mode (plain text or visual chips)
|
|
204
|
+
*
|
|
205
|
+
* @defaultValue StringRepresentation.plain
|
|
206
|
+
*/
|
|
207
|
+
readonly representation?: StringRepresentation;
|
|
208
|
+
/** Optional visual separator rendered between sequential values */
|
|
209
|
+
readonly separator?: Separator;
|
|
168
210
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
169
211
|
readonly modifiers?: PrimitiveModifiers;
|
|
170
212
|
}
|
|
@@ -245,21 +287,56 @@ export interface RatioElement extends UiElementBase {
|
|
|
245
287
|
* @defaultValue "ratio"
|
|
246
288
|
*/
|
|
247
289
|
readonly type: "ratio";
|
|
248
|
-
/** Aspect ratio
|
|
249
|
-
readonly value:
|
|
290
|
+
/** Aspect ratio numerical expression */
|
|
291
|
+
readonly value: number;
|
|
250
292
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
251
293
|
readonly modifiers?: PrimitiveModifiers;
|
|
252
294
|
}
|
|
253
|
-
/**
|
|
295
|
+
/** Image dimensions representation displaying formatted width and height in pixels. */
|
|
296
|
+
export interface DimensionsElement extends UiElementBase {
|
|
297
|
+
/**
|
|
298
|
+
* Discriminator type
|
|
299
|
+
*
|
|
300
|
+
* @defaultValue "dimensions"
|
|
301
|
+
*/
|
|
302
|
+
readonly type: "dimensions";
|
|
303
|
+
/** Width in pixels */
|
|
304
|
+
readonly width: number;
|
|
305
|
+
/** Height in pixels */
|
|
306
|
+
readonly height: number;
|
|
307
|
+
/** Optional visual modifiers (copyable) */
|
|
308
|
+
readonly modifiers?: BaseModifiers;
|
|
309
|
+
}
|
|
310
|
+
/** Single color representation with hex value, shape/size styling, text display toggle, and copy affordance. */
|
|
254
311
|
export interface ColourElement extends UiElementBase {
|
|
255
312
|
/**
|
|
256
313
|
* Discriminator type
|
|
257
314
|
*
|
|
258
|
-
* @defaultValue "color
|
|
315
|
+
* @defaultValue "color"
|
|
259
316
|
*/
|
|
260
|
-
readonly type: "color
|
|
317
|
+
readonly type: "color";
|
|
261
318
|
/** Hexadecimal color code */
|
|
262
319
|
readonly value: string;
|
|
320
|
+
/** Optional descriptive color name label */
|
|
321
|
+
readonly label?: string;
|
|
322
|
+
/**
|
|
323
|
+
* Whether to display the textual color code or label next to the swatch
|
|
324
|
+
*
|
|
325
|
+
* @defaultValue true
|
|
326
|
+
*/
|
|
327
|
+
readonly showText?: boolean;
|
|
328
|
+
/**
|
|
329
|
+
* Visual shape of the color indicator
|
|
330
|
+
*
|
|
331
|
+
* @defaultValue Shape.circle
|
|
332
|
+
*/
|
|
333
|
+
readonly shape?: Shape;
|
|
334
|
+
/**
|
|
335
|
+
* Visual size of the color indicator
|
|
336
|
+
*
|
|
337
|
+
* @defaultValue Size.medium
|
|
338
|
+
*/
|
|
339
|
+
readonly size?: Size;
|
|
263
340
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
264
341
|
readonly modifiers?: PrimitiveModifiers;
|
|
265
342
|
}
|
|
@@ -314,29 +391,25 @@ export interface NumberBoundedMeterElement extends UiElementBase {
|
|
|
314
391
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
315
392
|
readonly modifiers?: PrimitiveModifiers;
|
|
316
393
|
}
|
|
317
|
-
/**
|
|
318
|
-
|
|
394
|
+
/**
|
|
395
|
+
* Universal boolean primitive element.
|
|
396
|
+
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
397
|
+
*/
|
|
398
|
+
export interface BooleanElement extends UiElementBase {
|
|
319
399
|
/**
|
|
320
400
|
* Discriminator type
|
|
321
401
|
*
|
|
322
|
-
* @defaultValue "boolean
|
|
402
|
+
* @defaultValue "boolean"
|
|
323
403
|
*/
|
|
324
|
-
readonly type: "boolean
|
|
404
|
+
readonly type: "boolean";
|
|
325
405
|
/** Boolean state value */
|
|
326
406
|
readonly value: boolean;
|
|
327
|
-
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
328
|
-
readonly modifiers?: PrimitiveModifiers;
|
|
329
|
-
}
|
|
330
|
-
/** Visual badge pill representation of a boolean state. */
|
|
331
|
-
export interface BooleanBadgeElement extends UiElementBase {
|
|
332
407
|
/**
|
|
333
|
-
*
|
|
408
|
+
* Display representation mode
|
|
334
409
|
*
|
|
335
|
-
* @defaultValue
|
|
410
|
+
* @defaultValue BooleanRepresentation.plain
|
|
336
411
|
*/
|
|
337
|
-
readonly
|
|
338
|
-
/** Boolean state value */
|
|
339
|
-
readonly value: boolean;
|
|
412
|
+
readonly representation?: BooleanRepresentation;
|
|
340
413
|
/**
|
|
341
414
|
* Custom display label when true (defaults to "true")
|
|
342
415
|
*
|
|
@@ -350,7 +423,7 @@ export interface BooleanBadgeElement extends UiElementBase {
|
|
|
350
423
|
*/
|
|
351
424
|
readonly falseLabel?: string;
|
|
352
425
|
/**
|
|
353
|
-
* Badge color tone
|
|
426
|
+
* Badge color tone when rendered as badge
|
|
354
427
|
*
|
|
355
428
|
* @defaultValue BadgeVariant.neutral
|
|
356
429
|
*/
|
|
@@ -366,12 +439,12 @@ export interface TimestampElement extends UiElementBase {
|
|
|
366
439
|
* @defaultValue "timestamp"
|
|
367
440
|
*/
|
|
368
441
|
readonly type: "timestamp";
|
|
369
|
-
/**
|
|
370
|
-
readonly value:
|
|
442
|
+
/** The timestamp in milliseconds */
|
|
443
|
+
readonly value: number;
|
|
371
444
|
/**
|
|
372
445
|
* Presentation date/time format
|
|
373
446
|
*
|
|
374
|
-
* @defaultValue TimestampFormat.
|
|
447
|
+
* @defaultValue TimestampFormat.datetime
|
|
375
448
|
*/
|
|
376
449
|
readonly format?: TimestampFormat;
|
|
377
450
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
@@ -398,17 +471,6 @@ export interface ImageReferenceElement extends UiElementBase {
|
|
|
398
471
|
/** Fallback placeholder image URI */
|
|
399
472
|
readonly placeholder?: string;
|
|
400
473
|
}
|
|
401
|
-
/** Dominant color set palette rendered in descending dominance order. */
|
|
402
|
-
export interface DominantColourSetElement extends UiElementBase {
|
|
403
|
-
/**
|
|
404
|
-
* Discriminator type
|
|
405
|
-
*
|
|
406
|
-
* @defaultValue "color-set"
|
|
407
|
-
*/
|
|
408
|
-
readonly type: "color-set";
|
|
409
|
-
/** List of hexadecimal color strings in descending priority */
|
|
410
|
-
readonly colors: string[];
|
|
411
|
-
}
|
|
412
474
|
/** Interactive button action triggering an extension command. */
|
|
413
475
|
export interface ButtonActionElement extends UiActionBase {
|
|
414
476
|
/**
|
|
@@ -479,32 +541,43 @@ export interface HtmlBlockElement extends UiElementBase {
|
|
|
479
541
|
export interface Slot {
|
|
480
542
|
/** Optional slot label (e.g. "Slot A") */
|
|
481
543
|
readonly label?: string;
|
|
482
|
-
/**
|
|
483
|
-
readonly width?:
|
|
544
|
+
/** Width percentage (1-100) */
|
|
545
|
+
readonly width?: number;
|
|
484
546
|
/** Rendered content inside the slot */
|
|
485
547
|
readonly content: UiElement;
|
|
486
548
|
}
|
|
487
|
-
/**
|
|
488
|
-
|
|
489
|
-
* Examples: "1/3 + 2/3", "equal thirds", "1/4 + 3/4".
|
|
490
|
-
*/
|
|
491
|
-
export interface MultiSlotRowElement extends UiElementBase {
|
|
549
|
+
/** Multi-slot horizontal row layout comprising slots with individual widths. */
|
|
550
|
+
export interface MultiSlotElement extends UiElementBase {
|
|
492
551
|
/**
|
|
493
552
|
* Discriminator type
|
|
494
553
|
*
|
|
495
554
|
* @defaultValue "multi-slot"
|
|
496
555
|
*/
|
|
497
556
|
readonly type: "multi-slot";
|
|
498
|
-
/** Proportions descriptor (e.g. "1/3 + 2/3", "equal", "1/4 + 3/4") */
|
|
499
|
-
readonly proportions?: string;
|
|
500
557
|
/** List of slots comprising the row */
|
|
501
558
|
readonly slots: Slot[];
|
|
502
559
|
}
|
|
560
|
+
/**
|
|
561
|
+
* Flowing inline layout container with automatic line wrapping.
|
|
562
|
+
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
563
|
+
*/
|
|
564
|
+
export interface FlowingElement extends UiElementBase {
|
|
565
|
+
/**
|
|
566
|
+
* Discriminator type
|
|
567
|
+
*
|
|
568
|
+
* @defaultValue "flowing"
|
|
569
|
+
*/
|
|
570
|
+
readonly type: "flowing";
|
|
571
|
+
/** Optional visual separator rendered between sequential child elements */
|
|
572
|
+
readonly separator?: Separator;
|
|
573
|
+
/** List of child elements rendered sequentially with line wrapping */
|
|
574
|
+
readonly elements: UiElement[];
|
|
575
|
+
}
|
|
503
576
|
/**
|
|
504
577
|
* Standard label and value row.
|
|
505
578
|
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
506
579
|
*/
|
|
507
|
-
export interface
|
|
580
|
+
export interface LabelValueElement extends UiElementBase {
|
|
508
581
|
/**
|
|
509
582
|
* Discriminator type
|
|
510
583
|
*
|
|
@@ -532,8 +605,14 @@ export interface TableColumn {
|
|
|
532
605
|
* @defaultValue TableColumnAlign.left
|
|
533
606
|
*/
|
|
534
607
|
readonly align?: TableColumnAlign;
|
|
535
|
-
/**
|
|
536
|
-
readonly width?:
|
|
608
|
+
/** Width percentage (1-100) */
|
|
609
|
+
readonly width?: number;
|
|
610
|
+
/**
|
|
611
|
+
* Sizing mode for the provided width
|
|
612
|
+
*
|
|
613
|
+
* @defaultValue TableColumnWidthMode.fixed
|
|
614
|
+
*/
|
|
615
|
+
readonly widthMode?: TableColumnWidthMode;
|
|
537
616
|
}
|
|
538
617
|
/** Single table row containing an array of cell values. */
|
|
539
618
|
export interface TableRow {
|
|
@@ -551,12 +630,6 @@ export interface TableElement extends UiElementBase {
|
|
|
551
630
|
* @defaultValue "table"
|
|
552
631
|
*/
|
|
553
632
|
readonly type: "table";
|
|
554
|
-
/**
|
|
555
|
-
* Whether to render a column header row
|
|
556
|
-
*
|
|
557
|
-
* @defaultValue true
|
|
558
|
-
*/
|
|
559
|
-
readonly hasHeader?: boolean;
|
|
560
633
|
/**
|
|
561
634
|
* Whether to render alternating row background colors
|
|
562
635
|
*
|
|
@@ -669,7 +742,7 @@ export interface UiCard extends UiContainer {
|
|
|
669
742
|
* Uses the @discriminator("type") decorator so all child models inheriting from UiElement
|
|
670
743
|
* are automatically recognized by schema emitters and SDK code generators.
|
|
671
744
|
*/
|
|
672
|
-
export type UiElement =
|
|
745
|
+
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;
|
|
673
746
|
/** Polymorphic base model for interactive actions. */
|
|
674
747
|
export type UiAction = ButtonActionElement | ExternalLinkActionElement;
|
|
675
748
|
/**
|
|
@@ -758,64 +831,75 @@ export declare class PrimitiveModifiersClass extends ViewKitNode<PrimitiveModifi
|
|
|
758
831
|
});
|
|
759
832
|
}
|
|
760
833
|
/**
|
|
761
|
-
* Class implementation of the `
|
|
834
|
+
* Class implementation of the `StringElement` interface.
|
|
762
835
|
*
|
|
763
836
|
* @remarks
|
|
764
|
-
*
|
|
765
|
-
* Supports plain text
|
|
837
|
+
* Universal textual string primitive element.
|
|
838
|
+
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
766
839
|
*/
|
|
767
|
-
export declare class
|
|
840
|
+
export declare class StringElementClass extends BaseUiElement<StringElement> implements StringElement {
|
|
768
841
|
/**
|
|
769
|
-
* Discriminator identifier for `
|
|
842
|
+
* Discriminator identifier for `StringElement`.
|
|
770
843
|
*
|
|
771
|
-
* @defaultValue "string
|
|
844
|
+
* @defaultValue "string"
|
|
772
845
|
*/
|
|
773
|
-
readonly type = "string
|
|
846
|
+
readonly type = "string";
|
|
774
847
|
/** Text value */
|
|
775
848
|
readonly value: string;
|
|
776
849
|
/**
|
|
777
850
|
* Display representation mode
|
|
778
851
|
*
|
|
779
|
-
* @defaultValue
|
|
852
|
+
* @defaultValue StringRepresentation.plain
|
|
780
853
|
*/
|
|
781
|
-
readonly representation?:
|
|
854
|
+
readonly representation?: StringRepresentation;
|
|
782
855
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
783
856
|
readonly modifiers?: PrimitiveModifiers;
|
|
784
857
|
/**
|
|
785
|
-
* Constructs a new `
|
|
858
|
+
* Constructs a new `StringElementClass` instance.
|
|
786
859
|
*
|
|
787
860
|
* @param value - Text value
|
|
788
861
|
* @param options - Optional component settings. (representation (defaults to `plain`), modifiers).
|
|
789
862
|
*/
|
|
790
863
|
constructor(value: string, options?: {
|
|
791
|
-
representation?:
|
|
864
|
+
representation?: StringRepresentation;
|
|
792
865
|
modifiers?: PrimitiveModifiers;
|
|
793
866
|
});
|
|
794
867
|
}
|
|
795
868
|
/**
|
|
796
|
-
* Class implementation of the `
|
|
869
|
+
* Class implementation of the `StringsElement` interface.
|
|
797
870
|
*
|
|
798
871
|
* @remarks
|
|
799
|
-
*
|
|
872
|
+
* Collection of textual string values rendered as a sequence of inline items or chips.
|
|
873
|
+
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
800
874
|
*/
|
|
801
|
-
export declare class
|
|
875
|
+
export declare class StringsElementClass extends BaseUiElement<StringsElement> implements StringsElement {
|
|
802
876
|
/**
|
|
803
|
-
* Discriminator identifier for `
|
|
877
|
+
* Discriminator identifier for `StringsElement`.
|
|
804
878
|
*
|
|
805
|
-
* @defaultValue "
|
|
879
|
+
* @defaultValue "strings"
|
|
806
880
|
*/
|
|
807
|
-
readonly type = "
|
|
808
|
-
/**
|
|
809
|
-
readonly
|
|
881
|
+
readonly type = "strings";
|
|
882
|
+
/** Array of string values */
|
|
883
|
+
readonly values: string[];
|
|
884
|
+
/**
|
|
885
|
+
* Display representation mode (plain text or visual chips)
|
|
886
|
+
*
|
|
887
|
+
* @defaultValue StringRepresentation.plain
|
|
888
|
+
*/
|
|
889
|
+
readonly representation?: StringRepresentation;
|
|
890
|
+
/** Optional visual separator rendered between sequential values */
|
|
891
|
+
readonly separator?: Separator;
|
|
810
892
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
811
893
|
readonly modifiers?: PrimitiveModifiers;
|
|
812
894
|
/**
|
|
813
|
-
* Constructs a new `
|
|
895
|
+
* Constructs a new `StringsElementClass` instance.
|
|
814
896
|
*
|
|
815
|
-
* @param
|
|
816
|
-
* @param options - Optional component settings. (modifiers).
|
|
897
|
+
* @param values - Array of string values
|
|
898
|
+
* @param options - Optional component settings. (representation (defaults to `plain`), separator, modifiers).
|
|
817
899
|
*/
|
|
818
|
-
constructor(
|
|
900
|
+
constructor(values: string[], options?: {
|
|
901
|
+
representation?: StringRepresentation;
|
|
902
|
+
separator?: Separator;
|
|
819
903
|
modifiers?: PrimitiveModifiers;
|
|
820
904
|
});
|
|
821
905
|
}
|
|
@@ -973,44 +1057,98 @@ export declare class RatioElementClass extends BaseUiElement<RatioElement> imple
|
|
|
973
1057
|
* @defaultValue "ratio"
|
|
974
1058
|
*/
|
|
975
1059
|
readonly type = "ratio";
|
|
976
|
-
/** Aspect ratio
|
|
977
|
-
readonly value:
|
|
1060
|
+
/** Aspect ratio numerical expression */
|
|
1061
|
+
readonly value: number;
|
|
978
1062
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
979
1063
|
readonly modifiers?: PrimitiveModifiers;
|
|
980
1064
|
/**
|
|
981
1065
|
* Constructs a new `RatioElementClass` instance.
|
|
982
1066
|
*
|
|
983
|
-
* @param value - Aspect ratio
|
|
1067
|
+
* @param value - Aspect ratio numerical expression
|
|
984
1068
|
* @param options - Optional component settings. (modifiers).
|
|
985
1069
|
*/
|
|
986
|
-
constructor(value:
|
|
1070
|
+
constructor(value: number, options?: {
|
|
987
1071
|
modifiers?: PrimitiveModifiers;
|
|
988
1072
|
});
|
|
989
1073
|
}
|
|
1074
|
+
/**
|
|
1075
|
+
* Class implementation of the `DimensionsElement` interface.
|
|
1076
|
+
*
|
|
1077
|
+
* @remarks
|
|
1078
|
+
* Image dimensions representation displaying formatted width and height in pixels.
|
|
1079
|
+
*/
|
|
1080
|
+
export declare class DimensionsElementClass extends BaseUiElement<DimensionsElement> implements DimensionsElement {
|
|
1081
|
+
/**
|
|
1082
|
+
* Discriminator identifier for `DimensionsElement`.
|
|
1083
|
+
*
|
|
1084
|
+
* @defaultValue "dimensions"
|
|
1085
|
+
*/
|
|
1086
|
+
readonly type = "dimensions";
|
|
1087
|
+
/** Width in pixels */
|
|
1088
|
+
readonly width: number;
|
|
1089
|
+
/** Height in pixels */
|
|
1090
|
+
readonly height: number;
|
|
1091
|
+
/** Optional visual modifiers (copyable) */
|
|
1092
|
+
readonly modifiers?: BaseModifiers;
|
|
1093
|
+
/**
|
|
1094
|
+
* Constructs a new `DimensionsElementClass` instance.
|
|
1095
|
+
*
|
|
1096
|
+
* @param width - Width in pixels
|
|
1097
|
+
* @param height - Height in pixels
|
|
1098
|
+
* @param options - Optional component settings. (modifiers).
|
|
1099
|
+
*/
|
|
1100
|
+
constructor(width: number, height: number, options?: {
|
|
1101
|
+
modifiers?: BaseModifiers;
|
|
1102
|
+
});
|
|
1103
|
+
}
|
|
990
1104
|
/**
|
|
991
1105
|
* Class implementation of the `ColourElement` interface.
|
|
992
1106
|
*
|
|
993
1107
|
* @remarks
|
|
994
|
-
* Single color
|
|
1108
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
995
1109
|
*/
|
|
996
1110
|
export declare class ColourElementClass extends BaseUiElement<ColourElement> implements ColourElement {
|
|
997
1111
|
/**
|
|
998
1112
|
* Discriminator identifier for `ColourElement`.
|
|
999
1113
|
*
|
|
1000
|
-
* @defaultValue "color
|
|
1114
|
+
* @defaultValue "color"
|
|
1001
1115
|
*/
|
|
1002
|
-
readonly type = "color
|
|
1116
|
+
readonly type = "color";
|
|
1003
1117
|
/** Hexadecimal color code */
|
|
1004
1118
|
readonly value: string;
|
|
1119
|
+
/** Optional descriptive color name label */
|
|
1120
|
+
readonly label?: string;
|
|
1121
|
+
/**
|
|
1122
|
+
* Whether to display the textual color code or label next to the swatch
|
|
1123
|
+
*
|
|
1124
|
+
* @defaultValue true
|
|
1125
|
+
*/
|
|
1126
|
+
readonly showText?: boolean;
|
|
1127
|
+
/**
|
|
1128
|
+
* Visual shape of the color indicator
|
|
1129
|
+
*
|
|
1130
|
+
* @defaultValue Shape.circle
|
|
1131
|
+
*/
|
|
1132
|
+
readonly shape?: Shape;
|
|
1133
|
+
/**
|
|
1134
|
+
* Visual size of the color indicator
|
|
1135
|
+
*
|
|
1136
|
+
* @defaultValue Size.medium
|
|
1137
|
+
*/
|
|
1138
|
+
readonly size?: Size;
|
|
1005
1139
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
1006
1140
|
readonly modifiers?: PrimitiveModifiers;
|
|
1007
1141
|
/**
|
|
1008
1142
|
* Constructs a new `ColourElementClass` instance.
|
|
1009
1143
|
*
|
|
1010
1144
|
* @param value - Hexadecimal color code
|
|
1011
|
-
* @param options - Optional component settings. (modifiers).
|
|
1145
|
+
* @param options - Optional component settings. (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
1012
1146
|
*/
|
|
1013
1147
|
constructor(value: string, options?: {
|
|
1148
|
+
label?: string;
|
|
1149
|
+
showText?: boolean;
|
|
1150
|
+
shape?: Shape;
|
|
1151
|
+
size?: Size;
|
|
1014
1152
|
modifiers?: PrimitiveModifiers;
|
|
1015
1153
|
});
|
|
1016
1154
|
}
|
|
@@ -1114,47 +1252,27 @@ export declare class NumberBoundedMeterElementClass extends BaseUiElement<Number
|
|
|
1114
1252
|
});
|
|
1115
1253
|
}
|
|
1116
1254
|
/**
|
|
1117
|
-
* Class implementation of the `
|
|
1255
|
+
* Class implementation of the `BooleanElement` interface.
|
|
1118
1256
|
*
|
|
1119
1257
|
* @remarks
|
|
1120
|
-
*
|
|
1258
|
+
* Universal boolean primitive element.
|
|
1259
|
+
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
1121
1260
|
*/
|
|
1122
|
-
export declare class
|
|
1261
|
+
export declare class BooleanElementClass extends BaseUiElement<BooleanElement> implements BooleanElement {
|
|
1123
1262
|
/**
|
|
1124
|
-
* Discriminator identifier for `
|
|
1263
|
+
* Discriminator identifier for `BooleanElement`.
|
|
1125
1264
|
*
|
|
1126
|
-
* @defaultValue "boolean
|
|
1265
|
+
* @defaultValue "boolean"
|
|
1127
1266
|
*/
|
|
1128
|
-
readonly type = "boolean
|
|
1267
|
+
readonly type = "boolean";
|
|
1129
1268
|
/** Boolean state value */
|
|
1130
1269
|
readonly value: boolean;
|
|
1131
|
-
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
1132
|
-
readonly modifiers?: PrimitiveModifiers;
|
|
1133
1270
|
/**
|
|
1134
|
-
*
|
|
1271
|
+
* Display representation mode
|
|
1135
1272
|
*
|
|
1136
|
-
* @
|
|
1137
|
-
* @param options - Optional component settings. (modifiers).
|
|
1273
|
+
* @defaultValue BooleanRepresentation.plain
|
|
1138
1274
|
*/
|
|
1139
|
-
|
|
1140
|
-
modifiers?: PrimitiveModifiers;
|
|
1141
|
-
});
|
|
1142
|
-
}
|
|
1143
|
-
/**
|
|
1144
|
-
* Class implementation of the `BooleanBadgeElement` interface.
|
|
1145
|
-
*
|
|
1146
|
-
* @remarks
|
|
1147
|
-
* Visual badge pill representation of a boolean state.
|
|
1148
|
-
*/
|
|
1149
|
-
export declare class BooleanBadgeElementClass extends BaseUiElement<BooleanBadgeElement> implements BooleanBadgeElement {
|
|
1150
|
-
/**
|
|
1151
|
-
* Discriminator identifier for `BooleanBadgeElement`.
|
|
1152
|
-
*
|
|
1153
|
-
* @defaultValue "boolean-badge"
|
|
1154
|
-
*/
|
|
1155
|
-
readonly type = "boolean-badge";
|
|
1156
|
-
/** Boolean state value */
|
|
1157
|
-
readonly value: boolean;
|
|
1275
|
+
readonly representation?: BooleanRepresentation;
|
|
1158
1276
|
/**
|
|
1159
1277
|
* Custom display label when true (defaults to "true")
|
|
1160
1278
|
*
|
|
@@ -1168,7 +1286,7 @@ export declare class BooleanBadgeElementClass extends BaseUiElement<BooleanBadge
|
|
|
1168
1286
|
*/
|
|
1169
1287
|
readonly falseLabel?: string;
|
|
1170
1288
|
/**
|
|
1171
|
-
* Badge color tone
|
|
1289
|
+
* Badge color tone when rendered as badge
|
|
1172
1290
|
*
|
|
1173
1291
|
* @defaultValue BadgeVariant.neutral
|
|
1174
1292
|
*/
|
|
@@ -1176,12 +1294,13 @@ export declare class BooleanBadgeElementClass extends BaseUiElement<BooleanBadge
|
|
|
1176
1294
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
1177
1295
|
readonly modifiers?: PrimitiveModifiers;
|
|
1178
1296
|
/**
|
|
1179
|
-
* Constructs a new `
|
|
1297
|
+
* Constructs a new `BooleanElementClass` instance.
|
|
1180
1298
|
*
|
|
1181
1299
|
* @param value - Boolean state value
|
|
1182
|
-
* @param options - Optional component settings. (trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
1300
|
+
* @param options - Optional component settings. (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
1183
1301
|
*/
|
|
1184
1302
|
constructor(value: boolean, options?: {
|
|
1303
|
+
representation?: BooleanRepresentation;
|
|
1185
1304
|
trueLabel?: string;
|
|
1186
1305
|
falseLabel?: string;
|
|
1187
1306
|
variant?: BadgeVariant;
|
|
@@ -1201,12 +1320,12 @@ export declare class TimestampElementClass extends BaseUiElement<TimestampElemen
|
|
|
1201
1320
|
* @defaultValue "timestamp"
|
|
1202
1321
|
*/
|
|
1203
1322
|
readonly type = "timestamp";
|
|
1204
|
-
/**
|
|
1205
|
-
readonly value:
|
|
1323
|
+
/** The timestamp in milliseconds */
|
|
1324
|
+
readonly value: number;
|
|
1206
1325
|
/**
|
|
1207
1326
|
* Presentation date/time format
|
|
1208
1327
|
*
|
|
1209
|
-
* @defaultValue TimestampFormat.
|
|
1328
|
+
* @defaultValue TimestampFormat.datetime
|
|
1210
1329
|
*/
|
|
1211
1330
|
readonly format?: TimestampFormat;
|
|
1212
1331
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
@@ -1214,10 +1333,10 @@ export declare class TimestampElementClass extends BaseUiElement<TimestampElemen
|
|
|
1214
1333
|
/**
|
|
1215
1334
|
* Constructs a new `TimestampElementClass` instance.
|
|
1216
1335
|
*
|
|
1217
|
-
* @param value -
|
|
1218
|
-
* @param options - Optional component settings. (format (defaults to `
|
|
1336
|
+
* @param value - The timestamp in milliseconds
|
|
1337
|
+
* @param options - Optional component settings. (format (defaults to `datetime`), modifiers).
|
|
1219
1338
|
*/
|
|
1220
|
-
constructor(value:
|
|
1339
|
+
constructor(value: number, options?: {
|
|
1221
1340
|
format?: TimestampFormat;
|
|
1222
1341
|
modifiers?: PrimitiveModifiers;
|
|
1223
1342
|
});
|
|
@@ -1259,28 +1378,6 @@ export declare class ImageReferenceElementClass extends BaseUiElement<ImageRefer
|
|
|
1259
1378
|
placeholder?: string;
|
|
1260
1379
|
});
|
|
1261
1380
|
}
|
|
1262
|
-
/**
|
|
1263
|
-
* Class implementation of the `DominantColourSetElement` interface.
|
|
1264
|
-
*
|
|
1265
|
-
* @remarks
|
|
1266
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
1267
|
-
*/
|
|
1268
|
-
export declare class DominantColourSetElementClass extends BaseUiElement<DominantColourSetElement> implements DominantColourSetElement {
|
|
1269
|
-
/**
|
|
1270
|
-
* Discriminator identifier for `DominantColourSetElement`.
|
|
1271
|
-
*
|
|
1272
|
-
* @defaultValue "color-set"
|
|
1273
|
-
*/
|
|
1274
|
-
readonly type = "color-set";
|
|
1275
|
-
/** List of hexadecimal color strings in descending priority */
|
|
1276
|
-
readonly colors: string[];
|
|
1277
|
-
/**
|
|
1278
|
-
* Constructs a new `DominantColourSetElementClass` instance.
|
|
1279
|
-
*
|
|
1280
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
1281
|
-
*/
|
|
1282
|
-
constructor(colors: string[]);
|
|
1283
|
-
}
|
|
1284
1381
|
/**
|
|
1285
1382
|
* Class implementation of the `ButtonActionElement` interface.
|
|
1286
1383
|
*
|
|
@@ -1421,8 +1518,8 @@ export declare class SlotClass extends ViewKitNode<Slot> implements Slot {
|
|
|
1421
1518
|
readonly content: UiElement;
|
|
1422
1519
|
/** Optional slot label (e.g. "Slot A") */
|
|
1423
1520
|
readonly label?: string;
|
|
1424
|
-
/**
|
|
1425
|
-
readonly width?:
|
|
1521
|
+
/** Width percentage (1-100) */
|
|
1522
|
+
readonly width?: number;
|
|
1426
1523
|
/**
|
|
1427
1524
|
* Constructs a new `SlotClass` instance.
|
|
1428
1525
|
*
|
|
@@ -1431,47 +1528,69 @@ export declare class SlotClass extends ViewKitNode<Slot> implements Slot {
|
|
|
1431
1528
|
*/
|
|
1432
1529
|
constructor(content: UiElement, options?: {
|
|
1433
1530
|
label?: string;
|
|
1434
|
-
width?:
|
|
1531
|
+
width?: number;
|
|
1435
1532
|
});
|
|
1436
1533
|
}
|
|
1437
1534
|
/**
|
|
1438
|
-
* Class implementation of the `
|
|
1535
|
+
* Class implementation of the `MultiSlotElement` interface.
|
|
1439
1536
|
*
|
|
1440
1537
|
* @remarks
|
|
1441
|
-
* Multi-slot horizontal row
|
|
1442
|
-
* Examples: "1/3 + 2/3", "equal thirds", "1/4 + 3/4".
|
|
1538
|
+
* Multi-slot horizontal row layout comprising slots with individual widths.
|
|
1443
1539
|
*/
|
|
1444
|
-
export declare class
|
|
1540
|
+
export declare class MultiSlotElementClass extends BaseUiElement<MultiSlotElement> implements MultiSlotElement {
|
|
1445
1541
|
/**
|
|
1446
|
-
* Discriminator identifier for `
|
|
1542
|
+
* Discriminator identifier for `MultiSlotElement`.
|
|
1447
1543
|
*
|
|
1448
1544
|
* @defaultValue "multi-slot"
|
|
1449
1545
|
*/
|
|
1450
1546
|
readonly type = "multi-slot";
|
|
1451
1547
|
/** List of slots comprising the row */
|
|
1452
1548
|
readonly slots: Slot[];
|
|
1453
|
-
/** Proportions descriptor (e.g. "1/3 + 2/3", "equal", "1/4 + 3/4") */
|
|
1454
|
-
readonly proportions?: string;
|
|
1455
1549
|
/**
|
|
1456
|
-
* Constructs a new `
|
|
1550
|
+
* Constructs a new `MultiSlotElementClass` instance.
|
|
1457
1551
|
*
|
|
1458
1552
|
* @param slots - List of slots comprising the row
|
|
1459
|
-
* @param options - Optional component settings. (proportions).
|
|
1460
1553
|
*/
|
|
1461
|
-
constructor(slots: Slot[]
|
|
1462
|
-
|
|
1554
|
+
constructor(slots: Slot[]);
|
|
1555
|
+
}
|
|
1556
|
+
/**
|
|
1557
|
+
* Class implementation of the `FlowingElement` interface.
|
|
1558
|
+
*
|
|
1559
|
+
* @remarks
|
|
1560
|
+
* Flowing inline layout container with automatic line wrapping.
|
|
1561
|
+
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
1562
|
+
*/
|
|
1563
|
+
export declare class FlowingElementClass extends BaseUiElement<FlowingElement> implements FlowingElement {
|
|
1564
|
+
/**
|
|
1565
|
+
* Discriminator identifier for `FlowingElement`.
|
|
1566
|
+
*
|
|
1567
|
+
* @defaultValue "flowing"
|
|
1568
|
+
*/
|
|
1569
|
+
readonly type = "flowing";
|
|
1570
|
+
/** List of child elements rendered sequentially with line wrapping */
|
|
1571
|
+
readonly elements: UiElement[];
|
|
1572
|
+
/** Optional visual separator rendered between sequential child elements */
|
|
1573
|
+
readonly separator?: Separator;
|
|
1574
|
+
/**
|
|
1575
|
+
* Constructs a new `FlowingElementClass` instance.
|
|
1576
|
+
*
|
|
1577
|
+
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
1578
|
+
* @param options - Optional component settings. (separator).
|
|
1579
|
+
*/
|
|
1580
|
+
constructor(elements: UiElement[], options?: {
|
|
1581
|
+
separator?: Separator;
|
|
1463
1582
|
});
|
|
1464
1583
|
}
|
|
1465
1584
|
/**
|
|
1466
|
-
* Class implementation of the `
|
|
1585
|
+
* Class implementation of the `LabelValueElement` interface.
|
|
1467
1586
|
*
|
|
1468
1587
|
* @remarks
|
|
1469
1588
|
* Standard label and value row.
|
|
1470
1589
|
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
1471
1590
|
*/
|
|
1472
|
-
export declare class
|
|
1591
|
+
export declare class LabelValueElementClass extends BaseUiElement<LabelValueElement> implements LabelValueElement {
|
|
1473
1592
|
/**
|
|
1474
|
-
* Discriminator identifier for `
|
|
1593
|
+
* Discriminator identifier for `LabelValueElement`.
|
|
1475
1594
|
*
|
|
1476
1595
|
* @defaultValue "label-value"
|
|
1477
1596
|
*/
|
|
@@ -1487,7 +1606,7 @@ export declare class LabelValueRowElementClass extends BaseUiElement<LabelValueR
|
|
|
1487
1606
|
*/
|
|
1488
1607
|
readonly withDivider?: boolean;
|
|
1489
1608
|
/**
|
|
1490
|
-
* Constructs a new `
|
|
1609
|
+
* Constructs a new `LabelValueElementClass` instance.
|
|
1491
1610
|
*
|
|
1492
1611
|
* @param label - Key or descriptive label displayed muted on the left
|
|
1493
1612
|
* @param value - Rendered value element on the right
|
|
@@ -1512,17 +1631,24 @@ export declare class TableColumnClass extends ViewKitNode<TableColumn> implement
|
|
|
1512
1631
|
* @defaultValue TableColumnAlign.left
|
|
1513
1632
|
*/
|
|
1514
1633
|
readonly align?: TableColumnAlign;
|
|
1515
|
-
/**
|
|
1516
|
-
readonly width?:
|
|
1634
|
+
/** Width percentage (1-100) */
|
|
1635
|
+
readonly width?: number;
|
|
1636
|
+
/**
|
|
1637
|
+
* Sizing mode for the provided width
|
|
1638
|
+
*
|
|
1639
|
+
* @defaultValue TableColumnWidthMode.fixed
|
|
1640
|
+
*/
|
|
1641
|
+
readonly widthMode?: TableColumnWidthMode;
|
|
1517
1642
|
/**
|
|
1518
1643
|
* Constructs a new `TableColumnClass` instance.
|
|
1519
1644
|
*
|
|
1520
|
-
* @param options - Optional component settings. (header, align (defaults to `left`), width).
|
|
1645
|
+
* @param options - Optional component settings. (header, align (defaults to `left`), width, widthMode (defaults to `fixed`)).
|
|
1521
1646
|
*/
|
|
1522
1647
|
constructor(options?: {
|
|
1523
1648
|
header?: string;
|
|
1524
1649
|
align?: TableColumnAlign;
|
|
1525
|
-
width?:
|
|
1650
|
+
width?: number;
|
|
1651
|
+
widthMode?: TableColumnWidthMode;
|
|
1526
1652
|
});
|
|
1527
1653
|
}
|
|
1528
1654
|
/**
|
|
@@ -1557,12 +1683,6 @@ export declare class TableElementClass extends BaseUiElement<TableElement> imple
|
|
|
1557
1683
|
readonly type = "table";
|
|
1558
1684
|
/** Tabular data rows */
|
|
1559
1685
|
readonly rows: TableRow[];
|
|
1560
|
-
/**
|
|
1561
|
-
* Whether to render a column header row
|
|
1562
|
-
*
|
|
1563
|
-
* @defaultValue true
|
|
1564
|
-
*/
|
|
1565
|
-
readonly hasHeader?: boolean;
|
|
1566
1686
|
/**
|
|
1567
1687
|
* Whether to render alternating row background colors
|
|
1568
1688
|
*
|
|
@@ -1587,10 +1707,9 @@ export declare class TableElementClass extends BaseUiElement<TableElement> imple
|
|
|
1587
1707
|
* Constructs a new `TableElementClass` instance.
|
|
1588
1708
|
*
|
|
1589
1709
|
* @param rows - Tabular data rows
|
|
1590
|
-
* @param options - Optional component settings. (
|
|
1710
|
+
* @param options - Optional component settings. (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
|
|
1591
1711
|
*/
|
|
1592
1712
|
constructor(rows: TableRow[], options?: {
|
|
1593
|
-
hasHeader?: boolean;
|
|
1594
1713
|
isStriped?: boolean;
|
|
1595
1714
|
withColumnSeparators?: boolean;
|
|
1596
1715
|
withRowSeparators?: boolean;
|
|
@@ -1820,31 +1939,34 @@ export declare class UiContainerBuilder {
|
|
|
1820
1939
|
*/
|
|
1821
1940
|
addElements(...items: UiElement[]): this;
|
|
1822
1941
|
/**
|
|
1823
|
-
* Appends a `
|
|
1942
|
+
* Appends a `StringElement` component.
|
|
1824
1943
|
*
|
|
1825
1944
|
* @remarks
|
|
1826
|
-
*
|
|
1827
|
-
* Supports plain text
|
|
1945
|
+
* Universal textual string primitive element.
|
|
1946
|
+
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
1828
1947
|
*
|
|
1829
1948
|
* @param value - Text value
|
|
1830
1949
|
* @param options - Optional component settings (representation (defaults to `plain`), modifiers).
|
|
1831
1950
|
* @returns This builder instance for method chaining.
|
|
1832
1951
|
*/
|
|
1833
|
-
|
|
1834
|
-
representation?:
|
|
1952
|
+
addString(value: string, options?: {
|
|
1953
|
+
representation?: StringRepresentation;
|
|
1835
1954
|
modifiers?: PrimitiveModifiers;
|
|
1836
1955
|
}): this;
|
|
1837
1956
|
/**
|
|
1838
|
-
* Appends a `
|
|
1957
|
+
* Appends a `StringsElement` component.
|
|
1839
1958
|
*
|
|
1840
1959
|
* @remarks
|
|
1841
|
-
*
|
|
1960
|
+
* Collection of textual string values rendered as a sequence of inline items or chips.
|
|
1961
|
+
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
1842
1962
|
*
|
|
1843
|
-
* @param
|
|
1844
|
-
* @param options - Optional component settings (modifiers).
|
|
1963
|
+
* @param values - Array of string values
|
|
1964
|
+
* @param options - Optional component settings (representation (defaults to `plain`), separator, modifiers).
|
|
1845
1965
|
* @returns This builder instance for method chaining.
|
|
1846
1966
|
*/
|
|
1847
|
-
|
|
1967
|
+
addStrings(values: string[], options?: {
|
|
1968
|
+
representation?: StringRepresentation;
|
|
1969
|
+
separator?: Separator;
|
|
1848
1970
|
modifiers?: PrimitiveModifiers;
|
|
1849
1971
|
}): this;
|
|
1850
1972
|
/**
|
|
@@ -1920,37 +2042,59 @@ export declare class UiContainerBuilder {
|
|
|
1920
2042
|
* @remarks
|
|
1921
2043
|
* Aspect ratio representation (e.g. "16:9", "4:3", "1:1").
|
|
1922
2044
|
*
|
|
1923
|
-
* @param value - Aspect ratio
|
|
2045
|
+
* @param value - Aspect ratio numerical expression
|
|
1924
2046
|
* @param options - Optional component settings (modifiers).
|
|
1925
2047
|
* @returns This builder instance for method chaining.
|
|
1926
2048
|
*/
|
|
1927
|
-
addRatio(value:
|
|
2049
|
+
addRatio(value: number, options?: {
|
|
1928
2050
|
modifiers?: PrimitiveModifiers;
|
|
1929
2051
|
}): this;
|
|
2052
|
+
/**
|
|
2053
|
+
* Appends a `DimensionsElement` component.
|
|
2054
|
+
*
|
|
2055
|
+
* @remarks
|
|
2056
|
+
* Image dimensions representation displaying formatted width and height in pixels.
|
|
2057
|
+
*
|
|
2058
|
+
* @param width - Width in pixels
|
|
2059
|
+
* @param height - Height in pixels
|
|
2060
|
+
* @param options - Optional component settings (modifiers).
|
|
2061
|
+
* @returns This builder instance for method chaining.
|
|
2062
|
+
*/
|
|
2063
|
+
addDimensions(width: number, height: number, options?: {
|
|
2064
|
+
modifiers?: BaseModifiers;
|
|
2065
|
+
}): this;
|
|
1930
2066
|
/**
|
|
1931
2067
|
* Appends a `ColourElement` component.
|
|
1932
2068
|
*
|
|
1933
2069
|
* @remarks
|
|
1934
|
-
* Single color
|
|
2070
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
1935
2071
|
*
|
|
1936
2072
|
* @param value - Hexadecimal color code
|
|
1937
|
-
* @param options - Optional component settings (modifiers).
|
|
2073
|
+
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
1938
2074
|
* @returns This builder instance for method chaining.
|
|
1939
2075
|
*/
|
|
1940
2076
|
addColour(value: string, options?: {
|
|
2077
|
+
label?: string;
|
|
2078
|
+
showText?: boolean;
|
|
2079
|
+
shape?: Shape;
|
|
2080
|
+
size?: Size;
|
|
1941
2081
|
modifiers?: PrimitiveModifiers;
|
|
1942
2082
|
}): this;
|
|
1943
2083
|
/**
|
|
1944
2084
|
* Appends a `ColourElement` component.
|
|
1945
2085
|
*
|
|
1946
2086
|
* @remarks
|
|
1947
|
-
* Single color
|
|
2087
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
1948
2088
|
*
|
|
1949
2089
|
* @param value - Hexadecimal color code
|
|
1950
|
-
* @param options - Optional component settings (modifiers).
|
|
2090
|
+
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
1951
2091
|
* @returns This builder instance for method chaining.
|
|
1952
2092
|
*/
|
|
1953
|
-
|
|
2093
|
+
addColor(value: string, options?: {
|
|
2094
|
+
label?: string;
|
|
2095
|
+
showText?: boolean;
|
|
2096
|
+
shape?: Shape;
|
|
2097
|
+
size?: Size;
|
|
1954
2098
|
modifiers?: PrimitiveModifiers;
|
|
1955
2099
|
}): this;
|
|
1956
2100
|
/**
|
|
@@ -2030,29 +2174,18 @@ export declare class UiContainerBuilder {
|
|
|
2030
2174
|
modifiers?: PrimitiveModifiers;
|
|
2031
2175
|
}): this;
|
|
2032
2176
|
/**
|
|
2033
|
-
* Appends a `
|
|
2034
|
-
*
|
|
2035
|
-
* @remarks
|
|
2036
|
-
* Plain boolean value representation (textual "true" / "false").
|
|
2037
|
-
*
|
|
2038
|
-
* @param value - Boolean state value
|
|
2039
|
-
* @param options - Optional component settings (modifiers).
|
|
2040
|
-
* @returns This builder instance for method chaining.
|
|
2041
|
-
*/
|
|
2042
|
-
addBooleanPlain(value: boolean, options?: {
|
|
2043
|
-
modifiers?: PrimitiveModifiers;
|
|
2044
|
-
}): this;
|
|
2045
|
-
/**
|
|
2046
|
-
* Appends a `BooleanBadgeElement` component.
|
|
2177
|
+
* Appends a `BooleanElement` component.
|
|
2047
2178
|
*
|
|
2048
2179
|
* @remarks
|
|
2049
|
-
*
|
|
2180
|
+
* Universal boolean primitive element.
|
|
2181
|
+
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
2050
2182
|
*
|
|
2051
2183
|
* @param value - Boolean state value
|
|
2052
|
-
* @param options - Optional component settings (trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
2184
|
+
* @param options - Optional component settings (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
2053
2185
|
* @returns This builder instance for method chaining.
|
|
2054
2186
|
*/
|
|
2055
|
-
|
|
2187
|
+
addBoolean(value: boolean, options?: {
|
|
2188
|
+
representation?: BooleanRepresentation;
|
|
2056
2189
|
trueLabel?: string;
|
|
2057
2190
|
falseLabel?: string;
|
|
2058
2191
|
variant?: BadgeVariant;
|
|
@@ -2064,11 +2197,11 @@ export declare class UiContainerBuilder {
|
|
|
2064
2197
|
* @remarks
|
|
2065
2198
|
* Formatted date and time representation.
|
|
2066
2199
|
*
|
|
2067
|
-
* @param value -
|
|
2068
|
-
* @param options - Optional component settings (format (defaults to `
|
|
2200
|
+
* @param value - The timestamp in milliseconds
|
|
2201
|
+
* @param options - Optional component settings (format (defaults to `datetime`), modifiers).
|
|
2069
2202
|
* @returns This builder instance for method chaining.
|
|
2070
2203
|
*/
|
|
2071
|
-
addTimestamp(value:
|
|
2204
|
+
addTimestamp(value: number, options?: {
|
|
2072
2205
|
format?: TimestampFormat;
|
|
2073
2206
|
modifiers?: PrimitiveModifiers;
|
|
2074
2207
|
}): this;
|
|
@@ -2102,26 +2235,6 @@ export declare class UiContainerBuilder {
|
|
|
2102
2235
|
aspectRatio?: string;
|
|
2103
2236
|
placeholder?: string;
|
|
2104
2237
|
}): this;
|
|
2105
|
-
/**
|
|
2106
|
-
* Appends a `DominantColourSetElement` component.
|
|
2107
|
-
*
|
|
2108
|
-
* @remarks
|
|
2109
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
2110
|
-
*
|
|
2111
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
2112
|
-
* @returns This builder instance for method chaining.
|
|
2113
|
-
*/
|
|
2114
|
-
addDominantColourSet(colors: string[]): this;
|
|
2115
|
-
/**
|
|
2116
|
-
* Appends a `DominantColourSetElement` component.
|
|
2117
|
-
*
|
|
2118
|
-
* @remarks
|
|
2119
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
2120
|
-
*
|
|
2121
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
2122
|
-
* @returns This builder instance for method chaining.
|
|
2123
|
-
*/
|
|
2124
|
-
addDominantColors(colors: string[]): this;
|
|
2125
2238
|
/**
|
|
2126
2239
|
* Appends a `MarkdownBlockElement` component.
|
|
2127
2240
|
*
|
|
@@ -2175,50 +2288,31 @@ export declare class UiContainerBuilder {
|
|
|
2175
2288
|
modifiers?: BaseModifiers;
|
|
2176
2289
|
}): this;
|
|
2177
2290
|
/**
|
|
2178
|
-
* Appends a `
|
|
2179
|
-
*
|
|
2180
|
-
* @remarks
|
|
2181
|
-
* Multi-slot horizontal row with declared column width proportions.
|
|
2182
|
-
* Examples: "1/3 + 2/3", "equal thirds", "1/4 + 3/4".
|
|
2183
|
-
*
|
|
2184
|
-
* @param slots - List of slots comprising the row
|
|
2185
|
-
* @param options - Optional component settings (proportions).
|
|
2186
|
-
* @returns This builder instance for method chaining.
|
|
2187
|
-
*/
|
|
2188
|
-
addMultiSlotRow(slots: Slot[], options?: {
|
|
2189
|
-
proportions?: string;
|
|
2190
|
-
}): this;
|
|
2191
|
-
/**
|
|
2192
|
-
* Appends a `MultiSlotRowElement` component.
|
|
2291
|
+
* Appends a `MultiSlotElement` component.
|
|
2193
2292
|
*
|
|
2194
2293
|
* @remarks
|
|
2195
|
-
* Multi-slot horizontal row
|
|
2196
|
-
* Examples: "1/3 + 2/3", "equal thirds", "1/4 + 3/4".
|
|
2294
|
+
* Multi-slot horizontal row layout comprising slots with individual widths.
|
|
2197
2295
|
*
|
|
2198
2296
|
* @param slots - List of slots comprising the row
|
|
2199
|
-
* @param options - Optional component settings (proportions).
|
|
2200
2297
|
* @returns This builder instance for method chaining.
|
|
2201
2298
|
*/
|
|
2202
|
-
addMultiSlot(slots: Slot[]
|
|
2203
|
-
proportions?: string;
|
|
2204
|
-
}): this;
|
|
2299
|
+
addMultiSlot(slots: Slot[]): this;
|
|
2205
2300
|
/**
|
|
2206
|
-
* Appends a `
|
|
2301
|
+
* Appends a `FlowingElement` component.
|
|
2207
2302
|
*
|
|
2208
2303
|
* @remarks
|
|
2209
|
-
*
|
|
2210
|
-
*
|
|
2304
|
+
* Flowing inline layout container with automatic line wrapping.
|
|
2305
|
+
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
2211
2306
|
*
|
|
2212
|
-
* @param
|
|
2213
|
-
* @param
|
|
2214
|
-
* @param options - Optional component settings (withDivider (defaults to `false`)).
|
|
2307
|
+
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
2308
|
+
* @param options - Optional component settings (separator).
|
|
2215
2309
|
* @returns This builder instance for method chaining.
|
|
2216
2310
|
*/
|
|
2217
|
-
|
|
2218
|
-
|
|
2311
|
+
addFlowing(elements: UiElement[], options?: {
|
|
2312
|
+
separator?: Separator;
|
|
2219
2313
|
}): this;
|
|
2220
2314
|
/**
|
|
2221
|
-
* Appends a `
|
|
2315
|
+
* Appends a `LabelValueElement` component.
|
|
2222
2316
|
*
|
|
2223
2317
|
* @remarks
|
|
2224
2318
|
* Standard label and value row.
|
|
@@ -2240,11 +2334,10 @@ export declare class UiContainerBuilder {
|
|
|
2240
2334
|
* Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
|
|
2241
2335
|
*
|
|
2242
2336
|
* @param rows - Tabular data rows
|
|
2243
|
-
* @param options - Optional component settings (
|
|
2337
|
+
* @param options - Optional component settings (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
|
|
2244
2338
|
* @returns This builder instance for method chaining.
|
|
2245
2339
|
*/
|
|
2246
2340
|
addTable(rows: TableRow[], options?: {
|
|
2247
|
-
hasHeader?: boolean;
|
|
2248
2341
|
isStriped?: boolean;
|
|
2249
2342
|
withColumnSeparators?: boolean;
|
|
2250
2343
|
withRowSeparators?: boolean;
|
|
@@ -2415,31 +2508,34 @@ export declare class UiCardBuilder {
|
|
|
2415
2508
|
*/
|
|
2416
2509
|
addElements(...items: UiElement[]): this;
|
|
2417
2510
|
/**
|
|
2418
|
-
* Appends a `
|
|
2511
|
+
* Appends a `StringElement` component.
|
|
2419
2512
|
*
|
|
2420
2513
|
* @remarks
|
|
2421
|
-
*
|
|
2422
|
-
* Supports plain text
|
|
2514
|
+
* Universal textual string primitive element.
|
|
2515
|
+
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
2423
2516
|
*
|
|
2424
2517
|
* @param value - Text value
|
|
2425
2518
|
* @param options - Optional component settings (representation (defaults to `plain`), modifiers).
|
|
2426
2519
|
* @returns This builder instance for method chaining.
|
|
2427
2520
|
*/
|
|
2428
|
-
|
|
2429
|
-
representation?:
|
|
2521
|
+
addString(value: string, options?: {
|
|
2522
|
+
representation?: StringRepresentation;
|
|
2430
2523
|
modifiers?: PrimitiveModifiers;
|
|
2431
2524
|
}): this;
|
|
2432
2525
|
/**
|
|
2433
|
-
* Appends a `
|
|
2526
|
+
* Appends a `StringsElement` component.
|
|
2434
2527
|
*
|
|
2435
2528
|
* @remarks
|
|
2436
|
-
*
|
|
2529
|
+
* Collection of textual string values rendered as a sequence of inline items or chips.
|
|
2530
|
+
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
2437
2531
|
*
|
|
2438
|
-
* @param
|
|
2439
|
-
* @param options - Optional component settings (modifiers).
|
|
2532
|
+
* @param values - Array of string values
|
|
2533
|
+
* @param options - Optional component settings (representation (defaults to `plain`), separator, modifiers).
|
|
2440
2534
|
* @returns This builder instance for method chaining.
|
|
2441
2535
|
*/
|
|
2442
|
-
|
|
2536
|
+
addStrings(values: string[], options?: {
|
|
2537
|
+
representation?: StringRepresentation;
|
|
2538
|
+
separator?: Separator;
|
|
2443
2539
|
modifiers?: PrimitiveModifiers;
|
|
2444
2540
|
}): this;
|
|
2445
2541
|
/**
|
|
@@ -2515,37 +2611,59 @@ export declare class UiCardBuilder {
|
|
|
2515
2611
|
* @remarks
|
|
2516
2612
|
* Aspect ratio representation (e.g. "16:9", "4:3", "1:1").
|
|
2517
2613
|
*
|
|
2518
|
-
* @param value - Aspect ratio
|
|
2614
|
+
* @param value - Aspect ratio numerical expression
|
|
2519
2615
|
* @param options - Optional component settings (modifiers).
|
|
2520
2616
|
* @returns This builder instance for method chaining.
|
|
2521
2617
|
*/
|
|
2522
|
-
addRatio(value:
|
|
2618
|
+
addRatio(value: number, options?: {
|
|
2523
2619
|
modifiers?: PrimitiveModifiers;
|
|
2524
2620
|
}): this;
|
|
2621
|
+
/**
|
|
2622
|
+
* Appends a `DimensionsElement` component.
|
|
2623
|
+
*
|
|
2624
|
+
* @remarks
|
|
2625
|
+
* Image dimensions representation displaying formatted width and height in pixels.
|
|
2626
|
+
*
|
|
2627
|
+
* @param width - Width in pixels
|
|
2628
|
+
* @param height - Height in pixels
|
|
2629
|
+
* @param options - Optional component settings (modifiers).
|
|
2630
|
+
* @returns This builder instance for method chaining.
|
|
2631
|
+
*/
|
|
2632
|
+
addDimensions(width: number, height: number, options?: {
|
|
2633
|
+
modifiers?: BaseModifiers;
|
|
2634
|
+
}): this;
|
|
2525
2635
|
/**
|
|
2526
2636
|
* Appends a `ColourElement` component.
|
|
2527
2637
|
*
|
|
2528
2638
|
* @remarks
|
|
2529
|
-
* Single color
|
|
2639
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
2530
2640
|
*
|
|
2531
2641
|
* @param value - Hexadecimal color code
|
|
2532
|
-
* @param options - Optional component settings (modifiers).
|
|
2642
|
+
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
2533
2643
|
* @returns This builder instance for method chaining.
|
|
2534
2644
|
*/
|
|
2535
2645
|
addColour(value: string, options?: {
|
|
2646
|
+
label?: string;
|
|
2647
|
+
showText?: boolean;
|
|
2648
|
+
shape?: Shape;
|
|
2649
|
+
size?: Size;
|
|
2536
2650
|
modifiers?: PrimitiveModifiers;
|
|
2537
2651
|
}): this;
|
|
2538
2652
|
/**
|
|
2539
2653
|
* Appends a `ColourElement` component.
|
|
2540
2654
|
*
|
|
2541
2655
|
* @remarks
|
|
2542
|
-
* Single color
|
|
2656
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
2543
2657
|
*
|
|
2544
2658
|
* @param value - Hexadecimal color code
|
|
2545
|
-
* @param options - Optional component settings (modifiers).
|
|
2659
|
+
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
2546
2660
|
* @returns This builder instance for method chaining.
|
|
2547
2661
|
*/
|
|
2548
|
-
|
|
2662
|
+
addColor(value: string, options?: {
|
|
2663
|
+
label?: string;
|
|
2664
|
+
showText?: boolean;
|
|
2665
|
+
shape?: Shape;
|
|
2666
|
+
size?: Size;
|
|
2549
2667
|
modifiers?: PrimitiveModifiers;
|
|
2550
2668
|
}): this;
|
|
2551
2669
|
/**
|
|
@@ -2625,29 +2743,18 @@ export declare class UiCardBuilder {
|
|
|
2625
2743
|
modifiers?: PrimitiveModifiers;
|
|
2626
2744
|
}): this;
|
|
2627
2745
|
/**
|
|
2628
|
-
* Appends a `
|
|
2629
|
-
*
|
|
2630
|
-
* @remarks
|
|
2631
|
-
* Plain boolean value representation (textual "true" / "false").
|
|
2632
|
-
*
|
|
2633
|
-
* @param value - Boolean state value
|
|
2634
|
-
* @param options - Optional component settings (modifiers).
|
|
2635
|
-
* @returns This builder instance for method chaining.
|
|
2636
|
-
*/
|
|
2637
|
-
addBooleanPlain(value: boolean, options?: {
|
|
2638
|
-
modifiers?: PrimitiveModifiers;
|
|
2639
|
-
}): this;
|
|
2640
|
-
/**
|
|
2641
|
-
* Appends a `BooleanBadgeElement` component.
|
|
2746
|
+
* Appends a `BooleanElement` component.
|
|
2642
2747
|
*
|
|
2643
2748
|
* @remarks
|
|
2644
|
-
*
|
|
2749
|
+
* Universal boolean primitive element.
|
|
2750
|
+
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
2645
2751
|
*
|
|
2646
2752
|
* @param value - Boolean state value
|
|
2647
|
-
* @param options - Optional component settings (trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
2753
|
+
* @param options - Optional component settings (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
2648
2754
|
* @returns This builder instance for method chaining.
|
|
2649
2755
|
*/
|
|
2650
|
-
|
|
2756
|
+
addBoolean(value: boolean, options?: {
|
|
2757
|
+
representation?: BooleanRepresentation;
|
|
2651
2758
|
trueLabel?: string;
|
|
2652
2759
|
falseLabel?: string;
|
|
2653
2760
|
variant?: BadgeVariant;
|
|
@@ -2659,11 +2766,11 @@ export declare class UiCardBuilder {
|
|
|
2659
2766
|
* @remarks
|
|
2660
2767
|
* Formatted date and time representation.
|
|
2661
2768
|
*
|
|
2662
|
-
* @param value -
|
|
2663
|
-
* @param options - Optional component settings (format (defaults to `
|
|
2769
|
+
* @param value - The timestamp in milliseconds
|
|
2770
|
+
* @param options - Optional component settings (format (defaults to `datetime`), modifiers).
|
|
2664
2771
|
* @returns This builder instance for method chaining.
|
|
2665
2772
|
*/
|
|
2666
|
-
addTimestamp(value:
|
|
2773
|
+
addTimestamp(value: number, options?: {
|
|
2667
2774
|
format?: TimestampFormat;
|
|
2668
2775
|
modifiers?: PrimitiveModifiers;
|
|
2669
2776
|
}): this;
|
|
@@ -2697,26 +2804,6 @@ export declare class UiCardBuilder {
|
|
|
2697
2804
|
aspectRatio?: string;
|
|
2698
2805
|
placeholder?: string;
|
|
2699
2806
|
}): this;
|
|
2700
|
-
/**
|
|
2701
|
-
* Appends a `DominantColourSetElement` component.
|
|
2702
|
-
*
|
|
2703
|
-
* @remarks
|
|
2704
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
2705
|
-
*
|
|
2706
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
2707
|
-
* @returns This builder instance for method chaining.
|
|
2708
|
-
*/
|
|
2709
|
-
addDominantColourSet(colors: string[]): this;
|
|
2710
|
-
/**
|
|
2711
|
-
* Appends a `DominantColourSetElement` component.
|
|
2712
|
-
*
|
|
2713
|
-
* @remarks
|
|
2714
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
2715
|
-
*
|
|
2716
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
2717
|
-
* @returns This builder instance for method chaining.
|
|
2718
|
-
*/
|
|
2719
|
-
addDominantColors(colors: string[]): this;
|
|
2720
2807
|
/**
|
|
2721
2808
|
* Appends a `MarkdownBlockElement` component.
|
|
2722
2809
|
*
|
|
@@ -2770,50 +2857,31 @@ export declare class UiCardBuilder {
|
|
|
2770
2857
|
modifiers?: BaseModifiers;
|
|
2771
2858
|
}): this;
|
|
2772
2859
|
/**
|
|
2773
|
-
* Appends a `
|
|
2860
|
+
* Appends a `MultiSlotElement` component.
|
|
2774
2861
|
*
|
|
2775
2862
|
* @remarks
|
|
2776
|
-
* Multi-slot horizontal row
|
|
2777
|
-
* Examples: "1/3 + 2/3", "equal thirds", "1/4 + 3/4".
|
|
2863
|
+
* Multi-slot horizontal row layout comprising slots with individual widths.
|
|
2778
2864
|
*
|
|
2779
2865
|
* @param slots - List of slots comprising the row
|
|
2780
|
-
* @param options - Optional component settings (proportions).
|
|
2781
2866
|
* @returns This builder instance for method chaining.
|
|
2782
2867
|
*/
|
|
2783
|
-
|
|
2784
|
-
proportions?: string;
|
|
2785
|
-
}): this;
|
|
2868
|
+
addMultiSlot(slots: Slot[]): this;
|
|
2786
2869
|
/**
|
|
2787
|
-
* Appends a `
|
|
2870
|
+
* Appends a `FlowingElement` component.
|
|
2788
2871
|
*
|
|
2789
2872
|
* @remarks
|
|
2790
|
-
*
|
|
2791
|
-
*
|
|
2873
|
+
* Flowing inline layout container with automatic line wrapping.
|
|
2874
|
+
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
2792
2875
|
*
|
|
2793
|
-
* @param
|
|
2794
|
-
* @param options - Optional component settings (
|
|
2876
|
+
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
2877
|
+
* @param options - Optional component settings (separator).
|
|
2795
2878
|
* @returns This builder instance for method chaining.
|
|
2796
2879
|
*/
|
|
2797
|
-
|
|
2798
|
-
|
|
2880
|
+
addFlowing(elements: UiElement[], options?: {
|
|
2881
|
+
separator?: Separator;
|
|
2799
2882
|
}): this;
|
|
2800
2883
|
/**
|
|
2801
|
-
* Appends a `
|
|
2802
|
-
*
|
|
2803
|
-
* @remarks
|
|
2804
|
-
* Standard label and value row.
|
|
2805
|
-
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
2806
|
-
*
|
|
2807
|
-
* @param label - Key or descriptive label displayed muted on the left
|
|
2808
|
-
* @param value - Rendered value element on the right
|
|
2809
|
-
* @param options - Optional component settings (withDivider (defaults to `false`)).
|
|
2810
|
-
* @returns This builder instance for method chaining.
|
|
2811
|
-
*/
|
|
2812
|
-
addLabelValueRow(label: string, value: UiElement, options?: {
|
|
2813
|
-
withDivider?: boolean;
|
|
2814
|
-
}): this;
|
|
2815
|
-
/**
|
|
2816
|
-
* Appends a `LabelValueRowElement` component.
|
|
2884
|
+
* Appends a `LabelValueElement` component.
|
|
2817
2885
|
*
|
|
2818
2886
|
* @remarks
|
|
2819
2887
|
* Standard label and value row.
|
|
@@ -2835,11 +2903,10 @@ export declare class UiCardBuilder {
|
|
|
2835
2903
|
* Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
|
|
2836
2904
|
*
|
|
2837
2905
|
* @param rows - Tabular data rows
|
|
2838
|
-
* @param options - Optional component settings (
|
|
2906
|
+
* @param options - Optional component settings (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
|
|
2839
2907
|
* @returns This builder instance for method chaining.
|
|
2840
2908
|
*/
|
|
2841
2909
|
addTable(rows: TableRow[], options?: {
|
|
2842
|
-
hasHeader?: boolean;
|
|
2843
2910
|
isStriped?: boolean;
|
|
2844
2911
|
withColumnSeparators?: boolean;
|
|
2845
2912
|
withRowSeparators?: boolean;
|
|
@@ -3007,33 +3074,36 @@ export declare function primitiveModifiers(options?: {
|
|
|
3007
3074
|
copyable?: boolean;
|
|
3008
3075
|
}): PrimitiveModifiers;
|
|
3009
3076
|
/**
|
|
3010
|
-
* Creates a `
|
|
3077
|
+
* Creates a `StringElement` component instance.
|
|
3011
3078
|
*
|
|
3012
3079
|
* @remarks
|
|
3013
|
-
*
|
|
3014
|
-
* Supports plain text
|
|
3080
|
+
* Universal textual string primitive element.
|
|
3081
|
+
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
3015
3082
|
*
|
|
3016
3083
|
* @param value - Text value
|
|
3017
3084
|
* @param options - Optional settings (representation (defaults to `plain`), modifiers).
|
|
3018
|
-
* @returns A strongly-typed `
|
|
3085
|
+
* @returns A strongly-typed `StringElement` object.
|
|
3019
3086
|
*/
|
|
3020
|
-
export declare function
|
|
3021
|
-
representation?:
|
|
3087
|
+
export declare function string(value: string, options?: {
|
|
3088
|
+
representation?: StringRepresentation;
|
|
3022
3089
|
modifiers?: PrimitiveModifiers;
|
|
3023
|
-
}):
|
|
3090
|
+
}): StringElement;
|
|
3024
3091
|
/**
|
|
3025
|
-
* Creates a `
|
|
3092
|
+
* Creates a `StringsElement` component instance.
|
|
3026
3093
|
*
|
|
3027
3094
|
* @remarks
|
|
3028
|
-
*
|
|
3095
|
+
* Collection of textual string values rendered as a sequence of inline items or chips.
|
|
3096
|
+
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
3029
3097
|
*
|
|
3030
|
-
* @param
|
|
3031
|
-
* @param options - Optional settings (modifiers).
|
|
3032
|
-
* @returns A strongly-typed `
|
|
3098
|
+
* @param values - Array of string values
|
|
3099
|
+
* @param options - Optional settings (representation (defaults to `plain`), separator, modifiers).
|
|
3100
|
+
* @returns A strongly-typed `StringsElement` object.
|
|
3033
3101
|
*/
|
|
3034
|
-
export declare function
|
|
3102
|
+
export declare function strings(values: string[], options?: {
|
|
3103
|
+
representation?: StringRepresentation;
|
|
3104
|
+
separator?: Separator;
|
|
3035
3105
|
modifiers?: PrimitiveModifiers;
|
|
3036
|
-
}):
|
|
3106
|
+
}): StringsElement;
|
|
3037
3107
|
/**
|
|
3038
3108
|
* Creates a `StringCodeElement` component instance.
|
|
3039
3109
|
*
|
|
@@ -3107,37 +3177,59 @@ export declare function identifier(value: string, options?: {
|
|
|
3107
3177
|
* @remarks
|
|
3108
3178
|
* Aspect ratio representation (e.g. "16:9", "4:3", "1:1").
|
|
3109
3179
|
*
|
|
3110
|
-
* @param value - Aspect ratio
|
|
3180
|
+
* @param value - Aspect ratio numerical expression
|
|
3111
3181
|
* @param options - Optional settings (modifiers).
|
|
3112
3182
|
* @returns A strongly-typed `RatioElement` object.
|
|
3113
3183
|
*/
|
|
3114
|
-
export declare function ratio(value:
|
|
3184
|
+
export declare function ratio(value: number, options?: {
|
|
3115
3185
|
modifiers?: PrimitiveModifiers;
|
|
3116
3186
|
}): RatioElement;
|
|
3187
|
+
/**
|
|
3188
|
+
* Creates a `DimensionsElement` component instance.
|
|
3189
|
+
*
|
|
3190
|
+
* @remarks
|
|
3191
|
+
* Image dimensions representation displaying formatted width and height in pixels.
|
|
3192
|
+
*
|
|
3193
|
+
* @param width - Width in pixels
|
|
3194
|
+
* @param height - Height in pixels
|
|
3195
|
+
* @param options - Optional settings (modifiers).
|
|
3196
|
+
* @returns A strongly-typed `DimensionsElement` object.
|
|
3197
|
+
*/
|
|
3198
|
+
export declare function dimensions(width: number, height: number, options?: {
|
|
3199
|
+
modifiers?: BaseModifiers;
|
|
3200
|
+
}): DimensionsElement;
|
|
3117
3201
|
/**
|
|
3118
3202
|
* Creates a `ColourElement` component instance.
|
|
3119
3203
|
*
|
|
3120
3204
|
* @remarks
|
|
3121
|
-
* Single color
|
|
3205
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
3122
3206
|
*
|
|
3123
3207
|
* @param value - Hexadecimal color code
|
|
3124
|
-
* @param options - Optional settings (modifiers).
|
|
3208
|
+
* @param options - Optional settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
3125
3209
|
* @returns A strongly-typed `ColourElement` object.
|
|
3126
3210
|
*/
|
|
3127
3211
|
export declare function colour(value: string, options?: {
|
|
3212
|
+
label?: string;
|
|
3213
|
+
showText?: boolean;
|
|
3214
|
+
shape?: Shape;
|
|
3215
|
+
size?: Size;
|
|
3128
3216
|
modifiers?: PrimitiveModifiers;
|
|
3129
3217
|
}): ColourElement;
|
|
3130
3218
|
/**
|
|
3131
3219
|
* Creates a `ColourElement` component instance.
|
|
3132
3220
|
*
|
|
3133
3221
|
* @remarks
|
|
3134
|
-
* Single color
|
|
3222
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
3135
3223
|
*
|
|
3136
3224
|
* @param value - Hexadecimal color code
|
|
3137
|
-
* @param options - Optional settings (modifiers).
|
|
3225
|
+
* @param options - Optional settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
3138
3226
|
* @returns A strongly-typed `ColourElement` object.
|
|
3139
3227
|
*/
|
|
3140
|
-
export declare function
|
|
3228
|
+
export declare function color(value: string, options?: {
|
|
3229
|
+
label?: string;
|
|
3230
|
+
showText?: boolean;
|
|
3231
|
+
shape?: Shape;
|
|
3232
|
+
size?: Size;
|
|
3141
3233
|
modifiers?: PrimitiveModifiers;
|
|
3142
3234
|
}): ColourElement;
|
|
3143
3235
|
/**
|
|
@@ -3217,45 +3309,34 @@ export declare function numberMeter(value: number, options?: {
|
|
|
3217
3309
|
modifiers?: PrimitiveModifiers;
|
|
3218
3310
|
}): NumberBoundedMeterElement;
|
|
3219
3311
|
/**
|
|
3220
|
-
* Creates a `
|
|
3312
|
+
* Creates a `BooleanElement` component instance.
|
|
3221
3313
|
*
|
|
3222
3314
|
* @remarks
|
|
3223
|
-
*
|
|
3315
|
+
* Universal boolean primitive element.
|
|
3316
|
+
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
3224
3317
|
*
|
|
3225
3318
|
* @param value - Boolean state value
|
|
3226
|
-
* @param options - Optional settings (modifiers).
|
|
3227
|
-
* @returns A strongly-typed `
|
|
3228
|
-
*/
|
|
3229
|
-
export declare function booleanPlain(value: boolean, options?: {
|
|
3230
|
-
modifiers?: PrimitiveModifiers;
|
|
3231
|
-
}): BooleanPlainElement;
|
|
3232
|
-
/**
|
|
3233
|
-
* Creates a `BooleanBadgeElement` component instance.
|
|
3234
|
-
*
|
|
3235
|
-
* @remarks
|
|
3236
|
-
* Visual badge pill representation of a boolean state.
|
|
3237
|
-
*
|
|
3238
|
-
* @param value - Boolean state value
|
|
3239
|
-
* @param options - Optional settings (trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
3240
|
-
* @returns A strongly-typed `BooleanBadgeElement` object.
|
|
3319
|
+
* @param options - Optional settings (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
3320
|
+
* @returns A strongly-typed `BooleanElement` object.
|
|
3241
3321
|
*/
|
|
3242
|
-
export declare function
|
|
3322
|
+
export declare function boolean(value: boolean, options?: {
|
|
3323
|
+
representation?: BooleanRepresentation;
|
|
3243
3324
|
trueLabel?: string;
|
|
3244
3325
|
falseLabel?: string;
|
|
3245
3326
|
variant?: BadgeVariant;
|
|
3246
3327
|
modifiers?: PrimitiveModifiers;
|
|
3247
|
-
}):
|
|
3328
|
+
}): BooleanElement;
|
|
3248
3329
|
/**
|
|
3249
3330
|
* Creates a `TimestampElement` component instance.
|
|
3250
3331
|
*
|
|
3251
3332
|
* @remarks
|
|
3252
3333
|
* Formatted date and time representation.
|
|
3253
3334
|
*
|
|
3254
|
-
* @param value -
|
|
3255
|
-
* @param options - Optional settings (format (defaults to `
|
|
3335
|
+
* @param value - The timestamp in milliseconds
|
|
3336
|
+
* @param options - Optional settings (format (defaults to `datetime`), modifiers).
|
|
3256
3337
|
* @returns A strongly-typed `TimestampElement` object.
|
|
3257
3338
|
*/
|
|
3258
|
-
export declare function timestamp(value:
|
|
3339
|
+
export declare function timestamp(value: number, options?: {
|
|
3259
3340
|
format?: TimestampFormat;
|
|
3260
3341
|
modifiers?: PrimitiveModifiers;
|
|
3261
3342
|
}): TimestampElement;
|
|
@@ -3289,26 +3370,6 @@ export declare function imageRef(src: string, options?: {
|
|
|
3289
3370
|
aspectRatio?: string;
|
|
3290
3371
|
placeholder?: string;
|
|
3291
3372
|
}): ImageReferenceElement;
|
|
3292
|
-
/**
|
|
3293
|
-
* Creates a `DominantColourSetElement` component instance.
|
|
3294
|
-
*
|
|
3295
|
-
* @remarks
|
|
3296
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
3297
|
-
*
|
|
3298
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
3299
|
-
* @returns A strongly-typed `DominantColourSetElement` object.
|
|
3300
|
-
*/
|
|
3301
|
-
export declare function dominantColourSet(colors: string[]): DominantColourSetElement;
|
|
3302
|
-
/**
|
|
3303
|
-
* Creates a `DominantColourSetElement` component instance.
|
|
3304
|
-
*
|
|
3305
|
-
* @remarks
|
|
3306
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
3307
|
-
*
|
|
3308
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
3309
|
-
* @returns A strongly-typed `DominantColourSetElement` object.
|
|
3310
|
-
*/
|
|
3311
|
-
export declare function dominantColors(colors: string[]): DominantColourSetElement;
|
|
3312
3373
|
/**
|
|
3313
3374
|
* Creates a `ButtonActionElement` component instance.
|
|
3314
3375
|
*
|
|
@@ -3402,53 +3463,34 @@ export declare function html(content: string, options?: {
|
|
|
3402
3463
|
*/
|
|
3403
3464
|
export declare function slot(content: UiElement, options?: {
|
|
3404
3465
|
label?: string;
|
|
3405
|
-
width?:
|
|
3466
|
+
width?: number;
|
|
3406
3467
|
}): Slot;
|
|
3407
3468
|
/**
|
|
3408
|
-
* Creates a `
|
|
3409
|
-
*
|
|
3410
|
-
* @remarks
|
|
3411
|
-
* Multi-slot horizontal row with declared column width proportions.
|
|
3412
|
-
* Examples: "1/3 + 2/3", "equal thirds", "1/4 + 3/4".
|
|
3413
|
-
*
|
|
3414
|
-
* @param slots - List of slots comprising the row
|
|
3415
|
-
* @param options - Optional settings (proportions).
|
|
3416
|
-
* @returns A strongly-typed `MultiSlotRowElement` object.
|
|
3417
|
-
*/
|
|
3418
|
-
export declare function multiSlotRow(slots: Slot[], options?: {
|
|
3419
|
-
proportions?: string;
|
|
3420
|
-
}): MultiSlotRowElement;
|
|
3421
|
-
/**
|
|
3422
|
-
* Creates a `MultiSlotRowElement` component instance.
|
|
3469
|
+
* Creates a `MultiSlotElement` component instance.
|
|
3423
3470
|
*
|
|
3424
3471
|
* @remarks
|
|
3425
|
-
* Multi-slot horizontal row
|
|
3426
|
-
* Examples: "1/3 + 2/3", "equal thirds", "1/4 + 3/4".
|
|
3472
|
+
* Multi-slot horizontal row layout comprising slots with individual widths.
|
|
3427
3473
|
*
|
|
3428
3474
|
* @param slots - List of slots comprising the row
|
|
3429
|
-
* @
|
|
3430
|
-
* @returns A strongly-typed `MultiSlotRowElement` object.
|
|
3475
|
+
* @returns A strongly-typed `MultiSlotElement` object.
|
|
3431
3476
|
*/
|
|
3432
|
-
export declare function multiSlot(slots: Slot[]
|
|
3433
|
-
proportions?: string;
|
|
3434
|
-
}): MultiSlotRowElement;
|
|
3477
|
+
export declare function multiSlot(slots: Slot[]): MultiSlotElement;
|
|
3435
3478
|
/**
|
|
3436
|
-
* Creates a `
|
|
3479
|
+
* Creates a `FlowingElement` component instance.
|
|
3437
3480
|
*
|
|
3438
3481
|
* @remarks
|
|
3439
|
-
*
|
|
3440
|
-
*
|
|
3482
|
+
* Flowing inline layout container with automatic line wrapping.
|
|
3483
|
+
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
3441
3484
|
*
|
|
3442
|
-
* @param
|
|
3443
|
-
* @param
|
|
3444
|
-
* @
|
|
3445
|
-
* @returns A strongly-typed `LabelValueRowElement` object.
|
|
3485
|
+
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
3486
|
+
* @param options - Optional settings (separator).
|
|
3487
|
+
* @returns A strongly-typed `FlowingElement` object.
|
|
3446
3488
|
*/
|
|
3447
|
-
export declare function
|
|
3448
|
-
|
|
3449
|
-
}):
|
|
3489
|
+
export declare function flowing(elements: UiElement[], options?: {
|
|
3490
|
+
separator?: Separator;
|
|
3491
|
+
}): FlowingElement;
|
|
3450
3492
|
/**
|
|
3451
|
-
* Creates a `
|
|
3493
|
+
* Creates a `LabelValueElement` component instance.
|
|
3452
3494
|
*
|
|
3453
3495
|
* @remarks
|
|
3454
3496
|
* Standard label and value row.
|
|
@@ -3457,24 +3499,25 @@ export declare function labelValueRow(label: string, value: UiElement, options?:
|
|
|
3457
3499
|
* @param label - Key or descriptive label displayed muted on the left
|
|
3458
3500
|
* @param value - Rendered value element on the right
|
|
3459
3501
|
* @param options - Optional settings (withDivider (defaults to `false`)).
|
|
3460
|
-
* @returns A strongly-typed `
|
|
3502
|
+
* @returns A strongly-typed `LabelValueElement` object.
|
|
3461
3503
|
*/
|
|
3462
3504
|
export declare function labelValue(label: string, value: UiElement, options?: {
|
|
3463
3505
|
withDivider?: boolean;
|
|
3464
|
-
}):
|
|
3506
|
+
}): LabelValueElement;
|
|
3465
3507
|
/**
|
|
3466
3508
|
* Creates a `TableColumn` component instance.
|
|
3467
3509
|
*
|
|
3468
3510
|
* @remarks
|
|
3469
3511
|
* Column definition for structured tables.
|
|
3470
3512
|
*
|
|
3471
|
-
* @param options - Optional settings (header, align (defaults to `left`), width).
|
|
3513
|
+
* @param options - Optional settings (header, align (defaults to `left`), width, widthMode (defaults to `fixed`)).
|
|
3472
3514
|
* @returns A strongly-typed `TableColumn` object.
|
|
3473
3515
|
*/
|
|
3474
3516
|
export declare function tableColumn(options?: {
|
|
3475
3517
|
header?: string;
|
|
3476
3518
|
align?: TableColumnAlign;
|
|
3477
|
-
width?:
|
|
3519
|
+
width?: number;
|
|
3520
|
+
widthMode?: TableColumnWidthMode;
|
|
3478
3521
|
}): TableColumn;
|
|
3479
3522
|
/**
|
|
3480
3523
|
* Creates a `TableRow` component instance.
|
|
@@ -3494,11 +3537,10 @@ export declare function tableRow(cells: UiElement[]): TableRow;
|
|
|
3494
3537
|
* Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
|
|
3495
3538
|
*
|
|
3496
3539
|
* @param rows - Tabular data rows
|
|
3497
|
-
* @param options - Optional settings (
|
|
3540
|
+
* @param options - Optional settings (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
|
|
3498
3541
|
* @returns A strongly-typed `TableElement` object.
|
|
3499
3542
|
*/
|
|
3500
3543
|
export declare function table(rows: TableRow[], options?: {
|
|
3501
|
-
hasHeader?: boolean;
|
|
3502
3544
|
isStriped?: boolean;
|
|
3503
3545
|
withColumnSeparators?: boolean;
|
|
3504
3546
|
withRowSeparators?: boolean;
|
|
@@ -3643,21 +3685,21 @@ export declare function isEnvelop(value: unknown, withDeepValidation?: boolean):
|
|
|
3643
3685
|
*/
|
|
3644
3686
|
export declare function isUiElement(value: unknown, withDeepValidation?: boolean): value is UiElement;
|
|
3645
3687
|
/**
|
|
3646
|
-
* Type guard predicate narrowing a value to `
|
|
3688
|
+
* Type guard predicate narrowing a value to `StringElement`.
|
|
3647
3689
|
*
|
|
3648
3690
|
* @param value - The value to inspect.
|
|
3649
3691
|
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3650
|
-
* @returns `true` if the value is a `
|
|
3692
|
+
* @returns `true` if the value is a `StringElement` (type = "string"), otherwise `false`.
|
|
3651
3693
|
*/
|
|
3652
|
-
export declare function
|
|
3694
|
+
export declare function isStringElement(value: unknown, withDeepValidation?: boolean): value is StringElement;
|
|
3653
3695
|
/**
|
|
3654
|
-
* Type guard predicate narrowing a value to `
|
|
3696
|
+
* Type guard predicate narrowing a value to `StringsElement`.
|
|
3655
3697
|
*
|
|
3656
3698
|
* @param value - The value to inspect.
|
|
3657
3699
|
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3658
|
-
* @returns `true` if the value is a `
|
|
3700
|
+
* @returns `true` if the value is a `StringsElement` (type = "strings"), otherwise `false`.
|
|
3659
3701
|
*/
|
|
3660
|
-
export declare function
|
|
3702
|
+
export declare function isStringsElement(value: unknown, withDeepValidation?: boolean): value is StringsElement;
|
|
3661
3703
|
/**
|
|
3662
3704
|
* Type guard predicate narrowing a value to `StringCodeElement`.
|
|
3663
3705
|
*
|
|
@@ -3706,12 +3748,20 @@ export declare function isIdentifierElement(value: unknown, withDeepValidation?:
|
|
|
3706
3748
|
* @returns `true` if the value is a `RatioElement` (type = "ratio"), otherwise `false`.
|
|
3707
3749
|
*/
|
|
3708
3750
|
export declare function isRatioElement(value: unknown, withDeepValidation?: boolean): value is RatioElement;
|
|
3751
|
+
/**
|
|
3752
|
+
* Type guard predicate narrowing a value to `DimensionsElement`.
|
|
3753
|
+
*
|
|
3754
|
+
* @param value - The value to inspect.
|
|
3755
|
+
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3756
|
+
* @returns `true` if the value is a `DimensionsElement` (type = "dimensions"), otherwise `false`.
|
|
3757
|
+
*/
|
|
3758
|
+
export declare function isDimensionsElement(value: unknown, withDeepValidation?: boolean): value is DimensionsElement;
|
|
3709
3759
|
/**
|
|
3710
3760
|
* Type guard predicate narrowing a value to `ColourElement`.
|
|
3711
3761
|
*
|
|
3712
3762
|
* @param value - The value to inspect.
|
|
3713
3763
|
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3714
|
-
* @returns `true` if the value is a `ColourElement` (type = "color
|
|
3764
|
+
* @returns `true` if the value is a `ColourElement` (type = "color"), otherwise `false`.
|
|
3715
3765
|
*/
|
|
3716
3766
|
export declare function isColourElement(value: unknown, withDeepValidation?: boolean): value is ColourElement;
|
|
3717
3767
|
/**
|
|
@@ -3739,21 +3789,13 @@ export declare function isNumberBoundedStarsElement(value: unknown, withDeepVali
|
|
|
3739
3789
|
*/
|
|
3740
3790
|
export declare function isNumberBoundedMeterElement(value: unknown, withDeepValidation?: boolean): value is NumberBoundedMeterElement;
|
|
3741
3791
|
/**
|
|
3742
|
-
* Type guard predicate narrowing a value to `
|
|
3743
|
-
*
|
|
3744
|
-
* @param value - The value to inspect.
|
|
3745
|
-
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3746
|
-
* @returns `true` if the value is a `BooleanPlainElement` (type = "boolean-plain"), otherwise `false`.
|
|
3747
|
-
*/
|
|
3748
|
-
export declare function isBooleanPlainElement(value: unknown, withDeepValidation?: boolean): value is BooleanPlainElement;
|
|
3749
|
-
/**
|
|
3750
|
-
* Type guard predicate narrowing a value to `BooleanBadgeElement`.
|
|
3792
|
+
* Type guard predicate narrowing a value to `BooleanElement`.
|
|
3751
3793
|
*
|
|
3752
3794
|
* @param value - The value to inspect.
|
|
3753
3795
|
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3754
|
-
* @returns `true` if the value is a `
|
|
3796
|
+
* @returns `true` if the value is a `BooleanElement` (type = "boolean"), otherwise `false`.
|
|
3755
3797
|
*/
|
|
3756
|
-
export declare function
|
|
3798
|
+
export declare function isBooleanElement(value: unknown, withDeepValidation?: boolean): value is BooleanElement;
|
|
3757
3799
|
/**
|
|
3758
3800
|
* Type guard predicate narrowing a value to `TimestampElement`.
|
|
3759
3801
|
*
|
|
@@ -3770,14 +3812,6 @@ export declare function isTimestampElement(value: unknown, withDeepValidation?:
|
|
|
3770
3812
|
* @returns `true` if the value is a `ImageReferenceElement` (type = "image-ref"), otherwise `false`.
|
|
3771
3813
|
*/
|
|
3772
3814
|
export declare function isImageReferenceElement(value: unknown, withDeepValidation?: boolean): value is ImageReferenceElement;
|
|
3773
|
-
/**
|
|
3774
|
-
* Type guard predicate narrowing a value to `DominantColourSetElement`.
|
|
3775
|
-
*
|
|
3776
|
-
* @param value - The value to inspect.
|
|
3777
|
-
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3778
|
-
* @returns `true` if the value is a `DominantColourSetElement` (type = "color-set"), otherwise `false`.
|
|
3779
|
-
*/
|
|
3780
|
-
export declare function isDominantColourSetElement(value: unknown, withDeepValidation?: boolean): value is DominantColourSetElement;
|
|
3781
3815
|
/**
|
|
3782
3816
|
* Type guard predicate narrowing a value to `MarkdownBlockElement`.
|
|
3783
3817
|
*
|
|
@@ -3795,21 +3829,29 @@ export declare function isMarkdownBlockElement(value: unknown, withDeepValidatio
|
|
|
3795
3829
|
*/
|
|
3796
3830
|
export declare function isHtmlBlockElement(value: unknown, withDeepValidation?: boolean): value is HtmlBlockElement;
|
|
3797
3831
|
/**
|
|
3798
|
-
* Type guard predicate narrowing a value to `
|
|
3832
|
+
* Type guard predicate narrowing a value to `MultiSlotElement`.
|
|
3833
|
+
*
|
|
3834
|
+
* @param value - The value to inspect.
|
|
3835
|
+
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3836
|
+
* @returns `true` if the value is a `MultiSlotElement` (type = "multi-slot"), otherwise `false`.
|
|
3837
|
+
*/
|
|
3838
|
+
export declare function isMultiSlotElement(value: unknown, withDeepValidation?: boolean): value is MultiSlotElement;
|
|
3839
|
+
/**
|
|
3840
|
+
* Type guard predicate narrowing a value to `FlowingElement`.
|
|
3799
3841
|
*
|
|
3800
3842
|
* @param value - The value to inspect.
|
|
3801
3843
|
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3802
|
-
* @returns `true` if the value is a `
|
|
3844
|
+
* @returns `true` if the value is a `FlowingElement` (type = "flowing"), otherwise `false`.
|
|
3803
3845
|
*/
|
|
3804
|
-
export declare function
|
|
3846
|
+
export declare function isFlowingElement(value: unknown, withDeepValidation?: boolean): value is FlowingElement;
|
|
3805
3847
|
/**
|
|
3806
|
-
* Type guard predicate narrowing a value to `
|
|
3848
|
+
* Type guard predicate narrowing a value to `LabelValueElement`.
|
|
3807
3849
|
*
|
|
3808
3850
|
* @param value - The value to inspect.
|
|
3809
3851
|
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3810
|
-
* @returns `true` if the value is a `
|
|
3852
|
+
* @returns `true` if the value is a `LabelValueElement` (type = "label-value"), otherwise `false`.
|
|
3811
3853
|
*/
|
|
3812
|
-
export declare function
|
|
3854
|
+
export declare function isLabelValueElement(value: unknown, withDeepValidation?: boolean): value is LabelValueElement;
|
|
3813
3855
|
/**
|
|
3814
3856
|
* Type guard predicate narrowing a value to `TableElement`.
|
|
3815
3857
|
*
|