@vectoriox/iox-ui 5.31.2 → 5.32.0

package/actions-core/index.d.ts

@@ -116,5 +116,55 @@ declare function groupedElementActions(): ReadonlyArray<{
     actions: ActionDescriptor[];
 }>;
 
-export { BEHAVIOUR_ACTION_TYPES, CONSENT_ACTION_TYPES, ELEMENT_ACTION_DESCRIPTORS, ELEMENT_ACTION_GROUP_ORDER, FORM_SUBMIT_ACTION_DESCRIPTORS, SERVER_ELEMENT_ACTION_TYPES, addableActions, groupedElementActions, resolveActionAvailability };
-export type { ActionAvailability, ActionAvailabilityContext, ActionAvailabilityState, ActionDescriptor, ActionGroup, ActionKind, ActionParamSpec, ActionTargetSpec, BuilderBehaviour };
+/**
+ * What an element that OPENS a dialog says about itself (CC1, N3 — APG disclosure/dialog pattern).
+ * The element whose click runs `openDialog` / `toggleDialog` (a menu button, a bottom bar's More) is
+ * announced as one: `aria-haspopup="dialog"`, `aria-controls` = the dialog's DOM id, and
+ * `aria-expanded` — `false` in the server render, kept in step on open and close by each runtime.
+ *
+ * ONE decision for every renderer (the builder canvas, the engine's component path and its string
+ * path), framework-free so iox-cms can read it too. The dialog's DOM id comes from `dialogDomId`, the
+ * one place that names it, so an opener and its dialog can never disagree.
+ */
+/** The interaction trigger that opens a dialog from an element. */
+declare const DIALOG_OPENER_TRIGGER = "click";
+/** The actions that make an element a dialog OPENER (close-only actions do not). */
+declare const DIALOG_OPENER_ACTION_TYPES: ReadonlySet<string>;
+/** Every action that opens, closes or toggles a dialog — what a runtime watches to sync `aria-expanded`. */
+declare const DIALOG_ACTION_TYPE_SET: ReadonlySet<string>;
+/** The selector of every dialog a renderer emits (the live `<dialog data-iox-dialog>`). */
+declare const DIALOG_SELECTOR = "dialog[data-iox-dialog]";
+/** The DOM id of a Dialog node's `<dialog>` — what an opener's `aria-controls` names. */
+declare function dialogDomId(nodeId: string): string;
+/** The node id a dialog DOM id names, or null. */
+declare function nodeIdOfDialogDomId(domId: string | null | undefined): string | null;
+declare enum OpenerAttribute {
+    HasPopup = "aria-haspopup",
+    Expanded = "aria-expanded",
+    Controls = "aria-controls"
+}
+interface OpenerActionLike {
+    type?: string;
+    target?: string;
+    disabled?: boolean;
+}
+interface OpenerInteractionLike {
+    trigger?: string;
+    actions?: ReadonlyArray<OpenerActionLike> | null;
+}
+interface OpenerNodeLike {
+    interactions?: ReadonlyArray<OpenerInteractionLike> | 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;
+/**
+ * The opener attributes for a node: `{}` when its click opens no dialog, else
+ * `aria-haspopup="dialog"`, `aria-controls="iox-dialog-<id>"` and `aria-expanded` (`false` unless
+ * `open` says the dialog is open right now).
+ */
+declare function dialogOpenerAttributes(node: OpenerNodeLike | null | undefined, open?: boolean): Record<string, string>;
+/** 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;
+
+export { BEHAVIOUR_ACTION_TYPES, CONSENT_ACTION_TYPES, DIALOG_ACTION_TYPE_SET, DIALOG_OPENER_ACTION_TYPES, DIALOG_OPENER_TRIGGER, DIALOG_SELECTOR, ELEMENT_ACTION_DESCRIPTORS, ELEMENT_ACTION_GROUP_ORDER, FORM_SUBMIT_ACTION_DESCRIPTORS, OpenerAttribute, SERVER_ELEMENT_ACTION_TYPES, addableActions, dialogDomId, dialogOpenerAttributes, dialogOpenersSelector, groupedElementActions, nodeIdOfDialogDomId, openedDialogId, resolveActionAvailability };
+export type { ActionAvailability, ActionAvailabilityContext, ActionAvailabilityState, ActionDescriptor, ActionGroup, ActionKind, ActionParamSpec, ActionTargetSpec, BuilderBehaviour, OpenerActionLike, OpenerInteractionLike, OpenerNodeLike };