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