@picteus/extension-sdk 0.18.0 → 0.20.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 +1728 -378
- package/dist/generated/viewKit.js +1024 -300
- 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 +166 -2
- package/dist/picteus-ws-client/apis/ExtensionApi.js +199 -2
- package/dist/picteus-ws-client/apis/ImageApi.d.ts +25 -1
- package/dist/picteus-ws-client/apis/ImageApi.js +25 -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/AiModel.d.ts +44 -0
- package/dist/picteus-ws-client/models/AiModel.js +49 -0
- 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/CaptionInstruction.d.ts +50 -0
- package/dist/picteus-ws-client/models/CaptionInstruction.js +55 -0
- 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 +15 -1
- package/dist/picteus-ws-client/models/ConstantsRegistry.js +11 -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/EligibleTagsInstruction.d.ts +56 -0
- package/dist/picteus-ws-client/models/EligibleTagsInstruction.js +59 -0
- 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/ExtensionAiModel.d.ts +56 -0
- package/dist/picteus-ws-client/models/ExtensionAiModel.js +57 -0
- package/dist/picteus-ws-client/models/ExtensionAndManual.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionAndManual.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionCaption.d.ts +44 -0
- package/dist/picteus-ws-client/models/ExtensionCaption.js +51 -0
- 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/ExtensionEligibleTags.d.ts +44 -0
- package/dist/picteus-ws-client/models/ExtensionEligibleTags.js +51 -0
- 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 +2 -2
- 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/GenerationRecipeVersion.d.ts +24 -0
- package/dist/picteus-ws-client/models/GenerationRecipeVersion.js +42 -0
- 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/ManifestCapabilityCaptionsDetails.d.ts +32 -0
- package/dist/picteus-ws-client/models/ManifestCapabilityCaptionsDetails.js +41 -0
- package/dist/picteus-ws-client/models/ManifestCapabilityEligibleTagsDetails.d.ts +32 -0
- package/dist/picteus-ws-client/models/ManifestCapabilityEligibleTagsDetails.js +41 -0
- 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/ManifestImageFeaturesCapability.d.ts +40 -0
- package/dist/picteus-ws-client/models/ManifestImageFeaturesCapability.js +47 -0
- package/dist/picteus-ws-client/models/ManifestImageTagsCapability.d.ts +40 -0
- package/dist/picteus-ws-client/models/ManifestImageTagsCapability.js +47 -0
- package/dist/picteus-ws-client/models/ManifestInstructions.d.ts +4 -4
- package/dist/picteus-ws-client/models/ManifestInstructions.js +4 -4
- package/dist/picteus-ws-client/models/ManifestInstructionsCapabilitiesInner.d.ts +32 -0
- package/dist/picteus-ws-client/models/ManifestInstructionsCapabilitiesInner.js +56 -0
- 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/TagsPlaceholder.d.ts +24 -0
- package/dist/picteus-ws-client/models/TagsPlaceholder.js +42 -0
- package/dist/picteus-ws-client/models/TextualPrompt.d.ts +1 -1
- package/dist/picteus-ws-client/models/TextualPrompt.js +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceAnchor.d.ts +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceAnchor.js +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceSidebarIntegration.d.ts +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceSidebarIntegration.js +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceWindowIntegration.d.ts +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceWindowIntegration.js +1 -1
- package/dist/picteus-ws-client/models/index.d.ts +11 -0
- package/dist/picteus-ws-client/models/index.js +11 -0
- package/dist/picteus-ws-client/runtime.d.ts +1 -1
- package/dist/picteus-ws-client/runtime.js +1 -1
- package/dist/picteusExtension.d.ts +27 -5
- package/dist/picteusExtension.js +62 -27
- 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
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// ---------------------------------------------------------------------------
|
|
2
|
-
// Auto-generated by @picteus/specification-factory
|
|
2
|
+
// Auto-generated by @picteus/specification-factory. Do not edit directly.
|
|
3
3
|
// ---------------------------------------------------------------------------
|
|
4
4
|
/** Generic base class providing recursive JSON serialization for all model instances. */
|
|
5
5
|
export class ViewKitNode {
|
|
@@ -41,147 +41,170 @@ export class ViewKitNode {
|
|
|
41
41
|
/** Typographic stroke weight styling. */
|
|
42
42
|
export var TextWeight;
|
|
43
43
|
(function (TextWeight) {
|
|
44
|
-
|
|
44
|
+
/** Thin / light text weight */
|
|
45
45
|
TextWeight["thin"] = "thin";
|
|
46
|
-
|
|
46
|
+
/** Standard text weight */
|
|
47
47
|
TextWeight["normal"] = "normal";
|
|
48
|
-
|
|
48
|
+
/** Heavy / bold text weight */
|
|
49
49
|
TextWeight["heavy"] = "heavy";
|
|
50
50
|
})(TextWeight || (TextWeight = {}));
|
|
51
51
|
/** Visual text color intensity and contrast. */
|
|
52
52
|
export var TextIntensity;
|
|
53
53
|
(function (TextIntensity) {
|
|
54
|
-
|
|
54
|
+
/** Low visual contrast / subdued text color */
|
|
55
55
|
TextIntensity["low"] = "low";
|
|
56
|
-
|
|
56
|
+
/** Standard text color */
|
|
57
57
|
TextIntensity["medium"] = "medium";
|
|
58
|
-
|
|
58
|
+
/** High visual contrast / intense text color */
|
|
59
59
|
TextIntensity["high"] = "high";
|
|
60
60
|
})(TextIntensity || (TextIntensity = {}));
|
|
61
61
|
/** Geometric shape representation for visual containers and indicators. */
|
|
62
62
|
export var Shape;
|
|
63
63
|
(function (Shape) {
|
|
64
|
-
|
|
64
|
+
/** Circular container shape */
|
|
65
65
|
Shape["circle"] = "circle";
|
|
66
|
-
|
|
66
|
+
/** Square container shape */
|
|
67
67
|
Shape["square"] = "square";
|
|
68
68
|
})(Shape || (Shape = {}));
|
|
69
69
|
/** Relative sizing scale for visual elements and indicators. */
|
|
70
70
|
export var Size;
|
|
71
71
|
(function (Size) {
|
|
72
|
-
|
|
72
|
+
/** Compact small size */
|
|
73
73
|
Size["small"] = "small";
|
|
74
|
-
|
|
74
|
+
/** Standard medium size */
|
|
75
75
|
Size["medium"] = "medium";
|
|
76
|
-
|
|
76
|
+
/** Prominent large size */
|
|
77
77
|
Size["large"] = "large";
|
|
78
78
|
})(Size || (Size = {}));
|
|
79
|
+
/** Measurement unit for text truncation. */
|
|
80
|
+
export var TruncateMode;
|
|
81
|
+
(function (TruncateMode) {
|
|
82
|
+
/** Truncate by total character count */
|
|
83
|
+
TruncateMode["characters"] = "characters";
|
|
84
|
+
/** Truncate by number of rendered lines */
|
|
85
|
+
TruncateMode["lines"] = "lines";
|
|
86
|
+
})(TruncateMode || (TruncateMode = {}));
|
|
79
87
|
/** Visual presentation style for string values. */
|
|
80
88
|
export var StringRepresentation;
|
|
81
89
|
(function (StringRepresentation) {
|
|
82
|
-
|
|
90
|
+
/** Standard inline text rendering */
|
|
83
91
|
StringRepresentation["plain"] = "plain";
|
|
84
|
-
|
|
92
|
+
/** Visual chip / tag pill representation */
|
|
85
93
|
StringRepresentation["chip"] = "chip";
|
|
86
|
-
|
|
94
|
+
/** Multiline text with preserved whitespace and line breaks */
|
|
87
95
|
StringRepresentation["multiline"] = "multiline";
|
|
88
96
|
})(StringRepresentation || (StringRepresentation = {}));
|
|
89
97
|
/** Visual separator rendered between sequential elements or items. */
|
|
90
98
|
export var Separator;
|
|
91
99
|
(function (Separator) {
|
|
92
|
-
|
|
100
|
+
/** Vertical dividing bar */
|
|
93
101
|
Separator["bar"] = "bar";
|
|
94
|
-
|
|
102
|
+
/** Comma separator */
|
|
95
103
|
Separator["comma"] = "comma";
|
|
96
|
-
|
|
104
|
+
/** Bullet dot separator */
|
|
97
105
|
Separator["dot"] = "dot";
|
|
98
|
-
|
|
106
|
+
/** Forward slash separator */
|
|
99
107
|
Separator["slash"] = "slash";
|
|
100
|
-
|
|
108
|
+
/** Dash separator */
|
|
101
109
|
Separator["dash"] = "dash";
|
|
102
|
-
|
|
110
|
+
/** Space separator */
|
|
103
111
|
Separator["space"] = "space";
|
|
104
112
|
})(Separator || (Separator = {}));
|
|
105
113
|
/** Supported syntax highlighting languages for formatted code blocks. */
|
|
106
114
|
export var CodeLanguage;
|
|
107
115
|
(function (CodeLanguage) {
|
|
108
|
-
|
|
116
|
+
/** XML markup syntax */
|
|
109
117
|
CodeLanguage["xml"] = "xml";
|
|
110
|
-
|
|
118
|
+
/** JSON format syntax */
|
|
111
119
|
CodeLanguage["json"] = "json";
|
|
112
|
-
|
|
120
|
+
/** YAML format syntax */
|
|
113
121
|
CodeLanguage["yaml"] = "yaml";
|
|
114
122
|
})(CodeLanguage || (CodeLanguage = {}));
|
|
115
123
|
/** Visual presentation style for boolean values. */
|
|
116
124
|
export var BooleanRepresentation;
|
|
117
125
|
(function (BooleanRepresentation) {
|
|
118
|
-
|
|
126
|
+
/** Standard inline text rendering (e.g. "true" / "false" or custom labels) */
|
|
119
127
|
BooleanRepresentation["plain"] = "plain";
|
|
120
|
-
|
|
128
|
+
/** Visual badge pill representation */
|
|
121
129
|
BooleanRepresentation["badge"] = "badge";
|
|
122
130
|
})(BooleanRepresentation || (BooleanRepresentation = {}));
|
|
123
131
|
/** Visual color tone variants for badge pill representations. */
|
|
124
132
|
export var BadgeVariant;
|
|
125
133
|
(function (BadgeVariant) {
|
|
126
|
-
|
|
134
|
+
/** Neutral gray tone */
|
|
127
135
|
BadgeVariant["neutral"] = "neutral";
|
|
128
|
-
|
|
136
|
+
/** Success green tone */
|
|
129
137
|
BadgeVariant["success"] = "success";
|
|
130
|
-
|
|
138
|
+
/** Warning yellow/orange tone */
|
|
131
139
|
BadgeVariant["warning"] = "warning";
|
|
132
|
-
|
|
140
|
+
/** Danger red tone */
|
|
133
141
|
BadgeVariant["danger"] = "danger";
|
|
134
142
|
})(BadgeVariant || (BadgeVariant = {}));
|
|
135
143
|
/** Presentation format styles for timestamp elements. */
|
|
136
144
|
export var TimestampFormat;
|
|
137
145
|
(function (TimestampFormat) {
|
|
138
|
-
|
|
146
|
+
/** Complete date and time display */
|
|
139
147
|
TimestampFormat["datetime"] = "datetime";
|
|
140
|
-
|
|
148
|
+
/** Date-only display */
|
|
141
149
|
TimestampFormat["date"] = "date";
|
|
142
|
-
|
|
150
|
+
/** Time-only display */
|
|
143
151
|
TimestampFormat["time"] = "time";
|
|
144
|
-
|
|
152
|
+
/** Relative time expression (e.g. "5 minutes ago") */
|
|
145
153
|
TimestampFormat["relative"] = "relative";
|
|
146
154
|
})(TimestampFormat || (TimestampFormat = {}));
|
|
147
155
|
/** Visual style variants for interactive button actions. */
|
|
148
156
|
export var ButtonVariant;
|
|
149
157
|
(function (ButtonVariant) {
|
|
150
|
-
|
|
158
|
+
/** Primary emphasis button style for default/recommended actions */
|
|
151
159
|
ButtonVariant["primary"] = "primary";
|
|
152
|
-
|
|
160
|
+
/** Secondary standard button style */
|
|
153
161
|
ButtonVariant["secondary"] = "secondary";
|
|
154
|
-
|
|
162
|
+
/** Subtle low-contrast button style */
|
|
155
163
|
ButtonVariant["subtle"] = "subtle";
|
|
156
|
-
|
|
164
|
+
/** Destructive / dangerous action button style */
|
|
157
165
|
ButtonVariant["danger"] = "danger";
|
|
158
166
|
})(ButtonVariant || (ButtonVariant = {}));
|
|
159
|
-
/**
|
|
167
|
+
/**
|
|
168
|
+
* Text horizontal alignment options for table columns.
|
|
169
|
+
*
|
|
170
|
+
* @remarks
|
|
171
|
+
* Horizontal alignment applied within cells of a TableColumn. The alignment is a presentation choice and does not affect the stored cell values.
|
|
172
|
+
*/
|
|
160
173
|
export var TableColumnAlign;
|
|
161
174
|
(function (TableColumnAlign) {
|
|
162
|
-
|
|
175
|
+
/** Left-aligned text */
|
|
163
176
|
TableColumnAlign["left"] = "left";
|
|
164
|
-
|
|
177
|
+
/** Center-aligned text */
|
|
165
178
|
TableColumnAlign["center"] = "center";
|
|
166
|
-
|
|
179
|
+
/** Right-aligned text */
|
|
167
180
|
TableColumnAlign["right"] = "right";
|
|
168
181
|
})(TableColumnAlign || (TableColumnAlign = {}));
|
|
169
|
-
/**
|
|
182
|
+
/**
|
|
183
|
+
* Width mode for table columns.
|
|
184
|
+
*
|
|
185
|
+
* @remarks
|
|
186
|
+
* Controls how an optional TableColumn width is interpreted by the table renderer.
|
|
187
|
+
*/
|
|
170
188
|
export var TableColumnWidthMode;
|
|
171
189
|
(function (TableColumnWidthMode) {
|
|
172
|
-
|
|
190
|
+
/** Fixed width constraint */
|
|
173
191
|
TableColumnWidthMode["fixed"] = "fixed";
|
|
174
|
-
|
|
192
|
+
/** Maximum width upper bound constraint */
|
|
175
193
|
TableColumnWidthMode["maximum"] = "maximum";
|
|
176
194
|
})(TableColumnWidthMode || (TableColumnWidthMode = {}));
|
|
177
|
-
/**
|
|
195
|
+
/**
|
|
196
|
+
* Visual styling variants for hairline dividers.
|
|
197
|
+
*
|
|
198
|
+
* @remarks
|
|
199
|
+
* Selects the visual stroke treatment used by DividerElement.
|
|
200
|
+
*/
|
|
178
201
|
export var DividerStyle;
|
|
179
202
|
(function (DividerStyle) {
|
|
180
|
-
|
|
203
|
+
/** Subtle thin hairline border */
|
|
181
204
|
DividerStyle["hairline"] = "hairline";
|
|
182
|
-
|
|
205
|
+
/** Solid standard divider line */
|
|
183
206
|
DividerStyle["solid"] = "solid";
|
|
184
|
-
|
|
207
|
+
/** Dashed separator line */
|
|
185
208
|
DividerStyle["dashed"] = "dashed";
|
|
186
209
|
})(DividerStyle || (DividerStyle = {}));
|
|
187
210
|
/** Abstract base class for all `UiElement` models. */
|
|
@@ -195,26 +218,46 @@ export class BaseUiAction extends ViewKitNode {
|
|
|
195
218
|
* Class implementation of the `TruncateOptions` interface.
|
|
196
219
|
*
|
|
197
220
|
* @remarks
|
|
198
|
-
*
|
|
221
|
+
* Controls how a renderer abbreviates long text. When mode is characters, limit represents maximum character count; when mode is lines, limit represents visual line count.
|
|
199
222
|
*/
|
|
200
223
|
export class TruncateOptionsClass extends ViewKitNode {
|
|
201
|
-
/**
|
|
202
|
-
|
|
224
|
+
/**
|
|
225
|
+
* Maximum threshold limit before truncating
|
|
226
|
+
*
|
|
227
|
+
* @remarks
|
|
228
|
+
* Threshold after which the renderer can shorten the displayed text. When mode is characters, this represents character count; when mode is lines, this represents visual line count.
|
|
229
|
+
*/
|
|
230
|
+
limit;
|
|
231
|
+
/**
|
|
232
|
+
* Truncation measurement mode (characters or lines)
|
|
233
|
+
*
|
|
234
|
+
* @remarks
|
|
235
|
+
* Whether limit represents character count or line count. Defaults to lines.
|
|
236
|
+
*
|
|
237
|
+
* @defaultValue TruncateMode.lines
|
|
238
|
+
*/
|
|
239
|
+
mode;
|
|
203
240
|
/**
|
|
204
241
|
* Whether to render a "Show more" / "Show less" toggle affordance
|
|
205
242
|
*
|
|
243
|
+
* @remarks
|
|
244
|
+
* When true, permits an expand/collapse control for text beyond the truncation threshold. Defaults to true.
|
|
245
|
+
*
|
|
206
246
|
* @defaultValue true
|
|
207
247
|
*/
|
|
208
248
|
showMore;
|
|
209
249
|
/**
|
|
210
250
|
* Constructs a new `TruncateOptionsClass` instance.
|
|
211
251
|
*
|
|
212
|
-
* @param
|
|
213
|
-
|
|
252
|
+
* @param limit - Maximum threshold limit before truncating
|
|
253
|
+
|
|
254
|
+
Threshold after which the renderer can shorten the displayed text. When mode is characters, this represents character count; when mode is lines, this represents visual line count.
|
|
255
|
+
* @param options - Optional component settings. (mode (defaults to `lines`), showMore (defaults to `true`)).
|
|
214
256
|
*/
|
|
215
|
-
constructor(
|
|
257
|
+
constructor(limit, options) {
|
|
216
258
|
super();
|
|
217
|
-
this.
|
|
259
|
+
this.limit = limit;
|
|
260
|
+
this.mode = options?.mode ?? TruncateMode.lines;
|
|
218
261
|
this.showMore = options?.showMore ?? true;
|
|
219
262
|
}
|
|
220
263
|
}
|
|
@@ -222,10 +265,15 @@ export class TruncateOptionsClass extends ViewKitNode {
|
|
|
222
265
|
* Class implementation of the `BaseModifiers` interface.
|
|
223
266
|
*
|
|
224
267
|
* @remarks
|
|
225
|
-
*
|
|
268
|
+
* 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.
|
|
226
269
|
*/
|
|
227
270
|
export class BaseModifiersClass extends ViewKitNode {
|
|
228
|
-
/**
|
|
271
|
+
/**
|
|
272
|
+
* Adds an interactive copy button/action next to the rendered value
|
|
273
|
+
*
|
|
274
|
+
* @remarks
|
|
275
|
+
* When true, exposes a copy affordance for the associated value where supported by the renderer.
|
|
276
|
+
*/
|
|
229
277
|
copyable;
|
|
230
278
|
/**
|
|
231
279
|
* Constructs a new `BaseModifiersClass` instance.
|
|
@@ -241,30 +289,49 @@ export class BaseModifiersClass extends ViewKitNode {
|
|
|
241
289
|
* Class implementation of the `PrimitiveModifiers` interface.
|
|
242
290
|
*
|
|
243
291
|
* @remarks
|
|
244
|
-
*
|
|
292
|
+
* Extends BaseModifiers with text styling controls. Defaults provide normal weight, medium intensity, and proportional text unless a feature explicitly overrides them.
|
|
245
293
|
*/
|
|
246
294
|
export class PrimitiveModifiersClass extends ViewKitNode {
|
|
247
|
-
/**
|
|
295
|
+
/**
|
|
296
|
+
* Configures truncation threshold with show-more affordance
|
|
297
|
+
*
|
|
298
|
+
* @remarks
|
|
299
|
+
* Optional text abbreviation behavior. The source text remains unchanged, and the renderer may offer expansion according to showMore.
|
|
300
|
+
*/
|
|
248
301
|
truncate;
|
|
249
302
|
/**
|
|
250
303
|
* Typographic text weight
|
|
251
304
|
*
|
|
305
|
+
* @remarks
|
|
306
|
+
* Relative font weight for textual rendering; defaults to normal.
|
|
307
|
+
*
|
|
252
308
|
* @defaultValue TextWeight.normal
|
|
253
309
|
*/
|
|
254
310
|
weight;
|
|
255
311
|
/**
|
|
256
312
|
* Visual text color intensity
|
|
257
313
|
*
|
|
314
|
+
* @remarks
|
|
315
|
+
* Relative contrast treatment for the text; defaults to medium.
|
|
316
|
+
*
|
|
258
317
|
* @defaultValue TextIntensity.medium
|
|
259
318
|
*/
|
|
260
319
|
intensity;
|
|
261
320
|
/**
|
|
262
321
|
* Whether to use monospace font rendering (for hashes, IDs, codes)
|
|
263
322
|
*
|
|
323
|
+
* @remarks
|
|
324
|
+
* When true, requests a fixed-width font suitable for identifiers and code-like values. Defaults to false.
|
|
325
|
+
*
|
|
264
326
|
* @defaultValue false
|
|
265
327
|
*/
|
|
266
328
|
monospace;
|
|
267
|
-
/**
|
|
329
|
+
/**
|
|
330
|
+
* Adds an interactive copy button/action next to the rendered value
|
|
331
|
+
*
|
|
332
|
+
* @remarks
|
|
333
|
+
* When true, exposes a copy affordance for the associated value where supported by the renderer.
|
|
334
|
+
*/
|
|
268
335
|
copyable;
|
|
269
336
|
/**
|
|
270
337
|
* Constructs a new `PrimitiveModifiersClass` instance.
|
|
@@ -284,8 +351,7 @@ export class PrimitiveModifiersClass extends ViewKitNode {
|
|
|
284
351
|
* Class implementation of the `StringElement` interface.
|
|
285
352
|
*
|
|
286
353
|
* @remarks
|
|
287
|
-
*
|
|
288
|
-
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
354
|
+
* 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.
|
|
289
355
|
*/
|
|
290
356
|
export class StringElementClass extends BaseUiElement {
|
|
291
357
|
/**
|
|
@@ -294,11 +360,19 @@ export class StringElementClass extends BaseUiElement {
|
|
|
294
360
|
* @defaultValue "string"
|
|
295
361
|
*/
|
|
296
362
|
type = "string";
|
|
297
|
-
/**
|
|
363
|
+
/**
|
|
364
|
+
* Text value
|
|
365
|
+
*
|
|
366
|
+
* @remarks
|
|
367
|
+
* Text to render. Supply plain text; this field is not a Markdown or HTML document.
|
|
368
|
+
*/
|
|
298
369
|
value;
|
|
299
370
|
/**
|
|
300
371
|
* Display representation mode
|
|
301
372
|
*
|
|
373
|
+
* @remarks
|
|
374
|
+
* Selects inline, chip, or multiline rendering. The default is plain, so callers can omit this for ordinary text.
|
|
375
|
+
*
|
|
302
376
|
* @defaultValue StringRepresentation.plain
|
|
303
377
|
*/
|
|
304
378
|
representation;
|
|
@@ -308,6 +382,8 @@ export class StringElementClass extends BaseUiElement {
|
|
|
308
382
|
* Constructs a new `StringElementClass` instance.
|
|
309
383
|
*
|
|
310
384
|
* @param value - Text value
|
|
385
|
+
|
|
386
|
+
Text to render. Supply plain text; this field is not a Markdown or HTML document.
|
|
311
387
|
* @param options - Optional component settings. (representation (defaults to `plain`), modifiers).
|
|
312
388
|
*/
|
|
313
389
|
constructor(value, options) {
|
|
@@ -321,8 +397,7 @@ export class StringElementClass extends BaseUiElement {
|
|
|
321
397
|
* Class implementation of the `StringsElement` interface.
|
|
322
398
|
*
|
|
323
399
|
* @remarks
|
|
324
|
-
*
|
|
325
|
-
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
400
|
+
* 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.
|
|
326
401
|
*/
|
|
327
402
|
export class StringsElementClass extends BaseUiElement {
|
|
328
403
|
/**
|
|
@@ -331,15 +406,28 @@ export class StringsElementClass extends BaseUiElement {
|
|
|
331
406
|
* @defaultValue "strings"
|
|
332
407
|
*/
|
|
333
408
|
type = "strings";
|
|
334
|
-
/**
|
|
409
|
+
/**
|
|
410
|
+
* Array of string values
|
|
411
|
+
*
|
|
412
|
+
* @remarks
|
|
413
|
+
* Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
|
|
414
|
+
*/
|
|
335
415
|
values;
|
|
336
416
|
/**
|
|
337
417
|
* Display representation mode (plain text or visual chips)
|
|
338
418
|
*
|
|
419
|
+
* @remarks
|
|
420
|
+
* Selects whether values appear as ordinary inline text or as separate visual chips. The default uses the plain representation.
|
|
421
|
+
*
|
|
339
422
|
* @defaultValue StringRepresentation.plain
|
|
340
423
|
*/
|
|
341
424
|
representation;
|
|
342
|
-
/**
|
|
425
|
+
/**
|
|
426
|
+
* Optional visual separator rendered between sequential values
|
|
427
|
+
*
|
|
428
|
+
* @remarks
|
|
429
|
+
* Separator inserted between adjacent values in plain representation. It does not become part of any value.
|
|
430
|
+
*/
|
|
343
431
|
separator;
|
|
344
432
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
345
433
|
modifiers;
|
|
@@ -347,6 +435,8 @@ export class StringsElementClass extends BaseUiElement {
|
|
|
347
435
|
* Constructs a new `StringsElementClass` instance.
|
|
348
436
|
*
|
|
349
437
|
* @param values - Array of string values
|
|
438
|
+
|
|
439
|
+
Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
|
|
350
440
|
* @param options - Optional component settings. (representation (defaults to `plain`), separator, modifiers).
|
|
351
441
|
*/
|
|
352
442
|
constructor(values, options) {
|
|
@@ -361,7 +451,7 @@ export class StringsElementClass extends BaseUiElement {
|
|
|
361
451
|
* Class implementation of the `StringCodeElement` interface.
|
|
362
452
|
*
|
|
363
453
|
* @remarks
|
|
364
|
-
*
|
|
454
|
+
* 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.
|
|
365
455
|
*/
|
|
366
456
|
export class StringCodeElementClass extends BaseUiElement {
|
|
367
457
|
/**
|
|
@@ -370,9 +460,19 @@ export class StringCodeElementClass extends BaseUiElement {
|
|
|
370
460
|
* @defaultValue "string-code"
|
|
371
461
|
*/
|
|
372
462
|
type = "string-code";
|
|
373
|
-
/**
|
|
463
|
+
/**
|
|
464
|
+
* Text value
|
|
465
|
+
*
|
|
466
|
+
* @remarks
|
|
467
|
+
* Code or text snippet to display. Include any desired line breaks in this string.
|
|
468
|
+
*/
|
|
374
469
|
value;
|
|
375
|
-
/**
|
|
470
|
+
/**
|
|
471
|
+
* Optional syntax highlighting language identifier
|
|
472
|
+
*
|
|
473
|
+
* @remarks
|
|
474
|
+
* Optional syntax hint for the renderer. Supported values describe highlighting modes and do not validate the snippet's syntax.
|
|
475
|
+
*/
|
|
376
476
|
language;
|
|
377
477
|
/** Optional visual modifiers (copyable) */
|
|
378
478
|
modifiers;
|
|
@@ -380,6 +480,8 @@ export class StringCodeElementClass extends BaseUiElement {
|
|
|
380
480
|
* Constructs a new `StringCodeElementClass` instance.
|
|
381
481
|
*
|
|
382
482
|
* @param value - Text value
|
|
483
|
+
|
|
484
|
+
Code or text snippet to display. Include any desired line breaks in this string.
|
|
383
485
|
* @param options - Optional component settings. (language, modifiers).
|
|
384
486
|
*/
|
|
385
487
|
constructor(value, options) {
|
|
@@ -393,7 +495,7 @@ export class StringCodeElementClass extends BaseUiElement {
|
|
|
393
495
|
* Class implementation of the `XmlElement` interface.
|
|
394
496
|
*
|
|
395
497
|
* @remarks
|
|
396
|
-
* XML
|
|
498
|
+
* Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
|
|
397
499
|
*/
|
|
398
500
|
export class XmlElementClass extends BaseUiElement {
|
|
399
501
|
/**
|
|
@@ -402,7 +504,12 @@ export class XmlElementClass extends BaseUiElement {
|
|
|
402
504
|
* @defaultValue "xml"
|
|
403
505
|
*/
|
|
404
506
|
type = "xml";
|
|
405
|
-
/**
|
|
507
|
+
/**
|
|
508
|
+
* XML content value
|
|
509
|
+
*
|
|
510
|
+
* @remarks
|
|
511
|
+
* XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
|
|
512
|
+
*/
|
|
406
513
|
value;
|
|
407
514
|
/** Optional visual modifiers (copyable) */
|
|
408
515
|
modifiers;
|
|
@@ -410,6 +517,8 @@ export class XmlElementClass extends BaseUiElement {
|
|
|
410
517
|
* Constructs a new `XmlElementClass` instance.
|
|
411
518
|
*
|
|
412
519
|
* @param value - XML content value
|
|
520
|
+
|
|
521
|
+
XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
|
|
413
522
|
* @param options - Optional component settings. (modifiers).
|
|
414
523
|
*/
|
|
415
524
|
constructor(value, options) {
|
|
@@ -422,7 +531,7 @@ export class XmlElementClass extends BaseUiElement {
|
|
|
422
531
|
* Class implementation of the `JsonElement` interface.
|
|
423
532
|
*
|
|
424
533
|
* @remarks
|
|
425
|
-
* JSON
|
|
534
|
+
* 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.
|
|
426
535
|
*/
|
|
427
536
|
export class JsonElementClass extends BaseUiElement {
|
|
428
537
|
/**
|
|
@@ -431,7 +540,12 @@ export class JsonElementClass extends BaseUiElement {
|
|
|
431
540
|
* @defaultValue "json"
|
|
432
541
|
*/
|
|
433
542
|
type = "json";
|
|
434
|
-
/**
|
|
543
|
+
/**
|
|
544
|
+
* JSON content value
|
|
545
|
+
*
|
|
546
|
+
* @remarks
|
|
547
|
+
* Serialized JSON text to render. No parsing or schema validation is implied by this element.
|
|
548
|
+
*/
|
|
435
549
|
value;
|
|
436
550
|
/** Optional visual modifiers (copyable) */
|
|
437
551
|
modifiers;
|
|
@@ -439,6 +553,8 @@ export class JsonElementClass extends BaseUiElement {
|
|
|
439
553
|
* Constructs a new `JsonElementClass` instance.
|
|
440
554
|
*
|
|
441
555
|
* @param value - JSON content value
|
|
556
|
+
|
|
557
|
+
Serialized JSON text to render. No parsing or schema validation is implied by this element.
|
|
442
558
|
* @param options - Optional component settings. (modifiers).
|
|
443
559
|
*/
|
|
444
560
|
constructor(value, options) {
|
|
@@ -451,7 +567,7 @@ export class JsonElementClass extends BaseUiElement {
|
|
|
451
567
|
* Class implementation of the `StringUrlElement` interface.
|
|
452
568
|
*
|
|
453
569
|
* @remarks
|
|
454
|
-
*
|
|
570
|
+
* 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.
|
|
455
571
|
*/
|
|
456
572
|
export class StringUrlElementClass extends BaseUiElement {
|
|
457
573
|
/**
|
|
@@ -460,7 +576,12 @@ export class StringUrlElementClass extends BaseUiElement {
|
|
|
460
576
|
* @defaultValue "string-url"
|
|
461
577
|
*/
|
|
462
578
|
type = "string-url";
|
|
463
|
-
/**
|
|
579
|
+
/**
|
|
580
|
+
* Target URL or navigation destination
|
|
581
|
+
*
|
|
582
|
+
* @remarks
|
|
583
|
+
* Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
|
|
584
|
+
*/
|
|
464
585
|
value;
|
|
465
586
|
/** Optional custom anchor text label */
|
|
466
587
|
label;
|
|
@@ -470,6 +591,8 @@ export class StringUrlElementClass extends BaseUiElement {
|
|
|
470
591
|
* Constructs a new `StringUrlElementClass` instance.
|
|
471
592
|
*
|
|
472
593
|
* @param value - Target URL or navigation destination
|
|
594
|
+
|
|
595
|
+
Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
|
|
473
596
|
* @param options - Optional component settings. (label, modifiers).
|
|
474
597
|
*/
|
|
475
598
|
constructor(value, options) {
|
|
@@ -483,7 +606,7 @@ export class StringUrlElementClass extends BaseUiElement {
|
|
|
483
606
|
* Class implementation of the `IdentifierElement` interface.
|
|
484
607
|
*
|
|
485
608
|
* @remarks
|
|
486
|
-
*
|
|
609
|
+
* 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.
|
|
487
610
|
*/
|
|
488
611
|
export class IdentifierElementClass extends BaseUiElement {
|
|
489
612
|
/**
|
|
@@ -492,7 +615,12 @@ export class IdentifierElementClass extends BaseUiElement {
|
|
|
492
615
|
* @defaultValue "identifier"
|
|
493
616
|
*/
|
|
494
617
|
type = "identifier";
|
|
495
|
-
/**
|
|
618
|
+
/**
|
|
619
|
+
* Identifier string value
|
|
620
|
+
*
|
|
621
|
+
* @remarks
|
|
622
|
+
* Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
|
|
623
|
+
*/
|
|
496
624
|
value;
|
|
497
625
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
498
626
|
modifiers;
|
|
@@ -500,6 +628,8 @@ export class IdentifierElementClass extends BaseUiElement {
|
|
|
500
628
|
* Constructs a new `IdentifierElementClass` instance.
|
|
501
629
|
*
|
|
502
630
|
* @param value - Identifier string value
|
|
631
|
+
|
|
632
|
+
Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
|
|
503
633
|
* @param options - Optional component settings. (modifiers).
|
|
504
634
|
*/
|
|
505
635
|
constructor(value, options) {
|
|
@@ -512,7 +642,7 @@ export class IdentifierElementClass extends BaseUiElement {
|
|
|
512
642
|
* Class implementation of the `RatioElement` interface.
|
|
513
643
|
*
|
|
514
644
|
* @remarks
|
|
515
|
-
*
|
|
645
|
+
* 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.
|
|
516
646
|
*/
|
|
517
647
|
export class RatioElementClass extends BaseUiElement {
|
|
518
648
|
/**
|
|
@@ -521,7 +651,12 @@ export class RatioElementClass extends BaseUiElement {
|
|
|
521
651
|
* @defaultValue "ratio"
|
|
522
652
|
*/
|
|
523
653
|
type = "ratio";
|
|
524
|
-
/**
|
|
654
|
+
/**
|
|
655
|
+
* Aspect ratio numerical expression
|
|
656
|
+
*
|
|
657
|
+
* @remarks
|
|
658
|
+
* Numeric ratio value used by the renderer to produce an aspect-ratio display.
|
|
659
|
+
*/
|
|
525
660
|
value;
|
|
526
661
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
527
662
|
modifiers;
|
|
@@ -529,6 +664,8 @@ export class RatioElementClass extends BaseUiElement {
|
|
|
529
664
|
* Constructs a new `RatioElementClass` instance.
|
|
530
665
|
*
|
|
531
666
|
* @param value - Aspect ratio numerical expression
|
|
667
|
+
|
|
668
|
+
Numeric ratio value used by the renderer to produce an aspect-ratio display.
|
|
532
669
|
* @param options - Optional component settings. (modifiers).
|
|
533
670
|
*/
|
|
534
671
|
constructor(value, options) {
|
|
@@ -541,7 +678,7 @@ export class RatioElementClass extends BaseUiElement {
|
|
|
541
678
|
* Class implementation of the `DimensionsElement` interface.
|
|
542
679
|
*
|
|
543
680
|
* @remarks
|
|
544
|
-
*
|
|
681
|
+
* 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.
|
|
545
682
|
*/
|
|
546
683
|
export class DimensionsElementClass extends BaseUiElement {
|
|
547
684
|
/**
|
|
@@ -550,9 +687,19 @@ export class DimensionsElementClass extends BaseUiElement {
|
|
|
550
687
|
* @defaultValue "dimensions"
|
|
551
688
|
*/
|
|
552
689
|
type = "dimensions";
|
|
553
|
-
/**
|
|
690
|
+
/**
|
|
691
|
+
* Width in pixels
|
|
692
|
+
*
|
|
693
|
+
* @remarks
|
|
694
|
+
* Horizontal pixel count. Values below one are rejected by the schema constraint.
|
|
695
|
+
*/
|
|
554
696
|
width;
|
|
555
|
-
/**
|
|
697
|
+
/**
|
|
698
|
+
* Height in pixels
|
|
699
|
+
*
|
|
700
|
+
* @remarks
|
|
701
|
+
* Vertical pixel count. Values below one are rejected by the schema constraint.
|
|
702
|
+
*/
|
|
556
703
|
height;
|
|
557
704
|
/** Optional visual modifiers (copyable) */
|
|
558
705
|
modifiers;
|
|
@@ -560,7 +707,11 @@ export class DimensionsElementClass extends BaseUiElement {
|
|
|
560
707
|
* Constructs a new `DimensionsElementClass` instance.
|
|
561
708
|
*
|
|
562
709
|
* @param width - Width in pixels
|
|
710
|
+
|
|
711
|
+
Horizontal pixel count. Values below one are rejected by the schema constraint.
|
|
563
712
|
* @param height - Height in pixels
|
|
713
|
+
|
|
714
|
+
Vertical pixel count. Values below one are rejected by the schema constraint.
|
|
564
715
|
* @param options - Optional component settings. (modifiers).
|
|
565
716
|
*/
|
|
566
717
|
constructor(width, height, options) {
|
|
@@ -574,7 +725,7 @@ export class DimensionsElementClass extends BaseUiElement {
|
|
|
574
725
|
* Class implementation of the `ColourElement` interface.
|
|
575
726
|
*
|
|
576
727
|
* @remarks
|
|
577
|
-
*
|
|
728
|
+
* 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.
|
|
578
729
|
*/
|
|
579
730
|
export class ColourElementClass extends BaseUiElement {
|
|
580
731
|
/**
|
|
@@ -583,25 +734,44 @@ export class ColourElementClass extends BaseUiElement {
|
|
|
583
734
|
* @defaultValue "color"
|
|
584
735
|
*/
|
|
585
736
|
type = "color";
|
|
586
|
-
/**
|
|
737
|
+
/**
|
|
738
|
+
* Hexadecimal color code
|
|
739
|
+
*
|
|
740
|
+
* @remarks
|
|
741
|
+
* Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
742
|
+
*/
|
|
587
743
|
value;
|
|
588
|
-
/**
|
|
744
|
+
/**
|
|
745
|
+
* Optional descriptive color name label
|
|
746
|
+
*
|
|
747
|
+
* @remarks
|
|
748
|
+
* Human-readable color name available to the renderer when text is shown.
|
|
749
|
+
*/
|
|
589
750
|
label;
|
|
590
751
|
/**
|
|
591
752
|
* Whether to display the textual color code or label next to the swatch
|
|
592
753
|
*
|
|
754
|
+
* @remarks
|
|
755
|
+
* When true, allows the renderer to show the color's text label alongside the swatch. The default is true.
|
|
756
|
+
*
|
|
593
757
|
* @defaultValue true
|
|
594
758
|
*/
|
|
595
759
|
showText;
|
|
596
760
|
/**
|
|
597
761
|
* Visual shape of the color indicator
|
|
598
762
|
*
|
|
763
|
+
* @remarks
|
|
764
|
+
* Geometry used for the swatch; defaults to a circle.
|
|
765
|
+
*
|
|
599
766
|
* @defaultValue Shape.circle
|
|
600
767
|
*/
|
|
601
768
|
shape;
|
|
602
769
|
/**
|
|
603
770
|
* Visual size of the color indicator
|
|
604
771
|
*
|
|
772
|
+
* @remarks
|
|
773
|
+
* Relative size class for the swatch; defaults to medium.
|
|
774
|
+
*
|
|
605
775
|
* @defaultValue Size.medium
|
|
606
776
|
*/
|
|
607
777
|
size;
|
|
@@ -611,6 +781,8 @@ export class ColourElementClass extends BaseUiElement {
|
|
|
611
781
|
* Constructs a new `ColourElementClass` instance.
|
|
612
782
|
*
|
|
613
783
|
* @param value - Hexadecimal color code
|
|
784
|
+
|
|
785
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
614
786
|
* @param options - Optional component settings. (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
615
787
|
*/
|
|
616
788
|
constructor(value, options) {
|
|
@@ -627,7 +799,7 @@ export class ColourElementClass extends BaseUiElement {
|
|
|
627
799
|
* Class implementation of the `NumberUnboundedElement` interface.
|
|
628
800
|
*
|
|
629
801
|
* @remarks
|
|
630
|
-
*
|
|
802
|
+
* 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.
|
|
631
803
|
*/
|
|
632
804
|
export class NumberUnboundedElementClass extends BaseUiElement {
|
|
633
805
|
/**
|
|
@@ -636,9 +808,19 @@ export class NumberUnboundedElementClass extends BaseUiElement {
|
|
|
636
808
|
* @defaultValue "number-unbounded"
|
|
637
809
|
*/
|
|
638
810
|
type = "number-unbounded";
|
|
639
|
-
/**
|
|
811
|
+
/**
|
|
812
|
+
* Numeric value
|
|
813
|
+
*
|
|
814
|
+
* @remarks
|
|
815
|
+
* Number to display. Its meaning and any valid range are defined by the producing feature.
|
|
816
|
+
*/
|
|
640
817
|
value;
|
|
641
|
-
/**
|
|
818
|
+
/**
|
|
819
|
+
* Optional unit suffix (e.g. "px", "ms", "MB")
|
|
820
|
+
*
|
|
821
|
+
* @remarks
|
|
822
|
+
* Short unit label appended or otherwise associated with the displayed value. Include only the unit text, not a second copy of the number.
|
|
823
|
+
*/
|
|
642
824
|
unit;
|
|
643
825
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
644
826
|
modifiers;
|
|
@@ -646,6 +828,8 @@ export class NumberUnboundedElementClass extends BaseUiElement {
|
|
|
646
828
|
* Constructs a new `NumberUnboundedElementClass` instance.
|
|
647
829
|
*
|
|
648
830
|
* @param value - Numeric value
|
|
831
|
+
|
|
832
|
+
Number to display. Its meaning and any valid range are defined by the producing feature.
|
|
649
833
|
* @param options - Optional component settings. (unit, modifiers).
|
|
650
834
|
*/
|
|
651
835
|
constructor(value, options) {
|
|
@@ -659,7 +843,7 @@ export class NumberUnboundedElementClass extends BaseUiElement {
|
|
|
659
843
|
* Class implementation of the `NumberBoundedStarsElement` interface.
|
|
660
844
|
*
|
|
661
845
|
* @remarks
|
|
662
|
-
*
|
|
846
|
+
* 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.
|
|
663
847
|
*/
|
|
664
848
|
export class NumberBoundedStarsElementClass extends BaseUiElement {
|
|
665
849
|
/**
|
|
@@ -668,9 +852,19 @@ export class NumberBoundedStarsElementClass extends BaseUiElement {
|
|
|
668
852
|
* @defaultValue "number-stars"
|
|
669
853
|
*/
|
|
670
854
|
type = "number-stars";
|
|
671
|
-
/**
|
|
855
|
+
/**
|
|
856
|
+
* Numeric rating score
|
|
857
|
+
*
|
|
858
|
+
* @remarks
|
|
859
|
+
* Score represented by the filled portion of the star display.
|
|
860
|
+
*/
|
|
672
861
|
value;
|
|
673
|
-
/**
|
|
862
|
+
/**
|
|
863
|
+
* Maximum rating scale (defaults to 5)
|
|
864
|
+
*
|
|
865
|
+
* @remarks
|
|
866
|
+
* Upper end of the rating scale. When omitted, the scale is five; value should use the same scale.
|
|
867
|
+
*/
|
|
674
868
|
maximum;
|
|
675
869
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
676
870
|
modifiers;
|
|
@@ -678,6 +872,8 @@ export class NumberBoundedStarsElementClass extends BaseUiElement {
|
|
|
678
872
|
* Constructs a new `NumberBoundedStarsElementClass` instance.
|
|
679
873
|
*
|
|
680
874
|
* @param value - Numeric rating score
|
|
875
|
+
|
|
876
|
+
Score represented by the filled portion of the star display.
|
|
681
877
|
* @param options - Optional component settings. (maximum, modifiers).
|
|
682
878
|
*/
|
|
683
879
|
constructor(value, options) {
|
|
@@ -691,7 +887,7 @@ export class NumberBoundedStarsElementClass extends BaseUiElement {
|
|
|
691
887
|
* Class implementation of the `NumberBoundedMeterElement` interface.
|
|
692
888
|
*
|
|
693
889
|
* @remarks
|
|
694
|
-
*
|
|
890
|
+
* 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.
|
|
695
891
|
*/
|
|
696
892
|
export class NumberBoundedMeterElementClass extends BaseUiElement {
|
|
697
893
|
/**
|
|
@@ -700,15 +896,40 @@ export class NumberBoundedMeterElementClass extends BaseUiElement {
|
|
|
700
896
|
* @defaultValue "number-meter"
|
|
701
897
|
*/
|
|
702
898
|
type = "number-meter";
|
|
703
|
-
/**
|
|
899
|
+
/**
|
|
900
|
+
* Numeric value
|
|
901
|
+
*
|
|
902
|
+
* @remarks
|
|
903
|
+
* Current measurement or score represented by the meter.
|
|
904
|
+
*/
|
|
704
905
|
value;
|
|
705
|
-
/**
|
|
906
|
+
/**
|
|
907
|
+
* Minimum scale bound (defaults to 0)
|
|
908
|
+
*
|
|
909
|
+
* @remarks
|
|
910
|
+
* Lower end of the meter range. Defaults to zero when omitted.
|
|
911
|
+
*/
|
|
706
912
|
minimum;
|
|
707
|
-
/**
|
|
913
|
+
/**
|
|
914
|
+
* Maximum scale bound (e.g. 100)
|
|
915
|
+
*
|
|
916
|
+
* @remarks
|
|
917
|
+
* Upper end of the meter range. Choose a bound consistent with value and minimum.
|
|
918
|
+
*/
|
|
708
919
|
maximum;
|
|
709
|
-
/**
|
|
920
|
+
/**
|
|
921
|
+
* Optional custom text label override (e.g. "68 / 100")
|
|
922
|
+
*
|
|
923
|
+
* @remarks
|
|
924
|
+
* Optional readout text to use instead of a renderer-generated value and range label.
|
|
925
|
+
*/
|
|
710
926
|
label;
|
|
711
|
-
/**
|
|
927
|
+
/**
|
|
928
|
+
* Optional unit suffix (e.g. "%")
|
|
929
|
+
*
|
|
930
|
+
* @remarks
|
|
931
|
+
* Unit associated with the value, such as a percent sign. This affects display only and does not convert the numeric value.
|
|
932
|
+
*/
|
|
712
933
|
unit;
|
|
713
934
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
714
935
|
modifiers;
|
|
@@ -716,6 +937,8 @@ export class NumberBoundedMeterElementClass extends BaseUiElement {
|
|
|
716
937
|
* Constructs a new `NumberBoundedMeterElementClass` instance.
|
|
717
938
|
*
|
|
718
939
|
* @param value - Numeric value
|
|
940
|
+
|
|
941
|
+
Current measurement or score represented by the meter.
|
|
719
942
|
* @param options - Optional component settings. (minimum, maximum, label, unit, modifiers).
|
|
720
943
|
*/
|
|
721
944
|
constructor(value, options) {
|
|
@@ -732,8 +955,7 @@ export class NumberBoundedMeterElementClass extends BaseUiElement {
|
|
|
732
955
|
* Class implementation of the `BooleanElement` interface.
|
|
733
956
|
*
|
|
734
957
|
* @remarks
|
|
735
|
-
*
|
|
736
|
-
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
958
|
+
* 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.
|
|
737
959
|
*/
|
|
738
960
|
export class BooleanElementClass extends BaseUiElement {
|
|
739
961
|
/**
|
|
@@ -742,29 +964,46 @@ export class BooleanElementClass extends BaseUiElement {
|
|
|
742
964
|
* @defaultValue "boolean"
|
|
743
965
|
*/
|
|
744
966
|
type = "boolean";
|
|
745
|
-
/**
|
|
967
|
+
/**
|
|
968
|
+
* Boolean state value
|
|
969
|
+
*
|
|
970
|
+
* @remarks
|
|
971
|
+
* State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
|
|
972
|
+
*/
|
|
746
973
|
value;
|
|
747
974
|
/**
|
|
748
975
|
* Display representation mode
|
|
749
976
|
*
|
|
977
|
+
* @remarks
|
|
978
|
+
* Selects ordinary text or a badge pill. Badge color applies only to badge presentation.
|
|
979
|
+
*
|
|
750
980
|
* @defaultValue BooleanRepresentation.plain
|
|
751
981
|
*/
|
|
752
982
|
representation;
|
|
753
983
|
/**
|
|
754
984
|
* Custom display label when true (defaults to "true")
|
|
755
985
|
*
|
|
986
|
+
* @remarks
|
|
987
|
+
* Text used for the true state in plain representation. Defaults to the literal text true.
|
|
988
|
+
*
|
|
756
989
|
* @defaultValue "true"
|
|
757
990
|
*/
|
|
758
991
|
trueLabel;
|
|
759
992
|
/**
|
|
760
993
|
* Custom display label when false (defaults to "false")
|
|
761
994
|
*
|
|
995
|
+
* @remarks
|
|
996
|
+
* Text used for the false state in plain representation. Defaults to the literal text false.
|
|
997
|
+
*
|
|
762
998
|
* @defaultValue "false"
|
|
763
999
|
*/
|
|
764
1000
|
falseLabel;
|
|
765
1001
|
/**
|
|
766
1002
|
* Badge color tone when rendered as badge
|
|
767
1003
|
*
|
|
1004
|
+
* @remarks
|
|
1005
|
+
* Semantic color treatment for badge presentation; it has no effect in plain representation.
|
|
1006
|
+
*
|
|
768
1007
|
* @defaultValue BadgeVariant.neutral
|
|
769
1008
|
*/
|
|
770
1009
|
variant;
|
|
@@ -774,6 +1013,8 @@ export class BooleanElementClass extends BaseUiElement {
|
|
|
774
1013
|
* Constructs a new `BooleanElementClass` instance.
|
|
775
1014
|
*
|
|
776
1015
|
* @param value - Boolean state value
|
|
1016
|
+
|
|
1017
|
+
State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
|
|
777
1018
|
* @param options - Optional component settings. (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
778
1019
|
*/
|
|
779
1020
|
constructor(value, options) {
|
|
@@ -790,7 +1031,7 @@ export class BooleanElementClass extends BaseUiElement {
|
|
|
790
1031
|
* Class implementation of the `TimestampElement` interface.
|
|
791
1032
|
*
|
|
792
1033
|
* @remarks
|
|
793
|
-
*
|
|
1034
|
+
* 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.
|
|
794
1035
|
*/
|
|
795
1036
|
export class TimestampElementClass extends BaseUiElement {
|
|
796
1037
|
/**
|
|
@@ -799,11 +1040,19 @@ export class TimestampElementClass extends BaseUiElement {
|
|
|
799
1040
|
* @defaultValue "timestamp"
|
|
800
1041
|
*/
|
|
801
1042
|
type = "timestamp";
|
|
802
|
-
/**
|
|
1043
|
+
/**
|
|
1044
|
+
* The timestamp in milliseconds
|
|
1045
|
+
*
|
|
1046
|
+
* @remarks
|
|
1047
|
+
* Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
|
|
1048
|
+
*/
|
|
803
1049
|
value;
|
|
804
1050
|
/**
|
|
805
1051
|
* Presentation date/time format
|
|
806
1052
|
*
|
|
1053
|
+
* @remarks
|
|
1054
|
+
* Controls whether the timestamp is shown as date and time, date only, time only, or relative text. The default is datetime.
|
|
1055
|
+
*
|
|
807
1056
|
* @defaultValue TimestampFormat.datetime
|
|
808
1057
|
*/
|
|
809
1058
|
format;
|
|
@@ -813,6 +1062,8 @@ export class TimestampElementClass extends BaseUiElement {
|
|
|
813
1062
|
* Constructs a new `TimestampElementClass` instance.
|
|
814
1063
|
*
|
|
815
1064
|
* @param value - The timestamp in milliseconds
|
|
1065
|
+
|
|
1066
|
+
Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
|
|
816
1067
|
* @param options - Optional component settings. (format (defaults to `datetime`), modifiers).
|
|
817
1068
|
*/
|
|
818
1069
|
constructor(value, options) {
|
|
@@ -826,7 +1077,7 @@ export class TimestampElementClass extends BaseUiElement {
|
|
|
826
1077
|
* Class implementation of the `ImageReferenceElement` interface.
|
|
827
1078
|
*
|
|
828
1079
|
* @remarks
|
|
829
|
-
*
|
|
1080
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
830
1081
|
*/
|
|
831
1082
|
export class ImageReferenceElementClass extends BaseUiElement {
|
|
832
1083
|
/**
|
|
@@ -835,22 +1086,42 @@ export class ImageReferenceElementClass extends BaseUiElement {
|
|
|
835
1086
|
* @defaultValue "image-ref"
|
|
836
1087
|
*/
|
|
837
1088
|
type = "image-ref";
|
|
838
|
-
/**
|
|
1089
|
+
/**
|
|
1090
|
+
* Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
1091
|
+
*
|
|
1092
|
+
* @remarks
|
|
1093
|
+
* 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.
|
|
1094
|
+
*/
|
|
839
1095
|
src;
|
|
840
|
-
/**
|
|
1096
|
+
/**
|
|
1097
|
+
* Accessible alternative description
|
|
1098
|
+
*
|
|
1099
|
+
* @remarks
|
|
1100
|
+
* Alternative text describing the image for assistive technology. Provide meaningful text when the image conveys information; omit it only when it is decorative.
|
|
1101
|
+
*/
|
|
841
1102
|
alt;
|
|
842
1103
|
/**
|
|
843
1104
|
* Aspect ratio of the thumbnail container
|
|
844
1105
|
*
|
|
1106
|
+
* @remarks
|
|
1107
|
+
* 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.
|
|
1108
|
+
*
|
|
845
1109
|
* @defaultValue "1:1"
|
|
846
1110
|
*/
|
|
847
1111
|
aspectRatio;
|
|
848
|
-
/**
|
|
1112
|
+
/**
|
|
1113
|
+
* Fallback placeholder image URI
|
|
1114
|
+
*
|
|
1115
|
+
* @remarks
|
|
1116
|
+
* Optional source to display when the primary image cannot be loaded. It follows the same URI conventions as src.
|
|
1117
|
+
*/
|
|
849
1118
|
placeholder;
|
|
850
1119
|
/**
|
|
851
1120
|
* Constructs a new `ImageReferenceElementClass` instance.
|
|
852
1121
|
*
|
|
853
1122
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
1123
|
+
|
|
1124
|
+
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.
|
|
854
1125
|
* @param options - Optional component settings. (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
855
1126
|
*/
|
|
856
1127
|
constructor(src, options) {
|
|
@@ -865,7 +1136,7 @@ export class ImageReferenceElementClass extends BaseUiElement {
|
|
|
865
1136
|
* Class implementation of the `ButtonActionElement` interface.
|
|
866
1137
|
*
|
|
867
1138
|
* @remarks
|
|
868
|
-
*
|
|
1139
|
+
* 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.
|
|
869
1140
|
*/
|
|
870
1141
|
export class ButtonActionElementClass extends BaseUiAction {
|
|
871
1142
|
/**
|
|
@@ -874,25 +1145,56 @@ export class ButtonActionElementClass extends BaseUiAction {
|
|
|
874
1145
|
* @defaultValue "button"
|
|
875
1146
|
*/
|
|
876
1147
|
type = "button";
|
|
877
|
-
/**
|
|
1148
|
+
/**
|
|
1149
|
+
* Command identifier to invoke
|
|
1150
|
+
*
|
|
1151
|
+
* @remarks
|
|
1152
|
+
* Identifier of the registered extension command to dispatch when the button is activated.
|
|
1153
|
+
*/
|
|
878
1154
|
commandId;
|
|
879
|
-
/**
|
|
1155
|
+
/**
|
|
1156
|
+
* Display label for the action
|
|
1157
|
+
*
|
|
1158
|
+
* @remarks
|
|
1159
|
+
* User-facing label shown on the control. Keep it short and action-oriented.
|
|
1160
|
+
*/
|
|
880
1161
|
label;
|
|
881
|
-
/**
|
|
1162
|
+
/**
|
|
1163
|
+
* Extension identifier owning the target command
|
|
1164
|
+
*
|
|
1165
|
+
* @remarks
|
|
1166
|
+
* Extension that registers commandId. Omit only when the client can resolve the command in the current extension context.
|
|
1167
|
+
*/
|
|
882
1168
|
extensionId;
|
|
883
|
-
/**
|
|
1169
|
+
/**
|
|
1170
|
+
* Target entity or context identifier
|
|
1171
|
+
*
|
|
1172
|
+
* @remarks
|
|
1173
|
+
* Optional entity or context identifier forwarded to the command handler. Its format is determined by the target extension.
|
|
1174
|
+
*/
|
|
884
1175
|
target;
|
|
885
|
-
/**
|
|
1176
|
+
/**
|
|
1177
|
+
* Optional arbitrary parameters payload forwarded to the command handler
|
|
1178
|
+
*
|
|
1179
|
+
* @remarks
|
|
1180
|
+
* JSON-compatible arguments passed to the extension command. Define and validate their shape in the command implementation.
|
|
1181
|
+
*/
|
|
886
1182
|
parameters;
|
|
887
1183
|
/**
|
|
888
1184
|
* Whether the button is disabled / unavailable
|
|
889
1185
|
*
|
|
1186
|
+
* @remarks
|
|
1187
|
+
* When true, the client renders the action as unavailable and should not dispatch it from user activation.
|
|
1188
|
+
*
|
|
890
1189
|
* @defaultValue false
|
|
891
1190
|
*/
|
|
892
1191
|
disabled;
|
|
893
1192
|
/**
|
|
894
1193
|
* Button visual style variant
|
|
895
1194
|
*
|
|
1195
|
+
* @remarks
|
|
1196
|
+
* Selects the button's emphasis style. Use danger for destructive operations and primary for the main recommended action; the variant does not change behavior.
|
|
1197
|
+
*
|
|
896
1198
|
* @defaultValue ButtonVariant.secondary
|
|
897
1199
|
*/
|
|
898
1200
|
variant;
|
|
@@ -900,7 +1202,11 @@ export class ButtonActionElementClass extends BaseUiAction {
|
|
|
900
1202
|
* Constructs a new `ButtonActionElementClass` instance.
|
|
901
1203
|
*
|
|
902
1204
|
* @param commandId - Command identifier to invoke
|
|
1205
|
+
|
|
1206
|
+
Identifier of the registered extension command to dispatch when the button is activated.
|
|
903
1207
|
* @param label - Display label for the action
|
|
1208
|
+
|
|
1209
|
+
User-facing label shown on the control. Keep it short and action-oriented.
|
|
904
1210
|
* @param options - Optional component settings. (extensionId, target, parameters, disabled (defaults to `false`), variant (defaults to `secondary`)).
|
|
905
1211
|
*/
|
|
906
1212
|
constructor(commandId, label, options) {
|
|
@@ -918,7 +1224,7 @@ export class ButtonActionElementClass extends BaseUiAction {
|
|
|
918
1224
|
* Class implementation of the `ExternalLinkActionElement` interface.
|
|
919
1225
|
*
|
|
920
1226
|
* @remarks
|
|
921
|
-
*
|
|
1227
|
+
* Renders a user-invokable action that opens a destination externally. Use StringUrlElement for a link embedded in content rather than an action control.
|
|
922
1228
|
*/
|
|
923
1229
|
export class ExternalLinkActionElementClass extends BaseUiAction {
|
|
924
1230
|
/**
|
|
@@ -927,15 +1233,29 @@ export class ExternalLinkActionElementClass extends BaseUiAction {
|
|
|
927
1233
|
* @defaultValue "external-link"
|
|
928
1234
|
*/
|
|
929
1235
|
type = "external-link";
|
|
930
|
-
/**
|
|
1236
|
+
/**
|
|
1237
|
+
* Target URL destination
|
|
1238
|
+
*
|
|
1239
|
+
* @remarks
|
|
1240
|
+
* External destination opened when the user activates the link action. The client controls how external navigation is handed to the platform.
|
|
1241
|
+
*/
|
|
931
1242
|
url;
|
|
932
|
-
/**
|
|
1243
|
+
/**
|
|
1244
|
+
* Display label for the action
|
|
1245
|
+
*
|
|
1246
|
+
* @remarks
|
|
1247
|
+
* User-facing label shown on the control. Keep it short and action-oriented.
|
|
1248
|
+
*/
|
|
933
1249
|
label;
|
|
934
1250
|
/**
|
|
935
1251
|
* Constructs a new `ExternalLinkActionElementClass` instance.
|
|
936
1252
|
*
|
|
937
1253
|
* @param url - Target URL destination
|
|
1254
|
+
|
|
1255
|
+
External destination opened when the user activates the link action. The client controls how external navigation is handed to the platform.
|
|
938
1256
|
* @param label - Display label for the action
|
|
1257
|
+
|
|
1258
|
+
User-facing label shown on the control. Keep it short and action-oriented.
|
|
939
1259
|
*/
|
|
940
1260
|
constructor(url, label) {
|
|
941
1261
|
super();
|
|
@@ -947,7 +1267,7 @@ export class ExternalLinkActionElementClass extends BaseUiAction {
|
|
|
947
1267
|
* Class implementation of the `MarkdownBlockElement` interface.
|
|
948
1268
|
*
|
|
949
1269
|
* @remarks
|
|
950
|
-
*
|
|
1270
|
+
* 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.
|
|
951
1271
|
*/
|
|
952
1272
|
export class MarkdownBlockElementClass extends BaseUiElement {
|
|
953
1273
|
/**
|
|
@@ -956,7 +1276,12 @@ export class MarkdownBlockElementClass extends BaseUiElement {
|
|
|
956
1276
|
* @defaultValue "markdown"
|
|
957
1277
|
*/
|
|
958
1278
|
type = "markdown";
|
|
959
|
-
/**
|
|
1279
|
+
/**
|
|
1280
|
+
* Raw Markdown markup content
|
|
1281
|
+
*
|
|
1282
|
+
* @remarks
|
|
1283
|
+
* Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
1284
|
+
*/
|
|
960
1285
|
content;
|
|
961
1286
|
/** Optional visual modifiers (copyable) */
|
|
962
1287
|
modifiers;
|
|
@@ -964,6 +1289,8 @@ export class MarkdownBlockElementClass extends BaseUiElement {
|
|
|
964
1289
|
* Constructs a new `MarkdownBlockElementClass` instance.
|
|
965
1290
|
*
|
|
966
1291
|
* @param content - Raw Markdown markup content
|
|
1292
|
+
|
|
1293
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
967
1294
|
* @param options - Optional component settings. (modifiers).
|
|
968
1295
|
*/
|
|
969
1296
|
constructor(content, options) {
|
|
@@ -976,7 +1303,7 @@ export class MarkdownBlockElementClass extends BaseUiElement {
|
|
|
976
1303
|
* Class implementation of the `HtmlBlockElement` interface.
|
|
977
1304
|
*
|
|
978
1305
|
* @remarks
|
|
979
|
-
*
|
|
1306
|
+
* 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.
|
|
980
1307
|
*/
|
|
981
1308
|
export class HtmlBlockElementClass extends BaseUiElement {
|
|
982
1309
|
/**
|
|
@@ -985,7 +1312,12 @@ export class HtmlBlockElementClass extends BaseUiElement {
|
|
|
985
1312
|
* @defaultValue "html"
|
|
986
1313
|
*/
|
|
987
1314
|
type = "html";
|
|
988
|
-
/**
|
|
1315
|
+
/**
|
|
1316
|
+
* Raw HTML markup content
|
|
1317
|
+
*
|
|
1318
|
+
* @remarks
|
|
1319
|
+
* HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
1320
|
+
*/
|
|
989
1321
|
content;
|
|
990
1322
|
/** Optional visual modifiers (copyable) */
|
|
991
1323
|
modifiers;
|
|
@@ -993,6 +1325,8 @@ export class HtmlBlockElementClass extends BaseUiElement {
|
|
|
993
1325
|
* Constructs a new `HtmlBlockElementClass` instance.
|
|
994
1326
|
*
|
|
995
1327
|
* @param content - Raw HTML markup content
|
|
1328
|
+
|
|
1329
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
996
1330
|
* @param options - Optional component settings. (modifiers).
|
|
997
1331
|
*/
|
|
998
1332
|
constructor(content, options) {
|
|
@@ -1005,19 +1339,36 @@ export class HtmlBlockElementClass extends BaseUiElement {
|
|
|
1005
1339
|
* Class implementation of the `Slot` interface.
|
|
1006
1340
|
*
|
|
1007
1341
|
* @remarks
|
|
1008
|
-
*
|
|
1342
|
+
* 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.
|
|
1009
1343
|
*/
|
|
1010
1344
|
export class SlotClass extends ViewKitNode {
|
|
1011
|
-
/**
|
|
1345
|
+
/**
|
|
1346
|
+
* Rendered content inside the slot
|
|
1347
|
+
*
|
|
1348
|
+
* @remarks
|
|
1349
|
+
* One visual element displayed in this slot. Use a nested layout element when the slot itself needs multiple children.
|
|
1350
|
+
*/
|
|
1012
1351
|
content;
|
|
1013
|
-
/**
|
|
1352
|
+
/**
|
|
1353
|
+
* Optional slot label (e.g. "Slot A")
|
|
1354
|
+
*
|
|
1355
|
+
* @remarks
|
|
1356
|
+
* Short text identifying this region of the row. It is independent of the rendered content.
|
|
1357
|
+
*/
|
|
1014
1358
|
label;
|
|
1015
|
-
/**
|
|
1359
|
+
/**
|
|
1360
|
+
* Width percentage (1-100)
|
|
1361
|
+
*
|
|
1362
|
+
* @remarks
|
|
1363
|
+
* Relative share of the row width. The schema constrains explicit values to the inclusive range 1 through 100.
|
|
1364
|
+
*/
|
|
1016
1365
|
width;
|
|
1017
1366
|
/**
|
|
1018
1367
|
* Constructs a new `SlotClass` instance.
|
|
1019
1368
|
*
|
|
1020
1369
|
* @param content - Rendered content inside the slot
|
|
1370
|
+
|
|
1371
|
+
One visual element displayed in this slot. Use a nested layout element when the slot itself needs multiple children.
|
|
1021
1372
|
* @param options - Optional component settings. (label, width).
|
|
1022
1373
|
*/
|
|
1023
1374
|
constructor(content, options) {
|
|
@@ -1031,7 +1382,7 @@ export class SlotClass extends ViewKitNode {
|
|
|
1031
1382
|
* Class implementation of the `MultiSlotElement` interface.
|
|
1032
1383
|
*
|
|
1033
1384
|
* @remarks
|
|
1034
|
-
*
|
|
1385
|
+
* 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.
|
|
1035
1386
|
*/
|
|
1036
1387
|
export class MultiSlotElementClass extends BaseUiElement {
|
|
1037
1388
|
/**
|
|
@@ -1040,12 +1391,19 @@ export class MultiSlotElementClass extends BaseUiElement {
|
|
|
1040
1391
|
* @defaultValue "multi-slot"
|
|
1041
1392
|
*/
|
|
1042
1393
|
type = "multi-slot";
|
|
1043
|
-
/**
|
|
1394
|
+
/**
|
|
1395
|
+
* List of slots comprising the row
|
|
1396
|
+
*
|
|
1397
|
+
* @remarks
|
|
1398
|
+
* Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
|
|
1399
|
+
*/
|
|
1044
1400
|
slots;
|
|
1045
1401
|
/**
|
|
1046
1402
|
* Constructs a new `MultiSlotElementClass` instance.
|
|
1047
1403
|
*
|
|
1048
1404
|
* @param slots - List of slots comprising the row
|
|
1405
|
+
|
|
1406
|
+
Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
|
|
1049
1407
|
*/
|
|
1050
1408
|
constructor(slots) {
|
|
1051
1409
|
super();
|
|
@@ -1056,8 +1414,7 @@ export class MultiSlotElementClass extends BaseUiElement {
|
|
|
1056
1414
|
* Class implementation of the `FlowingElement` interface.
|
|
1057
1415
|
*
|
|
1058
1416
|
* @remarks
|
|
1059
|
-
*
|
|
1060
|
-
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
1417
|
+
* 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.
|
|
1061
1418
|
*/
|
|
1062
1419
|
export class FlowingElementClass extends BaseUiElement {
|
|
1063
1420
|
/**
|
|
@@ -1066,14 +1423,26 @@ export class FlowingElementClass extends BaseUiElement {
|
|
|
1066
1423
|
* @defaultValue "flowing"
|
|
1067
1424
|
*/
|
|
1068
1425
|
type = "flowing";
|
|
1069
|
-
/**
|
|
1426
|
+
/**
|
|
1427
|
+
* List of child elements rendered sequentially with line wrapping
|
|
1428
|
+
*
|
|
1429
|
+
* @remarks
|
|
1430
|
+
* Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
|
|
1431
|
+
*/
|
|
1070
1432
|
elements;
|
|
1071
|
-
/**
|
|
1433
|
+
/**
|
|
1434
|
+
* Optional visual separator rendered between sequential child elements
|
|
1435
|
+
*
|
|
1436
|
+
* @remarks
|
|
1437
|
+
* Separator placed between adjacent elements. Omit it when spacing or the child renderers already provide sufficient separation.
|
|
1438
|
+
*/
|
|
1072
1439
|
separator;
|
|
1073
1440
|
/**
|
|
1074
1441
|
* Constructs a new `FlowingElementClass` instance.
|
|
1075
1442
|
*
|
|
1076
1443
|
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
1444
|
+
|
|
1445
|
+
Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
|
|
1077
1446
|
* @param options - Optional component settings. (separator).
|
|
1078
1447
|
*/
|
|
1079
1448
|
constructor(elements, options) {
|
|
@@ -1086,8 +1455,7 @@ export class FlowingElementClass extends BaseUiElement {
|
|
|
1086
1455
|
* Class implementation of the `LabelValueElement` interface.
|
|
1087
1456
|
*
|
|
1088
1457
|
* @remarks
|
|
1089
|
-
*
|
|
1090
|
-
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
1458
|
+
* 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.
|
|
1091
1459
|
*/
|
|
1092
1460
|
export class LabelValueElementClass extends BaseUiElement {
|
|
1093
1461
|
/**
|
|
@@ -1096,13 +1464,26 @@ export class LabelValueElementClass extends BaseUiElement {
|
|
|
1096
1464
|
* @defaultValue "label-value"
|
|
1097
1465
|
*/
|
|
1098
1466
|
type = "label-value";
|
|
1099
|
-
/**
|
|
1467
|
+
/**
|
|
1468
|
+
* Key or descriptive label displayed muted on the left
|
|
1469
|
+
*
|
|
1470
|
+
* @remarks
|
|
1471
|
+
* Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
|
|
1472
|
+
*/
|
|
1100
1473
|
label;
|
|
1101
|
-
/**
|
|
1474
|
+
/**
|
|
1475
|
+
* Rendered value element on the right
|
|
1476
|
+
*
|
|
1477
|
+
* @remarks
|
|
1478
|
+
* Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
|
|
1479
|
+
*/
|
|
1102
1480
|
value;
|
|
1103
1481
|
/**
|
|
1104
1482
|
* Whether to render a bottom border/hairline divider
|
|
1105
1483
|
*
|
|
1484
|
+
* @remarks
|
|
1485
|
+
* Enables a horizontal separator beneath this row when true. Defaults to false.
|
|
1486
|
+
*
|
|
1106
1487
|
* @defaultValue false
|
|
1107
1488
|
*/
|
|
1108
1489
|
withDivider;
|
|
@@ -1110,7 +1491,11 @@ export class LabelValueElementClass extends BaseUiElement {
|
|
|
1110
1491
|
* Constructs a new `LabelValueElementClass` instance.
|
|
1111
1492
|
*
|
|
1112
1493
|
* @param label - Key or descriptive label displayed muted on the left
|
|
1494
|
+
|
|
1495
|
+
Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
|
|
1113
1496
|
* @param value - Rendered value element on the right
|
|
1497
|
+
|
|
1498
|
+
Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
|
|
1114
1499
|
* @param options - Optional component settings. (withDivider (defaults to `false`)).
|
|
1115
1500
|
*/
|
|
1116
1501
|
constructor(label, value, options) {
|
|
@@ -1124,22 +1509,38 @@ export class LabelValueElementClass extends BaseUiElement {
|
|
|
1124
1509
|
* Class implementation of the `TableColumn` interface.
|
|
1125
1510
|
*
|
|
1126
1511
|
* @remarks
|
|
1127
|
-
*
|
|
1512
|
+
* Describes one table column and its visual sizing. When columns are supplied, their order corresponds to the position of each cell in a row.
|
|
1128
1513
|
*/
|
|
1129
1514
|
export class TableColumnClass extends ViewKitNode {
|
|
1130
|
-
/**
|
|
1515
|
+
/**
|
|
1516
|
+
* Display header text
|
|
1517
|
+
*
|
|
1518
|
+
* @remarks
|
|
1519
|
+
* Optional header shown above values in this column. Omit when the table has no header row.
|
|
1520
|
+
*/
|
|
1131
1521
|
header;
|
|
1132
1522
|
/**
|
|
1133
1523
|
* Text horizontal alignment
|
|
1134
1524
|
*
|
|
1525
|
+
* @remarks
|
|
1526
|
+
* Horizontal alignment applied to cell content in the column. Defaults to left.
|
|
1527
|
+
*
|
|
1135
1528
|
* @defaultValue TableColumnAlign.left
|
|
1136
1529
|
*/
|
|
1137
1530
|
align;
|
|
1138
|
-
/**
|
|
1531
|
+
/**
|
|
1532
|
+
* Width percentage (1-100)
|
|
1533
|
+
*
|
|
1534
|
+
* @remarks
|
|
1535
|
+
* Column width percentage used with widthMode. Explicit values are constrained to 1 through 100.
|
|
1536
|
+
*/
|
|
1139
1537
|
width;
|
|
1140
1538
|
/**
|
|
1141
1539
|
* Sizing mode for the provided width
|
|
1142
1540
|
*
|
|
1541
|
+
* @remarks
|
|
1542
|
+
* Determines whether width is a fixed percentage allocation or an upper bound. Defaults to fixed.
|
|
1543
|
+
*
|
|
1143
1544
|
* @defaultValue TableColumnWidthMode.fixed
|
|
1144
1545
|
*/
|
|
1145
1546
|
widthMode;
|
|
@@ -1160,15 +1561,22 @@ export class TableColumnClass extends ViewKitNode {
|
|
|
1160
1561
|
* Class implementation of the `TableRow` interface.
|
|
1161
1562
|
*
|
|
1162
1563
|
* @remarks
|
|
1163
|
-
*
|
|
1564
|
+
* 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.
|
|
1164
1565
|
*/
|
|
1165
1566
|
export class TableRowClass extends ViewKitNode {
|
|
1166
|
-
/**
|
|
1567
|
+
/**
|
|
1568
|
+
* Array of cell values corresponding to table columns
|
|
1569
|
+
*
|
|
1570
|
+
* @remarks
|
|
1571
|
+
* Ordered contents for this row. Each cell is a UiElement so values can use the same primitive and layout renderers as other ViewKit content.
|
|
1572
|
+
*/
|
|
1167
1573
|
cells;
|
|
1168
1574
|
/**
|
|
1169
1575
|
* Constructs a new `TableRowClass` instance.
|
|
1170
1576
|
*
|
|
1171
1577
|
* @param cells - Array of cell values corresponding to table columns
|
|
1578
|
+
|
|
1579
|
+
Ordered contents for this row. Each cell is a UiElement so values can use the same primitive and layout renderers as other ViewKit content.
|
|
1172
1580
|
*/
|
|
1173
1581
|
constructor(cells) {
|
|
1174
1582
|
super();
|
|
@@ -1179,8 +1587,7 @@ export class TableRowClass extends ViewKitNode {
|
|
|
1179
1587
|
* Class implementation of the `TableElement` interface.
|
|
1180
1588
|
*
|
|
1181
1589
|
* @remarks
|
|
1182
|
-
*
|
|
1183
|
-
* Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
|
|
1590
|
+
* 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.
|
|
1184
1591
|
*/
|
|
1185
1592
|
export class TableElementClass extends BaseUiElement {
|
|
1186
1593
|
/**
|
|
@@ -1189,32 +1596,53 @@ export class TableElementClass extends BaseUiElement {
|
|
|
1189
1596
|
* @defaultValue "table"
|
|
1190
1597
|
*/
|
|
1191
1598
|
type = "table";
|
|
1192
|
-
/**
|
|
1599
|
+
/**
|
|
1600
|
+
* Tabular data rows
|
|
1601
|
+
*
|
|
1602
|
+
* @remarks
|
|
1603
|
+
* Ordered table rows. Each row's cells correspond positionally to the declared columns.
|
|
1604
|
+
*/
|
|
1193
1605
|
rows;
|
|
1194
1606
|
/**
|
|
1195
1607
|
* Whether to render alternating row background colors
|
|
1196
1608
|
*
|
|
1609
|
+
* @remarks
|
|
1610
|
+
* Enables alternating backgrounds across successive rows to improve scanability. Defaults to false.
|
|
1611
|
+
*
|
|
1197
1612
|
* @defaultValue false
|
|
1198
1613
|
*/
|
|
1199
1614
|
isStriped;
|
|
1200
1615
|
/**
|
|
1201
1616
|
* Whether to render vertical column separators
|
|
1202
1617
|
*
|
|
1618
|
+
* @remarks
|
|
1619
|
+
* Adds vertical dividers between columns when true. Defaults to false.
|
|
1620
|
+
*
|
|
1203
1621
|
* @defaultValue false
|
|
1204
1622
|
*/
|
|
1205
1623
|
withColumnSeparators;
|
|
1206
1624
|
/**
|
|
1207
1625
|
* Whether to render horizontal row separators
|
|
1208
1626
|
*
|
|
1627
|
+
* @remarks
|
|
1628
|
+
* Adds horizontal dividers between rows when true. Defaults to false.
|
|
1629
|
+
*
|
|
1209
1630
|
* @defaultValue false
|
|
1210
1631
|
*/
|
|
1211
1632
|
withRowSeparators;
|
|
1212
|
-
/**
|
|
1633
|
+
/**
|
|
1634
|
+
* Optional explicit column definitions
|
|
1635
|
+
*
|
|
1636
|
+
* @remarks
|
|
1637
|
+
* Optional ordered column metadata defining headers, alignment, and width. When omitted, the renderer may infer a basic layout from row cells.
|
|
1638
|
+
*/
|
|
1213
1639
|
columns;
|
|
1214
1640
|
/**
|
|
1215
1641
|
* Constructs a new `TableElementClass` instance.
|
|
1216
1642
|
*
|
|
1217
1643
|
* @param rows - Tabular data rows
|
|
1644
|
+
|
|
1645
|
+
Ordered table rows. Each row's cells correspond positionally to the declared columns.
|
|
1218
1646
|
* @param options - Optional component settings. (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
|
|
1219
1647
|
*/
|
|
1220
1648
|
constructor(rows, options) {
|
|
@@ -1230,19 +1658,36 @@ export class TableElementClass extends BaseUiElement {
|
|
|
1230
1658
|
* Class implementation of the `RepeatingGroupEntry` interface.
|
|
1231
1659
|
*
|
|
1232
1660
|
* @remarks
|
|
1233
|
-
*
|
|
1661
|
+
* 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.
|
|
1234
1662
|
*/
|
|
1235
1663
|
export class RepeatingGroupEntryClass extends ViewKitNode {
|
|
1236
|
-
/**
|
|
1664
|
+
/**
|
|
1665
|
+
* Entry label
|
|
1666
|
+
*
|
|
1667
|
+
* @remarks
|
|
1668
|
+
* Short label identifying this entry within the repeated group.
|
|
1669
|
+
*/
|
|
1237
1670
|
label;
|
|
1238
|
-
/**
|
|
1671
|
+
/**
|
|
1672
|
+
* Primary entry value or nested elements
|
|
1673
|
+
*
|
|
1674
|
+
* @remarks
|
|
1675
|
+
* Optional primary visual value for a compact entry. Use elements for a multi-part structured entry.
|
|
1676
|
+
*/
|
|
1239
1677
|
value;
|
|
1240
|
-
/**
|
|
1678
|
+
/**
|
|
1679
|
+
* Nested elements for structured entries
|
|
1680
|
+
*
|
|
1681
|
+
* @remarks
|
|
1682
|
+
* Optional ordered content for entries that require more than one value element.
|
|
1683
|
+
*/
|
|
1241
1684
|
elements;
|
|
1242
1685
|
/**
|
|
1243
1686
|
* Constructs a new `RepeatingGroupEntryClass` instance.
|
|
1244
1687
|
*
|
|
1245
1688
|
* @param label - Entry label
|
|
1689
|
+
|
|
1690
|
+
Short label identifying this entry within the repeated group.
|
|
1246
1691
|
* @param options - Optional component settings. (value, elements).
|
|
1247
1692
|
*/
|
|
1248
1693
|
constructor(label, options) {
|
|
@@ -1256,7 +1701,7 @@ export class RepeatingGroupEntryClass extends ViewKitNode {
|
|
|
1256
1701
|
* Class implementation of the `RepeatingGroupElement` interface.
|
|
1257
1702
|
*
|
|
1258
1703
|
* @remarks
|
|
1259
|
-
*
|
|
1704
|
+
* 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.
|
|
1260
1705
|
*/
|
|
1261
1706
|
export class RepeatingGroupElementClass extends BaseUiElement {
|
|
1262
1707
|
/**
|
|
@@ -1265,14 +1710,26 @@ export class RepeatingGroupElementClass extends BaseUiElement {
|
|
|
1265
1710
|
* @defaultValue "repeating-group"
|
|
1266
1711
|
*/
|
|
1267
1712
|
type = "repeating-group";
|
|
1268
|
-
/**
|
|
1713
|
+
/**
|
|
1714
|
+
* List of repeated entry records
|
|
1715
|
+
*
|
|
1716
|
+
* @remarks
|
|
1717
|
+
* Entries in display order. Each entry supplies its own label and content.
|
|
1718
|
+
*/
|
|
1269
1719
|
entries;
|
|
1270
|
-
/**
|
|
1720
|
+
/**
|
|
1721
|
+
* Optional section header for the group
|
|
1722
|
+
*
|
|
1723
|
+
* @remarks
|
|
1724
|
+
* Heading displayed for the repeated section, separate from the labels of individual entries.
|
|
1725
|
+
*/
|
|
1271
1726
|
title;
|
|
1272
1727
|
/**
|
|
1273
1728
|
* Constructs a new `RepeatingGroupElementClass` instance.
|
|
1274
1729
|
*
|
|
1275
1730
|
* @param entries - List of repeated entry records
|
|
1731
|
+
|
|
1732
|
+
Entries in display order. Each entry supplies its own label and content.
|
|
1276
1733
|
* @param options - Optional component settings. (title).
|
|
1277
1734
|
*/
|
|
1278
1735
|
constructor(entries, options) {
|
|
@@ -1285,7 +1742,7 @@ export class RepeatingGroupElementClass extends BaseUiElement {
|
|
|
1285
1742
|
* Class implementation of the `CollapsibleGroupElement` interface.
|
|
1286
1743
|
*
|
|
1287
1744
|
* @remarks
|
|
1288
|
-
*
|
|
1745
|
+
* 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.
|
|
1289
1746
|
*/
|
|
1290
1747
|
export class CollapsibleGroupElementClass extends BaseUiElement {
|
|
1291
1748
|
/**
|
|
@@ -1294,15 +1751,33 @@ export class CollapsibleGroupElementClass extends BaseUiElement {
|
|
|
1294
1751
|
* @defaultValue "collapsible-group"
|
|
1295
1752
|
*/
|
|
1296
1753
|
type = "collapsible-group";
|
|
1297
|
-
/**
|
|
1754
|
+
/**
|
|
1755
|
+
* Group title (e.g. "Show specimen details")
|
|
1756
|
+
*
|
|
1757
|
+
* @remarks
|
|
1758
|
+
* Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
|
|
1759
|
+
*/
|
|
1298
1760
|
title;
|
|
1299
|
-
/**
|
|
1761
|
+
/**
|
|
1762
|
+
* Nested content elements revealed when expanded
|
|
1763
|
+
*
|
|
1764
|
+
* @remarks
|
|
1765
|
+
* Ordered child elements made visible by expanding the group.
|
|
1766
|
+
*/
|
|
1300
1767
|
elements;
|
|
1301
|
-
/**
|
|
1768
|
+
/**
|
|
1769
|
+
* Secondary summary indicator (e.g. "2 neutral values")
|
|
1770
|
+
*
|
|
1771
|
+
* @remarks
|
|
1772
|
+
* Compact contextual text shown alongside the title while the group is collapsed or expanded. It does not replace the nested content.
|
|
1773
|
+
*/
|
|
1302
1774
|
summary;
|
|
1303
1775
|
/**
|
|
1304
1776
|
* Whether the disclosure is open/expanded by default
|
|
1305
1777
|
*
|
|
1778
|
+
* @remarks
|
|
1779
|
+
* Initial expanded state requested by the data. Defaults to false; subsequent interaction is managed by the client.
|
|
1780
|
+
*
|
|
1306
1781
|
* @defaultValue false
|
|
1307
1782
|
*/
|
|
1308
1783
|
defaultExpanded;
|
|
@@ -1310,7 +1785,11 @@ export class CollapsibleGroupElementClass extends BaseUiElement {
|
|
|
1310
1785
|
* Constructs a new `CollapsibleGroupElementClass` instance.
|
|
1311
1786
|
*
|
|
1312
1787
|
* @param title - Group title (e.g. "Show specimen details")
|
|
1788
|
+
|
|
1789
|
+
Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
|
|
1313
1790
|
* @param elements - Nested content elements revealed when expanded
|
|
1791
|
+
|
|
1792
|
+
Ordered child elements made visible by expanding the group.
|
|
1314
1793
|
* @param options - Optional component settings. (summary, defaultExpanded (defaults to `false`)).
|
|
1315
1794
|
*/
|
|
1316
1795
|
constructor(title, elements, options) {
|
|
@@ -1325,7 +1804,7 @@ export class CollapsibleGroupElementClass extends BaseUiElement {
|
|
|
1325
1804
|
* Class implementation of the `DividerElement` interface.
|
|
1326
1805
|
*
|
|
1327
1806
|
* @remarks
|
|
1328
|
-
*
|
|
1807
|
+
* 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.
|
|
1329
1808
|
*/
|
|
1330
1809
|
export class DividerElementClass extends BaseUiElement {
|
|
1331
1810
|
/**
|
|
@@ -1337,6 +1816,9 @@ export class DividerElementClass extends BaseUiElement {
|
|
|
1337
1816
|
/**
|
|
1338
1817
|
* Line styling
|
|
1339
1818
|
*
|
|
1819
|
+
* @remarks
|
|
1820
|
+
* Visual stroke treatment for the separator. Defaults to a subtle hairline.
|
|
1821
|
+
*
|
|
1340
1822
|
* @defaultValue DividerStyle.hairline
|
|
1341
1823
|
*/
|
|
1342
1824
|
style;
|
|
@@ -1354,12 +1836,15 @@ export class DividerElementClass extends BaseUiElement {
|
|
|
1354
1836
|
* Class implementation of the `Envelop` interface.
|
|
1355
1837
|
*
|
|
1356
1838
|
* @remarks
|
|
1357
|
-
*
|
|
1839
|
+
* All root ViewKit documents extend this envelope so consumers can identify the schema contract version before processing the root content.
|
|
1358
1840
|
*/
|
|
1359
1841
|
export class EnvelopClass extends ViewKitNode {
|
|
1360
1842
|
/**
|
|
1361
1843
|
* Schema specification version
|
|
1362
1844
|
*
|
|
1845
|
+
* @remarks
|
|
1846
|
+
* Version of the ViewKit envelope contract. It is a literal value and should be preserved when serializing or forwarding a document.
|
|
1847
|
+
*
|
|
1363
1848
|
* @defaultValue "1.0"
|
|
1364
1849
|
*/
|
|
1365
1850
|
schemaVersion;
|
|
@@ -1377,14 +1862,22 @@ export class EnvelopClass extends ViewKitNode {
|
|
|
1377
1862
|
* Class implementation of the `UiContainer` interface.
|
|
1378
1863
|
*
|
|
1379
1864
|
* @remarks
|
|
1380
|
-
*
|
|
1865
|
+
* 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.
|
|
1381
1866
|
*/
|
|
1382
1867
|
export class UiContainerClass extends ViewKitNode {
|
|
1383
|
-
/**
|
|
1868
|
+
/**
|
|
1869
|
+
* Ordered list of visual elements, structures, and content
|
|
1870
|
+
*
|
|
1871
|
+
* @remarks
|
|
1872
|
+
* Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
|
|
1873
|
+
*/
|
|
1384
1874
|
elements;
|
|
1385
1875
|
/**
|
|
1386
1876
|
* Schema specification version
|
|
1387
1877
|
*
|
|
1878
|
+
* @remarks
|
|
1879
|
+
* Version of the ViewKit envelope contract. It is a literal value and should be preserved when serializing or forwarding a document.
|
|
1880
|
+
*
|
|
1388
1881
|
* @defaultValue "1.0"
|
|
1389
1882
|
*/
|
|
1390
1883
|
schemaVersion;
|
|
@@ -1392,6 +1885,8 @@ export class UiContainerClass extends ViewKitNode {
|
|
|
1392
1885
|
* Constructs a new `UiContainerClass` instance.
|
|
1393
1886
|
*
|
|
1394
1887
|
* @param elements - Ordered list of visual elements, structures, and content
|
|
1888
|
+
|
|
1889
|
+
Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
|
|
1395
1890
|
* @param options - Optional component settings. (schemaVersion (defaults to `1.0`)).
|
|
1396
1891
|
*/
|
|
1397
1892
|
constructor(elements, options) {
|
|
@@ -1404,21 +1899,43 @@ export class UiContainerClass extends ViewKitNode {
|
|
|
1404
1899
|
* Class implementation of the `UiCard` interface.
|
|
1405
1900
|
*
|
|
1406
1901
|
* @remarks
|
|
1407
|
-
*
|
|
1408
|
-
* Represents a complete feature card rendered inside the 360px panel.
|
|
1902
|
+
* 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.
|
|
1409
1903
|
*/
|
|
1410
1904
|
export class UiCardClass extends ViewKitNode {
|
|
1411
|
-
/**
|
|
1905
|
+
/**
|
|
1906
|
+
* Human-readable feature title displayed in the card header
|
|
1907
|
+
*
|
|
1908
|
+
* @remarks
|
|
1909
|
+
* Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
|
|
1910
|
+
*/
|
|
1412
1911
|
title;
|
|
1413
|
-
/**
|
|
1912
|
+
/**
|
|
1913
|
+
* Ordered list of visual elements, structures, and content
|
|
1914
|
+
*
|
|
1915
|
+
* @remarks
|
|
1916
|
+
* Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
|
|
1917
|
+
*/
|
|
1414
1918
|
elements;
|
|
1415
|
-
/**
|
|
1919
|
+
/**
|
|
1920
|
+
* Optional neutral subtitle / description for the feature
|
|
1921
|
+
*
|
|
1922
|
+
* @remarks
|
|
1923
|
+
* Brief secondary context shown with the title. Use the content elements for detailed information rather than placing an entire report in this field.
|
|
1924
|
+
*/
|
|
1416
1925
|
description;
|
|
1417
|
-
/**
|
|
1926
|
+
/**
|
|
1927
|
+
* Optional card action buttons rendered at the base of the feature card
|
|
1928
|
+
*
|
|
1929
|
+
* @remarks
|
|
1930
|
+
* 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.
|
|
1931
|
+
*/
|
|
1418
1932
|
actions;
|
|
1419
1933
|
/**
|
|
1420
1934
|
* Schema specification version
|
|
1421
1935
|
*
|
|
1936
|
+
* @remarks
|
|
1937
|
+
* Version of the ViewKit envelope contract. It is a literal value and should be preserved when serializing or forwarding a document.
|
|
1938
|
+
*
|
|
1422
1939
|
* @defaultValue "1.0"
|
|
1423
1940
|
*/
|
|
1424
1941
|
schemaVersion;
|
|
@@ -1426,7 +1943,11 @@ export class UiCardClass extends ViewKitNode {
|
|
|
1426
1943
|
* Constructs a new `UiCardClass` instance.
|
|
1427
1944
|
*
|
|
1428
1945
|
* @param title - Human-readable feature title displayed in the card header
|
|
1946
|
+
|
|
1947
|
+
Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
|
|
1429
1948
|
* @param elements - Ordered list of visual elements, structures, and content
|
|
1949
|
+
|
|
1950
|
+
Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
|
|
1430
1951
|
* @param options - Optional component settings. (description, actions, schemaVersion (defaults to `1.0`)).
|
|
1431
1952
|
*/
|
|
1432
1953
|
constructor(title, elements, options) {
|
|
@@ -1442,7 +1963,7 @@ export class UiCardClass extends ViewKitNode {
|
|
|
1442
1963
|
* Fluent builder for constructing strongly-typed `UiContainer` instances.
|
|
1443
1964
|
*
|
|
1444
1965
|
* @remarks
|
|
1445
|
-
*
|
|
1966
|
+
* 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.
|
|
1446
1967
|
*/
|
|
1447
1968
|
export class UiContainerBuilder {
|
|
1448
1969
|
_elements = [];
|
|
@@ -1473,10 +1994,11 @@ export class UiContainerBuilder {
|
|
|
1473
1994
|
* Appends a `StringElement` component.
|
|
1474
1995
|
*
|
|
1475
1996
|
* @remarks
|
|
1476
|
-
*
|
|
1477
|
-
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
1997
|
+
* 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.
|
|
1478
1998
|
*
|
|
1479
1999
|
* @param value - Text value
|
|
2000
|
+
|
|
2001
|
+
Text to render. Supply plain text; this field is not a Markdown or HTML document.
|
|
1480
2002
|
* @param options - Optional component settings (representation (defaults to `plain`), modifiers).
|
|
1481
2003
|
* @returns This builder instance for method chaining.
|
|
1482
2004
|
*/
|
|
@@ -1487,10 +2009,11 @@ export class UiContainerBuilder {
|
|
|
1487
2009
|
* Appends a `StringsElement` component.
|
|
1488
2010
|
*
|
|
1489
2011
|
* @remarks
|
|
1490
|
-
*
|
|
1491
|
-
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
2012
|
+
* 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.
|
|
1492
2013
|
*
|
|
1493
2014
|
* @param values - Array of string values
|
|
2015
|
+
|
|
2016
|
+
Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
|
|
1494
2017
|
* @param options - Optional component settings (representation (defaults to `plain`), separator, modifiers).
|
|
1495
2018
|
* @returns This builder instance for method chaining.
|
|
1496
2019
|
*/
|
|
@@ -1501,9 +2024,11 @@ export class UiContainerBuilder {
|
|
|
1501
2024
|
* Appends a `StringCodeElement` component.
|
|
1502
2025
|
*
|
|
1503
2026
|
* @remarks
|
|
1504
|
-
*
|
|
2027
|
+
* 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.
|
|
1505
2028
|
*
|
|
1506
2029
|
* @param value - Text value
|
|
2030
|
+
|
|
2031
|
+
Code or text snippet to display. Include any desired line breaks in this string.
|
|
1507
2032
|
* @param options - Optional component settings (language, modifiers).
|
|
1508
2033
|
* @returns This builder instance for method chaining.
|
|
1509
2034
|
*/
|
|
@@ -1514,9 +2039,11 @@ export class UiContainerBuilder {
|
|
|
1514
2039
|
* Appends a `XmlElement` component.
|
|
1515
2040
|
*
|
|
1516
2041
|
* @remarks
|
|
1517
|
-
* XML
|
|
2042
|
+
* Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
|
|
1518
2043
|
*
|
|
1519
2044
|
* @param value - XML content value
|
|
2045
|
+
|
|
2046
|
+
XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
|
|
1520
2047
|
* @param options - Optional component settings (modifiers).
|
|
1521
2048
|
* @returns This builder instance for method chaining.
|
|
1522
2049
|
*/
|
|
@@ -1527,9 +2054,11 @@ export class UiContainerBuilder {
|
|
|
1527
2054
|
* Appends a `JsonElement` component.
|
|
1528
2055
|
*
|
|
1529
2056
|
* @remarks
|
|
1530
|
-
* JSON
|
|
2057
|
+
* 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.
|
|
1531
2058
|
*
|
|
1532
2059
|
* @param value - JSON content value
|
|
2060
|
+
|
|
2061
|
+
Serialized JSON text to render. No parsing or schema validation is implied by this element.
|
|
1533
2062
|
* @param options - Optional component settings (modifiers).
|
|
1534
2063
|
* @returns This builder instance for method chaining.
|
|
1535
2064
|
*/
|
|
@@ -1540,9 +2069,11 @@ export class UiContainerBuilder {
|
|
|
1540
2069
|
* Appends a `StringUrlElement` component.
|
|
1541
2070
|
*
|
|
1542
2071
|
* @remarks
|
|
1543
|
-
*
|
|
2072
|
+
* 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.
|
|
1544
2073
|
*
|
|
1545
2074
|
* @param value - Target URL or navigation destination
|
|
2075
|
+
|
|
2076
|
+
Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
|
|
1546
2077
|
* @param options - Optional component settings (label, modifiers).
|
|
1547
2078
|
* @returns This builder instance for method chaining.
|
|
1548
2079
|
*/
|
|
@@ -1553,9 +2084,11 @@ export class UiContainerBuilder {
|
|
|
1553
2084
|
* Appends a `IdentifierElement` component.
|
|
1554
2085
|
*
|
|
1555
2086
|
* @remarks
|
|
1556
|
-
*
|
|
2087
|
+
* 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.
|
|
1557
2088
|
*
|
|
1558
2089
|
* @param value - Identifier string value
|
|
2090
|
+
|
|
2091
|
+
Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
|
|
1559
2092
|
* @param options - Optional component settings (modifiers).
|
|
1560
2093
|
* @returns This builder instance for method chaining.
|
|
1561
2094
|
*/
|
|
@@ -1566,9 +2099,11 @@ export class UiContainerBuilder {
|
|
|
1566
2099
|
* Appends a `RatioElement` component.
|
|
1567
2100
|
*
|
|
1568
2101
|
* @remarks
|
|
1569
|
-
*
|
|
2102
|
+
* 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.
|
|
1570
2103
|
*
|
|
1571
2104
|
* @param value - Aspect ratio numerical expression
|
|
2105
|
+
|
|
2106
|
+
Numeric ratio value used by the renderer to produce an aspect-ratio display.
|
|
1572
2107
|
* @param options - Optional component settings (modifiers).
|
|
1573
2108
|
* @returns This builder instance for method chaining.
|
|
1574
2109
|
*/
|
|
@@ -1579,10 +2114,14 @@ export class UiContainerBuilder {
|
|
|
1579
2114
|
* Appends a `DimensionsElement` component.
|
|
1580
2115
|
*
|
|
1581
2116
|
* @remarks
|
|
1582
|
-
*
|
|
2117
|
+
* 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.
|
|
1583
2118
|
*
|
|
1584
2119
|
* @param width - Width in pixels
|
|
2120
|
+
|
|
2121
|
+
Horizontal pixel count. Values below one are rejected by the schema constraint.
|
|
1585
2122
|
* @param height - Height in pixels
|
|
2123
|
+
|
|
2124
|
+
Vertical pixel count. Values below one are rejected by the schema constraint.
|
|
1586
2125
|
* @param options - Optional component settings (modifiers).
|
|
1587
2126
|
* @returns This builder instance for method chaining.
|
|
1588
2127
|
*/
|
|
@@ -1593,9 +2132,11 @@ export class UiContainerBuilder {
|
|
|
1593
2132
|
* Appends a `ColourElement` component.
|
|
1594
2133
|
*
|
|
1595
2134
|
* @remarks
|
|
1596
|
-
*
|
|
2135
|
+
* 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.
|
|
1597
2136
|
*
|
|
1598
2137
|
* @param value - Hexadecimal color code
|
|
2138
|
+
|
|
2139
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
1599
2140
|
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
1600
2141
|
* @returns This builder instance for method chaining.
|
|
1601
2142
|
*/
|
|
@@ -1606,9 +2147,11 @@ export class UiContainerBuilder {
|
|
|
1606
2147
|
* Appends a `ColourElement` component.
|
|
1607
2148
|
*
|
|
1608
2149
|
* @remarks
|
|
1609
|
-
*
|
|
2150
|
+
* 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.
|
|
1610
2151
|
*
|
|
1611
2152
|
* @param value - Hexadecimal color code
|
|
2153
|
+
|
|
2154
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
1612
2155
|
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
1613
2156
|
* @returns This builder instance for method chaining.
|
|
1614
2157
|
*/
|
|
@@ -1619,9 +2162,11 @@ export class UiContainerBuilder {
|
|
|
1619
2162
|
* Appends a `NumberUnboundedElement` component.
|
|
1620
2163
|
*
|
|
1621
2164
|
* @remarks
|
|
1622
|
-
*
|
|
2165
|
+
* 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.
|
|
1623
2166
|
*
|
|
1624
2167
|
* @param value - Numeric value
|
|
2168
|
+
|
|
2169
|
+
Number to display. Its meaning and any valid range are defined by the producing feature.
|
|
1625
2170
|
* @param options - Optional component settings (unit, modifiers).
|
|
1626
2171
|
* @returns This builder instance for method chaining.
|
|
1627
2172
|
*/
|
|
@@ -1632,9 +2177,11 @@ export class UiContainerBuilder {
|
|
|
1632
2177
|
* Appends a `NumberBoundedStarsElement` component.
|
|
1633
2178
|
*
|
|
1634
2179
|
* @remarks
|
|
1635
|
-
*
|
|
2180
|
+
* 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.
|
|
1636
2181
|
*
|
|
1637
2182
|
* @param value - Numeric rating score
|
|
2183
|
+
|
|
2184
|
+
Score represented by the filled portion of the star display.
|
|
1638
2185
|
* @param options - Optional component settings (maximum, modifiers).
|
|
1639
2186
|
* @returns This builder instance for method chaining.
|
|
1640
2187
|
*/
|
|
@@ -1645,9 +2192,11 @@ export class UiContainerBuilder {
|
|
|
1645
2192
|
* Appends a `NumberBoundedStarsElement` component.
|
|
1646
2193
|
*
|
|
1647
2194
|
* @remarks
|
|
1648
|
-
*
|
|
2195
|
+
* 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.
|
|
1649
2196
|
*
|
|
1650
2197
|
* @param value - Numeric rating score
|
|
2198
|
+
|
|
2199
|
+
Score represented by the filled portion of the star display.
|
|
1651
2200
|
* @param options - Optional component settings (maximum, modifiers).
|
|
1652
2201
|
* @returns This builder instance for method chaining.
|
|
1653
2202
|
*/
|
|
@@ -1658,9 +2207,11 @@ export class UiContainerBuilder {
|
|
|
1658
2207
|
* Appends a `NumberBoundedMeterElement` component.
|
|
1659
2208
|
*
|
|
1660
2209
|
* @remarks
|
|
1661
|
-
*
|
|
2210
|
+
* 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.
|
|
1662
2211
|
*
|
|
1663
2212
|
* @param value - Numeric value
|
|
2213
|
+
|
|
2214
|
+
Current measurement or score represented by the meter.
|
|
1664
2215
|
* @param options - Optional component settings (minimum, maximum, label, unit, modifiers).
|
|
1665
2216
|
* @returns This builder instance for method chaining.
|
|
1666
2217
|
*/
|
|
@@ -1671,9 +2222,11 @@ export class UiContainerBuilder {
|
|
|
1671
2222
|
* Appends a `NumberBoundedMeterElement` component.
|
|
1672
2223
|
*
|
|
1673
2224
|
* @remarks
|
|
1674
|
-
*
|
|
2225
|
+
* 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.
|
|
1675
2226
|
*
|
|
1676
2227
|
* @param value - Numeric value
|
|
2228
|
+
|
|
2229
|
+
Current measurement or score represented by the meter.
|
|
1677
2230
|
* @param options - Optional component settings (minimum, maximum, label, unit, modifiers).
|
|
1678
2231
|
* @returns This builder instance for method chaining.
|
|
1679
2232
|
*/
|
|
@@ -1684,10 +2237,11 @@ export class UiContainerBuilder {
|
|
|
1684
2237
|
* Appends a `BooleanElement` component.
|
|
1685
2238
|
*
|
|
1686
2239
|
* @remarks
|
|
1687
|
-
*
|
|
1688
|
-
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
2240
|
+
* 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.
|
|
1689
2241
|
*
|
|
1690
2242
|
* @param value - Boolean state value
|
|
2243
|
+
|
|
2244
|
+
State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
|
|
1691
2245
|
* @param options - Optional component settings (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
1692
2246
|
* @returns This builder instance for method chaining.
|
|
1693
2247
|
*/
|
|
@@ -1698,9 +2252,11 @@ export class UiContainerBuilder {
|
|
|
1698
2252
|
* Appends a `TimestampElement` component.
|
|
1699
2253
|
*
|
|
1700
2254
|
* @remarks
|
|
1701
|
-
*
|
|
2255
|
+
* 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.
|
|
1702
2256
|
*
|
|
1703
2257
|
* @param value - The timestamp in milliseconds
|
|
2258
|
+
|
|
2259
|
+
Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
|
|
1704
2260
|
* @param options - Optional component settings (format (defaults to `datetime`), modifiers).
|
|
1705
2261
|
* @returns This builder instance for method chaining.
|
|
1706
2262
|
*/
|
|
@@ -1711,9 +2267,11 @@ export class UiContainerBuilder {
|
|
|
1711
2267
|
* Appends a `ImageReferenceElement` component.
|
|
1712
2268
|
*
|
|
1713
2269
|
* @remarks
|
|
1714
|
-
*
|
|
2270
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
1715
2271
|
*
|
|
1716
2272
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
2273
|
+
|
|
2274
|
+
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.
|
|
1717
2275
|
* @param options - Optional component settings (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
1718
2276
|
* @returns This builder instance for method chaining.
|
|
1719
2277
|
*/
|
|
@@ -1724,9 +2282,11 @@ export class UiContainerBuilder {
|
|
|
1724
2282
|
* Appends a `ImageReferenceElement` component.
|
|
1725
2283
|
*
|
|
1726
2284
|
* @remarks
|
|
1727
|
-
*
|
|
2285
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
1728
2286
|
*
|
|
1729
2287
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
2288
|
+
|
|
2289
|
+
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.
|
|
1730
2290
|
* @param options - Optional component settings (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
1731
2291
|
* @returns This builder instance for method chaining.
|
|
1732
2292
|
*/
|
|
@@ -1737,9 +2297,11 @@ export class UiContainerBuilder {
|
|
|
1737
2297
|
* Appends a `MarkdownBlockElement` component.
|
|
1738
2298
|
*
|
|
1739
2299
|
* @remarks
|
|
1740
|
-
*
|
|
2300
|
+
* 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.
|
|
1741
2301
|
*
|
|
1742
2302
|
* @param content - Raw Markdown markup content
|
|
2303
|
+
|
|
2304
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
1743
2305
|
* @param options - Optional component settings (modifiers).
|
|
1744
2306
|
* @returns This builder instance for method chaining.
|
|
1745
2307
|
*/
|
|
@@ -1750,9 +2312,11 @@ export class UiContainerBuilder {
|
|
|
1750
2312
|
* Appends a `MarkdownBlockElement` component.
|
|
1751
2313
|
*
|
|
1752
2314
|
* @remarks
|
|
1753
|
-
*
|
|
2315
|
+
* 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.
|
|
1754
2316
|
*
|
|
1755
2317
|
* @param content - Raw Markdown markup content
|
|
2318
|
+
|
|
2319
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
1756
2320
|
* @param options - Optional component settings (modifiers).
|
|
1757
2321
|
* @returns This builder instance for method chaining.
|
|
1758
2322
|
*/
|
|
@@ -1763,9 +2327,11 @@ export class UiContainerBuilder {
|
|
|
1763
2327
|
* Appends a `HtmlBlockElement` component.
|
|
1764
2328
|
*
|
|
1765
2329
|
* @remarks
|
|
1766
|
-
*
|
|
2330
|
+
* 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.
|
|
1767
2331
|
*
|
|
1768
2332
|
* @param content - Raw HTML markup content
|
|
2333
|
+
|
|
2334
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
1769
2335
|
* @param options - Optional component settings (modifiers).
|
|
1770
2336
|
* @returns This builder instance for method chaining.
|
|
1771
2337
|
*/
|
|
@@ -1776,9 +2342,11 @@ export class UiContainerBuilder {
|
|
|
1776
2342
|
* Appends a `HtmlBlockElement` component.
|
|
1777
2343
|
*
|
|
1778
2344
|
* @remarks
|
|
1779
|
-
*
|
|
2345
|
+
* 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.
|
|
1780
2346
|
*
|
|
1781
2347
|
* @param content - Raw HTML markup content
|
|
2348
|
+
|
|
2349
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
1782
2350
|
* @param options - Optional component settings (modifiers).
|
|
1783
2351
|
* @returns This builder instance for method chaining.
|
|
1784
2352
|
*/
|
|
@@ -1789,9 +2357,11 @@ export class UiContainerBuilder {
|
|
|
1789
2357
|
* Appends a `MultiSlotElement` component.
|
|
1790
2358
|
*
|
|
1791
2359
|
* @remarks
|
|
1792
|
-
*
|
|
2360
|
+
* 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.
|
|
1793
2361
|
*
|
|
1794
2362
|
* @param slots - List of slots comprising the row
|
|
2363
|
+
|
|
2364
|
+
Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
|
|
1795
2365
|
* @returns This builder instance for method chaining.
|
|
1796
2366
|
*/
|
|
1797
2367
|
addMultiSlot(slots) {
|
|
@@ -1801,10 +2371,11 @@ export class UiContainerBuilder {
|
|
|
1801
2371
|
* Appends a `FlowingElement` component.
|
|
1802
2372
|
*
|
|
1803
2373
|
* @remarks
|
|
1804
|
-
*
|
|
1805
|
-
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
2374
|
+
* 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.
|
|
1806
2375
|
*
|
|
1807
2376
|
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
2377
|
+
|
|
2378
|
+
Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
|
|
1808
2379
|
* @param options - Optional component settings (separator).
|
|
1809
2380
|
* @returns This builder instance for method chaining.
|
|
1810
2381
|
*/
|
|
@@ -1815,11 +2386,14 @@ export class UiContainerBuilder {
|
|
|
1815
2386
|
* Appends a `LabelValueElement` component.
|
|
1816
2387
|
*
|
|
1817
2388
|
* @remarks
|
|
1818
|
-
*
|
|
1819
|
-
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
2389
|
+
* 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.
|
|
1820
2390
|
*
|
|
1821
2391
|
* @param label - Key or descriptive label displayed muted on the left
|
|
2392
|
+
|
|
2393
|
+
Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
|
|
1822
2394
|
* @param value - Rendered value element on the right
|
|
2395
|
+
|
|
2396
|
+
Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
|
|
1823
2397
|
* @param options - Optional component settings (withDivider (defaults to `false`)).
|
|
1824
2398
|
* @returns This builder instance for method chaining.
|
|
1825
2399
|
*/
|
|
@@ -1830,10 +2404,11 @@ export class UiContainerBuilder {
|
|
|
1830
2404
|
* Appends a `TableElement` component.
|
|
1831
2405
|
*
|
|
1832
2406
|
* @remarks
|
|
1833
|
-
*
|
|
1834
|
-
* Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
|
|
2407
|
+
* 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.
|
|
1835
2408
|
*
|
|
1836
2409
|
* @param rows - Tabular data rows
|
|
2410
|
+
|
|
2411
|
+
Ordered table rows. Each row's cells correspond positionally to the declared columns.
|
|
1837
2412
|
* @param options - Optional component settings (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
|
|
1838
2413
|
* @returns This builder instance for method chaining.
|
|
1839
2414
|
*/
|
|
@@ -1844,9 +2419,11 @@ export class UiContainerBuilder {
|
|
|
1844
2419
|
* Appends a `RepeatingGroupElement` component.
|
|
1845
2420
|
*
|
|
1846
2421
|
* @remarks
|
|
1847
|
-
*
|
|
2422
|
+
* 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.
|
|
1848
2423
|
*
|
|
1849
2424
|
* @param entries - List of repeated entry records
|
|
2425
|
+
|
|
2426
|
+
Entries in display order. Each entry supplies its own label and content.
|
|
1850
2427
|
* @param options - Optional component settings (title).
|
|
1851
2428
|
* @returns This builder instance for method chaining.
|
|
1852
2429
|
*/
|
|
@@ -1857,10 +2434,14 @@ export class UiContainerBuilder {
|
|
|
1857
2434
|
* Appends a `CollapsibleGroupElement` component.
|
|
1858
2435
|
*
|
|
1859
2436
|
* @remarks
|
|
1860
|
-
*
|
|
2437
|
+
* 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.
|
|
1861
2438
|
*
|
|
1862
2439
|
* @param title - Group title (e.g. "Show specimen details")
|
|
2440
|
+
|
|
2441
|
+
Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
|
|
1863
2442
|
* @param elements - Nested content elements revealed when expanded
|
|
2443
|
+
|
|
2444
|
+
Ordered child elements made visible by expanding the group.
|
|
1864
2445
|
* @param options - Optional component settings (summary, defaultExpanded (defaults to `false`)).
|
|
1865
2446
|
* @returns This builder instance for method chaining.
|
|
1866
2447
|
*/
|
|
@@ -1871,7 +2452,7 @@ export class UiContainerBuilder {
|
|
|
1871
2452
|
* Appends a `DividerElement` component.
|
|
1872
2453
|
*
|
|
1873
2454
|
* @remarks
|
|
1874
|
-
*
|
|
2455
|
+
* 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.
|
|
1875
2456
|
*
|
|
1876
2457
|
* @param options - Optional component settings (style (defaults to `hairline`)).
|
|
1877
2458
|
* @returns This builder instance for method chaining.
|
|
@@ -1945,7 +2526,7 @@ export const UiContainer = {
|
|
|
1945
2526
|
* Functional helper to create a `UiContainerClass` instance directly.
|
|
1946
2527
|
*
|
|
1947
2528
|
* @remarks
|
|
1948
|
-
*
|
|
2529
|
+
* 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.
|
|
1949
2530
|
*
|
|
1950
2531
|
* @param options - Optional configuration properties.
|
|
1951
2532
|
* @returns A strongly-typed `UiContainerClass` instance.
|
|
@@ -1957,7 +2538,7 @@ export function createUiContainer(options) {
|
|
|
1957
2538
|
* Parses a JSON string or raw object into a validated `UiContainerClass` instance.
|
|
1958
2539
|
*
|
|
1959
2540
|
* @remarks
|
|
1960
|
-
*
|
|
2541
|
+
* 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.
|
|
1961
2542
|
*
|
|
1962
2543
|
* @param json - JSON string or parsed JavaScript object to validate and hydrate.
|
|
1963
2544
|
* @param withDeepValidation - Whether to recursively validate all nested child entities.
|
|
@@ -1970,8 +2551,7 @@ export function parseUiContainer(json, withDeepValidation = true) {
|
|
|
1970
2551
|
* Fluent builder for constructing strongly-typed `UiCard` instances.
|
|
1971
2552
|
*
|
|
1972
2553
|
* @remarks
|
|
1973
|
-
*
|
|
1974
|
-
* Represents a complete feature card rendered inside the 360px panel.
|
|
2554
|
+
* 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.
|
|
1975
2555
|
*/
|
|
1976
2556
|
export class UiCardBuilder {
|
|
1977
2557
|
_title;
|
|
@@ -1982,6 +2562,8 @@ export class UiCardBuilder {
|
|
|
1982
2562
|
* Initializes a new `UiCardBuilder`.
|
|
1983
2563
|
*
|
|
1984
2564
|
* @param title - Human-readable feature title displayed in the card header
|
|
2565
|
+
|
|
2566
|
+
Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
|
|
1985
2567
|
*/
|
|
1986
2568
|
constructor(title) {
|
|
1987
2569
|
this._title = title;
|
|
@@ -1990,6 +2572,8 @@ export class UiCardBuilder {
|
|
|
1990
2572
|
* Sets the `description` property on this builder.
|
|
1991
2573
|
*
|
|
1992
2574
|
* @param description - Optional neutral subtitle / description for the feature
|
|
2575
|
+
|
|
2576
|
+
Brief secondary context shown with the title. Use the content elements for detailed information rather than placing an entire report in this field.
|
|
1993
2577
|
* @returns This builder instance for method chaining.
|
|
1994
2578
|
*/
|
|
1995
2579
|
description(description) {
|
|
@@ -2040,10 +2624,11 @@ export class UiCardBuilder {
|
|
|
2040
2624
|
* Appends a `StringElement` component.
|
|
2041
2625
|
*
|
|
2042
2626
|
* @remarks
|
|
2043
|
-
*
|
|
2044
|
-
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
2627
|
+
* 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.
|
|
2045
2628
|
*
|
|
2046
2629
|
* @param value - Text value
|
|
2630
|
+
|
|
2631
|
+
Text to render. Supply plain text; this field is not a Markdown or HTML document.
|
|
2047
2632
|
* @param options - Optional component settings (representation (defaults to `plain`), modifiers).
|
|
2048
2633
|
* @returns This builder instance for method chaining.
|
|
2049
2634
|
*/
|
|
@@ -2054,10 +2639,11 @@ export class UiCardBuilder {
|
|
|
2054
2639
|
* Appends a `StringsElement` component.
|
|
2055
2640
|
*
|
|
2056
2641
|
* @remarks
|
|
2057
|
-
*
|
|
2058
|
-
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
2642
|
+
* 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.
|
|
2059
2643
|
*
|
|
2060
2644
|
* @param values - Array of string values
|
|
2645
|
+
|
|
2646
|
+
Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
|
|
2061
2647
|
* @param options - Optional component settings (representation (defaults to `plain`), separator, modifiers).
|
|
2062
2648
|
* @returns This builder instance for method chaining.
|
|
2063
2649
|
*/
|
|
@@ -2068,9 +2654,11 @@ export class UiCardBuilder {
|
|
|
2068
2654
|
* Appends a `StringCodeElement` component.
|
|
2069
2655
|
*
|
|
2070
2656
|
* @remarks
|
|
2071
|
-
*
|
|
2657
|
+
* 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.
|
|
2072
2658
|
*
|
|
2073
2659
|
* @param value - Text value
|
|
2660
|
+
|
|
2661
|
+
Code or text snippet to display. Include any desired line breaks in this string.
|
|
2074
2662
|
* @param options - Optional component settings (language, modifiers).
|
|
2075
2663
|
* @returns This builder instance for method chaining.
|
|
2076
2664
|
*/
|
|
@@ -2081,9 +2669,11 @@ export class UiCardBuilder {
|
|
|
2081
2669
|
* Appends a `XmlElement` component.
|
|
2082
2670
|
*
|
|
2083
2671
|
* @remarks
|
|
2084
|
-
* XML
|
|
2672
|
+
* Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
|
|
2085
2673
|
*
|
|
2086
2674
|
* @param value - XML content value
|
|
2675
|
+
|
|
2676
|
+
XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
|
|
2087
2677
|
* @param options - Optional component settings (modifiers).
|
|
2088
2678
|
* @returns This builder instance for method chaining.
|
|
2089
2679
|
*/
|
|
@@ -2094,9 +2684,11 @@ export class UiCardBuilder {
|
|
|
2094
2684
|
* Appends a `JsonElement` component.
|
|
2095
2685
|
*
|
|
2096
2686
|
* @remarks
|
|
2097
|
-
* JSON
|
|
2687
|
+
* 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.
|
|
2098
2688
|
*
|
|
2099
2689
|
* @param value - JSON content value
|
|
2690
|
+
|
|
2691
|
+
Serialized JSON text to render. No parsing or schema validation is implied by this element.
|
|
2100
2692
|
* @param options - Optional component settings (modifiers).
|
|
2101
2693
|
* @returns This builder instance for method chaining.
|
|
2102
2694
|
*/
|
|
@@ -2107,9 +2699,11 @@ export class UiCardBuilder {
|
|
|
2107
2699
|
* Appends a `StringUrlElement` component.
|
|
2108
2700
|
*
|
|
2109
2701
|
* @remarks
|
|
2110
|
-
*
|
|
2702
|
+
* 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.
|
|
2111
2703
|
*
|
|
2112
2704
|
* @param value - Target URL or navigation destination
|
|
2705
|
+
|
|
2706
|
+
Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
|
|
2113
2707
|
* @param options - Optional component settings (label, modifiers).
|
|
2114
2708
|
* @returns This builder instance for method chaining.
|
|
2115
2709
|
*/
|
|
@@ -2120,9 +2714,11 @@ export class UiCardBuilder {
|
|
|
2120
2714
|
* Appends a `IdentifierElement` component.
|
|
2121
2715
|
*
|
|
2122
2716
|
* @remarks
|
|
2123
|
-
*
|
|
2717
|
+
* 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.
|
|
2124
2718
|
*
|
|
2125
2719
|
* @param value - Identifier string value
|
|
2720
|
+
|
|
2721
|
+
Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
|
|
2126
2722
|
* @param options - Optional component settings (modifiers).
|
|
2127
2723
|
* @returns This builder instance for method chaining.
|
|
2128
2724
|
*/
|
|
@@ -2133,9 +2729,11 @@ export class UiCardBuilder {
|
|
|
2133
2729
|
* Appends a `RatioElement` component.
|
|
2134
2730
|
*
|
|
2135
2731
|
* @remarks
|
|
2136
|
-
*
|
|
2732
|
+
* 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.
|
|
2137
2733
|
*
|
|
2138
2734
|
* @param value - Aspect ratio numerical expression
|
|
2735
|
+
|
|
2736
|
+
Numeric ratio value used by the renderer to produce an aspect-ratio display.
|
|
2139
2737
|
* @param options - Optional component settings (modifiers).
|
|
2140
2738
|
* @returns This builder instance for method chaining.
|
|
2141
2739
|
*/
|
|
@@ -2146,10 +2744,14 @@ export class UiCardBuilder {
|
|
|
2146
2744
|
* Appends a `DimensionsElement` component.
|
|
2147
2745
|
*
|
|
2148
2746
|
* @remarks
|
|
2149
|
-
*
|
|
2747
|
+
* 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.
|
|
2150
2748
|
*
|
|
2151
2749
|
* @param width - Width in pixels
|
|
2750
|
+
|
|
2751
|
+
Horizontal pixel count. Values below one are rejected by the schema constraint.
|
|
2152
2752
|
* @param height - Height in pixels
|
|
2753
|
+
|
|
2754
|
+
Vertical pixel count. Values below one are rejected by the schema constraint.
|
|
2153
2755
|
* @param options - Optional component settings (modifiers).
|
|
2154
2756
|
* @returns This builder instance for method chaining.
|
|
2155
2757
|
*/
|
|
@@ -2160,9 +2762,11 @@ export class UiCardBuilder {
|
|
|
2160
2762
|
* Appends a `ColourElement` component.
|
|
2161
2763
|
*
|
|
2162
2764
|
* @remarks
|
|
2163
|
-
*
|
|
2765
|
+
* 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.
|
|
2164
2766
|
*
|
|
2165
2767
|
* @param value - Hexadecimal color code
|
|
2768
|
+
|
|
2769
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
2166
2770
|
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
2167
2771
|
* @returns This builder instance for method chaining.
|
|
2168
2772
|
*/
|
|
@@ -2173,9 +2777,11 @@ export class UiCardBuilder {
|
|
|
2173
2777
|
* Appends a `ColourElement` component.
|
|
2174
2778
|
*
|
|
2175
2779
|
* @remarks
|
|
2176
|
-
*
|
|
2780
|
+
* 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.
|
|
2177
2781
|
*
|
|
2178
2782
|
* @param value - Hexadecimal color code
|
|
2783
|
+
|
|
2784
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
2179
2785
|
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
2180
2786
|
* @returns This builder instance for method chaining.
|
|
2181
2787
|
*/
|
|
@@ -2186,9 +2792,11 @@ export class UiCardBuilder {
|
|
|
2186
2792
|
* Appends a `NumberUnboundedElement` component.
|
|
2187
2793
|
*
|
|
2188
2794
|
* @remarks
|
|
2189
|
-
*
|
|
2795
|
+
* 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.
|
|
2190
2796
|
*
|
|
2191
2797
|
* @param value - Numeric value
|
|
2798
|
+
|
|
2799
|
+
Number to display. Its meaning and any valid range are defined by the producing feature.
|
|
2192
2800
|
* @param options - Optional component settings (unit, modifiers).
|
|
2193
2801
|
* @returns This builder instance for method chaining.
|
|
2194
2802
|
*/
|
|
@@ -2199,9 +2807,11 @@ export class UiCardBuilder {
|
|
|
2199
2807
|
* Appends a `NumberBoundedStarsElement` component.
|
|
2200
2808
|
*
|
|
2201
2809
|
* @remarks
|
|
2202
|
-
*
|
|
2810
|
+
* 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.
|
|
2203
2811
|
*
|
|
2204
2812
|
* @param value - Numeric rating score
|
|
2813
|
+
|
|
2814
|
+
Score represented by the filled portion of the star display.
|
|
2205
2815
|
* @param options - Optional component settings (maximum, modifiers).
|
|
2206
2816
|
* @returns This builder instance for method chaining.
|
|
2207
2817
|
*/
|
|
@@ -2212,9 +2822,11 @@ export class UiCardBuilder {
|
|
|
2212
2822
|
* Appends a `NumberBoundedStarsElement` component.
|
|
2213
2823
|
*
|
|
2214
2824
|
* @remarks
|
|
2215
|
-
*
|
|
2825
|
+
* 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.
|
|
2216
2826
|
*
|
|
2217
2827
|
* @param value - Numeric rating score
|
|
2828
|
+
|
|
2829
|
+
Score represented by the filled portion of the star display.
|
|
2218
2830
|
* @param options - Optional component settings (maximum, modifiers).
|
|
2219
2831
|
* @returns This builder instance for method chaining.
|
|
2220
2832
|
*/
|
|
@@ -2225,9 +2837,11 @@ export class UiCardBuilder {
|
|
|
2225
2837
|
* Appends a `NumberBoundedMeterElement` component.
|
|
2226
2838
|
*
|
|
2227
2839
|
* @remarks
|
|
2228
|
-
*
|
|
2840
|
+
* 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.
|
|
2229
2841
|
*
|
|
2230
2842
|
* @param value - Numeric value
|
|
2843
|
+
|
|
2844
|
+
Current measurement or score represented by the meter.
|
|
2231
2845
|
* @param options - Optional component settings (minimum, maximum, label, unit, modifiers).
|
|
2232
2846
|
* @returns This builder instance for method chaining.
|
|
2233
2847
|
*/
|
|
@@ -2238,9 +2852,11 @@ export class UiCardBuilder {
|
|
|
2238
2852
|
* Appends a `NumberBoundedMeterElement` component.
|
|
2239
2853
|
*
|
|
2240
2854
|
* @remarks
|
|
2241
|
-
*
|
|
2855
|
+
* 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.
|
|
2242
2856
|
*
|
|
2243
2857
|
* @param value - Numeric value
|
|
2858
|
+
|
|
2859
|
+
Current measurement or score represented by the meter.
|
|
2244
2860
|
* @param options - Optional component settings (minimum, maximum, label, unit, modifiers).
|
|
2245
2861
|
* @returns This builder instance for method chaining.
|
|
2246
2862
|
*/
|
|
@@ -2251,10 +2867,11 @@ export class UiCardBuilder {
|
|
|
2251
2867
|
* Appends a `BooleanElement` component.
|
|
2252
2868
|
*
|
|
2253
2869
|
* @remarks
|
|
2254
|
-
*
|
|
2255
|
-
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
2870
|
+
* 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.
|
|
2256
2871
|
*
|
|
2257
2872
|
* @param value - Boolean state value
|
|
2873
|
+
|
|
2874
|
+
State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
|
|
2258
2875
|
* @param options - Optional component settings (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
2259
2876
|
* @returns This builder instance for method chaining.
|
|
2260
2877
|
*/
|
|
@@ -2265,9 +2882,11 @@ export class UiCardBuilder {
|
|
|
2265
2882
|
* Appends a `TimestampElement` component.
|
|
2266
2883
|
*
|
|
2267
2884
|
* @remarks
|
|
2268
|
-
*
|
|
2885
|
+
* 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.
|
|
2269
2886
|
*
|
|
2270
2887
|
* @param value - The timestamp in milliseconds
|
|
2888
|
+
|
|
2889
|
+
Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
|
|
2271
2890
|
* @param options - Optional component settings (format (defaults to `datetime`), modifiers).
|
|
2272
2891
|
* @returns This builder instance for method chaining.
|
|
2273
2892
|
*/
|
|
@@ -2278,9 +2897,11 @@ export class UiCardBuilder {
|
|
|
2278
2897
|
* Appends a `ImageReferenceElement` component.
|
|
2279
2898
|
*
|
|
2280
2899
|
* @remarks
|
|
2281
|
-
*
|
|
2900
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
2282
2901
|
*
|
|
2283
2902
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
2903
|
+
|
|
2904
|
+
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.
|
|
2284
2905
|
* @param options - Optional component settings (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
2285
2906
|
* @returns This builder instance for method chaining.
|
|
2286
2907
|
*/
|
|
@@ -2291,9 +2912,11 @@ export class UiCardBuilder {
|
|
|
2291
2912
|
* Appends a `ImageReferenceElement` component.
|
|
2292
2913
|
*
|
|
2293
2914
|
* @remarks
|
|
2294
|
-
*
|
|
2915
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
2295
2916
|
*
|
|
2296
2917
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
2918
|
+
|
|
2919
|
+
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.
|
|
2297
2920
|
* @param options - Optional component settings (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
2298
2921
|
* @returns This builder instance for method chaining.
|
|
2299
2922
|
*/
|
|
@@ -2304,9 +2927,11 @@ export class UiCardBuilder {
|
|
|
2304
2927
|
* Appends a `MarkdownBlockElement` component.
|
|
2305
2928
|
*
|
|
2306
2929
|
* @remarks
|
|
2307
|
-
*
|
|
2930
|
+
* 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.
|
|
2308
2931
|
*
|
|
2309
2932
|
* @param content - Raw Markdown markup content
|
|
2933
|
+
|
|
2934
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
2310
2935
|
* @param options - Optional component settings (modifiers).
|
|
2311
2936
|
* @returns This builder instance for method chaining.
|
|
2312
2937
|
*/
|
|
@@ -2317,9 +2942,11 @@ export class UiCardBuilder {
|
|
|
2317
2942
|
* Appends a `MarkdownBlockElement` component.
|
|
2318
2943
|
*
|
|
2319
2944
|
* @remarks
|
|
2320
|
-
*
|
|
2945
|
+
* 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.
|
|
2321
2946
|
*
|
|
2322
2947
|
* @param content - Raw Markdown markup content
|
|
2948
|
+
|
|
2949
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
2323
2950
|
* @param options - Optional component settings (modifiers).
|
|
2324
2951
|
* @returns This builder instance for method chaining.
|
|
2325
2952
|
*/
|
|
@@ -2330,9 +2957,11 @@ export class UiCardBuilder {
|
|
|
2330
2957
|
* Appends a `HtmlBlockElement` component.
|
|
2331
2958
|
*
|
|
2332
2959
|
* @remarks
|
|
2333
|
-
*
|
|
2960
|
+
* 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.
|
|
2334
2961
|
*
|
|
2335
2962
|
* @param content - Raw HTML markup content
|
|
2963
|
+
|
|
2964
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
2336
2965
|
* @param options - Optional component settings (modifiers).
|
|
2337
2966
|
* @returns This builder instance for method chaining.
|
|
2338
2967
|
*/
|
|
@@ -2343,9 +2972,11 @@ export class UiCardBuilder {
|
|
|
2343
2972
|
* Appends a `HtmlBlockElement` component.
|
|
2344
2973
|
*
|
|
2345
2974
|
* @remarks
|
|
2346
|
-
*
|
|
2975
|
+
* 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.
|
|
2347
2976
|
*
|
|
2348
2977
|
* @param content - Raw HTML markup content
|
|
2978
|
+
|
|
2979
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
2349
2980
|
* @param options - Optional component settings (modifiers).
|
|
2350
2981
|
* @returns This builder instance for method chaining.
|
|
2351
2982
|
*/
|
|
@@ -2356,9 +2987,11 @@ export class UiCardBuilder {
|
|
|
2356
2987
|
* Appends a `MultiSlotElement` component.
|
|
2357
2988
|
*
|
|
2358
2989
|
* @remarks
|
|
2359
|
-
*
|
|
2990
|
+
* 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.
|
|
2360
2991
|
*
|
|
2361
2992
|
* @param slots - List of slots comprising the row
|
|
2993
|
+
|
|
2994
|
+
Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
|
|
2362
2995
|
* @returns This builder instance for method chaining.
|
|
2363
2996
|
*/
|
|
2364
2997
|
addMultiSlot(slots) {
|
|
@@ -2368,10 +3001,11 @@ export class UiCardBuilder {
|
|
|
2368
3001
|
* Appends a `FlowingElement` component.
|
|
2369
3002
|
*
|
|
2370
3003
|
* @remarks
|
|
2371
|
-
*
|
|
2372
|
-
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
3004
|
+
* 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.
|
|
2373
3005
|
*
|
|
2374
3006
|
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
3007
|
+
|
|
3008
|
+
Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
|
|
2375
3009
|
* @param options - Optional component settings (separator).
|
|
2376
3010
|
* @returns This builder instance for method chaining.
|
|
2377
3011
|
*/
|
|
@@ -2382,11 +3016,14 @@ export class UiCardBuilder {
|
|
|
2382
3016
|
* Appends a `LabelValueElement` component.
|
|
2383
3017
|
*
|
|
2384
3018
|
* @remarks
|
|
2385
|
-
*
|
|
2386
|
-
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
3019
|
+
* 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.
|
|
2387
3020
|
*
|
|
2388
3021
|
* @param label - Key or descriptive label displayed muted on the left
|
|
3022
|
+
|
|
3023
|
+
Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
|
|
2389
3024
|
* @param value - Rendered value element on the right
|
|
3025
|
+
|
|
3026
|
+
Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
|
|
2390
3027
|
* @param options - Optional component settings (withDivider (defaults to `false`)).
|
|
2391
3028
|
* @returns This builder instance for method chaining.
|
|
2392
3029
|
*/
|
|
@@ -2397,10 +3034,11 @@ export class UiCardBuilder {
|
|
|
2397
3034
|
* Appends a `TableElement` component.
|
|
2398
3035
|
*
|
|
2399
3036
|
* @remarks
|
|
2400
|
-
*
|
|
2401
|
-
* Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
|
|
3037
|
+
* 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.
|
|
2402
3038
|
*
|
|
2403
3039
|
* @param rows - Tabular data rows
|
|
3040
|
+
|
|
3041
|
+
Ordered table rows. Each row's cells correspond positionally to the declared columns.
|
|
2404
3042
|
* @param options - Optional component settings (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
|
|
2405
3043
|
* @returns This builder instance for method chaining.
|
|
2406
3044
|
*/
|
|
@@ -2411,9 +3049,11 @@ export class UiCardBuilder {
|
|
|
2411
3049
|
* Appends a `RepeatingGroupElement` component.
|
|
2412
3050
|
*
|
|
2413
3051
|
* @remarks
|
|
2414
|
-
*
|
|
3052
|
+
* 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.
|
|
2415
3053
|
*
|
|
2416
3054
|
* @param entries - List of repeated entry records
|
|
3055
|
+
|
|
3056
|
+
Entries in display order. Each entry supplies its own label and content.
|
|
2417
3057
|
* @param options - Optional component settings (title).
|
|
2418
3058
|
* @returns This builder instance for method chaining.
|
|
2419
3059
|
*/
|
|
@@ -2424,10 +3064,14 @@ export class UiCardBuilder {
|
|
|
2424
3064
|
* Appends a `CollapsibleGroupElement` component.
|
|
2425
3065
|
*
|
|
2426
3066
|
* @remarks
|
|
2427
|
-
*
|
|
3067
|
+
* 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.
|
|
2428
3068
|
*
|
|
2429
3069
|
* @param title - Group title (e.g. "Show specimen details")
|
|
3070
|
+
|
|
3071
|
+
Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
|
|
2430
3072
|
* @param elements - Nested content elements revealed when expanded
|
|
3073
|
+
|
|
3074
|
+
Ordered child elements made visible by expanding the group.
|
|
2431
3075
|
* @param options - Optional component settings (summary, defaultExpanded (defaults to `false`)).
|
|
2432
3076
|
* @returns This builder instance for method chaining.
|
|
2433
3077
|
*/
|
|
@@ -2438,7 +3082,7 @@ export class UiCardBuilder {
|
|
|
2438
3082
|
* Appends a `DividerElement` component.
|
|
2439
3083
|
*
|
|
2440
3084
|
* @remarks
|
|
2441
|
-
*
|
|
3085
|
+
* 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.
|
|
2442
3086
|
*
|
|
2443
3087
|
* @param options - Optional component settings (style (defaults to `hairline`)).
|
|
2444
3088
|
* @returns This builder instance for method chaining.
|
|
@@ -2480,6 +3124,8 @@ export const UiCard = {
|
|
|
2480
3124
|
* Creates a new fluent builder for constructing a `UiCard`.
|
|
2481
3125
|
*
|
|
2482
3126
|
* @param title - Human-readable feature title displayed in the card header
|
|
3127
|
+
|
|
3128
|
+
Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
|
|
2483
3129
|
* @returns A new `UiCardBuilder` instance.
|
|
2484
3130
|
*/
|
|
2485
3131
|
builder(title) {
|
|
@@ -2519,10 +3165,11 @@ export const UiCard = {
|
|
|
2519
3165
|
* Functional helper to create a `UiCardClass` instance directly.
|
|
2520
3166
|
*
|
|
2521
3167
|
* @remarks
|
|
2522
|
-
*
|
|
2523
|
-
* Represents a complete feature card rendered inside the 360px panel.
|
|
3168
|
+
* 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.
|
|
2524
3169
|
*
|
|
2525
3170
|
* @param title - Human-readable feature title displayed in the card header
|
|
3171
|
+
|
|
3172
|
+
Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
|
|
2526
3173
|
* @param options - Optional configuration properties.
|
|
2527
3174
|
* @returns A strongly-typed `UiCardClass` instance.
|
|
2528
3175
|
*/
|
|
@@ -2536,8 +3183,7 @@ export function createUiCard(title, options) {
|
|
|
2536
3183
|
* Parses a JSON string or raw object into a validated `UiCardClass` instance.
|
|
2537
3184
|
*
|
|
2538
3185
|
* @remarks
|
|
2539
|
-
*
|
|
2540
|
-
* Represents a complete feature card rendered inside the 360px panel.
|
|
3186
|
+
* 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.
|
|
2541
3187
|
*
|
|
2542
3188
|
* @param json - JSON string or parsed JavaScript object to validate and hydrate.
|
|
2543
3189
|
* @param withDeepValidation - Whether to recursively validate all nested child entities.
|
|
@@ -2551,15 +3197,18 @@ export function parseUiCard(json, withDeepValidation = true) {
|
|
|
2551
3197
|
* Creates a `TruncateOptions` component instance.
|
|
2552
3198
|
*
|
|
2553
3199
|
* @remarks
|
|
2554
|
-
*
|
|
3200
|
+
* Controls how a renderer abbreviates long text. When mode is characters, limit represents maximum character count; when mode is lines, limit represents visual line count.
|
|
2555
3201
|
*
|
|
2556
|
-
* @param
|
|
2557
|
-
|
|
3202
|
+
* @param limit - Maximum threshold limit before truncating
|
|
3203
|
+
|
|
3204
|
+
Threshold after which the renderer can shorten the displayed text. When mode is characters, this represents character count; when mode is lines, this represents visual line count.
|
|
3205
|
+
* @param options - Optional settings (mode (defaults to `lines`), showMore (defaults to `true`)).
|
|
2558
3206
|
* @returns A strongly-typed `TruncateOptions` object.
|
|
2559
3207
|
*/
|
|
2560
|
-
export function truncateOptions(
|
|
3208
|
+
export function truncateOptions(limit, options) {
|
|
2561
3209
|
return {
|
|
2562
|
-
|
|
3210
|
+
limit,
|
|
3211
|
+
mode: options?.mode ?? TruncateMode.lines,
|
|
2563
3212
|
showMore: options?.showMore ?? true
|
|
2564
3213
|
};
|
|
2565
3214
|
}
|
|
@@ -2567,7 +3216,7 @@ export function truncateOptions(characterLimit, options) {
|
|
|
2567
3216
|
* Creates a `BaseModifiers` component instance.
|
|
2568
3217
|
*
|
|
2569
3218
|
* @remarks
|
|
2570
|
-
*
|
|
3219
|
+
* 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.
|
|
2571
3220
|
*
|
|
2572
3221
|
* @param options - Optional settings (copyable).
|
|
2573
3222
|
* @returns A strongly-typed `BaseModifiers` object.
|
|
@@ -2581,7 +3230,7 @@ export function baseModifiers(options) {
|
|
|
2581
3230
|
* Creates a `PrimitiveModifiers` component instance.
|
|
2582
3231
|
*
|
|
2583
3232
|
* @remarks
|
|
2584
|
-
*
|
|
3233
|
+
* Extends BaseModifiers with text styling controls. Defaults provide normal weight, medium intensity, and proportional text unless a feature explicitly overrides them.
|
|
2585
3234
|
*
|
|
2586
3235
|
* @param options - Optional settings (truncate, weight (defaults to `normal`), intensity (defaults to `medium`), monospace (defaults to `false`), copyable).
|
|
2587
3236
|
* @returns A strongly-typed `PrimitiveModifiers` object.
|
|
@@ -2599,10 +3248,11 @@ export function primitiveModifiers(options) {
|
|
|
2599
3248
|
* Creates a `StringElement` component instance.
|
|
2600
3249
|
*
|
|
2601
3250
|
* @remarks
|
|
2602
|
-
*
|
|
2603
|
-
* Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
|
|
3251
|
+
* 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.
|
|
2604
3252
|
*
|
|
2605
3253
|
* @param value - Text value
|
|
3254
|
+
|
|
3255
|
+
Text to render. Supply plain text; this field is not a Markdown or HTML document.
|
|
2606
3256
|
* @param options - Optional settings (representation (defaults to `plain`), modifiers).
|
|
2607
3257
|
* @returns A strongly-typed `StringElement` object.
|
|
2608
3258
|
*/
|
|
@@ -2618,10 +3268,11 @@ export function string(value, options) {
|
|
|
2618
3268
|
* Creates a `StringsElement` component instance.
|
|
2619
3269
|
*
|
|
2620
3270
|
* @remarks
|
|
2621
|
-
*
|
|
2622
|
-
* Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
|
|
3271
|
+
* 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.
|
|
2623
3272
|
*
|
|
2624
3273
|
* @param values - Array of string values
|
|
3274
|
+
|
|
3275
|
+
Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
|
|
2625
3276
|
* @param options - Optional settings (representation (defaults to `plain`), separator, modifiers).
|
|
2626
3277
|
* @returns A strongly-typed `StringsElement` object.
|
|
2627
3278
|
*/
|
|
@@ -2638,9 +3289,11 @@ export function strings(values, options) {
|
|
|
2638
3289
|
* Creates a `StringCodeElement` component instance.
|
|
2639
3290
|
*
|
|
2640
3291
|
* @remarks
|
|
2641
|
-
*
|
|
3292
|
+
* 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.
|
|
2642
3293
|
*
|
|
2643
3294
|
* @param value - Text value
|
|
3295
|
+
|
|
3296
|
+
Code or text snippet to display. Include any desired line breaks in this string.
|
|
2644
3297
|
* @param options - Optional settings (language, modifiers).
|
|
2645
3298
|
* @returns A strongly-typed `StringCodeElement` object.
|
|
2646
3299
|
*/
|
|
@@ -2656,9 +3309,11 @@ export function stringCode(value, options) {
|
|
|
2656
3309
|
* Creates a `XmlElement` component instance.
|
|
2657
3310
|
*
|
|
2658
3311
|
* @remarks
|
|
2659
|
-
* XML
|
|
3312
|
+
* Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
|
|
2660
3313
|
*
|
|
2661
3314
|
* @param value - XML content value
|
|
3315
|
+
|
|
3316
|
+
XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
|
|
2662
3317
|
* @param options - Optional settings (modifiers).
|
|
2663
3318
|
* @returns A strongly-typed `XmlElement` object.
|
|
2664
3319
|
*/
|
|
@@ -2673,9 +3328,11 @@ export function xml(value, options) {
|
|
|
2673
3328
|
* Creates a `JsonElement` component instance.
|
|
2674
3329
|
*
|
|
2675
3330
|
* @remarks
|
|
2676
|
-
* JSON
|
|
3331
|
+
* 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.
|
|
2677
3332
|
*
|
|
2678
3333
|
* @param value - JSON content value
|
|
3334
|
+
|
|
3335
|
+
Serialized JSON text to render. No parsing or schema validation is implied by this element.
|
|
2679
3336
|
* @param options - Optional settings (modifiers).
|
|
2680
3337
|
* @returns A strongly-typed `JsonElement` object.
|
|
2681
3338
|
*/
|
|
@@ -2690,9 +3347,11 @@ export function json(value, options) {
|
|
|
2690
3347
|
* Creates a `StringUrlElement` component instance.
|
|
2691
3348
|
*
|
|
2692
3349
|
* @remarks
|
|
2693
|
-
*
|
|
3350
|
+
* 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.
|
|
2694
3351
|
*
|
|
2695
3352
|
* @param value - Target URL or navigation destination
|
|
3353
|
+
|
|
3354
|
+
Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
|
|
2696
3355
|
* @param options - Optional settings (label, modifiers).
|
|
2697
3356
|
* @returns A strongly-typed `StringUrlElement` object.
|
|
2698
3357
|
*/
|
|
@@ -2708,9 +3367,11 @@ export function stringUrl(value, options) {
|
|
|
2708
3367
|
* Creates a `IdentifierElement` component instance.
|
|
2709
3368
|
*
|
|
2710
3369
|
* @remarks
|
|
2711
|
-
*
|
|
3370
|
+
* 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.
|
|
2712
3371
|
*
|
|
2713
3372
|
* @param value - Identifier string value
|
|
3373
|
+
|
|
3374
|
+
Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
|
|
2714
3375
|
* @param options - Optional settings (modifiers).
|
|
2715
3376
|
* @returns A strongly-typed `IdentifierElement` object.
|
|
2716
3377
|
*/
|
|
@@ -2725,9 +3386,11 @@ export function identifier(value, options) {
|
|
|
2725
3386
|
* Creates a `RatioElement` component instance.
|
|
2726
3387
|
*
|
|
2727
3388
|
* @remarks
|
|
2728
|
-
*
|
|
3389
|
+
* 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.
|
|
2729
3390
|
*
|
|
2730
3391
|
* @param value - Aspect ratio numerical expression
|
|
3392
|
+
|
|
3393
|
+
Numeric ratio value used by the renderer to produce an aspect-ratio display.
|
|
2731
3394
|
* @param options - Optional settings (modifiers).
|
|
2732
3395
|
* @returns A strongly-typed `RatioElement` object.
|
|
2733
3396
|
*/
|
|
@@ -2742,10 +3405,14 @@ export function ratio(value, options) {
|
|
|
2742
3405
|
* Creates a `DimensionsElement` component instance.
|
|
2743
3406
|
*
|
|
2744
3407
|
* @remarks
|
|
2745
|
-
*
|
|
3408
|
+
* 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.
|
|
2746
3409
|
*
|
|
2747
3410
|
* @param width - Width in pixels
|
|
3411
|
+
|
|
3412
|
+
Horizontal pixel count. Values below one are rejected by the schema constraint.
|
|
2748
3413
|
* @param height - Height in pixels
|
|
3414
|
+
|
|
3415
|
+
Vertical pixel count. Values below one are rejected by the schema constraint.
|
|
2749
3416
|
* @param options - Optional settings (modifiers).
|
|
2750
3417
|
* @returns A strongly-typed `DimensionsElement` object.
|
|
2751
3418
|
*/
|
|
@@ -2761,9 +3428,11 @@ export function dimensions(width, height, options) {
|
|
|
2761
3428
|
* Creates a `ColourElement` component instance.
|
|
2762
3429
|
*
|
|
2763
3430
|
* @remarks
|
|
2764
|
-
*
|
|
3431
|
+
* 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.
|
|
2765
3432
|
*
|
|
2766
3433
|
* @param value - Hexadecimal color code
|
|
3434
|
+
|
|
3435
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
2767
3436
|
* @param options - Optional settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
2768
3437
|
* @returns A strongly-typed `ColourElement` object.
|
|
2769
3438
|
*/
|
|
@@ -2782,9 +3451,11 @@ export function colour(value, options) {
|
|
|
2782
3451
|
* Creates a `ColourElement` component instance.
|
|
2783
3452
|
*
|
|
2784
3453
|
* @remarks
|
|
2785
|
-
*
|
|
3454
|
+
* 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.
|
|
2786
3455
|
*
|
|
2787
3456
|
* @param value - Hexadecimal color code
|
|
3457
|
+
|
|
3458
|
+
Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
|
|
2788
3459
|
* @param options - Optional settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
2789
3460
|
* @returns A strongly-typed `ColourElement` object.
|
|
2790
3461
|
*/
|
|
@@ -2803,9 +3474,11 @@ export function color(value, options) {
|
|
|
2803
3474
|
* Creates a `NumberUnboundedElement` component instance.
|
|
2804
3475
|
*
|
|
2805
3476
|
* @remarks
|
|
2806
|
-
*
|
|
3477
|
+
* 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.
|
|
2807
3478
|
*
|
|
2808
3479
|
* @param value - Numeric value
|
|
3480
|
+
|
|
3481
|
+
Number to display. Its meaning and any valid range are defined by the producing feature.
|
|
2809
3482
|
* @param options - Optional settings (unit, modifiers).
|
|
2810
3483
|
* @returns A strongly-typed `NumberUnboundedElement` object.
|
|
2811
3484
|
*/
|
|
@@ -2821,9 +3494,11 @@ export function numberUnbounded(value, options) {
|
|
|
2821
3494
|
* Creates a `NumberBoundedStarsElement` component instance.
|
|
2822
3495
|
*
|
|
2823
3496
|
* @remarks
|
|
2824
|
-
*
|
|
3497
|
+
* 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.
|
|
2825
3498
|
*
|
|
2826
3499
|
* @param value - Numeric rating score
|
|
3500
|
+
|
|
3501
|
+
Score represented by the filled portion of the star display.
|
|
2827
3502
|
* @param options - Optional settings (maximum, modifiers).
|
|
2828
3503
|
* @returns A strongly-typed `NumberBoundedStarsElement` object.
|
|
2829
3504
|
*/
|
|
@@ -2839,9 +3514,11 @@ export function numberBoundedStars(value, options) {
|
|
|
2839
3514
|
* Creates a `NumberBoundedStarsElement` component instance.
|
|
2840
3515
|
*
|
|
2841
3516
|
* @remarks
|
|
2842
|
-
*
|
|
3517
|
+
* 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.
|
|
2843
3518
|
*
|
|
2844
3519
|
* @param value - Numeric rating score
|
|
3520
|
+
|
|
3521
|
+
Score represented by the filled portion of the star display.
|
|
2845
3522
|
* @param options - Optional settings (maximum, modifiers).
|
|
2846
3523
|
* @returns A strongly-typed `NumberBoundedStarsElement` object.
|
|
2847
3524
|
*/
|
|
@@ -2857,9 +3534,11 @@ export function numberStars(value, options) {
|
|
|
2857
3534
|
* Creates a `NumberBoundedMeterElement` component instance.
|
|
2858
3535
|
*
|
|
2859
3536
|
* @remarks
|
|
2860
|
-
*
|
|
3537
|
+
* 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.
|
|
2861
3538
|
*
|
|
2862
3539
|
* @param value - Numeric value
|
|
3540
|
+
|
|
3541
|
+
Current measurement or score represented by the meter.
|
|
2863
3542
|
* @param options - Optional settings (minimum, maximum, label, unit, modifiers).
|
|
2864
3543
|
* @returns A strongly-typed `NumberBoundedMeterElement` object.
|
|
2865
3544
|
*/
|
|
@@ -2878,9 +3557,11 @@ export function numberBoundedMeter(value, options) {
|
|
|
2878
3557
|
* Creates a `NumberBoundedMeterElement` component instance.
|
|
2879
3558
|
*
|
|
2880
3559
|
* @remarks
|
|
2881
|
-
*
|
|
3560
|
+
* 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.
|
|
2882
3561
|
*
|
|
2883
3562
|
* @param value - Numeric value
|
|
3563
|
+
|
|
3564
|
+
Current measurement or score represented by the meter.
|
|
2884
3565
|
* @param options - Optional settings (minimum, maximum, label, unit, modifiers).
|
|
2885
3566
|
* @returns A strongly-typed `NumberBoundedMeterElement` object.
|
|
2886
3567
|
*/
|
|
@@ -2899,10 +3580,11 @@ export function numberMeter(value, options) {
|
|
|
2899
3580
|
* Creates a `BooleanElement` component instance.
|
|
2900
3581
|
*
|
|
2901
3582
|
* @remarks
|
|
2902
|
-
*
|
|
2903
|
-
* Supports standard plain text or badge pill presentation with customizable labels and variants.
|
|
3583
|
+
* 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.
|
|
2904
3584
|
*
|
|
2905
3585
|
* @param value - Boolean state value
|
|
3586
|
+
|
|
3587
|
+
State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
|
|
2906
3588
|
* @param options - Optional settings (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
|
|
2907
3589
|
* @returns A strongly-typed `BooleanElement` object.
|
|
2908
3590
|
*/
|
|
@@ -2921,9 +3603,11 @@ export function boolean(value, options) {
|
|
|
2921
3603
|
* Creates a `TimestampElement` component instance.
|
|
2922
3604
|
*
|
|
2923
3605
|
* @remarks
|
|
2924
|
-
*
|
|
3606
|
+
* 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.
|
|
2925
3607
|
*
|
|
2926
3608
|
* @param value - The timestamp in milliseconds
|
|
3609
|
+
|
|
3610
|
+
Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
|
|
2927
3611
|
* @param options - Optional settings (format (defaults to `datetime`), modifiers).
|
|
2928
3612
|
* @returns A strongly-typed `TimestampElement` object.
|
|
2929
3613
|
*/
|
|
@@ -2939,9 +3623,11 @@ export function timestamp(value, options) {
|
|
|
2939
3623
|
* Creates a `ImageReferenceElement` component instance.
|
|
2940
3624
|
*
|
|
2941
3625
|
* @remarks
|
|
2942
|
-
*
|
|
3626
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
2943
3627
|
*
|
|
2944
3628
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
3629
|
+
|
|
3630
|
+
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.
|
|
2945
3631
|
* @param options - Optional settings (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
2946
3632
|
* @returns A strongly-typed `ImageReferenceElement` object.
|
|
2947
3633
|
*/
|
|
@@ -2958,9 +3644,11 @@ export function imageReference(src, options) {
|
|
|
2958
3644
|
* Creates a `ImageReferenceElement` component instance.
|
|
2959
3645
|
*
|
|
2960
3646
|
* @remarks
|
|
2961
|
-
*
|
|
3647
|
+
* References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
|
|
2962
3648
|
*
|
|
2963
3649
|
* @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
|
|
3650
|
+
|
|
3651
|
+
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.
|
|
2964
3652
|
* @param options - Optional settings (alt, aspectRatio (defaults to `1:1`), placeholder).
|
|
2965
3653
|
* @returns A strongly-typed `ImageReferenceElement` object.
|
|
2966
3654
|
*/
|
|
@@ -2977,10 +3665,14 @@ export function imageRef(src, options) {
|
|
|
2977
3665
|
* Creates a `ButtonActionElement` component instance.
|
|
2978
3666
|
*
|
|
2979
3667
|
* @remarks
|
|
2980
|
-
*
|
|
3668
|
+
* 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.
|
|
2981
3669
|
*
|
|
2982
3670
|
* @param commandId - Command identifier to invoke
|
|
3671
|
+
|
|
3672
|
+
Identifier of the registered extension command to dispatch when the button is activated.
|
|
2983
3673
|
* @param label - Display label for the action
|
|
3674
|
+
|
|
3675
|
+
User-facing label shown on the control. Keep it short and action-oriented.
|
|
2984
3676
|
* @param options - Optional settings (extensionId, target, parameters, disabled (defaults to `false`), variant (defaults to `secondary`)).
|
|
2985
3677
|
* @returns A strongly-typed `ButtonActionElement` object.
|
|
2986
3678
|
*/
|
|
@@ -3000,10 +3692,14 @@ export function buttonAction(commandId, label, options) {
|
|
|
3000
3692
|
* Creates a `ExternalLinkActionElement` component instance.
|
|
3001
3693
|
*
|
|
3002
3694
|
* @remarks
|
|
3003
|
-
*
|
|
3695
|
+
* Renders a user-invokable action that opens a destination externally. Use StringUrlElement for a link embedded in content rather than an action control.
|
|
3004
3696
|
*
|
|
3005
3697
|
* @param url - Target URL destination
|
|
3698
|
+
|
|
3699
|
+
External destination opened when the user activates the link action. The client controls how external navigation is handed to the platform.
|
|
3006
3700
|
* @param label - Display label for the action
|
|
3701
|
+
|
|
3702
|
+
User-facing label shown on the control. Keep it short and action-oriented.
|
|
3007
3703
|
* @returns A strongly-typed `ExternalLinkActionElement` object.
|
|
3008
3704
|
*/
|
|
3009
3705
|
export function externalLinkAction(url, label) {
|
|
@@ -3017,9 +3713,11 @@ export function externalLinkAction(url, label) {
|
|
|
3017
3713
|
* Creates a `MarkdownBlockElement` component instance.
|
|
3018
3714
|
*
|
|
3019
3715
|
* @remarks
|
|
3020
|
-
*
|
|
3716
|
+
* 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.
|
|
3021
3717
|
*
|
|
3022
3718
|
* @param content - Raw Markdown markup content
|
|
3719
|
+
|
|
3720
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
3023
3721
|
* @param options - Optional settings (modifiers).
|
|
3024
3722
|
* @returns A strongly-typed `MarkdownBlockElement` object.
|
|
3025
3723
|
*/
|
|
@@ -3034,9 +3732,11 @@ export function markdownBlock(content, options) {
|
|
|
3034
3732
|
* Creates a `MarkdownBlockElement` component instance.
|
|
3035
3733
|
*
|
|
3036
3734
|
* @remarks
|
|
3037
|
-
*
|
|
3735
|
+
* 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.
|
|
3038
3736
|
*
|
|
3039
3737
|
* @param content - Raw Markdown markup content
|
|
3738
|
+
|
|
3739
|
+
Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
|
|
3040
3740
|
* @param options - Optional settings (modifiers).
|
|
3041
3741
|
* @returns A strongly-typed `MarkdownBlockElement` object.
|
|
3042
3742
|
*/
|
|
@@ -3051,9 +3751,11 @@ export function markdown(content, options) {
|
|
|
3051
3751
|
* Creates a `HtmlBlockElement` component instance.
|
|
3052
3752
|
*
|
|
3053
3753
|
* @remarks
|
|
3054
|
-
*
|
|
3754
|
+
* 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.
|
|
3055
3755
|
*
|
|
3056
3756
|
* @param content - Raw HTML markup content
|
|
3757
|
+
|
|
3758
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
3057
3759
|
* @param options - Optional settings (modifiers).
|
|
3058
3760
|
* @returns A strongly-typed `HtmlBlockElement` object.
|
|
3059
3761
|
*/
|
|
@@ -3068,9 +3770,11 @@ export function htmlBlock(content, options) {
|
|
|
3068
3770
|
* Creates a `HtmlBlockElement` component instance.
|
|
3069
3771
|
*
|
|
3070
3772
|
* @remarks
|
|
3071
|
-
*
|
|
3773
|
+
* 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.
|
|
3072
3774
|
*
|
|
3073
3775
|
* @param content - Raw HTML markup content
|
|
3776
|
+
|
|
3777
|
+
HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
|
|
3074
3778
|
* @param options - Optional settings (modifiers).
|
|
3075
3779
|
* @returns A strongly-typed `HtmlBlockElement` object.
|
|
3076
3780
|
*/
|
|
@@ -3085,9 +3789,11 @@ export function html(content, options) {
|
|
|
3085
3789
|
* Creates a `Slot` component instance.
|
|
3086
3790
|
*
|
|
3087
3791
|
* @remarks
|
|
3088
|
-
*
|
|
3792
|
+
* 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.
|
|
3089
3793
|
*
|
|
3090
3794
|
* @param content - Rendered content inside the slot
|
|
3795
|
+
|
|
3796
|
+
One visual element displayed in this slot. Use a nested layout element when the slot itself needs multiple children.
|
|
3091
3797
|
* @param options - Optional settings (label, width).
|
|
3092
3798
|
* @returns A strongly-typed `Slot` object.
|
|
3093
3799
|
*/
|
|
@@ -3102,9 +3808,11 @@ export function slot(content, options) {
|
|
|
3102
3808
|
* Creates a `MultiSlotElement` component instance.
|
|
3103
3809
|
*
|
|
3104
3810
|
* @remarks
|
|
3105
|
-
*
|
|
3811
|
+
* 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.
|
|
3106
3812
|
*
|
|
3107
3813
|
* @param slots - List of slots comprising the row
|
|
3814
|
+
|
|
3815
|
+
Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
|
|
3108
3816
|
* @returns A strongly-typed `MultiSlotElement` object.
|
|
3109
3817
|
*/
|
|
3110
3818
|
export function multiSlot(slots) {
|
|
@@ -3117,10 +3825,11 @@ export function multiSlot(slots) {
|
|
|
3117
3825
|
* Creates a `FlowingElement` component instance.
|
|
3118
3826
|
*
|
|
3119
3827
|
* @remarks
|
|
3120
|
-
*
|
|
3121
|
-
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
3828
|
+
* 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.
|
|
3122
3829
|
*
|
|
3123
3830
|
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
3831
|
+
|
|
3832
|
+
Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
|
|
3124
3833
|
* @param options - Optional settings (separator).
|
|
3125
3834
|
* @returns A strongly-typed `FlowingElement` object.
|
|
3126
3835
|
*/
|
|
@@ -3135,11 +3844,14 @@ export function flowing(elements, options) {
|
|
|
3135
3844
|
* Creates a `LabelValueElement` component instance.
|
|
3136
3845
|
*
|
|
3137
3846
|
* @remarks
|
|
3138
|
-
*
|
|
3139
|
-
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
3847
|
+
* 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.
|
|
3140
3848
|
*
|
|
3141
3849
|
* @param label - Key or descriptive label displayed muted on the left
|
|
3850
|
+
|
|
3851
|
+
Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
|
|
3142
3852
|
* @param value - Rendered value element on the right
|
|
3853
|
+
|
|
3854
|
+
Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
|
|
3143
3855
|
* @param options - Optional settings (withDivider (defaults to `false`)).
|
|
3144
3856
|
* @returns A strongly-typed `LabelValueElement` object.
|
|
3145
3857
|
*/
|
|
@@ -3155,7 +3867,7 @@ export function labelValue(label, value, options) {
|
|
|
3155
3867
|
* Creates a `TableColumn` component instance.
|
|
3156
3868
|
*
|
|
3157
3869
|
* @remarks
|
|
3158
|
-
*
|
|
3870
|
+
* Describes one table column and its visual sizing. When columns are supplied, their order corresponds to the position of each cell in a row.
|
|
3159
3871
|
*
|
|
3160
3872
|
* @param options - Optional settings (header, align (defaults to `left`), width, widthMode (defaults to `fixed`)).
|
|
3161
3873
|
* @returns A strongly-typed `TableColumn` object.
|
|
@@ -3172,9 +3884,11 @@ export function tableColumn(options) {
|
|
|
3172
3884
|
* Creates a `TableRow` component instance.
|
|
3173
3885
|
*
|
|
3174
3886
|
* @remarks
|
|
3175
|
-
*
|
|
3887
|
+
* 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.
|
|
3176
3888
|
*
|
|
3177
3889
|
* @param cells - Array of cell values corresponding to table columns
|
|
3890
|
+
|
|
3891
|
+
Ordered contents for this row. Each cell is a UiElement so values can use the same primitive and layout renderers as other ViewKit content.
|
|
3178
3892
|
* @returns A strongly-typed `TableRow` object.
|
|
3179
3893
|
*/
|
|
3180
3894
|
export function tableRow(cells) {
|
|
@@ -3186,10 +3900,11 @@ export function tableRow(cells) {
|
|
|
3186
3900
|
* Creates a `TableElement` component instance.
|
|
3187
3901
|
*
|
|
3188
3902
|
* @remarks
|
|
3189
|
-
*
|
|
3190
|
-
* Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
|
|
3903
|
+
* 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.
|
|
3191
3904
|
*
|
|
3192
3905
|
* @param rows - Tabular data rows
|
|
3906
|
+
|
|
3907
|
+
Ordered table rows. Each row's cells correspond positionally to the declared columns.
|
|
3193
3908
|
* @param options - Optional settings (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
|
|
3194
3909
|
* @returns A strongly-typed `TableElement` object.
|
|
3195
3910
|
*/
|
|
@@ -3207,9 +3922,11 @@ export function table(rows, options) {
|
|
|
3207
3922
|
* Creates a `RepeatingGroupEntry` component instance.
|
|
3208
3923
|
*
|
|
3209
3924
|
* @remarks
|
|
3210
|
-
*
|
|
3925
|
+
* 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.
|
|
3211
3926
|
*
|
|
3212
3927
|
* @param label - Entry label
|
|
3928
|
+
|
|
3929
|
+
Short label identifying this entry within the repeated group.
|
|
3213
3930
|
* @param options - Optional settings (value, elements).
|
|
3214
3931
|
* @returns A strongly-typed `RepeatingGroupEntry` object.
|
|
3215
3932
|
*/
|
|
@@ -3224,9 +3941,11 @@ export function repeatingGroupEntry(label, options) {
|
|
|
3224
3941
|
* Creates a `RepeatingGroupElement` component instance.
|
|
3225
3942
|
*
|
|
3226
3943
|
* @remarks
|
|
3227
|
-
*
|
|
3944
|
+
* 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.
|
|
3228
3945
|
*
|
|
3229
3946
|
* @param entries - List of repeated entry records
|
|
3947
|
+
|
|
3948
|
+
Entries in display order. Each entry supplies its own label and content.
|
|
3230
3949
|
* @param options - Optional settings (title).
|
|
3231
3950
|
* @returns A strongly-typed `RepeatingGroupElement` object.
|
|
3232
3951
|
*/
|
|
@@ -3241,10 +3960,14 @@ export function repeatingGroup(entries, options) {
|
|
|
3241
3960
|
* Creates a `CollapsibleGroupElement` component instance.
|
|
3242
3961
|
*
|
|
3243
3962
|
* @remarks
|
|
3244
|
-
*
|
|
3963
|
+
* 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.
|
|
3245
3964
|
*
|
|
3246
3965
|
* @param title - Group title (e.g. "Show specimen details")
|
|
3966
|
+
|
|
3967
|
+
Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
|
|
3247
3968
|
* @param elements - Nested content elements revealed when expanded
|
|
3969
|
+
|
|
3970
|
+
Ordered child elements made visible by expanding the group.
|
|
3248
3971
|
* @param options - Optional settings (summary, defaultExpanded (defaults to `false`)).
|
|
3249
3972
|
* @returns A strongly-typed `CollapsibleGroupElement` object.
|
|
3250
3973
|
*/
|
|
@@ -3261,7 +3984,7 @@ export function collapsibleGroup(title, elements, options) {
|
|
|
3261
3984
|
* Creates a `DividerElement` component instance.
|
|
3262
3985
|
*
|
|
3263
3986
|
* @remarks
|
|
3264
|
-
*
|
|
3987
|
+
* 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.
|
|
3265
3988
|
*
|
|
3266
3989
|
* @param options - Optional settings (style (defaults to `hairline`)).
|
|
3267
3990
|
* @returns A strongly-typed `DividerElement` object.
|
|
@@ -3276,7 +3999,7 @@ export function divider(options) {
|
|
|
3276
3999
|
* Creates a `Envelop` component instance.
|
|
3277
4000
|
*
|
|
3278
4001
|
* @remarks
|
|
3279
|
-
*
|
|
4002
|
+
* All root ViewKit documents extend this envelope so consumers can identify the schema contract version before processing the root content.
|
|
3280
4003
|
*
|
|
3281
4004
|
* @param options - Optional settings (schemaVersion (defaults to `1.0`)).
|
|
3282
4005
|
* @returns A strongly-typed `Envelop` object.
|
|
@@ -3302,7 +4025,8 @@ export function isTruncateOptions(value, withDeepValidation = false) {
|
|
|
3302
4025
|
return true;
|
|
3303
4026
|
}
|
|
3304
4027
|
const element = value;
|
|
3305
|
-
return ("
|
|
4028
|
+
return ("limit" in value && typeof element.limit === "number") &&
|
|
4029
|
+
(element.mode === undefined || Object.values(TruncateMode).includes(element.mode)) &&
|
|
3306
4030
|
(element.showMore === undefined || typeof element.showMore === "boolean");
|
|
3307
4031
|
}
|
|
3308
4032
|
/**
|