@apexnative/navigation 0.0.0-stage → 1.0.0-alpha.0

package/lib/typescript/interfaces/Events.d.ts

@@ -0,0 +1,199 @@
+/**
+ * The native side is ready for JavaScript to start the app. It carries no data. JavaScript answers by setting the
+ * default options and the root. It is sent after each bundle load, after a reload, and (Android) for each new
+ * activity.
+ */
+export type AppLaunchedEvent = Record<string, never>;
+/** The commands that report their completion with `CommandCompletedEvent`. */
+export type CompletedCommandName = 'setRoot' | 'push' | 'pop' | 'popTo' | 'popToRoot' | 'setStackRoot' | 'showInColumn' | 'showModal' | 'dismissModal' | 'dismissAllModals' | 'showOverlay' | 'dismissOverlay' | 'dismissAllOverlays';
+/**
+ * A command finished successfully. It is sent after the promise of the command resolved, never for a command that was
+ * refused. The library itself does not listen to it: it is for external tools, such as end-to-end tests and latency
+ * measurements.
+ */
+export interface CommandCompletedEvent {
+    /** The name of the command. */
+    commandName: CompletedCommandName;
+    /** The id of this call of the command. */
+    commandId: string;
+    /** When the command finished, in milliseconds since the Unix epoch. */
+    completionTime: number;
+}
+/**
+ * What the user sees changed. It is sent only when the state differs from the last one sent, and before the promise of
+ * a command that changed it resolves.
+ */
+export interface NavigationStateChangedEvent {
+    /**
+     * The visible screen with its name in `screens`, or `null` when there is none. In a container the visible screen is
+     * the one it shows.
+     */
+    screen: {
+        id: string;
+        name: string;
+    } | null;
+    /** The index of the selected tab of the nearest tabs around the visible screen, or `null` outside tabs. */
+    tab: number | null;
+}
+/**
+ * A tab was selected by the user: a press on the tab, a pick from the "More" list or a press on "More" that showed a
+ * tab (iOS). It is sent after the selection, and only when the tab changed; a press on the current tab is reported by
+ * `BottomTabPressedEvent` alone. Selecting a tab from code sends nothing.
+ */
+export interface BottomTabSelectedEvent {
+    /** The index of the tab that is now selected. */
+    selectedTabIndex: number;
+    /** The index of the tab that was selected before. */
+    unselectedTabIndex: number;
+    /** The id of the tabs. */
+    bottomTabsId: string;
+}
+/**
+ * A tab was pressed, the selected one too. It is sent before the tab is selected; with `selectTabOnPress: false` it is
+ * the only thing that happens. A long press sends `BottomTabLongPressedEvent` instead.
+ */
+export interface BottomTabPressedEvent {
+    /** The index of the tab that was pressed. */
+    tabIndex: number;
+    /** The id of the tabs. */
+    bottomTabsId: string;
+    /** The id of the screen the tab shows: the top of its stack. */
+    screenId?: string;
+    /** Whether the tab was the selected one already; a press on the selected tab scrolls its content to the top. */
+    wasSelected: boolean;
+}
+/**
+ * A tab was pressed and held. The tab is not selected and gets no press event. On iOS it is not sent for the tabs
+ * that are components (`bottomTab.component`, `bottomTabs.customRow`), for "More", or for the tab strip at the top of an
+ * iPad. On Android it replaces the tooltip of the tab.
+ */
+export interface BottomTabLongPressedEvent {
+    /** The index of the tab that was pressed. */
+    selectedTabIndex: number;
+    /** The id of the tabs. */
+    bottomTabsId: string;
+}
+/**
+ * Whether the columns of a split view are shown as one stack, one over the other: on iOS a split view collapsed
+ * without a compact layout, on Android the sliding pane. It is sent when the split view enters the window or is first
+ * laid out, and on each change.
+ */
+export interface SplitViewColumnsStackedEvent {
+    /** The id of the split view. */
+    componentId: string;
+    /** Whether the columns are shown as one stack. */
+    stacked: boolean;
+}
+/**
+ * A screen of the single React tree was destroyed and the slot still belongs to it: JavaScript removes the slot from
+ * its tree. It is not sent for a prepared screen that was never pushed, nor when JavaScript reloads.
+ */
+export interface SlotDestroyedEvent {
+    /** The id of the screen that owned the slot. */
+    componentId: string;
+}
+/**
+ * The distances by which the bars and the system cover the content of a screen on each side, in points on iOS and dp
+ * on Android: what the safe area view of the screen did not already take off. It is sent after the screen is laid out
+ * and on each change, never twice with the same values. The same values are read synchronously with
+ * `getScreenInsets`.
+ */
+export interface ScreenInsetsChangedEvent {
+    /** The id of the screen. */
+    componentId: string;
+    /** The distance at the top. */
+    top: number;
+    /** The distance at the right. */
+    right: number;
+    /** The distance at the bottom. */
+    bottom: number;
+    /** The distance at the left. */
+    left: number;
+}
+/** A rectangle in the coordinates of a screen. */
+export interface ScreenRegionRect {
+    /** The distance of its left edge from the left edge of the screen. */
+    x: number;
+    /** The distance of its top edge from the top edge of the screen. */
+    y: number;
+    /** Its width. */
+    width: number;
+    /** Its height. */
+    height: number;
+}
+/**
+ * The parts of a screen that the device divides or covers, only those inside the screen. It is sent when they change.
+ * The same values are read synchronously with `getScreenRegions`. On iOS it needs iOS 27.1; Android takes the folds
+ * from the window.
+ */
+export interface ScreenRegionsChangedEvent {
+    /** The id of the screen. */
+    componentId: string;
+    /** The folds, without margins. */
+    division: ScreenRegionRect[];
+    /** The areas covered by a camera or anything else that hides part of the screen. */
+    occlusion: ScreenRegionRect[];
+}
+/**
+ * How the screens of a pair are shown. It is sent for a screen of a pair when this changes. The same state is read
+ * synchronously with `getArrangementState`.
+ */
+export interface ArrangementChangedEvent {
+    /** The id of the screen of the pair. */
+    componentId: string;
+    /** Which part of the pair the screen is. */
+    placement: 'primary' | 'secondary';
+    /** How the pair lies: side by side, one over the other, one over the other as an overlay, or only one of them. */
+    layout: 'sideBySide' | 'stacked' | 'overlay' | 'single';
+    /** Whether the screen is in front. */
+    front: boolean;
+    /** Whether the screen is hidden. */
+    hidden: boolean;
+}
+/** The state of the hinge of a foldable device. */
+export type HingeState = 'closed' | 'partiallyOpen' | 'fullyOpen' | 'unknown';
+/**
+ * The hinge of the device changed. It is sent only while JavaScript has turned hinge updates on, each value once. An
+ * empty event means the device has no hinge, or it is no longer known.
+ */
+export interface HingeChangedEvent {
+    /**
+     * The state of the hinge. On Android `closed` means the device has no fold, or its angle is below 90 degrees.
+     */
+    state?: HingeState;
+    /**
+     * The angle of the hinge in degrees (on iOS to tenths). Missing when the state is `unknown` and where the system
+     * gives no angle.
+     */
+    angle?: number;
+}
+/**
+ * A native screen calls into JavaScript: a function among its props, or a navigation command made from the screen.
+ * JavaScript answers with `resolveNativeScreenCall`, with a value or an error. A call made while the navigation is not
+ * running fails at once; one pending when JavaScript reloads fails with `JavaScript reloaded`.
+ */
+export interface NativeScreenCallEvent {
+    /** The id of the native screen that makes the call. */
+    componentId: string;
+    /** The id of the call, to answer it. */
+    callId: string;
+    /** What is called: a function of the props, or a navigation command. */
+    kind: 'function' | 'command';
+    /**
+     * The name of the function, or of the command: `push`, `pop`, `popTo`, `popToRoot`, `showInColumn`, `showModal`,
+     * `dismiss`, `showOverlay`, `setOptions`, `selectTab` or `setTabBadge`.
+     */
+    name: string;
+    /** The arguments of the call. */
+    args: unknown[];
+}
+/**
+ * A native screen left the layout, however it left: back, a swipe, a closed modal, a new root, or (Android) the
+ * activity going away. It is sent once; JavaScript lets go of the hook and the functions of the screen. It is not sent
+ * when JavaScript reloads.
+ */
+export interface NativeScreenReleasedEvent {
+    /** The id of the native screen. */
+    componentId: string;
+}
+//# sourceMappingURL=Events.d.ts.map

package/lib/typescript/interfaces/Events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Events.d.ts","sourceRoot":"","sources":["../../../src/interfaces/Events.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAErD,8EAA8E;AAC9E,MAAM,MAAM,oBAAoB,GAC5B,SAAS,GACT,MAAM,GACN,KAAK,GACL,OAAO,GACP,WAAW,GACX,cAAc,GACd,cAAc,GACd,WAAW,GACX,cAAc,GACd,kBAAkB,GAClB,aAAa,GACb,gBAAgB,GAChB,oBAAoB,CAAC;AAEzB;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,+BAA+B;IAC/B,WAAW,EAAE,oBAAoB,CAAC;IAClC,0CAA0C;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,MAAM,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAC5C,2GAA2G;IAC3G,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,iDAAiD;IACjD,gBAAgB,EAAE,MAAM,CAAC;IACzB,qDAAqD;IACrD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,0BAA0B;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,0BAA0B;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gHAAgH;IAChH,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,6CAA6C;IAC7C,gBAAgB,EAAE,MAAM,CAAC;IACzB,0BAA0B;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,gDAAgD;IAChD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,+BAA+B;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,kDAAkD;AAClD,MAAM,WAAW,gBAAgB;IAC/B,sEAAsE;IACtE,CAAC,EAAE,MAAM,CAAC;IACV,oEAAoE;IACpE,CAAC,EAAE,MAAM,CAAC;IACV,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B,oFAAoF;IACpF,SAAS,EAAE,gBAAgB,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,4CAA4C;IAC5C,SAAS,EAAE,SAAS,GAAG,WAAW,CAAC;IACnC,kHAAkH;IAClH,MAAM,EAAE,YAAY,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IACxD,sCAAsC;IACtC,KAAK,EAAE,OAAO,CAAC;IACf,oCAAoC;IACpC,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,mDAAmD;AACnD,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,eAAe,GAAG,WAAW,GAAG,SAAS,CAAC;AAE9E;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,uDAAuD;IACvD,WAAW,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,wEAAwE;IACxE,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,mCAAmC;IACnC,WAAW,EAAE,MAAM,CAAC;CACrB"}

package/lib/typescript/interfaces/Layout.d.ts

@@ -0,0 +1,150 @@
+import type { Options } from './Options.js';
+/**
+ * A screen of the app, a React Native one: the name it has in `screens`, the props it gets, and the options of this
+ * show.
+ */
+export interface LayoutComponent {
+    /**
+     * The id of the screen, to address it in commands and events. Without it, the library gives the screen one. An id
+     * names one screen in the whole app at a time: a layout that gives it twice, or a command that shows a screen
+     * under the id of one that is already shown elsewhere, is refused.
+     */
+    id?: string;
+    /** The name of the screen in `screens`. A name that is not there is refused before anything is sent. */
+    name: string;
+    /**
+     * The props the screen gets. They stay in JavaScript, under the id of the screen; the native side never sees them.
+     */
+    passProps?: object;
+    /** The options of this show of the screen, over its own options and under those of its containers. */
+    options?: Options;
+}
+/**
+ * A screen the app creates in native code and registered under a name. The native side makes it through the creator
+ * registered for the name.
+ */
+export interface ExternalComponent {
+    /** The id of the screen. Without it, the library gives the screen one. */
+    id?: string;
+    /** The name the screen is registered under on the native side; it need not be a name in `screens`. */
+    name: string;
+    /**
+     * The props the native screen gets, as JSON: functions are dropped from the data (the native screen calls them by
+     * name), `undefined` values are left out and dates become strings.
+     */
+    passProps?: object;
+    /** The options of the screen: its bar, its buttons, as for a React screen. */
+    options?: Options;
+}
+/**
+ * A stack of screens. The last child shows; going back reveals the one before it. A stack takes screens only, a
+ * container inside a stack is refused.
+ */
+export interface LayoutStack {
+    /** The id of the stack. Without it, the library gives the stack one. */
+    id?: string;
+    /**
+     * The screens from the bottom up. A stack without screens is refused by the native side. The screens under the
+     * last one are created at once, but they are shown and drawn only when they are reached.
+     */
+    children?: LayoutStackChildren[];
+    /** The options of the stack: defaults for its screens, such as their bar or their animations. */
+    options?: Options;
+}
+/**
+ * What a stack holds: a screen, React Native or native. It is a layout that sets one of the two screen keys.
+ */
+export type LayoutStackChildren = Pick<Layout, 'component' | 'externalComponent'>;
+/**
+ * A set of bottom tabs. Each child is a tab. The tab bar button is built from the `bottomTab` options of the child
+ * and of its screens.
+ */
+export interface LayoutBottomTabs {
+    /**
+     * The id of the tabs, named by `bottomTabsId` in the tab events. Without it, the library gives the tabs one. The
+     * commands that act on a tab take the id of the tab itself, not this one.
+     */
+    id?: string;
+    /**
+     * The tabs in order: the index of a child is the index of its tab in events and options. A stack, a screen, or a
+     * side menu fits a tab. Android shows at most 5 tabs and refuses a layout with more; iOS shows the tabs after the
+     * fourth under "More" on an iPhone. Tabs without children are refused by the native side.
+     */
+    children?: Layout[];
+    /** The options of the tabs, such as the tab to show first (`bottomTabs.currentTabIndex`, `currentTabId`). */
+    options?: Options;
+}
+/**
+ * A side menu: a center and, at its sides, up to two menus.
+ */
+export interface LayoutSideMenu {
+    /** The id of the side menu. Without it, the library gives the menu one. */
+    id?: string;
+    /** The content of the menu at the left (leading) edge. Without it, there is no menu on that side. */
+    left?: Layout;
+    /** The content that the menus belong to. A side menu cannot be built without it. */
+    center: Layout;
+    /** The content of the menu at the right (trailing) edge. Without it, there is no menu on that side. */
+    right?: Layout;
+    /** The options of the side menu: its visibility, widths and gestures. */
+    options?: Options;
+}
+/**
+ * A split view: columns side by side, or one over the other when the window is narrow. `master` and `detail` are
+ * required; a layout without them is refused.
+ */
+export interface LayoutSplitView {
+    /** The id of the split view. Without it, the library gives the split view one. */
+    id?: string;
+    /** The primary column. */
+    master: Layout;
+    /** The secondary column, the one that shows the content of the item chosen in the primary. */
+    detail: Layout;
+    /** (iOS) The middle column. A split view with it has three columns. */
+    supplementary?: Layout;
+    /**
+     * What an iPhone, a narrow window and a narrow Android screen show in place of the columns. Without it, the
+     * columns collapse by the rules of the platform.
+     */
+    compact?: Layout;
+    /** (iPadOS 26+) The column at the trailing edge. Android has no such column and ignores it. */
+    inspector?: Layout;
+    /** The options of the split view: its display mode, column widths and buttons. */
+    options?: Options;
+}
+/**
+ * One node of a layout: exactly one of its keys is set, and it names the kind of the node. A layout with none of them
+ * is refused before it is sent.
+ */
+export interface Layout {
+    /** A React Native screen. */
+    component?: LayoutComponent;
+    /** A screen created in native code. */
+    externalComponent?: ExternalComponent;
+    /** A stack of screens. */
+    stack?: LayoutStack;
+    /** Bottom tabs. */
+    bottomTabs?: LayoutBottomTabs;
+    /** A side menu. */
+    sideMenu?: LayoutSideMenu;
+    /** A split view. */
+    splitView?: LayoutSplitView;
+}
+/**
+ * The layout of the whole app: what `setRoot` takes. A modal or an overlay is not a kind of node: any node becomes
+ * one when it is listed under `modals` or `overlays`.
+ */
+export interface LayoutRoot {
+    /** The root of the app. It replaces the previous one. */
+    root: Layout;
+    /**
+     * The modals to show over the root once it is in place, in order, each over the one before. Only the last one is
+     * animated; the ones under it come at once. Without it, none.
+     */
+    modals?: Layout[];
+    /**
+     * The overlays to show after the modals, one by one. Overlays shown before the new root stay. Without it, none.
+     */
+    overlays?: Layout[];
+}
+//# sourceMappingURL=Layout.d.ts.map

package/lib/typescript/interfaces/Layout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Layout.d.ts","sourceRoot":"","sources":["../../../src/interfaces/Layout.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAW,CAAC;AAEzC;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,wGAAwG;IACxG,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sGAAsG;IACtG,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,0EAA0E;IAC1E,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,sGAAsG;IACtG,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8EAA8E;IAC9E,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,wEAAwE;IACxE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACjC,iGAAiG;IACjG,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,MAAM,EAAE,WAAW,GAAG,mBAAmB,CAAC,CAAC;AAElF;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,6GAA6G;IAC7G,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,2EAA2E;IAC3E,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,qGAAqG;IACrG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oFAAoF;IACpF,MAAM,EAAE,MAAM,CAAC;IACf,uGAAuG;IACvG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yEAAyE;IACzE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,kFAAkF;IAClF,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,8FAA8F;IAC9F,MAAM,EAAE,MAAM,CAAC;IACf,uEAAuE;IACvE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+FAA+F;IAC/F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kFAAkF;IAClF,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,uCAAuC;IACvC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,0BAA0B;IAC1B,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,mBAAmB;IACnB,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,mBAAmB;IACnB,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,oBAAoB;IACpB,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB"}

package/lib/typescript/interfaces/Options.d.ts

@@ -0,0 +1,93 @@
+import type { AnimationOptions } from './options/animations.js';
+import type { OptionsBottomTab, OptionsBottomTabs } from './options/bottomTabs.js';
+import type { Color } from './options/common.js';
+import type { ModalOptions, OptionsModalPresentationStyle, OptionsModalTransitionStyle, OverlayOptions } from './options/modals.js';
+import type { PreviewOptions } from './options/preview.js';
+import type { OptionsSideMenu } from './options/sideMenu.js';
+import type { OptionsSplitView } from './options/splitView.js';
+import type { HardwareBackButtonOptions, OptionsFab } from './options/stack.js';
+import type { NavigationBarOptions, OptionsKeyCommand, OptionsLayout, OptionsStatusBar } from './options/system.js';
+import type { OptionsToolbar } from './options/toolbar.js';
+import type { OptionsScrollEdgeEffect, OptionsTopBar } from './options/topBar.js';
+/**
+ * The options of a screen or a container. A screen shows its own options over those of its containers (its stack, its
+ * tabs, its side menu), and all of them over the default options of the app. Objects merge key by key, arrays and
+ * values replace what was there, and a key left out keeps what the layers below give.
+ */
+export interface Options {
+    /** The bar at the top of a screen in a stack: its title, buttons, back button, search and look. */
+    topBar?: OptionsTopBar;
+    /** (iOS) The toolbar at the bottom of a screen in a stack. */
+    toolbar?: OptionsToolbar;
+    /** (iOS 26+) How the content fades or blurs where it scrolls under a bar. */
+    scrollEdgeEffect?: OptionsScrollEdgeEffect;
+    /** The tab bar of the tabs the screen is in, while the screen shows. */
+    bottomTabs?: OptionsBottomTabs;
+    /** The tab of a screen that is a tab of a tab bar (or the first screen of a stack that is one). */
+    bottomTab?: OptionsBottomTab;
+    /** A screen shown as a modal: how it is presented, how it can be dismissed, its sheet. */
+    modal?: ModalOptions;
+    /** How a modal is presented: full screen, as a page sheet, a form sheet, a popover… */
+    modalPresentationStyle?: OptionsModalPresentationStyle;
+    /** (iOS) The system transition of a modal: cover vertical, flip horizontal, cross dissolve, partial curl. */
+    modalTransitionStyle?: OptionsModalTransitionStyle;
+    /** A screen shown as an overlay: whether touches outside its content go through to what is below. */
+    overlay?: OverlayOptions;
+    /** The side menus of the side menu the screen is in: their visibility, width, gestures. */
+    sideMenu?: OptionsSideMenu;
+    /** The split view the screen is in: its columns, their widths, how they show. */
+    splitView?: OptionsSplitView;
+    /** The screen's layout: its background, safe area, orientation. */
+    layout?: OptionsLayout;
+    /** The status bar while the screen shows. */
+    statusBar?: OptionsStatusBar;
+    /** (Android) The navigation bar while the screen shows. */
+    navigationBar?: NavigationBarOptions;
+    /** The transitions of the commands: push, pop, modals, the root, and elements that move between screens. */
+    animations?: AnimationOptions;
+    /**
+     * (iOS) The swipe back in the stack: `true` from the edge and, on iOS 26, from anywhere in the content; `'edge'`
+     * only from the edge, so horizontal gestures of the content (sliders, carousels) keep theirs; `false` no swipe, the
+     * back button still works. The top screen's value applies each time it shows, and at once through `mergeOptions`.
+     * Before iOS 26 `'edge'` is the same as `true`. Android has the system back instead and doesn't read it.
+     * @default true
+     */
+    popGesture?: boolean | 'edge';
+    /** (Android) What the system back button and the back gesture do on the screen. */
+    hardwareBackButton?: HardwareBackButtonOptions;
+    /** (Android) The floating action button of the screen. */
+    fab?: OptionsFab;
+    /** (iOS) The keyboard shortcuts of the screen, shown by the system when a hardware keyboard is held. */
+    keyCommands?: OptionsKeyCommand[];
+    /**
+     * Whether a text field of the screen loses the focus, and the keyboard hides, as the screen leaves: when the
+     * transition that takes it away starts (a pop, a modal's dismiss, a new stack root or app root), so the keyboard
+     * doesn't stay up during the transition.
+     * @default false
+     */
+    blurOnUnmount?: boolean;
+    /**
+     * The preview of a pushed screen, for a view of the screen it is pushed from (iOS). Set by `usePreview`; apps
+     * don't set it.
+     * @internal
+     */
+    preview?: PreviewOptions;
+}
+/** (iOS) The app's window, behind every screen: seen around a modal while it comes in. */
+export interface WindowOptions {
+    /** The color of the window; without it, the system background. */
+    backgroundColor?: Color;
+}
+export type { AnimationOptions } from './options/animations.js';
+export type { AppearingElementAnimation, DisappearingElementAnimation, ElementAnimation, ElementTransition, EnterExitAnimationOptions, Interpolation, ModalAnimationOptions, OptionsAnimationPropertyConfig, ScreenAnimationOptions, SharedElementTransition, StackAnimationOptions, StackPushAnimationOptions, TopBarAnimationOptions, ViewAnimationOptions, ZoomTransitionOptions, } from './options/animations.js';
+export type { BottomTabsCustomRowOptions, DotIndicatorOptions, OptionsBottomTab, OptionsBottomTabs, OptionsBottomTabsAccessory, ShadowOptions, } from './options/bottomTabs.js';
+export type { IconBackgroundOptions, IconInsets, OptionsTopBarButton, OptionsTopBarButtonMenu, OptionsTopBarButtonMenuElement, OptionsTopBarButtonMenuItem, OptionsTopBarButtonSubmenu, SystemItemIcon, } from './options/buttons.js';
+export type { Color, ImageResource, PlatformIcon } from './options/common.js';
+export type { ModalOptions, OptionsModalPopover, OptionsModalPresentationStyle, OptionsModalSheet, OptionsModalSheetDetent, OptionsModalTransitionStyle, OverlayOptions, } from './options/modals.js';
+export type { OptionsSideMenu, SideMenuSide } from './options/sideMenu.js';
+export type { OptionsSplitView, OptionsSplitViewColumn } from './options/splitView.js';
+export type { HardwareBackButtonOptions, OptionsFab } from './options/stack.js';
+export type { LayoutOrientation, NavigationBarOptions, OptionsKeyCommand, OptionsLayout, OptionsStatusBar, SafeAreaEdge, } from './options/system.js';
+export type { OptionsToolbar, OptionsToolbarSearchField, OptionsToolbarSpace, } from './options/toolbar.js';
+export type { OptionsScrollEdge, OptionsScrollEdgeEffect, OptionsSearchBar, OptionsSearchBarScope, OptionsSearchBarSuggestion, OptionsSearchBarToken, OptionsTopBar, OptionsTopBarBackButton, OptionsTopBarBackground, OptionsTopBarLargeTitle, OptionsTopBarScrollEdgeAppearance, OptionsTopBarScrollEdgeAppearanceBackground, OptionsTopBarScrollEdgeAppearanceTitle, OptionsTopBarSubtitle, OptionsTopBarTitle, } from './options/topBar.js';
+//# sourceMappingURL=Options.d.ts.map

package/lib/typescript/interfaces/Options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Options.d.ts","sourceRoot":"","sources":["../../../src/interfaces/Options.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,yBAAsB,CAAC;AAChF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qBAAkB,CAAC;AAC9C,OAAO,KAAK,EACV,YAAY,EACZ,6BAA6B,EAC7B,2BAA2B,EAC3B,cAAc,EACf,MAAM,qBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAqB,CAAC;AAC5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,UAAU,EAAE,MAAM,oBAAiB,CAAC;AAC7E,OAAO,KAAK,EACV,oBAAoB,EACpB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EACjB,MAAM,qBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,uBAAuB,EAAE,aAAa,EAAE,MAAM,qBAAkB,CAAC;AAE/E;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,mGAAmG;IACnG,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,8DAA8D;IAC9D,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,6EAA6E;IAC7E,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;IAC3C,wEAAwE;IACxE,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,mGAAmG;IACnG,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,0FAA0F;IAC1F,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,uFAAuF;IACvF,sBAAsB,CAAC,EAAE,6BAA6B,CAAC;IACvD,6GAA6G;IAC7G,oBAAoB,CAAC,EAAE,2BAA2B,CAAC;IACnD,qGAAqG;IACrG,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,iFAAiF;IACjF,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,mEAAmE;IACnE,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,6CAA6C;IAC7C,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,2DAA2D;IAC3D,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC,4GAA4G;IAC5G,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC9B,mFAAmF;IACnF,kBAAkB,CAAC,EAAE,yBAAyB,CAAC;IAC/C,0DAA0D;IAC1D,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,wGAAwG;IACxG,WAAW,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAClC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED,0FAA0F;AAC1F,MAAM,WAAW,aAAa;IAC5B,kEAAkE;IAClE,eAAe,CAAC,EAAE,KAAK,CAAC;CACzB;AAED,YAAY,EAAE,gBAAgB,EAAE,MAAM,yBAAsB,CAAC;AAC7D,YAAY,EACV,yBAAyB,EACzB,4BAA4B,EAC5B,gBAAgB,EAChB,iBAAiB,EACjB,yBAAyB,EACzB,aAAa,EACb,qBAAqB,EACrB,8BAA8B,EAC9B,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,GACtB,MAAM,yBAAsB,CAAC;AAC9B,YAAY,EACV,0BAA0B,EAC1B,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,0BAA0B,EAC1B,aAAa,GACd,MAAM,yBAAsB,CAAC;AAC9B,YAAY,EACV,qBAAqB,EACrB,UAAU,EACV,mBAAmB,EACnB,uBAAuB,EACvB,8BAA8B,EAC9B,2BAA2B,EAC3B,0BAA0B,EAC1B,cAAc,GACf,MAAM,sBAAmB,CAAC;AAC3B,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,qBAAkB,CAAC;AAC3E,YAAY,EACV,YAAY,EACZ,mBAAmB,EACnB,6BAA6B,EAC7B,iBAAiB,EACjB,uBAAuB,EACvB,2BAA2B,EAC3B,cAAc,GACf,MAAM,qBAAkB,CAAC;AAC1B,YAAY,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,uBAAoB,CAAC;AACxE,YAAY,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,wBAAqB,CAAC;AACpF,YAAY,EAAE,yBAAyB,EAAE,UAAU,EAAE,MAAM,oBAAiB,CAAC;AAC7E,YAAY,EACV,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,YAAY,GACb,MAAM,qBAAkB,CAAC;AAC1B,YAAY,EACV,cAAc,EACd,yBAAyB,EACzB,mBAAmB,GACpB,MAAM,sBAAmB,CAAC;AAC3B,YAAY,EACV,iBAAiB,EACjB,uBAAuB,EACvB,gBAAgB,EAChB,qBAAqB,EACrB,0BAA0B,EAC1B,qBAAqB,EACrB,aAAa,EACb,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,EACvB,iCAAiC,EACjC,2CAA2C,EAC3C,sCAAsC,EACtC,qBAAqB,EACrB,kBAAkB,GACnB,MAAM,qBAAkB,CAAC"}