@gjsify/adwaita-core 0.30.0 → 0.32.0

package/lib/types/conformance/split-view.d.ts

@@ -0,0 +1,290 @@
+import type { AdwLengthUnit, AdwPackType, AdwTextDirection, NavigationActionResult, NavigationStackPlan, OverlaySplitViewLayout, SidebarWidthSpec, SplitViewPaneRect } from '../split-view.js';
+/** One `adwLengthToPx` expectation. */
+export interface AdwLengthUnitVector {
+    unit: AdwLengthUnit;
+    value: number;
+    /** The `gtk-xft-dpi` in play. */
+    dpi: number;
+    /** The resulting pixel length. */
+    px: number;
+    /** Why this row exists. */
+    rule: string;
+}
+/** `adw_length_unit_to_px` (adw-length-unit.c:72-81). */
+export declare const ADW_LENGTH_UNIT_VECTORS: ReadonlyArray<AdwLengthUnitVector>;
+/** One `glibClamp` expectation. */
+export interface GlibClampVector {
+    x: number;
+    low: number;
+    high: number;
+    /** What GLib's CLAMP returns. */
+    clamped: number;
+    rule: string;
+}
+/**
+ * GLib's `CLAMP` (gmacros.h) — HIGH is tested first.
+ *
+ * The inverted rows are the point: `Math.min(high, Math.max(low, x))` returns
+ * `high` there, and `allocate_uncollapsed` reaches inverted bounds whenever the
+ * content pane's own minimum leaves less room than `min-sidebar-width`.
+ */
+export declare const GLIB_CLAMP_VECTORS: ReadonlyArray<GlibClampVector>;
+/** One `resolveSidebarBounds` expectation. */
+export interface SidebarBoundsVector {
+    spec: SidebarWidthSpec;
+    /** The sidebar child's own minimum width. */
+    sidebarChildMin: number;
+    /** `true` for the allocate paths (which `ceil()`), `false` for the measure paths. */
+    ceil: boolean;
+    min: number;
+    max: number;
+    rule: string;
+}
+/**
+ * The `MAX (…, adw_length_unit_to_px (…))` pair both widgets open with —
+ * allocate flavour at adw-navigation-split-view.c:292-300 /
+ * adw-overlay-split-view.c:452-460, measure flavour at :251-256 / :545-550.
+ */
+export declare const SIDEBAR_BOUNDS_VECTORS: ReadonlyArray<SidebarBoundsVector>;
+/** One allocated-sidebar-width expectation. */
+export interface SidebarWidthVector {
+    /** Which widget's rule applies — they answer the same input differently. */
+    widget: 'navigation' | 'overlay';
+    spec: SidebarWidthSpec;
+    totalWidth: number;
+    /** The content pane's own minimum width. */
+    contentMin: number;
+    /** The sidebar child's own minimum width. */
+    sidebarChildMin: number;
+    /** Overlay only: collapsed ignores the fraction and clamps the VIEW width. */
+    collapsed: boolean;
+    /** The allocated sidebar width. */
+    width: number;
+    rule: string;
+}
+/**
+ * `allocate_uncollapsed` (adw-navigation-split-view.c:292-304) versus
+ * `get_sidebar_width` + `allocate_uncollapsed` (adw-overlay-split-view.c:441-466, :585).
+ *
+ * The 300px pair is the reason this table keys on `widget`: identical input, 180 in
+ * the navigation split view and 100 in the overlay, because one caps the BOUND and
+ * the other caps the RESULT.
+ */
+export declare const SIDEBAR_WIDTH_VECTORS: ReadonlyArray<SidebarWidthVector>;
+/** One `resolveNaturalSidebarWidth` expectation. */
+export interface NaturalSidebarWidthVector {
+    contentNatural: number;
+    min: number;
+    max: number;
+    fraction: number;
+    natural: number;
+    rule: string;
+}
+/**
+ * `measure_uncollapsed`'s sidebar estimate (adw-navigation-split-view.c:260-262,
+ * adw-overlay-split-view.c:554-556) — the sidebar's OWN natural width is ignored.
+ */
+export declare const NATURAL_SIDEBAR_WIDTH_VECTORS: ReadonlyArray<NaturalSidebarWidthVector>;
+/** One `measureSplitViewHorizontal` expectation. */
+export interface SplitViewMeasureVector {
+    min: number;
+    max: number;
+    sidebarNatural: number;
+    contentMin: number;
+    contentNatural: number;
+    showProgress: number;
+    minimum: number;
+    natural: number;
+    rule: string;
+}
+/**
+ * `measure_uncollapsed` (adw-overlay-split-view.c:558-563; the navigation variant at
+ * adw-navigation-split-view.c:264-267 is the same rule at progress 1).
+ *
+ * This is the container minimum neither renderer had — which is why in both of them
+ * the content pane shrinks to nothing instead of the window refusing to get narrower.
+ */
+export declare const SPLIT_VIEW_MEASURE_VECTORS: ReadonlyArray<SplitViewMeasureVector>;
+/** One `layoutNavigationSplitView` expectation. */
+export interface NavigationLayoutVector {
+    totalWidth: number;
+    sidebarWidth: number;
+    sidebarPosition: AdwPackType;
+    direction: AdwTextDirection;
+    sidebar: SplitViewPaneRect;
+    content: SplitViewPaneRect;
+    rule: string;
+}
+/** `allocate_uncollapsed` (adw-navigation-split-view.c:306-316). */
+export declare const NAVIGATION_SPLIT_VIEW_LAYOUT_VECTORS: ReadonlyArray<NavigationLayoutVector>;
+/** One `layoutOverlaySplitView` expectation. */
+export interface OverlayLayoutVector {
+    totalWidth: number;
+    sidebarWidth: number;
+    showProgress: number;
+    collapsed: boolean;
+    sidebarPosition: AdwPackType;
+    direction: AdwTextDirection;
+    /** The full expected allocation, including the shield/paint/shadow state. */
+    layout: OverlaySplitViewLayout;
+    rule: string;
+}
+/**
+ * `allocate_uncollapsed` (adw-overlay-split-view.c:572-610) and `allocate_collapsed`
+ * (:653-703), plus `update_shield` (:249-256) and the snapshot gate (:757).
+ *
+ * `shadowProgress` is inverted relative to the reveal — 1 means NO shadow
+ * (adw-shadow-helper.c:234-249).
+ */
+export declare const OVERLAY_SPLIT_VIEW_LAYOUT_VECTORS: ReadonlyArray<OverlayLayoutVector>;
+/** One `tagsConflict` expectation. */
+export interface TagsConflictVector {
+    sidebarTag: string | null;
+    contentTag: string | null;
+    conflict: boolean;
+    rule: string;
+}
+/** `tags_equal` (adw-navigation-split-view.c:413-429). */
+export declare const TAGS_CONFLICT_VECTORS: ReadonlyArray<TagsConflictVector>;
+/** One `resolveNavigationStack` expectation. */
+export interface NavigationStackVector {
+    hasSidebar: boolean;
+    hasContent: boolean;
+    sidebarPosition: AdwPackType;
+    showContent: boolean;
+    /** Whether the animated (`set_show_content`) branch applies. */
+    changingPage: boolean;
+    plan: NavigationStackPlan;
+    rule: string;
+}
+/**
+ * `update_navigation_stack` (adw-navigation-split-view.c:342-405).
+ *
+ * The lone-child rows are the ones both renderers fail: their CSS / `visibility`
+ * tables key on `show-content` alone, so a collapsed split view holding only a
+ * sidebar renders nothing at all.
+ */
+export declare const NAVIGATION_STACK_VECTORS: ReadonlyArray<NavigationStackVector>;
+/** One `resolveNavigationAction` expectation. */
+export interface NavigationActionVector {
+    action: 'push' | 'pop';
+    /** `push` only — the tag the action names. */
+    tag?: string;
+    sidebarTag?: string | null;
+    contentTag?: string | null;
+    /** `pop` only. */
+    hasSidebar?: boolean;
+    /** `pop` only. */
+    hasContent?: boolean;
+    showContent: boolean;
+    collapsed: boolean;
+    result: NavigationActionResult;
+    rule: string;
+}
+/**
+ * `navigation_push_cb` (adw-navigation-split-view.c:644-685) and `navigation_pop_cb`
+ * (:687-702) — documented as working even when NOT collapsed (:124-132).
+ */
+export declare const NAVIGATION_ACTION_VECTORS: ReadonlyArray<NavigationActionVector>;
+/** The observable state of an `OverlaySplitViewState`. */
+export interface OverlaySplitViewSnapshot {
+    showSidebar: boolean;
+    collapsed: boolean;
+    showProgress: number;
+    shieldVisible: boolean;
+    sidebarFocusable: boolean;
+    contentFocusable: boolean;
+}
+/** One collapse-coupling expectation. */
+export interface OverlayCollapseVector {
+    /** Constructor options. */
+    initial: {
+        collapsed?: boolean;
+        showSidebar?: boolean;
+        pinSidebar?: boolean;
+    };
+    /** State right after construction. */
+    before: OverlaySplitViewSnapshot;
+    /** The `collapsed` value to set. */
+    setCollapsed: boolean;
+    /** State after the change. */
+    after: OverlaySplitViewSnapshot;
+    /** Which `notify::*` properties fire, in order. */
+    notifications: ReadonlyArray<'show-sidebar' | 'collapsed'>;
+    rule: string;
+}
+/**
+ * `adw_overlay_split_view_init` (:1106-1116) + `set_collapsed` (:1439-1481) +
+ * the can-focus pair (:330-331).
+ *
+ * `if (!self->pin_sidebar) set_show_sidebar (self, !self->collapsed, FALSE, 0);` is
+ * the single rule BOTH storybooks re-implemented by hand because neither widget
+ * offered it. `show-sidebar` is notified before `collapsed` because GTK freezes
+ * notifications across the whole setter and thaws them in queue order.
+ */
+export declare const OVERLAY_COLLAPSE_VECTORS: ReadonlyArray<OverlayCollapseVector>;
+/** One `resolveSwipeSnapPoints` expectation. */
+export interface SwipeSnapPointVector {
+    showProgress: number;
+    enableShowGesture: boolean;
+    enableHideGesture: boolean;
+    swipeActive: boolean;
+    snapPoints: number[];
+    rule: string;
+}
+/** `adw_overlay_split_view_get_snap_points` (adw-overlay-split-view.c:1214-1243). */
+export declare const OVERLAY_SWIPE_SNAP_POINT_VECTORS: ReadonlyArray<SwipeSnapPointVector>;
+/** One `resolveSwipeStart` expectation. */
+export interface SwipeStartVector {
+    showProgress: number;
+    collapsed: boolean;
+    direction: 'forward' | 'back';
+    enableShowGesture: boolean;
+    enableHideGesture: boolean;
+    detected: boolean;
+    rule: string;
+}
+/** `prepare_cb` (adw-overlay-split-view.c:362-387). */
+export declare const OVERLAY_SWIPE_START_VECTORS: ReadonlyArray<SwipeStartVector>;
+/** One `resolveSwipeRelease` expectation. */
+export interface SwipeReleaseVector {
+    to: number;
+    showSidebar: boolean;
+    /** `animate` = settle only; `set-show-sidebar` = a real property change. */
+    kind: 'animate' | 'set-show-sidebar';
+    /** The resulting `show-sidebar`, for the `set-show-sidebar` case. */
+    showSidebarAfter: boolean;
+    rule: string;
+}
+/** `end_swipe_cb` (adw-overlay-split-view.c:414-429). */
+export declare const OVERLAY_SWIPE_RELEASE_VECTORS: ReadonlyArray<SwipeReleaseVector>;
+/** One `swipeCancelProgress` expectation. */
+export interface SwipeCancelVector {
+    showProgress: number;
+    cancelProgress: number;
+    rule: string;
+}
+/** `adw_overlay_split_view_get_cancel_progress` (adw-overlay-split-view.c:1253-1258). */
+export declare const OVERLAY_SWIPE_CANCEL_VECTORS: ReadonlyArray<SwipeCancelVector>;
+/** One `resolveSwipeArea` expectation. */
+export interface SwipeAreaVector {
+    isDrag: boolean;
+    sidebarWidth: number;
+    showProgress: number;
+    totalWidth: number;
+    totalHeight: number;
+    sidebarPosition: AdwPackType;
+    direction: AdwTextDirection;
+    area: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    rule: string;
+}
+/**
+ * `adw_overlay_split_view_get_swipe_area` (adw-overlay-split-view.c:1261-1290);
+ * `ADW_SWIPE_BORDER` is 32 (adw-swipe-tracker-private.h:17).
+ */
+export declare const OVERLAY_SWIPE_AREA_VECTORS: ReadonlyArray<SwipeAreaVector>;