@vectoriox/iox-builder 4.8.0 → 4.10.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/index.d.ts
CHANGED
|
@@ -1440,7 +1440,11 @@ declare enum AuditCode {
|
|
|
1440
1440
|
FixedWidth = "fixed-width",
|
|
1441
1441
|
TapTarget = "tap-target",
|
|
1442
1442
|
TinyText = "tiny-text",
|
|
1443
|
-
UnboundedImage = "unbounded-image"
|
|
1443
|
+
UnboundedImage = "unbounded-image",
|
|
1444
|
+
/** A slider showing more slides than the width can carry — each one unreadably narrow. */
|
|
1445
|
+
SlidesOverflow = "slides-overflow",
|
|
1446
|
+
/** An out-of-flow node whose box lands outside the frame, so it is unreachable at this width. */
|
|
1447
|
+
OffscreenAbsolute = "offscreen-absolute"
|
|
1444
1448
|
}
|
|
1445
1449
|
declare enum AuditSeverity {
|
|
1446
1450
|
Error = "error",
|
|
@@ -1454,9 +1458,15 @@ interface AuditNode {
|
|
|
1454
1458
|
label?: string;
|
|
1455
1459
|
/** Styles RESOLVED at this breakpoint (base + every wider layer + this one). */
|
|
1456
1460
|
styleProps: StyleMap;
|
|
1461
|
+
/** Component TRAITS resolved at this breakpoint — the per-width values a media query cannot
|
|
1462
|
+
* express (a slider's `slidesPerView`). Absent for nodes with no traits worth auditing. */
|
|
1463
|
+
inputs?: Record<string, any>;
|
|
1457
1464
|
/** Laid-out size in CSS px at this width. */
|
|
1458
1465
|
width: number;
|
|
1459
1466
|
height: number;
|
|
1467
|
+
/** Laid-out position in CSS px, relative to the canvas frame. Absent when not measured. */
|
|
1468
|
+
left?: number;
|
|
1469
|
+
top?: number;
|
|
1460
1470
|
}
|
|
1461
1471
|
interface AuditFinding {
|
|
1462
1472
|
nodeId: string;
|
|
@@ -1467,6 +1477,9 @@ interface AuditFinding {
|
|
|
1467
1477
|
message: string;
|
|
1468
1478
|
/** Props to write into this breakpoint's layer to repair it; absent when no safe auto-fix. */
|
|
1469
1479
|
fix?: StyleMap;
|
|
1480
|
+
/** TRAIT values to write into this breakpoint's layer — some failures are not fixable with CSS.
|
|
1481
|
+
* Applied through `setInputOverride`, the trait twin of `setOverride`. */
|
|
1482
|
+
inputFix?: Record<string, any>;
|
|
1470
1483
|
}
|
|
1471
1484
|
/**
|
|
1472
1485
|
* Audit nodes laid out at `viewportWidth`. Returns findings ordered by severity (errors first),
|
|
@@ -1648,6 +1661,8 @@ declare class BuilderComponent implements OnInit, AfterViewInit, OnChanges, OnDe
|
|
|
1648
1661
|
* `utils/responsive-audit.util.ts`.
|
|
1649
1662
|
*/
|
|
1650
1663
|
runAudit(): void;
|
|
1664
|
+
/** The node's OWN trait values — the Base layer the responsive `inputs` cascade sits on top of. */
|
|
1665
|
+
private baseInputMapOf;
|
|
1651
1666
|
/** Apply one finding's fix into the current breakpoint's layer (or the base styles at Base). */
|
|
1652
1667
|
applyAuditFix(finding: AuditFinding): void;
|
|
1653
1668
|
/** Apply every fixable finding, then re-measure. */
|
|
@@ -2884,6 +2899,48 @@ declare class GalleryConfig extends ComponentConfig {
|
|
|
2884
2899
|
constructor();
|
|
2885
2900
|
}
|
|
2886
2901
|
|
|
2902
|
+
/**
|
|
2903
|
+
* Form — the container that scopes its fields by ANCESTRY (decision D1).
|
|
2904
|
+
*
|
|
2905
|
+
* The destination config ("After submit") is an ordered action list edited in the Bindings panel as
|
|
2906
|
+
* a property group, not here as flat traits — see forms-and-inputs-plan.md §4b. What lives here is
|
|
2907
|
+
* the handful of settings that ARE single values.
|
|
2908
|
+
*
|
|
2909
|
+
* Auto-creates a working contact form: two fields, a submit button, and the two non-deletable state
|
|
2910
|
+
* blocks. Dropping a Form therefore gives a form that already validates and already stores.
|
|
2911
|
+
*/
|
|
2912
|
+
declare class FormComponentConfig extends ComponentConfig {
|
|
2913
|
+
constructor();
|
|
2914
|
+
}
|
|
2915
|
+
/**
|
|
2916
|
+
* Field — ONE component for every control type (decision D4).
|
|
2917
|
+
*
|
|
2918
|
+
* `Required` is its own switch because it is the rule every form needs; the rest are added from a
|
|
2919
|
+
* menu, so an unused rule is invisible rather than an empty control (the Effects-group pattern).
|
|
2920
|
+
*/
|
|
2921
|
+
declare class FieldComponentConfig extends ComponentConfig {
|
|
2922
|
+
constructor();
|
|
2923
|
+
}
|
|
2924
|
+
/** A plain layout row so two fields can sit side by side. Config-only, like List/ListItem. */
|
|
2925
|
+
declare class FieldGroupComponentConfig extends ComponentConfig {
|
|
2926
|
+
constructor();
|
|
2927
|
+
}
|
|
2928
|
+
/** The submit button. Carries no destination — that lives on the Form (decision D9). */
|
|
2929
|
+
declare class SubmitButtonComponentConfig extends ComponentConfig {
|
|
2930
|
+
constructor();
|
|
2931
|
+
}
|
|
2932
|
+
/**
|
|
2933
|
+
* The Success block. `hidden` keeps it out of the Components panel: it is auto-created by the Form
|
|
2934
|
+
* and reached through the canvas state switcher, never dropped on its own.
|
|
2935
|
+
*/
|
|
2936
|
+
declare class FormSuccessComponentConfig extends ComponentConfig {
|
|
2937
|
+
constructor();
|
|
2938
|
+
}
|
|
2939
|
+
/** The Error block. One design, five reasons — the renderer writes the resolved reason in. */
|
|
2940
|
+
declare class FormErrorComponentConfig extends ComponentConfig {
|
|
2941
|
+
constructor();
|
|
2942
|
+
}
|
|
2943
|
+
|
|
2887
2944
|
declare class BuilderHeadingComponentConfig extends ComponentConfig {
|
|
2888
2945
|
constructor();
|
|
2889
2946
|
}
|
|
@@ -2937,5 +2994,5 @@ declare class TextBlockComponentConfig extends ComponentConfig {
|
|
|
2937
2994
|
constructor();
|
|
2938
2995
|
}
|
|
2939
2996
|
|
|
2940
|
-
export { ACTION_TYPE_OPTIONS, AuditCode, AuditPanelComponent, AuditSeverity, BREAKPOINT_PRESENTATION, BUILDER_CANVAS_CONTAINER, BackgroundGroupStyleConfig, BorderGroupStyleConfig, BreadcrumbBarComponent, BuilderButtonBlockComponent, BuilderButtonComponentConfig, BuilderClipboardService, BuilderComponent, BuilderContainerComponent, BuilderContainerComponentConfig, BuilderDataSourceService, BuilderDividerComponentConfig, BuilderHeadingComponentConfig, BuilderHistoryService, BuilderIconComponentConfig, BuilderImageComponentConfig, BuilderLinkComponentConfig, BuilderLinkedContainerComponent, BuilderLinkedContainerConfig, BuilderListComponentConfig, BuilderListItemComponentConfig, BuilderMode, BuilderRepeaterComponent, BuilderSpacerComponentConfig, ButtonBlockComponentConfig, CardComponentConfig, ChildLayoutGroupStyleConfig, ComponentConfig, ComponentRegistryService, DEFAULT_ESSENTIAL_TRAITS, DRAG_HANDLE_ATTR, DataSourceRegistryService, DataSourceType, DimensionsGroupStyleConfig, DragEngineService, EASING_OPTIONS, ESSENTIAL_TRAITS_BY_TYPE, EffectsGroupStyleConfig, GalleryConfig, GroupStyleConfig, INTERACTION_STATES, INVERSE_ACTION, IOX_DATA_SOURCE_ENDPOINTS, IOX_FONT_MANAGER, InteractionEngineService, InteractionPresetRegistryService, IoxBuilderModule, IoxDraggableDirective, IoxDropzoneDirective, LAYOUT_PRESETS, LayerTreeComponent, LayoutGroupStyleConfig, ListGroupStyleConfig, NodeAction, OverlayComponent, OverlayService, PanelChildComponent, PanelComponent, PanelEventService, PanelEventTypes, PanelTypes, PositionGroupStyleConfig, PresetRegistryService, RELATIONAL_STATES, RELATIONAL_STATE_BASE, ROUTE_ANIMATION_OPTIONS, RenderDirective, RepeaterComponentConfig, SCREEN_WIDTH_OPTIONS, STRUCTURAL_STATES, SUPPORTED_STATES, SectionComponent, SectionComponentConfig, SizeGroupStyleConfig, SliderContainerComponent, SliderContainerConfig, SliderSlideComponent, SliderSlideConfig, SpacingGroupStyleConfig, StyleCategory, StyleRegistryService, TraitConfig as StyleTraitConfig, SymbolRegistryService, TARGETED_STATES, TARGETED_STATE_BASE, TRIGGER_OPTIONS, TextBlockComponentConfig, ToolbarAction, ToolbarComponent, TraitConfig, TraitInputType, TypographyGroupStyleConfig, UNITS_ALL, UNITS_DEG, UNITS_FIXED, UNITS_NO_VW, ViewportService, ZOOM_OPTIONS, arrayItemSchemaFields, arraySchemaFields, auditNodes, buildFullStyleTraits, buildLayoutPreset, buildPresetStyleTraits, canFluidise, collapseColumnsProps, columnCountOf, defaultPageSettings, dropTargetLabel, essentialTraitsFor, findNodeLocation, findParentOf, flattenSchemaFields, fluidiseProps, generateNodeId, isHiddenAt, matchesControlSearch, nodeAncestorPath, nodeAncestorPathInEither, reorderProps, resolveInsertTarget, resolveTraitControllerType, resolveTraitOptions, setStyleTrait, stackChildrenProps, summarise, visibilityProps, wrapNode };
|
|
2997
|
+
export { ACTION_TYPE_OPTIONS, AuditCode, AuditPanelComponent, AuditSeverity, BREAKPOINT_PRESENTATION, BUILDER_CANVAS_CONTAINER, BackgroundGroupStyleConfig, BorderGroupStyleConfig, BreadcrumbBarComponent, BuilderButtonBlockComponent, BuilderButtonComponentConfig, BuilderClipboardService, BuilderComponent, BuilderContainerComponent, BuilderContainerComponentConfig, BuilderDataSourceService, BuilderDividerComponentConfig, BuilderHeadingComponentConfig, BuilderHistoryService, BuilderIconComponentConfig, BuilderImageComponentConfig, BuilderLinkComponentConfig, BuilderLinkedContainerComponent, BuilderLinkedContainerConfig, BuilderListComponentConfig, BuilderListItemComponentConfig, BuilderMode, BuilderRepeaterComponent, BuilderSpacerComponentConfig, ButtonBlockComponentConfig, CardComponentConfig, ChildLayoutGroupStyleConfig, ComponentConfig, ComponentRegistryService, DEFAULT_ESSENTIAL_TRAITS, DRAG_HANDLE_ATTR, DataSourceRegistryService, DataSourceType, DimensionsGroupStyleConfig, DragEngineService, EASING_OPTIONS, ESSENTIAL_TRAITS_BY_TYPE, EffectsGroupStyleConfig, FieldComponentConfig, FieldGroupComponentConfig, FormComponentConfig, FormErrorComponentConfig, FormSuccessComponentConfig, GalleryConfig, GroupStyleConfig, INTERACTION_STATES, INVERSE_ACTION, IOX_DATA_SOURCE_ENDPOINTS, IOX_FONT_MANAGER, InteractionEngineService, InteractionPresetRegistryService, IoxBuilderModule, IoxDraggableDirective, IoxDropzoneDirective, LAYOUT_PRESETS, LayerTreeComponent, LayoutGroupStyleConfig, ListGroupStyleConfig, NodeAction, OverlayComponent, OverlayService, PanelChildComponent, PanelComponent, PanelEventService, PanelEventTypes, PanelTypes, PositionGroupStyleConfig, PresetRegistryService, RELATIONAL_STATES, RELATIONAL_STATE_BASE, ROUTE_ANIMATION_OPTIONS, RenderDirective, RepeaterComponentConfig, SCREEN_WIDTH_OPTIONS, STRUCTURAL_STATES, SUPPORTED_STATES, SectionComponent, SectionComponentConfig, SizeGroupStyleConfig, SliderContainerComponent, SliderContainerConfig, SliderSlideComponent, SliderSlideConfig, SpacingGroupStyleConfig, 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, ViewportService, ZOOM_OPTIONS, arrayItemSchemaFields, arraySchemaFields, auditNodes, buildFullStyleTraits, buildLayoutPreset, buildPresetStyleTraits, canFluidise, collapseColumnsProps, columnCountOf, defaultPageSettings, dropTargetLabel, essentialTraitsFor, findNodeLocation, findParentOf, flattenSchemaFields, fluidiseProps, generateNodeId, isHiddenAt, matchesControlSearch, nodeAncestorPath, nodeAncestorPathInEither, reorderProps, resolveInsertTarget, resolveTraitControllerType, resolveTraitOptions, setStyleTrait, stackChildrenProps, summarise, visibilityProps, wrapNode };
|
|
2941
2998
|
export type { AuditFinding, AuditNode, BreakpointPresentation, BuilderClipboard, ComponentEventDef, ComponentMethodDef, ComponentNode, ComponentTrait, Crumb, DragPayload, DsFilterByQueryParam, DsFilterByRouteParam, ElementState, HistoryEntry, InsertTarget, InteractionAction, InteractionActionType, InteractionPreset, InteractionTrigger, IoxBinding, IoxDataSource, IoxDropEvent, IoxFontManager, IoxInteraction, IoxSymbol, LayoutPresetChildStyles, LayoutPresetDef, NodeRef, OverlayBoxModel, OverlayBoxSpacing, OverlayEntry, PageRouteAnimationSettings, PageScrollSettings, PageSettings, PageStyleSettings, PanelEvent, QuadSizeSegment, RouteAnimationPreset, ScreenWidthOption, SelectionBadge, StyleMap, StylePreset, StyleTrait, StyleTraitGroup, TraitOptionMap, TraitSelectOption, TraitShowCondition, TreePathNode, ViewportState, ZoomOption };
|