@vectoriox/iox-builder 9.5.1 → 9.5.3
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/index.d.ts
CHANGED
|
@@ -841,8 +841,10 @@ declare enum CanvasShowState {
|
|
|
841
841
|
Open = "open"
|
|
842
842
|
}
|
|
843
843
|
interface CanvasDesignSnapshot {
|
|
844
|
-
/** Hidden-at-rest
|
|
844
|
+
/** Hidden-at-rest PARTS (R2) the current SELECTION sits in (or is): shown while selected. */
|
|
845
845
|
revealed: ReadonlySet<string>;
|
|
846
|
+
/** Free-standing overlays the selection opened (board A4): shown until closed (X, backdrop, eye). */
|
|
847
|
+
pinned: ReadonlySet<string>;
|
|
846
848
|
/** "Showing on canvas" choices, by the part's node id. */
|
|
847
849
|
shown: ReadonlyMap<string, CanvasShowState>;
|
|
848
850
|
}
|
|
@@ -869,8 +871,13 @@ declare class CanvasDesignStateService {
|
|
|
869
871
|
get snapshot(): CanvasDesignSnapshot;
|
|
870
872
|
get pagePath(): string | null;
|
|
871
873
|
setPagePath(path: string | null | undefined): void;
|
|
872
|
-
/**
|
|
874
|
+
/**
|
|
875
|
+
* The selection moved. The hidden-at-rest PARTS on its path are revealed and every other part is not
|
|
876
|
+
* (R2); a free-standing overlay on the path is pinned open until it is closed (A4).
|
|
877
|
+
*/
|
|
873
878
|
setSelectionPath(path: ReadonlyArray<ComponentNode>): void;
|
|
879
|
+
/** Closed on the canvas (its X, its backdrop, the eye): no longer pinned or switched open. */
|
|
880
|
+
dismiss(nodeId: string | null | undefined): void;
|
|
874
881
|
/** The switcher's choice for one part (null = back to the saved default). */
|
|
875
882
|
setShown(nodeId: string, state: CanvasShowState | null): void;
|
|
876
883
|
/** The switcher's current choice for one part. */
|
|
@@ -3221,6 +3228,7 @@ declare function repeaterSubLabel(rows: LayerRepeaterRows): string | null;
|
|
|
3221
3228
|
declare function flattenLayerTree(nodes: ComponentNode[], ctx: LayerTreeContext): LayerTreeRow[];
|
|
3222
3229
|
|
|
3223
3230
|
type TreeNode = LayerTreeRow;
|
|
3231
|
+
type ChromeWord = 'page' | 'global' | 'empty' | 'globalEmpty' | 'rename' | 'duplicate' | 'delete';
|
|
3224
3232
|
declare class LayerTreeComponent implements OnInit, OnDestroy {
|
|
3225
3233
|
private registry;
|
|
3226
3234
|
private overlayService;
|
|
@@ -3247,6 +3255,8 @@ declare class LayerTreeComponent implements OnInit, OnDestroy {
|
|
|
3247
3255
|
readonly templateLabel: string;
|
|
3248
3256
|
readonly templateTitle: string;
|
|
3249
3257
|
readonly moreRowsTitle: string;
|
|
3258
|
+
/** The tree's own chrome words, through the host's i18n (builder.chrome.*). */
|
|
3259
|
+
readonly words: Record<ChromeWord, string>;
|
|
3250
3260
|
/** Cache: component type → icon class */
|
|
3251
3261
|
private iconMap;
|
|
3252
3262
|
private selectSub?;
|
|
@@ -3261,8 +3271,9 @@ declare class LayerTreeComponent implements OnInit, OnDestroy {
|
|
|
3261
3271
|
ngOnDestroy(): void;
|
|
3262
3272
|
/** "5 more rows from projects" — the line after a Repeater's template (boards 4 / 8). */
|
|
3263
3273
|
moreRowsText(more: LayerMoreRows): string;
|
|
3264
|
-
/** The
|
|
3265
|
-
|
|
3274
|
+
/** The name's title — the full text a narrow sidebar truncates: the name, its sub-label, and every
|
|
3275
|
+
* binding a bound part holds. */
|
|
3276
|
+
rowTitle(tn: TreeNode): string;
|
|
3266
3277
|
ngDoCheck(): void;
|
|
3267
3278
|
/** Cheap structural signature: node IDs + nesting depth only. */
|
|
3268
3279
|
private sig;
|
|
@@ -3464,6 +3475,21 @@ declare const HIDDEN_AT_REST_TYPES: ReadonlyArray<string>;
|
|
|
3464
3475
|
declare function isHiddenAtRest(node: {
|
|
3465
3476
|
type?: string;
|
|
3466
3477
|
} | null | undefined): boolean;
|
|
3478
|
+
/**
|
|
3479
|
+
* How the selection shows a node hidden at rest — the two approved rules, by what the node IS:
|
|
3480
|
+
* - a PART of a composite (it carries a `role`: the mobile menu's drawer) follows R2 (board 3): the
|
|
3481
|
+
* selection is the reveal, and moving it out of the part hides it again;
|
|
3482
|
+
* - a free-standing overlay (a plain Dialog) follows board A4: selecting it opens it, and it stays open
|
|
3483
|
+
* while the author works elsewhere, until its X, its backdrop or the eye closes it.
|
|
3484
|
+
*/
|
|
3485
|
+
declare enum SelectionReveal {
|
|
3486
|
+
WhileSelected = "while-selected",
|
|
3487
|
+
UntilClosed = "until-closed"
|
|
3488
|
+
}
|
|
3489
|
+
declare function selectionRevealOf(node: {
|
|
3490
|
+
type?: string;
|
|
3491
|
+
role?: string | null;
|
|
3492
|
+
} | null | undefined): SelectionReveal | null;
|
|
3467
3493
|
/** Root → `target`, inclusive, across `roots` (page layout and globals), or [] when it is not there. */
|
|
3468
3494
|
declare function pathToNode<T extends {
|
|
3469
3495
|
children?: T[];
|
|
@@ -3940,5 +3966,5 @@ declare class TextBlockComponentConfig extends ComponentConfig {
|
|
|
3940
3966
|
constructor();
|
|
3941
3967
|
}
|
|
3942
3968
|
|
|
3943
|
-
export { ACTION_TYPE_OPTIONS, AuditCode, AuditPanelComponent, AuditSeverity, BODY_CRUMB_LABEL, BOUND_ICON, BREAKPOINT_PRESENTATION, BUILDER_CANVAS_CONTAINER, BUILDER_CHROME_EN, BUILDER_FONT_LINK_ATTR, BUILDER_TOKEN_SCOPE_CLASS, BackgroundGroupStyleConfig, BorderGroupStyleConfig, BreadcrumbBarComponent, BuilderButtonBlockComponent, BuilderButtonComponentConfig, BuilderClipboardService, BuilderComponent, BuilderContainerComponent, BuilderContainerComponentConfig, BuilderDataSourceService, BuilderDialogComponent, BuilderDividerComponentConfig, BuilderHeadingComponentConfig, BuilderHistoryService, BuilderIconComponentConfig, BuilderImageComponentConfig, BuilderLinkComponentConfig, BuilderLinkedContainerComponent, BuilderLinkedContainerConfig, BuilderListComponentConfig, BuilderListItemComponentConfig, BuilderMode, BuilderRepeaterComponent, BuilderSpacerComponentConfig, ButtonBlockComponentConfig, CANVAS_EMPTY_IMAGE_LABEL_EN, CANVAS_EMPTY_IMAGE_LABEL_KEY, CANVAS_ROOT_RESET_CSS, COMPOSITE_PRESETS, CanvasDesignStateService, CanvasShowState, CardComponentConfig, ChildLayoutGroupStyleConfig, ComponentConfig, ComponentRegistryService, CompositePresetId, DEFAULT_ESSENTIAL_TRAITS, DRAG_HANDLE_ATTR, DROP_REFUSED_CLASS, DataSourceRegistryService, DataSourceType, DialogComponentConfig, DimensionsGroupStyleConfig, DragEngineService, EASING_OPTIONS, EDITOR_CHROME_ATTRIBUTE, ESSENTIAL_TRAITS_BY_TYPE, EffectsGroupStyleConfig, FIELD_KIND_PRESETS, FIELD_PARTS, FORM_STATE_BLOCK_TYPES, FORM_TYPE, FieldComponentConfig, FieldGroupComponentConfig, FormComponentConfig, FormErrorComponentConfig, FormStateService, FormSuccessComponentConfig, GalleryConfig, GroupStyleConfig, HIDDEN_AT_REST_LABEL_KEY, HIDDEN_AT_REST_TYPES, INSERT_REFUSAL_LABEL_KEYS, INTERACTION_STATES, INVERSE_ACTION, IOX_BUILDER_CANVAS, IOX_BUILDER_LABELS, IOX_DATA_SOURCE_ENDPOINTS, InsertRefusal, InteractionEngineService, InteractionPresetRegistryService, IoxBuilderModule, IoxDraggableDirective, IoxDropzoneDirective, LAYOUT_PRESETS, LayerTreeComponent, LayoutGroupStyleConfig, ListGroupStyleConfig, NodeAction, OverlayComponent, OverlayService, PALETTE_PRESET_DEFS, PanelChildComponent, PanelComponent, PanelEventService, PanelEventTypes, PanelTypes, PositionGroupStyleConfig, PresetRegistryService, RELATIONAL_STATES, RELATIONAL_STATE_BASE, REPEATER_SOURCE_PROP, REPEATER_TYPE, ROOT_ESCAPE_PX, ROUTE_ANIMATION_OPTIONS, RenderDirective, RepeaterComponentConfig, RootZone, SCREEN_WIDTH_OPTIONS, STRUCTURAL_STATES, SUPPORTED_STATES, SectionComponent, SectionComponentConfig, SizeGroupStyleConfig, SliderContainerComponent, SliderContainerConfig, SliderSlideComponent, SliderSlideConfig, SpacingGroupStyleConfig, StructureFix, StyleCategory, StyleRegistryService, TraitConfig as StyleTraitConfig, SubmitButtonComponentConfig, SymbolRegistryService, TARGETED_STATES, TARGETED_STATE_BASE, TRIGGER_OPTIONS, TextBlockComponentConfig, ToolbarAction, ToolbarComponent, TraitConfig, TraitInputType, TypographyGroupStyleConfig, UNITS_ALL, UNITS_DEG, UNITS_FIXED, UNITS_NO_VW, VALIDATION_STATES, VALIDATION_STATE_CLASS, ViewportService, ZOOM_OPTIONS, arrayItemSchemaFields, arraySchemaFields, auditNodes, bindingLabel, bindingLabels, buildCompositePreset, buildConsentPreset, buildElementStyleSpecimen, buildFieldKindPreset, buildFlavorSpecimen, buildFormPreset, buildFullStyleTraits, buildLayoutPreset, buildPalettePreset, buildPresetStyleTraits, builderCompositeFactory, canFluidise, canvasEmptyImageLabel, collapseColumnsProps, columnCountOf, defaultBuilderLabels, defaultPageSettings, dropTargetLabel, escapesRoot, essentialTraitsFor, findNodeLocation, findParentOf, flattenLayerTree, flattenSchemaFields, fluidiseProps, generateNodeId, insertRefusal, insertRefusalLabel, isHiddenAt, isHiddenAtRest, isSpecimen, markSpecimen, matchesControlSearch, nearestFormNode, nodeAncestorPath, nodeAncestorPathInEither, nodeStyleMap, pathToNode, refreshSubtree, removalRefusal, reorderProps, repeaterSourceAlias, repeaterSubLabel, resolveInsertTarget, resolveTraitControllerType, resolveTraitOptions, rootEscapeBand, rootZone, setStyleTrait, setTrait, stackChildrenProps, summarise, syncEmptyImagePlaceholder, syncNodeDesign, syncNodeInputs, textNode, upsertNodeStyles, visibilityProps, walkNodes, wrapNode };
|
|
3969
|
+
export { ACTION_TYPE_OPTIONS, AuditCode, AuditPanelComponent, AuditSeverity, BODY_CRUMB_LABEL, BOUND_ICON, BREAKPOINT_PRESENTATION, BUILDER_CANVAS_CONTAINER, BUILDER_CHROME_EN, BUILDER_FONT_LINK_ATTR, BUILDER_TOKEN_SCOPE_CLASS, BackgroundGroupStyleConfig, BorderGroupStyleConfig, BreadcrumbBarComponent, BuilderButtonBlockComponent, BuilderButtonComponentConfig, BuilderClipboardService, BuilderComponent, BuilderContainerComponent, BuilderContainerComponentConfig, BuilderDataSourceService, BuilderDialogComponent, BuilderDividerComponentConfig, BuilderHeadingComponentConfig, BuilderHistoryService, BuilderIconComponentConfig, BuilderImageComponentConfig, BuilderLinkComponentConfig, BuilderLinkedContainerComponent, BuilderLinkedContainerConfig, BuilderListComponentConfig, BuilderListItemComponentConfig, BuilderMode, BuilderRepeaterComponent, BuilderSpacerComponentConfig, ButtonBlockComponentConfig, CANVAS_EMPTY_IMAGE_LABEL_EN, CANVAS_EMPTY_IMAGE_LABEL_KEY, CANVAS_ROOT_RESET_CSS, COMPOSITE_PRESETS, CanvasDesignStateService, CanvasShowState, CardComponentConfig, ChildLayoutGroupStyleConfig, ComponentConfig, ComponentRegistryService, CompositePresetId, DEFAULT_ESSENTIAL_TRAITS, DRAG_HANDLE_ATTR, DROP_REFUSED_CLASS, DataSourceRegistryService, DataSourceType, DialogComponentConfig, DimensionsGroupStyleConfig, DragEngineService, EASING_OPTIONS, EDITOR_CHROME_ATTRIBUTE, ESSENTIAL_TRAITS_BY_TYPE, EffectsGroupStyleConfig, FIELD_KIND_PRESETS, FIELD_PARTS, FORM_STATE_BLOCK_TYPES, FORM_TYPE, FieldComponentConfig, FieldGroupComponentConfig, FormComponentConfig, FormErrorComponentConfig, FormStateService, FormSuccessComponentConfig, GalleryConfig, GroupStyleConfig, HIDDEN_AT_REST_LABEL_KEY, HIDDEN_AT_REST_TYPES, INSERT_REFUSAL_LABEL_KEYS, INTERACTION_STATES, INVERSE_ACTION, IOX_BUILDER_CANVAS, IOX_BUILDER_LABELS, IOX_DATA_SOURCE_ENDPOINTS, InsertRefusal, InteractionEngineService, InteractionPresetRegistryService, IoxBuilderModule, IoxDraggableDirective, IoxDropzoneDirective, LAYOUT_PRESETS, LayerTreeComponent, LayoutGroupStyleConfig, ListGroupStyleConfig, NodeAction, OverlayComponent, OverlayService, PALETTE_PRESET_DEFS, PanelChildComponent, PanelComponent, PanelEventService, PanelEventTypes, PanelTypes, PositionGroupStyleConfig, PresetRegistryService, RELATIONAL_STATES, RELATIONAL_STATE_BASE, REPEATER_SOURCE_PROP, REPEATER_TYPE, ROOT_ESCAPE_PX, ROUTE_ANIMATION_OPTIONS, RenderDirective, RepeaterComponentConfig, RootZone, SCREEN_WIDTH_OPTIONS, STRUCTURAL_STATES, SUPPORTED_STATES, SectionComponent, SectionComponentConfig, SelectionReveal, SizeGroupStyleConfig, SliderContainerComponent, SliderContainerConfig, SliderSlideComponent, SliderSlideConfig, SpacingGroupStyleConfig, StructureFix, StyleCategory, StyleRegistryService, TraitConfig as StyleTraitConfig, SubmitButtonComponentConfig, SymbolRegistryService, TARGETED_STATES, TARGETED_STATE_BASE, TRIGGER_OPTIONS, TextBlockComponentConfig, ToolbarAction, ToolbarComponent, TraitConfig, TraitInputType, TypographyGroupStyleConfig, UNITS_ALL, UNITS_DEG, UNITS_FIXED, UNITS_NO_VW, VALIDATION_STATES, VALIDATION_STATE_CLASS, ViewportService, ZOOM_OPTIONS, arrayItemSchemaFields, arraySchemaFields, auditNodes, bindingLabel, bindingLabels, buildCompositePreset, buildConsentPreset, buildElementStyleSpecimen, buildFieldKindPreset, buildFlavorSpecimen, buildFormPreset, buildFullStyleTraits, buildLayoutPreset, buildPalettePreset, buildPresetStyleTraits, builderCompositeFactory, canFluidise, canvasEmptyImageLabel, collapseColumnsProps, columnCountOf, defaultBuilderLabels, defaultPageSettings, dropTargetLabel, escapesRoot, essentialTraitsFor, findNodeLocation, findParentOf, flattenLayerTree, flattenSchemaFields, fluidiseProps, generateNodeId, insertRefusal, insertRefusalLabel, isHiddenAt, isHiddenAtRest, isSpecimen, markSpecimen, matchesControlSearch, nearestFormNode, nodeAncestorPath, nodeAncestorPathInEither, nodeStyleMap, pathToNode, refreshSubtree, removalRefusal, reorderProps, repeaterSourceAlias, repeaterSubLabel, resolveInsertTarget, resolveTraitControllerType, resolveTraitOptions, rootEscapeBand, rootZone, selectionRevealOf, setStyleTrait, setTrait, stackChildrenProps, summarise, syncEmptyImagePlaceholder, syncNodeDesign, syncNodeInputs, textNode, upsertNodeStyles, visibilityProps, walkNodes, wrapNode };
|
|
3944
3970
|
export type { AuditFinding, AuditNode, BreakpointPresentation, BuilderClipboard, BuilderLabelResolver, CanvasDesignSnapshot, ComponentEventDef, ComponentMethodDef, ComponentNode, ComponentTrait, CompositePresetDef, ConsentPreset, CreateConfig, Crumb, DesignSpecimenCopy, DragPayload, DsFilterByQueryParam, DsFilterByRouteParam, ElementState, FieldKindDef, FormStateSnapshot, HistoryChange, HistoryEntry, HistoryStep, InsertRefusedEvent, InsertTarget, InteractionAction, InteractionActionType, InteractionPreset, InteractionTrigger, IoxBinding, IoxDataSource, IoxDropEvent, IoxInteraction, IoxSymbol, LayerMoreRows, LayerRepeaterRows, LayerTreeContext, LayerTreeRow, LayoutPresetChildStyles, LayoutPresetDef, NodeRef, OverlayBoxModel, OverlayBoxSpacing, OverlayEntry, PageRouteAnimationSettings, PageScrollSettings, PageSettings, PalettePresetDef, PanelEvent, QuadSizeSegment, RootEscapeMemory, RouteAnimationPreset, ScreenWidthOption, SelectionBadge, StyleMap, StylePart, StylePreset, StyleTrait, StyleTraitGroup, TraitOptionMap, TraitSelectOption, TraitShowCondition, TreePathNode, UpsertTokensOptions, ViewportState, ZoomOption };
|