@syware/jlib 0.3.0 → 0.5.0

package/dist/types/jl-chip-group.types.d.ts

@@ -0,0 +1,10 @@
+/** One choice of a chip group. */
+export type ChipGroupOption = {
+    value: string;
+    label: string;
+    /** An icon name before the label; a chosen chip without one shows a check. */
+    icon?: string;
+    /** A count or a short word after the label: how many things the choice holds. */
+    badge?: string | number;
+    disabled?: boolean;
+};

package/dist/types/jl-confirm.types.d.ts

@@ -8,3 +8,18 @@ export type ConfirmOptions = {
     cancelLabel?: string;
     tone?: ConfirmTone;
 };
+/** What `guardLeave()` watches, and what it asks, in the app's words. */
+export type LeaveGuardOptions = {
+    /** Whether leaving now would lose changes. */
+    isDirty: () => boolean;
+    /** Ends the guard, such as the killSignal of the page it guards. */
+    signal: AbortSignal;
+    /** "Leave without saving?" */
+    heading?: string;
+    /** "Your changes are lost." */
+    text?: string;
+    /** "Leave" */
+    leaveLabel?: string;
+    /** "Keep editing" */
+    stayLabel?: string;
+};

package/dist/types/jl-load-state.types.d.ts

@@ -0,0 +1,10 @@
+/** Where the data of a list or a page is: on its way, shown, there but empty, or failed to come. */
+export type LoadState = 'loading' | 'ready' | 'empty' | 'error';
+/** The shape the skeleton takes while the data comes: rows of a list, cards of a grid, or lines of text. */
+export type LoadSkeleton = 'rows' | 'cards' | 'lines';
+/** What `load()` needs: how to fetch the data, how to draw it, and whether it holds nothing to show. */
+export type LoadTask<Value> = {
+    fetch: () => Promise<Value>;
+    draw: (value: Value) => void;
+    isEmpty?: (value: Value) => boolean;
+};

package/dist/types/jl-page.types.d.ts

@@ -0,0 +1,2 @@
+/** How wide a page gets: one column of fields, most pages, tables and grids, or the whole main area. */
+export type PageWidth = 'standard' | 'form' | 'wide' | 'full';

package/dist/types/jl-tab-bar.types.d.ts

@@ -0,0 +1,11 @@
+/** One place in a bottom tab bar: an icon over a short label. */
+export type TabBarItem = {
+    id: string;
+    label: string;
+    /** An icon name: the tab bar draws one over every label. */
+    icon: string;
+    /** A link to follow; without it the item is a button that only fires `select`. */
+    href?: string;
+    /** A count or a short word over the icon: `3`, `New`. Counts above 99 show as `99+`. */
+    badge?: string | number;
+};

package/dist/types/jl-toaster.types.d.ts

@@ -8,7 +8,7 @@ export type ToastOptions = {
     tone?: ToastTone;
     /** An icon name; the tone's icon when absent. */
     icon?: string;
-    /** How long it stays, in milliseconds; 0 keeps it until closed. */
+    /** How long it stays, in milliseconds: 5000, or 8000 for an error or with an action; 0 keeps it until closed. */
     duration?: number;
     /** Shows a close button; on by default. */
     closable?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syware/jlib",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "A tree-shakeable component library on Jadis and native Web Components, organised in atomic design",
   "keywords": [
     "web-components",