@ghub/identity-chrome 0.1.0 → 0.3.0

package/dist/elements/apps.d.ts

@@ -0,0 +1,67 @@
+/**
+ * `<gp-apps>`, the apps picker (GPlatform Identity, sheet 31, option B).
+ *
+ * A nine dot trigger and, under it, the products this person has and the ones
+ * open to join: flat marks with nothing behind them until a pointer or the
+ * focus arrives, the current product on a resting plate in the selected wash,
+ * an invitation carrying a small plus.
+ *
+ * **What it is to assistive technology, which is most of the work:**
+ *
+ * - The trigger is a `button` with `aria-haspopup="dialog"`, named "Products".
+ * - The popup is a `dialog`, not modal and never a `menu`: the tiles are links
+ *   that navigate, and a menu would take the browser's link behaviour away
+ *   (middle click, copy the address). Below 600 wide it is a bottom sheet, and
+ *   there it is modal, with a scrim, a close button first and a contained
+ *   focus loop, because a sheet covers the page.
+ * - Focus opens on the current product, else the first tile. Each group is one
+ *   tab stop with a roving tabindex; the arrows move in two dimensions without
+ *   wrapping a row, Down from the last row of one group lands in the same
+ *   column of the next, Home and End go to the group's ends, and Tab from the
+ *   last group returns to the trigger and closes.
+ * - Each tile is named with its state: "GAdvisory, you are here", "GOpenCDR,
+ *   open to join", "DAnalytics, cannot be opened while offline". The current
+ *   one carries `aria-current="page"`; an offline one is `aria-disabled` and
+ *   stays focusable.
+ *
+ * **It draws the kept list at once.** The core holds the last answer in local
+ * storage; opening draws it with no network wait and asks again in the
+ * background, and a changed list swaps in without moving the focus. The
+ * skeleton is only for a first visit with nothing kept.
+ *
+ * The words are English by default and every one can be replaced (`labels`).
+ */
+export interface AppsLabels {
+    /** The trigger's name and the popup's heading. */
+    trigger: string;
+    yours: string;
+    more: string;
+    /** Known only from a seeded list and never opened. */
+    empty: string;
+    /** The kept list is shown because Identity could not be reached. */
+    stale: (time: string) => string;
+    retry: string;
+    failed: string;
+    here: (name: string) => string;
+    join: (name: string) => string;
+    offline: (name: string) => string;
+    offlineShort: string;
+    moreBelow: (count: number) => string;
+    close: string;
+}
+export declare const APPS_LABELS: AppsLabels;
+export declare const APPS_CSS: string;
+/**
+ * Where an arrow key goes in a grid of `count` tiles, `columns` wide, without
+ * wrapping a row. Null where the key leaves the grid downwards or upwards, so
+ * the caller can carry the column into the next group.
+ */
+export declare function moveInGrid(index: number, count: number, columns: number, key: string): number | "above" | "below" | null;
+/**
+ * Defines `<gp-apps>` once, where custom elements exist. Safe to import on a
+ * server: nothing touches the DOM until this is called in a browser.
+ */
+export declare function defineAppsElement(name?: string): void;
+/** The class itself, for a caller that registers it under its own name or in a scoped registry. */
+export declare function createAppsElementClass(): CustomElementConstructor;
+//# sourceMappingURL=apps.d.ts.map