@vectoriox/iox-ui 5.84.0 → 5.86.0

package/actions-core/index.d.ts

@@ -10,7 +10,7 @@ import { CompositeItemAction } from '@vectoriox/iox-ui/composite-core';
 /** How a step executes — decides which editor fields appear (timing only for `animated`). */
 type ActionKind = 'animated' | 'instant' | 'server';
 /** Picker grouping. Flat lists die at ~10 entries; the group is data, never a second list. */
-type ActionGroup = 'motion' | 'visibility' | 'navigate' | 'dialog' | 'item' | 'form' | 'data' | 'consent' | 'service';
+type ActionGroup = 'motion' | 'visibility' | 'navigate' | 'dialog' | 'popover' | 'notice' | 'item' | 'form' | 'data' | 'consent' | 'service';
 /**
  * What a step does inside the live builder canvas (the canvas RUNS interactions):
  * `run` for real (open the dialog), `simulate` announce-only (navigate), `inert` with a
@@ -109,6 +109,8 @@ declare const SERVER_ELEMENT_ACTION_TYPES: ReadonlySet<string>;
 /** The Tier-A behaviour executors' dispatch set (A1c) — the engines branch on it beside
  *  DIALOG/SWIPER. Dialog actions have their own set; context/visibility stay in the legacy path. */
 declare const BEHAVIOUR_ACTION_TYPES: ReadonlySet<string>;
+/** The toast action's dispatch set (premium M5) — the engines branch on it beside DIALOG / POPOVER. */
+declare const TOAST_ACTION_TYPES: ReadonlySet<string>;
 /** The item actions' dispatch set (T14) and what each does to its item — the engines branch on it beside
  *  DIALOG/BEHAVIOUR, and composite-core `runCompositeItemAction` runs it on the target item's own runtime. */
 declare const ITEM_ACTION_TYPES: Readonly<Record<string, CompositeItemAction>>;
@@ -169,6 +171,9 @@ interface OpenerInteractionLike {
 interface OpenerNodeLike {
     interactions?: ReadonlyArray<OpenerInteractionLike> | null;
 }
+/** The node id the element's click opens through one of `openerTypes` (its first enabled such action), or null —
+ *  the ONE reading every opener kind shares (a dialog's, a popover's). */
+declare function openedTargetId(node: OpenerNodeLike | null | undefined, openerTypes: ReadonlySet<string>): string | null;
 /** The Dialog node id the element's click opens (its first enabled opener action), or null. */
 declare function openedDialogId(node: OpenerNodeLike | null | undefined): string | null;
 /**
@@ -180,6 +185,29 @@ declare function dialogOpenerAttributes(node: OpenerNodeLike | null | undefined,
 /** The selector of every opener of one dialog (by its DOM id) — what a runtime updates on open/close. */
 declare function dialogOpenersSelector(dialogDomIdValue: string): string;
 
+/**
+ * What an element that OPENS a popover says about itself (premium components M5, N4 — the APG disclosure pattern over a
+ * non-modal dialog): `aria-haspopup="dialog"`, `aria-controls` = the popover's DOM id, and `aria-expanded` — `false` in
+ * the server render, kept in step by the runtime. ONE decision for every renderer, read the way a dialog opener is
+ * (`openedTargetId`); the popover's DOM id comes from `popoverDomId`, the one place that names it.
+ */
+/** The Popover node type. */
+declare const POPOVER_NODE_TYPE = "Popover";
+/** The actions that open a popover (close-only actions do not make an opener). */
+declare const POPOVER_OPENER_ACTION_TYPES: ReadonlySet<string>;
+/** Every action that opens, closes or toggles a popover — what the engines dispatch. */
+declare const POPOVER_ACTION_TYPE_SET: ReadonlySet<string>;
+/** The DOM id of a Popover node's panel — what an opener's `aria-controls` names. */
+declare function popoverDomId(nodeId: string): string;
+/** The node id a popover DOM id names, or null. */
+declare function nodeIdOfPopoverDomId(domId: string | null | undefined): string | null;
+/** The Popover node id the element's click opens, or null. */
+declare function openedPopoverId(node: OpenerNodeLike | null | undefined): string | null;
+/** The opener attributes for a node: `{}` when its click opens no popover. */
+declare function popoverOpenerAttributes(node: OpenerNodeLike | null | undefined, open?: boolean): Record<string, string>;
+/** The selector of every opener of one popover (by its DOM id). */
+declare function popoverOpenersSelector(popoverDomIdValue: string): string;
+
 /**
  * How a dialog LEAVES (CC1 follow-up — the drawer that vanished). Opening is pure CSS (`@starting-style`
  * in the shared `iox-design.css`); closing needs one beat of script, because `dialog.close()` drops the
@@ -240,6 +268,22 @@ declare function runExitMotion(el: ExitMotionElement, options: ExitMotionOptions
 declare function closeDialogAnimated(el: DialogElementLike, options: ExitMotionOptions): Promise<void>;
 /** True when a toggle should CLOSE the dialog: it is open and not already on its way out. */
 declare function dialogTogglesClosed(el: Pick<DialogElementLike, 'open' | 'hasAttribute'>): boolean;
+interface FocusableSheet {
+    classList: {
+        contains(token: string): boolean;
+    };
+    querySelector(selector: string): unknown;
+    hasAttribute(name: string): boolean;
+    setAttribute(name: string, value: string): void;
+    focus(options?: FocusOptions): void;
+}
+/**
+ * A styled dialog a visitor just opened takes focus on its SHEET (premium components M4 — M1.1's carry-over). A bare
+ * `showModal()` focuses its first control, and a phone can ring it after a tap; the sheet never rings (iox-design.css) and
+ * the first Tab moves to that control, with its ring. A dialog with an author's `[autofocus]` keeps it; a dialog saved
+ * before element styles keeps the browser's behaviour. True when the sheet took focus.
+ */
+declare function focusDialogSheet(dialog: FocusableSheet | null | undefined): boolean;
 
-export { BEHAVIOUR_ACTION_TYPES, CONSENT_ACTION_TYPES, DIALOG_ACTION_TYPE_SET, DIALOG_CLOSING_ATTRIBUTE, DIALOG_EXIT_TIMEOUT_MS, DIALOG_OPENER_ACTION_TYPES, DIALOG_OPENER_TRIGGER, DIALOG_SELECTOR, ELEMENT_ACTION_DESCRIPTORS, ELEMENT_ACTION_GROUP_ORDER, FORM_SUBMIT_ACTION_DESCRIPTORS, ITEM_ACTION_TYPES, OpenerAttribute, SERVER_ELEMENT_ACTION_TYPES, addableActions, cancelExit, closeDialogAnimated, dialogDomId, dialogOpenerAttributes, dialogOpenersSelector, dialogTogglesClosed, groupedElementActions, isExiting, itemActionOf, nodeIdOfDialogDomId, openedDialogId, opensAtClickedItem, resolveActionAvailability, runExitMotion };
-export type { ActionAvailability, ActionAvailabilityContext, ActionAvailabilityState, ActionDescriptor, ActionGroup, ActionKind, ActionParamSpec, ActionTargetSpec, BuilderBehaviour, DialogElementLike, ExitAnimationLike, ExitMotionElement, ExitMotionOptions, OpenerActionLike, OpenerInteractionLike, OpenerNodeLike };
+export { BEHAVIOUR_ACTION_TYPES, CONSENT_ACTION_TYPES, DIALOG_ACTION_TYPE_SET, DIALOG_CLOSING_ATTRIBUTE, DIALOG_EXIT_TIMEOUT_MS, DIALOG_OPENER_ACTION_TYPES, DIALOG_OPENER_TRIGGER, DIALOG_SELECTOR, ELEMENT_ACTION_DESCRIPTORS, ELEMENT_ACTION_GROUP_ORDER, FORM_SUBMIT_ACTION_DESCRIPTORS, ITEM_ACTION_TYPES, OpenerAttribute, POPOVER_ACTION_TYPE_SET, POPOVER_NODE_TYPE, POPOVER_OPENER_ACTION_TYPES, SERVER_ELEMENT_ACTION_TYPES, TOAST_ACTION_TYPES, addableActions, cancelExit, closeDialogAnimated, dialogDomId, dialogOpenerAttributes, dialogOpenersSelector, dialogTogglesClosed, focusDialogSheet, groupedElementActions, isExiting, itemActionOf, nodeIdOfDialogDomId, nodeIdOfPopoverDomId, openedDialogId, openedPopoverId, openedTargetId, opensAtClickedItem, popoverDomId, popoverOpenerAttributes, popoverOpenersSelector, resolveActionAvailability, runExitMotion };
+export type { ActionAvailability, ActionAvailabilityContext, ActionAvailabilityState, ActionDescriptor, ActionGroup, ActionKind, ActionParamSpec, ActionTargetSpec, BuilderBehaviour, DialogElementLike, ExitAnimationLike, ExitMotionElement, ExitMotionOptions, FocusableSheet, OpenerActionLike, OpenerInteractionLike, OpenerNodeLike };

package/composite-core/index.d.ts

@@ -1,4 +1,4 @@
-import { ElementStyleTarget } from '@vectoriox/iox-ui/design-core';
+import { ElementStyleTarget, HeaderBehaviour, HeaderEdge } from '@vectoriox/iox-ui/design-core';
 export { ROW_INDEX_ATTRIBUTE } from '@vectoriox/iox-ui/design-core';
 
 /**
@@ -825,7 +825,8 @@ declare function setCardLinked(card: CompositeNode, on: boolean): boolean;
 interface CompositeRoleSpec {
     /** The role of the part's parent; null for a composite root. */
     readonly parent: string | null;
-    /** The TYPE of the part's parent, for a part whose parent carries no role (a Slider's controls). */
+    /** The TYPE of the part's parent, for a part whose parent carries no role (a Slider's controls). With `parent`
+     *  also set, either parent places it (a Slider's control lives in the slider or in its bar). */
     readonly parentType?: string;
     readonly locked?: boolean;
     /** May be deleted, but never moved out of its parent (a Slider's controls work only as its direct children). */
@@ -888,17 +889,40 @@ declare enum SliderRole {
     Pause = "slider.pause",
     Prev = "slider.prev",
     Next = "slider.next",
-    Pagination = "slider.pagination"
+    Pagination = "slider.pagination",
+    /** Premium M4 (M1.3): the bar UNDER the picture that holds the controls — caption · count · arrows. */
+    Bar = "slider.bar",
+    /** The caption of the slide in view (its `caption`, else its picture's description) — drawn by the runtime. */
+    Caption = "slider.caption",
+    /** "1 / 3", drawn by the runtime, left to right in every language. */
+    Count = "slider.count"
 }
 /** Parts in the order they are stamped: the pause control first (APG: the first focus stop), the dots last. */
 declare const SLIDER_PART_ROLES: ReadonlyArray<SliderRole>;
+/** Where the controls sit (premium M4): over the picture (CC3, every slider saved before M4) or in the bar under it. */
+declare enum SliderPlacement {
+    Over = "over",
+    Under = "under"
+}
+declare const SLIDER_PLACEMENT_TRAIT = "controlsPlacement";
+/** The bar's parts in reading order: the pause control, the caption at the reading start, the count, the dots, the
+ *  arrows at the end (M1.3). */
+declare const SLIDER_BAR_ORDER: ReadonlyArray<SliderRole>;
+/** Premium M4: the trait that has the SCROLL play the slider (held mid-screen, resting on each picture). */
+declare const SLIDER_SCROLL_PLAYS_TRAIT = "scrollPlays";
+/** Premium M4: a slide's caption (SliderSlide ▸ Caption) — the bar's Caption part shows the one in view. */
+declare const SLIDE_CAPTION_TRAIT = "caption";
 declare const SLIDER_TYPE = "SliderContainer";
 declare const SLIDE_TYPE = "SliderSlide";
 /** The Bindings switches that own the parts. */
 declare enum SliderFlag {
     Navigation = "enableNavigation",
     Pagination = "enablePagination",
-    Autoplay = "enableAutoplay"
+    Autoplay = "enableAutoplay",
+    /** Premium M4: a caption under the picture (the bar only). */
+    Caption = "enableCaption",
+    /** Premium M4: "1 / 3" under the picture (the bar only). */
+    Count = "enableCount"
 }
 /** The trait that names the carousel (Slider ▸ Accessibility ▸ Carousel name) — the A11y trait every named part uses. */
 declare const SLIDER_NAME_TRAIT = "ariaLabel";
@@ -908,10 +932,18 @@ interface RoleLike {
 }
 declare function isSliderPart(node: RoleLike | null | undefined): boolean;
 declare function isSlider(node: RoleLike | null | undefined): boolean;
-/** The slider's own part playing `role` (a direct child), or undefined. */
-declare function sliderPart<T extends RoleLike>(slider: {
+/** The slider's own part playing `role` — a direct child, or one in its bar — or undefined. */
+declare function sliderPart<T extends RoleLike & {
+    children?: T[] | null;
+}>(slider: {
     children?: T[] | null;
 }, role: SliderRole): T | undefined;
+/**
+ * Where the slider's controls sit. The STRUCTURE decides once there are controls — a bar means under the picture, a
+ * control of its own means over it (every slider saved before M4) — so a stored trait can never disagree with what is
+ * drawn. A slider with no controls yet takes its `controlsPlacement` (the builder's new Slider: under the picture).
+ */
+declare function sliderPlacementOf(slider: CompositeNode | null | undefined): SliderPlacement;
 /** True when the slider's controls are parts (it was created or migrated in CC3) — Swiper then draws none of its own. */
 declare function hasSliderParts(slider: {
     children?: ReadonlyArray<RoleLike> | null;
@@ -926,7 +958,7 @@ declare function splitSliderChildren<T extends RoleLike>(children: ReadonlyArray
 /** The slides only (the template slide of a bound slider is `sliderSlides(children)[0]`). */
 declare function sliderSlides<T extends RoleLike>(children: ReadonlyArray<T> | null | undefined): T[];
 /** Each part's glyph (Phosphor) and its default accessible name. */
-declare const SLIDER_PART_GLYPH: Readonly<Record<Exclude<SliderRole, SliderRole.Pagination>, string>>;
+declare const SLIDER_PART_GLYPH: Readonly<Record<SliderRole.Pause | SliderRole.Prev | SliderRole.Next, string>>;
 declare const SLIDER_PLAY_GLYPH = "ph-fill ph-play";
 /**
  * What a saved slider drew through Swiper before CC3, carried into its parts by the migration so it looks the same:
@@ -941,19 +973,27 @@ interface LegacySliderLook {
 declare const SWIPER_THEME_COLOR = "#007aff";
 /** One part, from the recipe (board 6: `button-secondary` controls, token dots) or in a migrated slider's legacy look. */
 declare function buildSliderPart(create: CompositeNodeFactory, role: SliderRole, legacy?: LegacySliderLook): CompositeNode;
-/** The parts the slider's switches call for, in stamping order. */
-declare function wantedSliderParts(slider: CompositeNode): SliderRole[];
+/** The parts the slider's switches call for, in stamping order — and its bar, while the controls sit under the
+ *  picture. A caption and a count live in the bar only. */
+declare function wantedSliderParts(slider: CompositeNode, placement?: SliderPlacement): SliderRole[];
 interface SliderPartsChange {
     added: CompositeNode[];
     removed: CompositeNode[];
 }
 /**
- * Make the slider's parts match its switches — ONE edit (a palette switch, the migration, the composer). Missing
- * parts are stamped from the recipe (or, `legacy`, in the migrated look) at their place: the pause control, Previous
- * and Next before the first slide, the pagination after the last; parts whose switch is off are removed. Everything
- * else (the slides, the author's edits to an existing part) is kept.
+ * Make the slider's parts match its switches — ONE edit (a palette switch, the migration, the composer, a change of
+ * placement). Missing parts are stamped from the recipe (or, `legacy`, in the migrated look) at their place: over the
+ * picture, the pause control, Previous and Next before the first slide and the pagination after the last; under it
+ * (premium M4), every control in the bar in its reading order, the bar after the slides. Parts whose switch is off are
+ * removed wherever they are. Everything else (the slides, the author's edits to an existing part) is kept.
  */
 declare function syncSliderParts(slider: CompositeNode, create: CompositeNodeFactory, legacy?: LegacySliderLook): SliderPartsChange;
+/**
+ * Move the controls over the picture or into the bar under it (premium M4, M1.3 — Slider ▸ Controls) — ONE edit and
+ * one undo step. The parts keep their identity and the author's edits; only their place changes (in flow in the bar,
+ * absolute over the picture). A caption and a count exist only in the bar. True when anything changed.
+ */
+declare function setSliderPlacement(slider: CompositeNode, placement: SliderPlacement, create: CompositeNodeFactory): boolean;
 /** True when a saved slider still relies on Swiper-drawn controls: a switch is on and no part exists yet. */
 declare function needsSliderMigration(slider: CompositeNode | null | undefined): boolean;
 /**
@@ -1081,6 +1121,31 @@ declare class CarouselA11y {
 declare function carouselOf(el: Element | null | undefined): CarouselA11y | null;
 /** Attach once per Swiper (a re-init gets a fresh runtime). */
 declare function attachCarouselA11y(swiper: CarouselSwiper, options?: CarouselA11yOptions): CarouselA11y;
+/** Where the Caption and the Count parts get their words: generated content (`attr()`), never the element's text — so
+ *  the canvas's Text component and the runtime never write the same node. */
+declare const SLIDER_TEXT_ATTRIBUTE = "data-iox-text";
+/** Held for a frame while the caption changes, so its new words fade in (iox-design.css). */
+declare const SLIDER_SWAPPING_ATTRIBUTE = "data-iox-swapping";
+/** What the caption says for a slide: its own caption, else its picture's description, else nothing. */
+declare function sliderCaptionOf(slide: Element | null | undefined): string;
+/** "2 / 5" — the slide in view and how many there are; nothing for an empty slider. */
+declare function sliderCountText(index: number, total: number): string;
+/** The parts of a running Swiper the bar's runtime reads. */
+interface BarSwiper {
+    el: HTMLElement;
+    slides: HTMLElement[];
+    activeIndex: number;
+    realIndex?: number;
+    destroyed?: boolean;
+    on(event: string, handler: (...args: unknown[]) => void): void;
+    off(event: string, handler: (...args: unknown[]) => void): void;
+}
+/**
+ * Keep the bar's Caption and Count on the slide in view — the canvas, Preview and both engine paths (bootSlider). The
+ * caption changes behind a short fade (the first one does not); the count reads left to right in every language.
+ * Returns the stop; a slider with neither part gets a no-op.
+ */
+declare function attachSliderBar(swiper: BarSwiper): () => void;
 
 /**
  * THE LIGHTBOX (CC3 — complex-components plan §7d, board 6). Not a component: a Dialog holding a Slider bound to the
@@ -1631,5 +1696,18 @@ declare function isCompositeItemOn(el: Element): boolean;
  */
 declare function runCompositeItemAction(el: Element | null | undefined, action: CompositeItemAction): boolean | null;
 
-export { ACCORDION_BIND_PROP, ACCORDION_CONTENT_LIMIT, ACCORDION_DEFAULT_ONS, ACCORDION_ICONS, ACCORDION_ICON_GLYPH, ACCORDION_NEW_ITEM_WORDS, ACCORDION_WORDS, ACTIVATE_ON_ATTRIBUTE, AccordionClass, AccordionDefaultOn, AccordionEditRefusal, AccordionIcon, AccordionKeyAction, AccordionRole, AccordionRuntime, BADGE_TONES, BADGE_TONE_ICONS, BadgeTone, CARD_LAYOUTS, CARD_LAYOUT_CUSTOM, CARD_PARTS, CARD_PART_ROLE, CARD_STACK_BREAKPOINT, CARD_WORDS, CAROUSEL_QUOTES, CHIP_ICON, CHIP_STYLE, COMPOSITE_ATTRIBUTE, COMPOSITE_KIND_ROLES, COMPOSITE_ROLE_SPECS, CardLayout, CardPart, CardRole, CarouselA11y, CompositeBehaviourTrait, CompositeItemAction, CompositeKind, DEFAULT_ON_ATTRIBUTE, DISCLOSURE_ITEM_KEY, DISCLOSURE_WORDS, DisclosureRole, EXCLUSIVE_KIND_ROLES, ExclusiveRuntime, ITEM_KEY_ATTRIBUTE, ITEM_OFF_EVENT, ITEM_ON_EVENT, ITEM_OPEN_STATE, LIGHTBOX_ARROWS_HIDE_AT, LIGHTBOX_LABEL, MULTIPLE_ATTRIBUTE, NO_ELEMENT_STYLE, ON_ATTRIBUTE, ON_STATE, ORIENTATION_ATTRIBUTE, PILL_LABEL_STYLE, SCOPE_ATTRIBUTE, SEGMENTED_BADGE_TONE, SEGMENTED_BADGE_WORDS, SEGMENTED_BEHAVIOUR, SEGMENTED_MAX_OPTIONS, SEGMENTED_MIN_OPTIONS, SEGMENTED_NAME, SEGMENTED_NEW_OPTION_WORDS, SEGMENTED_WORDS, SLIDER_NAME_TRAIT, SLIDER_PART_GLYPH, SLIDER_PART_ROLES, SLIDER_PLAY_GLYPH, SLIDER_TYPE, SLIDER_WORDS, SLIDE_TO_ROW, SLIDE_TYPE, SWIPER_THEME_COLOR, SceneRole, SegmentedEditRefusal, SegmentedRole, SegmentedTrait, SliderFlag, SliderRole, StructureEdit, StructureRefusal, TABS_ACTIVATE_ONS, TABS_CONTENT_LIMIT, TABS_IMAGE_BIND_PROP, TABS_LABEL_BIND_PROP, TABS_NEW_TAB_WORDS, TABS_ORIENTATIONS, TABS_STACK_BREAKPOINT, TABS_TEXT_BIND_PROP, TABS_WORDS, TabsActivateOn, TabsBehaviourTrait, TabsEditRefusal, TabsOrientation, TabsRole, UNTIL_FOUND, acceptsRefusal, accordionAnswerOf, accordionBehaviour, accordionDomIds, accordionFocusIndex, accordionHeadingLevel, accordionItemAttributes, accordionItemLabel, accordionItemOf, accordionItemState, accordionItems, accordionKeyAction, accordionPanelAttributes, accordionPanelOf, accordionPartStyle, accordionQuestionOf, accordionRegionAttributes, accordionRemovalRefusal, accordionRootAttributes, accordionRootOf, accordionRootOfItem, accordionRuntimeOf, accordionScope, accordionToContent, accordionToManual, accordionTrackAttributes, accordionTriggerAttributes, accordionTriggerOf, addAccordionItem, addSegmentedOption, addTabPair, applyCardLayout, attachAccordionAt, attachAccordions, attachCarouselA11y, attachCompositeAt, attachExclusiveAt, badgeStyleId, badgeToneOf, buildAccordionItem, buildAccordionRecipe, buildBadge, buildCardRecipe, buildCarouselRecipe, buildChip, buildCompositeIcon, buildDisclosureRecipe, buildLightboxRecipe, buildSegmentedOption, buildSegmentedRecipe, buildSliderPart, buildTabPair, buildTabsRecipe, canOpenAtClickedItem, cardPartsOf, cardRootOf, cardTitleOf, carouselOf, clearLayerStyles, closeAccordionItem, closestAccordion, closestAccordionItem, closestExclusive, closestExclusiveItemPart, compositeItemOf, compositeItems, compositeKindOfRole, compositeRootOf, compositeRowKeys, compositeScopeId, detachAccordion, detectAccordionIcon, detectCardLayout, disclosureOpenByDefault, domSafeKey, exclusiveBehaviourOf, exclusiveDefaultOf, exclusiveItemLabel, exclusiveItemPartOf, exclusiveKindHasPanels, exclusiveKindOf, exclusiveLabelOf, exclusivePartAttributes, exclusiveRootAttributesOf, exclusiveRootHoldsTriggers, exclusiveRootOf, exclusiveRuntimeOf, exclusiveScopeFor, findByRole, hasLabelledRegion, hasSliderParts, initialAccordionOpen, isAccordionFromContent, isAccordionItemOn, isAccordionPart, isAccordionRoot, isAnyCompositeRoot, isCardLinked, isCardRoot, isCompositeItem, isCompositeItemOn, isCompositePanel, isCompositeRoot, isCompositeTrigger, isDisclosurePart, isDisclosureRoot, isExclusiveItemOn, isExclusiveItemPart, isExclusiveKind, isExclusiveList, isExclusivePanel, isExclusivePanels, isExclusiveRoot, isExclusiveTrigger, isLockedPart, isPartOfExclusiveScope, isPillNode, isSegmentedPart, isSegmentedRoot, isSlider, isSliderPart, isTabsFromContent, isTabsPart, isTabsRoot, isToggleKind, itemOpenTriggerIds, lightboxSliderOf, makeCompositePart, manualTabKeys, migrateSliderControls, moveAccordionItem, moveSegmentedOption, moveTabPair, needsSliderMigration, nextAccordionState, nextItemKey, nextSegmentedKey, nextTabKey, onAccordionItemState, onCompositeItemState, onExclusiveItemState, openAccordionItem, parentInComposite, pickAccordionAutoBinds, pickTabsAutoBinds, readLayerStyle, readProp, readStyle, removeFromComposite, removeSegmentedOption, removeTabPair, renameAccordionItem, renameSegmentedOption, renameTab, repeatSourceOf, rowIndexOf, rowItemKey, rowSourceOf, runCompositeItemAction, sameRepeatSource, segmentedAddRefusal, segmentedBadgeOf, segmentedDefaultOn, segmentedItemTriggerIds, segmentedKeyAction, segmentedKeys, segmentedLabel, segmentedOptionAttributes, segmentedOptionKey, segmentedOptionLabel, segmentedOptionLabelNodeOf, segmentedOptions, segmentedPartAttributes, segmentedRemovalRefusal, segmentedRootAttributes, segmentedRootAttributesOf, segmentedScopeFor, serializeDomAttributes, setAccordionBehaviour, setAccordionIcon, setBadgeTone, setCardLinked, setCardPart, setSegmentedBadge, setSegmentedBehaviour, setSliderFlag, setTabsBehaviour, shouldScrollToItem, slideIndexForRow, sliderLiveRegion, sliderPart, sliderPartElement, sliderPauseAttributes, sliderPauseGlyph, sliderSlides, sliderWords, splitSliderChildren, structureRefusal, syncSliderParts, tabLabel, tabLabelNodeOf, tabListAttributes, tabPanelAttributes, tabPanelImageOf, tabPanelOf, tabPanelTextOf, tabPartKey, tabTriggerAttributes, tabTriggerOf, tabsBehaviour, tabsItemState, tabsItemTriggerIds, tabsKeyAction, tabsLabel, tabsListOf, tabsPanels, tabsPanelsOf, tabsPartAttributes, tabsPartnerOf, tabsRemovalRefusal, tabsRootAttributes, tabsScope, tabsScopeFor, tabsToContent, tabsToManual, tabsTriggers, walkComposite, wantedSliderParts, writeLayerStyles, writeProp, writeStyles };
-export type { AccordionAutoBinds, AccordionBehaviour, AccordionDomIds, AccordionItemState, AccordionOptions, AccordionRuntimeOptions, AccordionScope, AccordionWords, BaselineStyles, CardEditOptions, CardLayoutResult, CardLayoutState, CardOptions, CardPartChange, CardWords, CarouselA11yOptions, CarouselOptions, CarouselQuote, CarouselSwiper, CompositeBinding, CompositeKindRoles, CompositeLayer, CompositeNode, CompositeNodeFactory, CompositeNodeSpec, CompositeRoleSpec, CompositeRuntime, CompositeTrait, ContentFieldLike, DisclosureOptions, DisclosureWords, DomAttributes, ExclusiveCompositeKind, ExclusiveKindRoles, ExclusiveRuntimeOptions, ExclusiveScope, LegacySliderLook, LightboxOptions, PillOptions, RepeatSource, SegmentedOptionWords, SegmentedOptions, SliderPartsChange, SliderWords, TabPair, TabWords, TabsAutoBinds, TabsBehaviour, TabsItemState, TabsOptions, TabsScope, ToggleCompositeKind };
+/**
+ * Set how a header behaves as the page scrolls (premium components T2, M4) — ONE edit for the builder's Header section
+ * and the composer (generation-core), on either node shape. A header that stays at the top is the containing block of its
+ * edge: the live site makes it sticky (iox-design.css), and a header stored `static` becomes `relative` — what the canvas,
+ * which forces a node's own position, draws it with. Nothing else of the author's is touched.
+ */
+declare function setHeaderBehaviour(node: CompositeNode, behaviour: HeaderBehaviour | `${HeaderBehaviour}`, edge: HeaderEdge | `${HeaderEdge}` | null): void;
+/** The header's behaviour and edge as stored (Scrolls / none for a header that never chose). */
+declare function headerBehaviourOfNode(node: CompositeNode | null | undefined): {
+    behaviour: HeaderBehaviour;
+    edge: HeaderEdge | null;
+};
+
+export { ACCORDION_BIND_PROP, ACCORDION_CONTENT_LIMIT, ACCORDION_DEFAULT_ONS, ACCORDION_ICONS, ACCORDION_ICON_GLYPH, ACCORDION_NEW_ITEM_WORDS, ACCORDION_WORDS, ACTIVATE_ON_ATTRIBUTE, AccordionClass, AccordionDefaultOn, AccordionEditRefusal, AccordionIcon, AccordionKeyAction, AccordionRole, AccordionRuntime, BADGE_TONES, BADGE_TONE_ICONS, BadgeTone, CARD_LAYOUTS, CARD_LAYOUT_CUSTOM, CARD_PARTS, CARD_PART_ROLE, CARD_STACK_BREAKPOINT, CARD_WORDS, CAROUSEL_QUOTES, CHIP_ICON, CHIP_STYLE, COMPOSITE_ATTRIBUTE, COMPOSITE_KIND_ROLES, COMPOSITE_ROLE_SPECS, CardLayout, CardPart, CardRole, CarouselA11y, CompositeBehaviourTrait, CompositeItemAction, CompositeKind, DEFAULT_ON_ATTRIBUTE, DISCLOSURE_ITEM_KEY, DISCLOSURE_WORDS, DisclosureRole, EXCLUSIVE_KIND_ROLES, ExclusiveRuntime, ITEM_KEY_ATTRIBUTE, ITEM_OFF_EVENT, ITEM_ON_EVENT, ITEM_OPEN_STATE, LIGHTBOX_ARROWS_HIDE_AT, LIGHTBOX_LABEL, MULTIPLE_ATTRIBUTE, NO_ELEMENT_STYLE, ON_ATTRIBUTE, ON_STATE, ORIENTATION_ATTRIBUTE, PILL_LABEL_STYLE, SCOPE_ATTRIBUTE, SEGMENTED_BADGE_TONE, SEGMENTED_BADGE_WORDS, SEGMENTED_BEHAVIOUR, SEGMENTED_MAX_OPTIONS, SEGMENTED_MIN_OPTIONS, SEGMENTED_NAME, SEGMENTED_NEW_OPTION_WORDS, SEGMENTED_WORDS, SLIDER_BAR_ORDER, SLIDER_NAME_TRAIT, SLIDER_PART_GLYPH, SLIDER_PART_ROLES, SLIDER_PLACEMENT_TRAIT, SLIDER_PLAY_GLYPH, SLIDER_SCROLL_PLAYS_TRAIT, SLIDER_SWAPPING_ATTRIBUTE, SLIDER_TEXT_ATTRIBUTE, SLIDER_TYPE, SLIDER_WORDS, SLIDE_CAPTION_TRAIT, SLIDE_TO_ROW, SLIDE_TYPE, SWIPER_THEME_COLOR, SceneRole, SegmentedEditRefusal, SegmentedRole, SegmentedTrait, SliderFlag, SliderPlacement, SliderRole, StructureEdit, StructureRefusal, TABS_ACTIVATE_ONS, TABS_CONTENT_LIMIT, TABS_IMAGE_BIND_PROP, TABS_LABEL_BIND_PROP, TABS_NEW_TAB_WORDS, TABS_ORIENTATIONS, TABS_STACK_BREAKPOINT, TABS_TEXT_BIND_PROP, TABS_WORDS, TabsActivateOn, TabsBehaviourTrait, TabsEditRefusal, TabsOrientation, TabsRole, UNTIL_FOUND, acceptsRefusal, accordionAnswerOf, accordionBehaviour, accordionDomIds, accordionFocusIndex, accordionHeadingLevel, accordionItemAttributes, accordionItemLabel, accordionItemOf, accordionItemState, accordionItems, accordionKeyAction, accordionPanelAttributes, accordionPanelOf, accordionPartStyle, accordionQuestionOf, accordionRegionAttributes, accordionRemovalRefusal, accordionRootAttributes, accordionRootOf, accordionRootOfItem, accordionRuntimeOf, accordionScope, accordionToContent, accordionToManual, accordionTrackAttributes, accordionTriggerAttributes, accordionTriggerOf, addAccordionItem, addSegmentedOption, addTabPair, applyCardLayout, attachAccordionAt, attachAccordions, attachCarouselA11y, attachCompositeAt, attachExclusiveAt, attachSliderBar, badgeStyleId, badgeToneOf, buildAccordionItem, buildAccordionRecipe, buildBadge, buildCardRecipe, buildCarouselRecipe, buildChip, buildCompositeIcon, buildDisclosureRecipe, buildLightboxRecipe, buildSegmentedOption, buildSegmentedRecipe, buildSliderPart, buildTabPair, buildTabsRecipe, canOpenAtClickedItem, cardPartsOf, cardRootOf, cardTitleOf, carouselOf, clearLayerStyles, closeAccordionItem, closestAccordion, closestAccordionItem, closestExclusive, closestExclusiveItemPart, compositeItemOf, compositeItems, compositeKindOfRole, compositeRootOf, compositeRowKeys, compositeScopeId, detachAccordion, detectAccordionIcon, detectCardLayout, disclosureOpenByDefault, domSafeKey, exclusiveBehaviourOf, exclusiveDefaultOf, exclusiveItemLabel, exclusiveItemPartOf, exclusiveKindHasPanels, exclusiveKindOf, exclusiveLabelOf, exclusivePartAttributes, exclusiveRootAttributesOf, exclusiveRootHoldsTriggers, exclusiveRootOf, exclusiveRuntimeOf, exclusiveScopeFor, findByRole, hasLabelledRegion, hasSliderParts, headerBehaviourOfNode, initialAccordionOpen, isAccordionFromContent, isAccordionItemOn, isAccordionPart, isAccordionRoot, isAnyCompositeRoot, isCardLinked, isCardRoot, isCompositeItem, isCompositeItemOn, isCompositePanel, isCompositeRoot, isCompositeTrigger, isDisclosurePart, isDisclosureRoot, isExclusiveItemOn, isExclusiveItemPart, isExclusiveKind, isExclusiveList, isExclusivePanel, isExclusivePanels, isExclusiveRoot, isExclusiveTrigger, isLockedPart, isPartOfExclusiveScope, isPillNode, isSegmentedPart, isSegmentedRoot, isSlider, isSliderPart, isTabsFromContent, isTabsPart, isTabsRoot, isToggleKind, itemOpenTriggerIds, lightboxSliderOf, makeCompositePart, manualTabKeys, migrateSliderControls, moveAccordionItem, moveSegmentedOption, moveTabPair, needsSliderMigration, nextAccordionState, nextItemKey, nextSegmentedKey, nextTabKey, onAccordionItemState, onCompositeItemState, onExclusiveItemState, openAccordionItem, parentInComposite, pickAccordionAutoBinds, pickTabsAutoBinds, readLayerStyle, readProp, readStyle, removeFromComposite, removeSegmentedOption, removeTabPair, renameAccordionItem, renameSegmentedOption, renameTab, repeatSourceOf, rowIndexOf, rowItemKey, rowSourceOf, runCompositeItemAction, sameRepeatSource, segmentedAddRefusal, segmentedBadgeOf, segmentedDefaultOn, segmentedItemTriggerIds, segmentedKeyAction, segmentedKeys, segmentedLabel, segmentedOptionAttributes, segmentedOptionKey, segmentedOptionLabel, segmentedOptionLabelNodeOf, segmentedOptions, segmentedPartAttributes, segmentedRemovalRefusal, segmentedRootAttributes, segmentedRootAttributesOf, segmentedScopeFor, serializeDomAttributes, setAccordionBehaviour, setAccordionIcon, setBadgeTone, setCardLinked, setCardPart, setHeaderBehaviour, setSegmentedBadge, setSegmentedBehaviour, setSliderFlag, setSliderPlacement, setTabsBehaviour, shouldScrollToItem, slideIndexForRow, sliderCaptionOf, sliderCountText, sliderLiveRegion, sliderPart, sliderPartElement, sliderPauseAttributes, sliderPauseGlyph, sliderPlacementOf, sliderSlides, sliderWords, splitSliderChildren, structureRefusal, syncSliderParts, tabLabel, tabLabelNodeOf, tabListAttributes, tabPanelAttributes, tabPanelImageOf, tabPanelOf, tabPanelTextOf, tabPartKey, tabTriggerAttributes, tabTriggerOf, tabsBehaviour, tabsItemState, tabsItemTriggerIds, tabsKeyAction, tabsLabel, tabsListOf, tabsPanels, tabsPanelsOf, tabsPartAttributes, tabsPartnerOf, tabsRemovalRefusal, tabsRootAttributes, tabsScope, tabsScopeFor, tabsToContent, tabsToManual, tabsTriggers, walkComposite, wantedSliderParts, writeLayerStyles, writeProp, writeStyles };
+export type { AccordionAutoBinds, AccordionBehaviour, AccordionDomIds, AccordionItemState, AccordionOptions, AccordionRuntimeOptions, AccordionScope, AccordionWords, BarSwiper, BaselineStyles, CardEditOptions, CardLayoutResult, CardLayoutState, CardOptions, CardPartChange, CardWords, CarouselA11yOptions, CarouselOptions, CarouselQuote, CarouselSwiper, CompositeBinding, CompositeKindRoles, CompositeLayer, CompositeNode, CompositeNodeFactory, CompositeNodeSpec, CompositeRoleSpec, CompositeRuntime, CompositeTrait, ContentFieldLike, DisclosureOptions, DisclosureWords, DomAttributes, ExclusiveCompositeKind, ExclusiveKindRoles, ExclusiveRuntimeOptions, ExclusiveScope, LegacySliderLook, LightboxOptions, PillOptions, RepeatSource, SegmentedOptionWords, SegmentedOptions, SliderPartsChange, SliderWords, TabPair, TabWords, TabsAutoBinds, TabsBehaviour, TabsItemState, TabsOptions, TabsScope, ToggleCompositeKind };