@astryxdesign/core 0.7.5-canary.fccd771 → 0.7.5

package/dist/BottomSheet/bottomSheetStack.d.ts

@@ -0,0 +1,262 @@
+export interface BottomSheetStackView {
+    /** Another modal sheet is presented alongside this one. */
+    readonly isStacked: boolean;
+    /** This sheet is the open sheet that is on top. */
+    readonly isTop: boolean;
+    /** This sheet is open with at least one open sheet above it. */
+    readonly isCovered: boolean;
+    /** Open sheets above this one; drives how far the sheet recedes. */
+    readonly depth: number;
+    /** This sheet's `::backdrop` is the one visible scrim of the stack. */
+    readonly ownsScrim: boolean;
+    /**
+     * This sheet took the scrim over from a sheet below it that is still
+     * sliding out, so its backdrop must appear at once rather than fade in.
+     */
+    readonly isScrimHandoff: boolean;
+    /**
+     * This sheet is covered and contains no presented sheet, so its whole
+     * dialog can be marked inert and hidden from assistive technology.
+     */
+    readonly isBlocked: boolean;
+    /**
+     * This sheet is closing and an open sheet above it owns the scrim now, so
+     * its own backdrop must leave at once rather than fade: the dim is the
+     * other sheet's from this frame on, and two backdrops would double it.
+     */
+    readonly isScrimTakenOver: boolean;
+    /**
+     * This closed sheet is being replaced by the sheet opened in the same
+     * update: it stays in place (`covered`), moves down to the entering sheet's
+     * top edge (`aligning`), or fades (`fading`), instead of sliding out.
+     */
+    readonly replacedMotion: BottomSheetReplacedMotion | null;
+    /** How far down a replaced sheet moves to meet the entering sheet, in px. */
+    readonly alignmentOffset: number;
+    /** This open sheet is replacing the sheet that closed in the same update. */
+    readonly isReplacing: boolean;
+}
+export type BottomSheetReplacedMotion = 'covered' | 'aligning' | 'fading';
+/** The motions a host's panel reports to the registry during a replace. */
+export type BottomSheetReplaceMotion = 'entering' | 'aligning' | 'fading' | 'exiting';
+export declare const BOTTOM_SHEET_STACK_DEFAULT_VIEW: BottomSheetStackView;
+/**
+ * Why the registry moves focus into a sheet: it was shown on top (`open`), a
+ * close above it revealed it (`reveal`), or it is replacing the sheet the
+ * person was in (`replace`: focus follows the person from one step to the
+ * next, whatever the native host did with it).
+ */
+export type BottomSheetFocusReason = 'open' | 'reveal' | 'replace';
+export interface BottomSheetStackRegistration {
+    /** Stable identity of the host component instance. */
+    key: object;
+    /** The host's native dialog. */
+    getElement: () => HTMLDialogElement | null;
+    /**
+     * The element whose place in the tree orders this level against the other
+     * sheets of its commit, when it is not the dialog itself: a switcher flow
+     * is realized by whichever step dialog is active, so its flow wrapper — the
+     * one element that contains every step — stands for it, and a handoff
+     * cannot reorder the flow against a sheet opened in the same commit.
+     */
+    getTreeAnchor?: () => Element | null;
+    /** Present the dialog modally (`showModal()`), capturing the opener first. */
+    show: () => void;
+    /** Take the dialog out of the top layer (`close()`) for a re-show. */
+    hide: () => void;
+    /** Move focus into the sheet: shown on top, or revealed by a close above. */
+    focus: (reason: BottomSheetFocusReason) => void;
+    /**
+     * Where focus returns when this sheet closes the stack: its explicit
+     * final-focus target, else the element that opened it. Read by the
+     * registry when several sheets close in one update.
+     */
+    getReturnTarget?: () => HTMLElement | null;
+    /** Receive this host's view whenever it changes. */
+    onView: (view: BottomSheetStackView) => void;
+    /**
+     * What a host must supply to take part in a replace. A host without it (a
+     * switcher flow, which replaces its own steps) is never paired.
+     */
+    replaceable?: BottomSheetReplaceable;
+}
+export interface BottomSheetReplaceable {
+    /** The host's visual panel, measured for the replace alignment. */
+    getPanel: () => HTMLElement | null;
+    /** The element focus returns to when the sheet closes the flow. */
+    getOpener: () => HTMLElement | null;
+    /** Adopt the replaced sheet's opener, so the flow closes back to it. */
+    setOpener: (opener: HTMLElement | null) => void;
+    /** The replace is over: this replaced sheet is hidden and its dialog closed. */
+    finish: () => void;
+}
+/**
+ * End the current batch. Hosts call it from a passive effect, which React runs
+ * after every layout effect of the same commit and before the next commit;
+ * registrations on either side of it are therefore different open orders.
+ */
+export declare function sealBottomSheetBatch(): void;
+/**
+ * Whether `key` closes as part of a "Close all" group. Its host then leaves
+ * the top layer without returning focus itself; the registry returns it
+ * once the whole group has left.
+ */
+export declare function isClosingTogether(key: object): boolean;
+/**
+ * A member of a "Close all" group has left the top layer. When it is the
+ * last one, focus returns to the group's target: the bottom-most sheet's
+ * final-focus target or opener, now that no modal dialog stands in the way.
+ */
+export declare function reportClosedTogether(key: object): void;
+/**
+ * Present a switcher step's dialog modally with no focus to return to.
+ * showModal() records the element focused at that moment and close() moves
+ * focus back to it, in Chromium and WebKit even when focus is in another
+ * dialog by then. For a step that element is the control that advanced the
+ * flow (Continue, Back) or the flow's opener, and the dialog closes a fade
+ * later, while the user is in the next step: the return would pull focus
+ * off the active panel with no user action. Blurring first leaves nothing
+ * recorded, so the close moves nothing; the entering step then focuses its
+ * own panel, and the switcher returns focus to the opener itself when the
+ * flow ends. The blur happens in the same task as the present, so no frame
+ * paints without focus.
+ */
+export declare function presentStepModally(dialog: HTMLDialogElement): void;
+/**
+ * Present a switcher dialog whose backdrop must start, and stay, clear: the
+ * opacity is set with the scrim transition pinned to 0s, the dialog is
+ * presented, and the pin is lifted only after a style flush has applied the
+ * clear backdrop, so no frame eases from a previous backdrop value.
+ */
+export declare function presentWithClearScrim(dialog: HTMLDialogElement): void;
+/** The pending restore of a dialog's scrim transition; one per host. */
+export interface BottomSheetScrimWrite {
+    frame: number | null;
+}
+/**
+ * Write a dialog's scrim opacity. A change while the dialog is up is a change
+ * of scrim owner, and lands with no transition at all: a `0.01s` duration
+ * still paints one frame at the old value, which reads as a dip or, with the
+ * old owner's backdrop still fading, as a doubled dim. The pin
+ * (`--_sheet-scrim-duration: 0s`, inline) stays for two animation frames
+ * (two nested `requestAnimationFrame`s: the first frame paints the new value,
+ * the second confirms it is on screen before the stylesheet's duration
+ * returns). Hosts cancel the pending restore with `cancelScrimWrite` when
+ * they unmount.
+ */
+export declare function writeScrimOpacity(dialog: HTMLDialogElement | null, opacity: '0' | '1', pending: BottomSheetScrimWrite): void;
+export declare function cancelScrimWrite(pending: BottomSheetScrimWrite): void;
+/**
+ * Whether a sheet's dialog is presented by the browser: as a modal dialog
+ * (`open`), as a manual popover (a non-modal sheet in the top layer), or by
+ * `show()` (a non-modal sheet below the Popover API support floor).
+ */
+export declare function isSheetHostPresented(dialog: HTMLDialogElement | null): boolean;
+/**
+ * Whether a modal dialog that does not contain `element` is open in its
+ * document. Such a modal makes everything outside it inert, so a non-modal
+ * sheet outside it must not paint above it.
+ */
+export declare function hasOpenModalOutside(element: Element): boolean;
+/**
+ * Move every waiting non-modal sheet whose outside modals have all gone into
+ * the top layer: it leaves `show()` and is presented again as a manual
+ * popover, announcing its entry so global hosts re-enter above it. Focus
+ * stays where it was.
+ */
+export declare function promoteDeferredNonModal(doc: Document): void;
+/**
+ * Present a non-modal sheet: in the top layer as a manual popover where the
+ * Popover API exists (Tier 2 and up), so later sheets order above earlier
+ * ones and no page-level z-index is needed; by `show()` below that floor.
+ * A manual popover has no light dismiss, no backdrop and no focus or scroll
+ * side effects, so the non-modal contract is otherwise unchanged.
+ *
+ * A non-modal sheet shown while a modal dialog that does not contain it is
+ * open (a modal sheet, a Dialog) is inert under that modal, so it is not put
+ * in the top layer — there it would paint above the modal while a press on
+ * it lands on the modal beneath — and is presented by `show()` instead, in
+ * page stacking order beneath the modal, with no page-level z-index; once
+ * the last such modal has gone it is presented again in the top layer
+ * (`promoteDeferredNonModal`). A non-modal sheet rendered inside the modal's
+ * content is not inert and enters the top layer at once.
+ */
+export declare function showSheetHostNonModal(dialog: HTMLDialogElement, panel: HTMLElement | null): void;
+/** Leave the native host, whichever one presents the sheet. */
+export declare function hideSheetHost(dialog: HTMLDialogElement): void;
+/**
+ * Close a dialog without letting the browser move focus. `close()` returns
+ * focus to the element that was focused when `showModal()` ran; with another
+ * sheet still open on top, that would pull focus out of the sheet the person
+ * is using (a re-show that repairs the top-layer order, a covered sheet
+ * closing from code, a replaced sheet leaving). Focus stays where it is; the
+ * caller decides where it goes next, if anywhere.
+ */
+export declare function closeDialogKeepingFocus(dialog: HTMLDialogElement | null): void;
+/**
+ * A host's panel reports the start and end of its motions here. During a
+ * replace they drive the handoff: when the entering sheet starts to rise, a
+ * taller retained sheet starts moving down to its top edge; the retained
+ * sheet fades once both have finished; when the fade ends the replace is over.
+ */
+export declare function reportBottomSheetMotion(key: object, event: 'start' | 'complete', motion: BottomSheetReplaceMotion): void;
+/**
+ * Join the stack for as long as the sheet is presented. Call from a layout
+ * effect; the returned function leaves the stack (also from its cleanup).
+ * `isOpen` is the controlled open state; a presented sheet whose `isOpen` is
+ * false is sliding out and keeps its place without counting as a layer.
+ */
+export declare function registerBottomSheet(registration: BottomSheetStackRegistration, isOpen: boolean, isModal?: boolean): () => void;
+/**
+ * The dialog that realizes a level changed: a switcher flow handed off to a
+ * step with its own dialog, which its host presented on top of the top layer
+ * in this same commit. The level keeps its rank; the registry records the new
+ * dialog as the most recently shown and puts the sheets that belong above it
+ * back on top before paint. A level on its own, or already on top, is left
+ * alone.
+ */
+export declare function notifyBottomSheetHostChanged(key: object): void;
+/**
+ * Report the controlled open state of a registered sheet. Closing keeps the
+ * sheet's place while it slides out; reopening takes a new rank, so the sheet
+ * returns on top.
+ */
+export declare function setBottomSheetOpen(key: object, isOpen: boolean): void;
+/**
+ * The open sheet directly beneath `key`: its dialog, and a way to move focus
+ * into it. Null when nothing open is beneath. A closing top sheet asks this
+ * to return focus into the sheet it reveals.
+ */
+export declare function getBottomSheetBeneath(key: object): {
+    element: HTMLDialogElement;
+    focus: () => void;
+} | null;
+/**
+ * Move focus into a sheet panel. Focus already inside the sheet stays put:
+ * on `open` the native host has normally run its own focusing steps, which
+ * land on the panel (`tabindex="-1"`), so a `data-autofocus` descendant is
+ * reached only where the host moved nothing (a stubbed host, or a browser
+ * whose focusing steps skipped the sheet) — the released behavior. On
+ * `replace` the entering step takes focus whatever its modality and whatever
+ * the host did, a `data-autofocus` descendant first; on `reveal` the panel
+ * itself takes focus, with a ring only after keyboard input.
+ */
+export declare function focusSheetPanel(panel: HTMLElement | null, reason: BottomSheetFocusReason, isModal: boolean): void;
+/** Test-only: the presented sheets' dialogs, bottom to top, with their views. */
+export declare function getBottomSheetStackForTests(doc?: Document, isModal?: boolean): ReadonlyArray<{
+    element: HTMLDialogElement | null;
+    isOpen: boolean;
+    view: BottomSheetStackView;
+}>;
+/** Test-only: forget every sheet and start the batch counter over. */
+export declare function resetBottomSheetStackForTests(): void;
+/** Test-only: the shared state's key, shape and protocol version, for the two-copies tests. */
+export declare const BOTTOM_SHEET_STACK_STATE_FOR_TESTS: {
+    key: symbol;
+    shape: number;
+    protocolVersion: number;
+    keyFor: (version: number) => symbol;
+    /** Whether the document has the press listeners installed. */
+    isListeningForPresses: (doc: Document) => boolean;
+};
+//# sourceMappingURL=bottomSheetStack.d.ts.map

package/dist/BottomSheet/bottomSheetStack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bottomSheetStack.d.ts","sourceRoot":"","sources":["../../src/BottomSheet/bottomSheetStack.ts"],"names":[],"mappings":"AAyGA,MAAM,WAAW,oBAAoB;IACnC,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,gEAAgE;IAChE,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,oEAAoE;IACpE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,uEAAuE;IACvE,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAC1D,6EAA6E;IAC7E,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,6EAA6E;IAC7E,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,MAAM,yBAAyB,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;AAE1E,2EAA2E;AAC3E,MAAM,MAAM,wBAAwB,GAClC,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEjD,eAAO,MAAM,+BAA+B,EAAE,oBAY7C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;AAcnE,MAAM,WAAW,4BAA4B;IAC3C,sDAAsD;IACtD,GAAG,EAAE,MAAM,CAAC;IACZ,gCAAgC;IAChC,UAAU,EAAE,MAAM,iBAAiB,GAAG,IAAI,CAAC;IAC3C;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,OAAO,GAAG,IAAI,CAAC;IACrC,8EAA8E;IAC9E,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,sEAAsE;IACtE,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,6EAA6E;IAC7E,KAAK,EAAE,CAAC,MAAM,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAChD;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,WAAW,GAAG,IAAI,CAAC;IAC3C,oDAAoD;IACpD,MAAM,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAC7C;;;OAGG;IACH,WAAW,CAAC,EAAE,sBAAsB,CAAC;CACtC;AAED,MAAM,WAAW,sBAAsB;IACrC,mEAAmE;IACnE,QAAQ,EAAE,MAAM,WAAW,GAAG,IAAI,CAAC;IACnC,mEAAmE;IACnE,SAAS,EAAE,MAAM,WAAW,GAAG,IAAI,CAAC;IACpC,wEAAwE;IACxE,SAAS,EAAE,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,KAAK,IAAI,CAAC;IAChD,gFAAgF;IAChF,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB;AAyMD;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAW3C;AAoDD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAGtD;AAaD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAOtD;AA4PD;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAqBlE;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAQrE;AAED,wEAAwE;AACxE,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,iBAAiB,GAAG,IAAI,EAChC,OAAO,EAAE,GAAG,GAAG,GAAG,EAClB,OAAO,EAAE,qBAAqB,GAC7B,IAAI,CAoBN;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAKrE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,iBAAiB,GAAG,IAAI,GAC/B,OAAO,CAaT;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAwGD;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,QAAQ,GAAG,IAAI,CAoC3D;AAwBD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,iBAAiB,EACzB,KAAK,EAAE,WAAW,GAAG,IAAI,GACxB,IAAI,CA8CN;AAgFD,+DAA+D;AAC/D,wBAAgB,aAAa,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAoB7D;AAED;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,iBAAiB,GAAG,IAAI,GAC/B,IAAI,CAcN;AA4ND;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,GAAG,UAAU,EAC3B,MAAM,EAAE,wBAAwB,GAC/B,IAAI,CA4DN;AAwID;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,4BAA4B,EAC1C,MAAM,EAAE,OAAO,EACf,OAAO,GAAE,OAAc,GACtB,MAAM,IAAI,CAmGZ;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAe9D;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,IAAI,CA8CrE;AAsBD;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,EAAE,MAAM,GACV;IAAC,OAAO,EAAE,iBAAiB,CAAC;IAAC,KAAK,EAAE,MAAM,IAAI,CAAA;CAAC,GAAG,IAAI,CAcxD;AAMD;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,WAAW,GAAG,IAAI,EACzB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,EAAE,OAAO,GACf,IAAI,CA2CN;AAED,iFAAiF;AACjF,wBAAgB,2BAA2B,CACzC,GAAG,GAAE,QAAmB,EACxB,OAAO,GAAE,OAAc,GACtB,aAAa,CAAC;IACf,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAClC,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,oBAAoB,CAAC;CAC5B,CAAC,CAMD;AAED,sEAAsE;AACtE,wBAAgB,6BAA6B,IAAI,IAAI,CA+BpD;AAED,+FAA+F;AAC/F,eAAO,MAAM,kCAAkC;;;;sBAI3B,MAAM;IAExB,8DAA8D;iCACjC,QAAQ;CACtC,CAAC"}