@vectoriox/iox-builder 4.11.0 → 4.12.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/fesm2022/vectoriox-iox-builder.mjs +147 -65
- package/fesm2022/vectoriox-iox-builder.mjs.map +1 -1
- package/index.d.ts +64 -22
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -2108,7 +2108,46 @@ declare class OverlayComponent implements OnInit, OnDestroy {
|
|
|
2108
2108
|
static ɵcmp: i0.ɵɵComponentDeclaration<OverlayComponent, "app-overlay", never, {}, { "toolbarAction": "toolbarAction"; }, never, never, false, never>;
|
|
2109
2109
|
}
|
|
2110
2110
|
|
|
2111
|
+
/**
|
|
2112
|
+
* Canvas data preview used to come from host-provided content services (IOX_CONTENT_SERVICE /
|
|
2113
|
+
* IOX_SHOP_SERVICE), whose `getContent(contentType, orgId)` hit the ADMIN resources endpoint and
|
|
2114
|
+
* accepted no filters — so the Repeater/Slider ignored every data-source filter. Data now flows
|
|
2115
|
+
* through BuilderDataSourceService + the shared planDataSource, configured with
|
|
2116
|
+
* IOX_DATA_SOURCE_ENDPOINTS. Those tokens are gone; do not reintroduce a fetch that bypasses it.
|
|
2117
|
+
*/
|
|
2118
|
+
/** Optional font manager. Provide from the host app to populate the fontFamily dropdown. */
|
|
2119
|
+
declare const IOX_FONT_MANAGER: InjectionToken<IoxFontManager>;
|
|
2120
|
+
interface IoxFontManager {
|
|
2121
|
+
loadFonts(orgId: string): void;
|
|
2122
|
+
uploadedFonts$: rxjs.Observable<any>;
|
|
2123
|
+
getAllFontOptions(): {
|
|
2124
|
+
label: string;
|
|
2125
|
+
value: string;
|
|
2126
|
+
}[];
|
|
2127
|
+
}
|
|
2128
|
+
/**
|
|
2129
|
+
* Translates the builder library's OWN chrome.
|
|
2130
|
+
*
|
|
2131
|
+
* The library cannot depend on ngx-translate — that is the host app's choice — but its toolbar was
|
|
2132
|
+
* hardcoded English, which shows through as untranslated controls in a Hebrew/RTL admin. This token
|
|
2133
|
+
* lets the host route those strings through its own i18n while the library keeps working standalone:
|
|
2134
|
+
* unprovided, `defaultBuilderLabels` returns the English text, so nothing ever renders a raw key.
|
|
2135
|
+
*
|
|
2136
|
+
* Keys are namespaced `builder.chrome.*` and listed in `BUILDER_CHROME_EN` below — that object is
|
|
2137
|
+
* the contract. A host providing this token should add those keys to its own bundles.
|
|
2138
|
+
*/
|
|
2139
|
+
declare const IOX_BUILDER_LABELS: InjectionToken<BuilderLabelResolver>;
|
|
2140
|
+
type BuilderLabelResolver = (key: string, fallback: string) => string;
|
|
2141
|
+
/** Standalone behaviour: the English text the library ships with. */
|
|
2142
|
+
declare const defaultBuilderLabels: BuilderLabelResolver;
|
|
2143
|
+
/**
|
|
2144
|
+
* Every user-visible string in the builder's own chrome, so a host can copy this into its bundles
|
|
2145
|
+
* in one go rather than discovering keys one missing label at a time.
|
|
2146
|
+
*/
|
|
2147
|
+
declare const BUILDER_CHROME_EN: Readonly<Record<string, string>>;
|
|
2148
|
+
|
|
2111
2149
|
declare class ToolbarComponent {
|
|
2150
|
+
private readonly labels;
|
|
2112
2151
|
activeMode: BuilderMode;
|
|
2113
2152
|
activeBreakpoint: Breakpoint;
|
|
2114
2153
|
/** Overrides per breakpoint — for the selection, or the page when nothing is selected. */
|
|
@@ -2163,13 +2202,25 @@ declare class ToolbarComponent {
|
|
|
2163
2202
|
get sliderZoom(): number;
|
|
2164
2203
|
toggleModePopover(event: Event): void;
|
|
2165
2204
|
selectMode(mode: BuilderMode): void;
|
|
2205
|
+
constructor(labels: BuilderLabelResolver);
|
|
2166
2206
|
selectBreakpoint(bp: Breakpoint): void;
|
|
2167
2207
|
/** The four states, in the order a submission moves through them. */
|
|
2168
2208
|
readonly formStates: {
|
|
2169
2209
|
id: FormRenderState;
|
|
2170
|
-
|
|
2210
|
+
labelKey: string;
|
|
2171
2211
|
icon: string;
|
|
2172
2212
|
}[];
|
|
2213
|
+
/**
|
|
2214
|
+
* Translate one of the builder's own chrome strings. Unprovided, the resolver returns the
|
|
2215
|
+
* English fallback from `BUILDER_CHROME_EN`, so the library still reads correctly standalone
|
|
2216
|
+
* and never renders a raw key.
|
|
2217
|
+
*/
|
|
2218
|
+
t(key: string): string;
|
|
2219
|
+
/** "Show the form's Success state" — one key with a slot, not four sentences to translate. */
|
|
2220
|
+
formStateHint(state: {
|
|
2221
|
+
labelKey: string;
|
|
2222
|
+
}): string;
|
|
2223
|
+
get publishLabel(): string;
|
|
2173
2224
|
selectFormState(state: FormRenderState): void;
|
|
2174
2225
|
onSliderChange(event: Event): void;
|
|
2175
2226
|
toggleWidthPopover(event: Event): void;
|
|
@@ -2230,6 +2281,15 @@ declare class BuilderContainerComponent implements OnInit, OnDestroy {
|
|
|
2230
2281
|
htmlTag: string;
|
|
2231
2282
|
start: number;
|
|
2232
2283
|
reversed: boolean;
|
|
2284
|
+
/**
|
|
2285
|
+
* Form-family marker: `iox-form`, `iox-form-success`, `iox-form-error` or `iox-field-group`.
|
|
2286
|
+
* The builder reuses THIS component for those types (as it already does for List/ListItem), so
|
|
2287
|
+
* they get the canvas drop zone and child rendering; the class is what lets the shared form
|
|
2288
|
+
* stylesheet treat them exactly as it treats the engine's own twins.
|
|
2289
|
+
*/
|
|
2290
|
+
formClass: string;
|
|
2291
|
+
/** Which state the canvas is showing. Only meaningful on a form host. */
|
|
2292
|
+
formState: string;
|
|
2233
2293
|
childClick: EventEmitter<any>;
|
|
2234
2294
|
childMouseEnter: EventEmitter<any>;
|
|
2235
2295
|
childMouseLeave: EventEmitter<void>;
|
|
@@ -2239,7 +2299,7 @@ declare class BuilderContainerComponent implements OnInit, OnDestroy {
|
|
|
2239
2299
|
get listOrientation(): 'horizontal' | 'vertical';
|
|
2240
2300
|
onDrop(event: IoxDropEvent): void;
|
|
2241
2301
|
static ɵfac: i0.ɵɵFactoryDeclaration<BuilderContainerComponent, never>;
|
|
2242
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<BuilderContainerComponent, "div[iox-container],section[iox-container],article[iox-container],header[iox-container],footer[iox-container],main[iox-container],nav[iox-container],ul[iox-container],ol[iox-container],li[iox-container]", never, { "children": { "alias": "children"; "required": false; }; "style": { "alias": "style"; "required": false; }; "nodeId": { "alias": "nodeId"; "required": false; }; "dropListId": { "alias": "dropListId"; "required": false; }; "htmlTag": { "alias": "htmlTag"; "required": false; }; "start": { "alias": "start"; "required": false; }; "reversed": { "alias": "reversed"; "required": false; }; }, { "childClick": "childClick"; "childMouseEnter": "childMouseEnter"; "childMouseLeave": "childMouseLeave"; }, never, never, false, never>;
|
|
2302
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<BuilderContainerComponent, "div[iox-container],section[iox-container],article[iox-container],header[iox-container],footer[iox-container],main[iox-container],nav[iox-container],ul[iox-container],ol[iox-container],li[iox-container],form[iox-container]", never, { "children": { "alias": "children"; "required": false; }; "style": { "alias": "style"; "required": false; }; "nodeId": { "alias": "nodeId"; "required": false; }; "dropListId": { "alias": "dropListId"; "required": false; }; "htmlTag": { "alias": "htmlTag"; "required": false; }; "start": { "alias": "start"; "required": false; }; "reversed": { "alias": "reversed"; "required": false; }; "formClass": { "alias": "formClass"; "required": false; }; "formState": { "alias": "formState"; "required": false; }; }, { "childClick": "childClick"; "childMouseEnter": "childMouseEnter"; "childMouseLeave": "childMouseLeave"; }, never, never, false, never>;
|
|
2243
2303
|
}
|
|
2244
2304
|
|
|
2245
2305
|
declare class BuilderLinkedContainerComponent implements OnInit, OnDestroy {
|
|
@@ -2770,24 +2830,6 @@ declare class BuilderHistoryService {
|
|
|
2770
2830
|
static ɵprov: i0.ɵɵInjectableDeclaration<BuilderHistoryService>;
|
|
2771
2831
|
}
|
|
2772
2832
|
|
|
2773
|
-
/**
|
|
2774
|
-
* Canvas data preview used to come from host-provided content services (IOX_CONTENT_SERVICE /
|
|
2775
|
-
* IOX_SHOP_SERVICE), whose `getContent(contentType, orgId)` hit the ADMIN resources endpoint and
|
|
2776
|
-
* accepted no filters — so the Repeater/Slider ignored every data-source filter. Data now flows
|
|
2777
|
-
* through BuilderDataSourceService + the shared planDataSource, configured with
|
|
2778
|
-
* IOX_DATA_SOURCE_ENDPOINTS. Those tokens are gone; do not reintroduce a fetch that bypasses it.
|
|
2779
|
-
*/
|
|
2780
|
-
/** Optional font manager. Provide from the host app to populate the fontFamily dropdown. */
|
|
2781
|
-
declare const IOX_FONT_MANAGER: InjectionToken<IoxFontManager>;
|
|
2782
|
-
interface IoxFontManager {
|
|
2783
|
-
loadFonts(orgId: string): void;
|
|
2784
|
-
uploadedFonts$: rxjs.Observable<any>;
|
|
2785
|
-
getAllFontOptions(): {
|
|
2786
|
-
label: string;
|
|
2787
|
-
value: string;
|
|
2788
|
-
}[];
|
|
2789
|
-
}
|
|
2790
|
-
|
|
2791
2833
|
/**
|
|
2792
2834
|
* node-path — pure ancestor-chain helpers for the builder's node tree.
|
|
2793
2835
|
*
|
|
@@ -3077,5 +3119,5 @@ declare class TextBlockComponentConfig extends ComponentConfig {
|
|
|
3077
3119
|
constructor();
|
|
3078
3120
|
}
|
|
3079
3121
|
|
|
3080
|
-
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, FORM_PRESETS, FORM_TYPE, 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, buildFormPreset, buildFullStyleTraits, buildLayoutPreset, buildPresetStyleTraits, canFluidise, collapseColumnsProps, columnCountOf, defaultPageSettings, dropTargetLabel, essentialTraitsFor, findNodeLocation, findParentOf, flattenSchemaFields, fluidiseProps, generateNodeId, isHiddenAt, matchesControlSearch, nearestFormNode, nodeAncestorPath, nodeAncestorPathInEither, reorderProps, resolveInsertTarget, resolveTraitControllerType, resolveTraitOptions, setStyleTrait, stackChildrenProps, summarise, visibilityProps, wrapNode };
|
|
3081
|
-
export type { AuditFinding, AuditNode, BreakpointPresentation, BuilderClipboard, ComponentEventDef, ComponentMethodDef, ComponentNode, ComponentTrait, CreateConfig, Crumb, DragPayload, DsFilterByQueryParam, DsFilterByRouteParam, ElementState, FormPresetDef, FormPresetField, 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 };
|
|
3122
|
+
export { ACTION_TYPE_OPTIONS, AuditCode, AuditPanelComponent, AuditSeverity, BREAKPOINT_PRESENTATION, BUILDER_CANVAS_CONTAINER, BUILDER_CHROME_EN, 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, FORM_PRESETS, FORM_TYPE, FieldComponentConfig, FieldGroupComponentConfig, FormComponentConfig, FormErrorComponentConfig, FormSuccessComponentConfig, GalleryConfig, GroupStyleConfig, INTERACTION_STATES, INVERSE_ACTION, IOX_BUILDER_LABELS, 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, buildFormPreset, buildFullStyleTraits, buildLayoutPreset, buildPresetStyleTraits, canFluidise, collapseColumnsProps, columnCountOf, defaultBuilderLabels, defaultPageSettings, dropTargetLabel, essentialTraitsFor, findNodeLocation, findParentOf, flattenSchemaFields, fluidiseProps, generateNodeId, isHiddenAt, matchesControlSearch, nearestFormNode, nodeAncestorPath, nodeAncestorPathInEither, reorderProps, resolveInsertTarget, resolveTraitControllerType, resolveTraitOptions, setStyleTrait, stackChildrenProps, summarise, visibilityProps, wrapNode };
|
|
3123
|
+
export type { AuditFinding, AuditNode, BreakpointPresentation, BuilderClipboard, BuilderLabelResolver, ComponentEventDef, ComponentMethodDef, ComponentNode, ComponentTrait, CreateConfig, Crumb, DragPayload, DsFilterByQueryParam, DsFilterByRouteParam, ElementState, FormPresetDef, FormPresetField, 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 };
|