glimpse-sdk 0.2.0 → 0.5.0

package/dist/src/widgets.d.ts

@@ -1,7 +1,11 @@
-import { Icon, MenuItem } from "./protocol.js";
+import { Icon } from "./protocol.js";
 export type Align = "fill" | "start" | "end" | "center" | "baseline";
 export type Orientation = "horizontal" | "vertical";
 export type Variant = "normal" | "muted" | "accent" | "success" | "warning" | "danger";
+export type ButtonVariant = "primary" | "secondary" | "compact" | "flat" | "danger";
+export type PagerAppearance = "dots" | "numbers";
+export type ContentFit = "fill" | "contain" | "cover" | "scale_down";
+export type LevelBarMode = "continuous" | "discrete";
 export interface WidgetNode {
     toProtocol(): Record<string, unknown>;
 }
@@ -39,30 +43,80 @@ export declare class Image extends WidgetBase {
     });
     toProtocol(): Record<string, unknown>;
 }
-export declare class IconWidget extends WidgetBase {
-    readonly icon: Icon;
+export declare class Progress extends WidgetBase {
     private readonly options;
-    constructor(icon: Icon, options?: CommonProps & {
-        pixel_size?: number;
+    constructor(options: CommonProps & {
+        value: number;
+        max?: number;
+        show_text?: boolean;
+        text?: string;
     });
     toProtocol(): Record<string, unknown>;
 }
-export declare class Progress extends WidgetBase {
+export declare class LevelBar extends WidgetBase {
     private readonly options;
     constructor(options: CommonProps & {
         value: number;
+        min?: number;
         max?: number;
-        show_text?: boolean;
-        text?: string;
+        mode?: LevelBarMode;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Picture extends WidgetBase {
+    readonly options: CommonProps & {
+        path: string;
+        content_fit?: ContentFit;
+    };
+    constructor(options: CommonProps & {
+        path: string;
+        content_fit?: ContentFit;
     });
     toProtocol(): Record<string, unknown>;
 }
 export declare class Button extends WidgetBase {
     private readonly options;
-    constructor(options?: CommonProps & {
+    constructor(options?: Omit<CommonProps, "variant"> & {
         label?: string;
-        icon?: Icon;
-        child?: TreeNode;
+        icon?: string;
+        enabled?: boolean;
+        variant?: ButtonVariant;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class LinkButton extends WidgetBase {
+    private readonly options;
+    constructor(options: CommonProps & {
+        uri: string;
+        label?: string;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Expander extends WidgetBase {
+    private readonly options;
+    constructor(options: CommonProps & {
+        label: string;
+        child: TreeNode;
+        expanded?: boolean;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class TreeExpander extends WidgetBase {
+    private readonly options;
+    constructor(options: CommonProps & {
+        child: TreeNode;
+        hide_expander?: boolean;
+        indent_for_depth?: boolean;
+        indent_for_icon?: boolean;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class MenuButton extends WidgetBase {
+    private readonly options;
+    constructor(options: CommonProps & {
+        label?: string;
+        icon?: string;
+        popover: TreeNode;
     });
     toProtocol(): Record<string, unknown>;
 }
@@ -74,7 +128,15 @@ export declare class Switch extends WidgetBase {
     });
     toProtocol(): Record<string, unknown>;
 }
-export declare class Scale extends WidgetBase {
+export declare class ToggleButton extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        label?: string;
+        active?: boolean;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Slider extends WidgetBase {
     private readonly options;
     constructor(options?: CommonProps & {
         min?: number;
@@ -94,16 +156,16 @@ export declare class Checkbox extends WidgetBase {
     });
     toProtocol(): Record<string, unknown>;
 }
-export declare class DropdownItem {
+export declare class SelectOption {
     readonly id: string;
     readonly label: string;
     constructor(id: string, label: string);
     toProtocol(): Record<string, unknown>;
 }
-export declare class Dropdown extends WidgetBase {
+export declare class Select extends WidgetBase {
     private readonly options;
     constructor(options?: CommonProps & {
-        items?: DropdownItem[];
+        items?: SelectOption[];
         selected?: number;
     });
     toProtocol(): Record<string, unknown>;
@@ -120,6 +182,21 @@ export declare class Scroll extends WidgetBase {
     constructor(child: TreeNode, options?: CommonProps);
     toProtocol(): Record<string, unknown>;
 }
+export declare class Overlay extends WidgetBase {
+    private readonly options;
+    constructor(options: CommonProps & {
+        child: TreeNode;
+        overlays?: TreeNode[];
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class ListBox extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        children?: TreeNode[];
+    });
+    toProtocol(): Record<string, unknown>;
+}
 export declare class GridChild {
     readonly row: number;
     readonly column: number;
@@ -154,54 +231,11 @@ export declare class Card extends WidgetBase {
     });
     toProtocol(): Record<string, unknown>;
 }
-export declare class Header {
-    readonly title: string;
-    readonly subtitle: string;
-    constructor(title: string, subtitle?: string);
-    toProtocol(): Record<string, unknown>;
-}
 export declare class Section extends WidgetBase {
     private readonly options;
     constructor(options: CommonProps & {
         title?: string;
         subtitle?: string;
-        header?: Header;
-        body?: TreeNode[];
-        children?: TreeNode[];
-    });
-    toProtocol(): Record<string, unknown>;
-}
-export declare class Collapsible extends WidgetBase {
-    private readonly options;
-    constructor(options: CommonProps & {
-        title?: string;
-        subtitle?: string;
-        header?: Header;
-        expanded?: boolean;
-        body?: TreeNode[];
-        children?: TreeNode[];
-    });
-    toProtocol(): Record<string, unknown>;
-}
-export declare class Item extends WidgetBase {
-    private readonly options;
-    constructor(options?: CommonProps & {
-        left?: TreeNode;
-        label?: string;
-        right?: TreeNode;
-        clickable?: boolean;
-        menu?: MenuItem[];
-    });
-    toProtocol(): Record<string, unknown>;
-}
-export declare class CollapsibleItem extends WidgetBase {
-    private readonly options;
-    constructor(options?: CommonProps & {
-        left?: TreeNode;
-        label?: string;
-        right?: TreeNode;
-        expanded?: boolean;
-        body?: TreeNode[];
         children?: TreeNode[];
     });
     toProtocol(): Record<string, unknown>;
@@ -228,32 +262,6 @@ export declare class Copyable extends WidgetBase {
     });
     toProtocol(): Record<string, unknown>;
 }
-export declare class ToastAction {
-    readonly id: string;
-    readonly label: string;
-    constructor(id: string, label: string);
-    toProtocol(): Record<string, unknown>;
-}
-export declare class Toast extends WidgetBase {
-    private readonly options;
-    constructor(options: CommonProps & {
-        icon?: Icon;
-        title: string;
-        message?: string;
-        action?: ToastAction;
-    });
-    toProtocol(): Record<string, unknown>;
-}
-export declare class ActionRow extends WidgetBase {
-    private readonly options;
-    constructor(options: CommonProps & {
-        title: string;
-        subtitle?: string;
-        meta?: string;
-        icon?: Icon;
-    });
-    toProtocol(): Record<string, unknown>;
-}
 export declare class Row extends WidgetBase {
     private readonly options;
     constructor(options?: CommonProps & {
@@ -270,50 +278,40 @@ export declare class Column extends WidgetBase {
     });
     toProtocol(): Record<string, unknown>;
 }
-export declare class ActionMenuItem {
-    readonly options: {
-        id: string;
-        label: string;
-        icon?: Icon;
-        visible?: boolean;
-        checked?: boolean;
-        selectable?: boolean;
-    };
-    constructor(options: {
-        id: string;
-        label: string;
-        icon?: Icon;
-        visible?: boolean;
-        checked?: boolean;
-        selectable?: boolean;
-    });
-    toProtocol(): Record<string, unknown>;
-}
-export declare class ActionMenu extends WidgetBase {
+export declare class Spinner extends WidgetBase {
     private readonly options;
     constructor(options?: CommonProps & {
-        header?: string;
-        items?: ActionMenuItem[];
+        spinning?: boolean;
     });
     toProtocol(): Record<string, unknown>;
 }
-export declare class Spinner extends WidgetBase {
+export type Properties = Record<string, string>;
+export declare class PropertyList extends WidgetBase {
     private readonly options;
     constructor(options?: CommonProps & {
-        spinning?: boolean;
+        title?: string;
+        rows?: Properties;
     });
     toProtocol(): Record<string, unknown>;
 }
-export declare class DetailGridItem {
-    readonly key: string;
-    readonly value: string;
-    constructor(key: string, value: string);
+export declare class Item extends WidgetBase {
+    private readonly options;
+    constructor(options: CommonProps & {
+        label: string;
+        sublabel?: string;
+        icon?: string;
+        right?: TreeNode;
+    });
     toProtocol(): Record<string, unknown>;
 }
-export declare class DetailGrid extends WidgetBase {
+export declare class ActionItem extends WidgetBase {
     private readonly options;
-    constructor(options?: CommonProps & {
-        rows?: DetailGridItem[];
+    constructor(options: CommonProps & {
+        label: string;
+        sublabel?: string;
+        icon?: string;
+        right?: TreeNode;
+        enabled?: boolean;
     });
     toProtocol(): Record<string, unknown>;
 }
@@ -336,6 +334,26 @@ export declare class StatusDot extends WidgetBase {
     constructor(options?: CommonProps);
     toProtocol(): Record<string, unknown>;
 }
+export declare class PagerItem extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        appearance?: PagerAppearance;
+        label?: string;
+        active?: boolean;
+        inactive?: boolean;
+        occupied?: boolean;
+        urgent?: boolean;
+    });
+    toData(): Record<string, unknown>;
+    toProtocol(): Record<string, unknown>;
+}
+export declare class PagerStrip extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        items?: PagerItem[];
+    });
+    toProtocol(): Record<string, unknown>;
+}
 export declare class Box extends WidgetBase {
     private readonly options;
     constructor(options?: CommonProps & {
@@ -347,5 +365,5 @@ export declare class Box extends WidgetBase {
     static horizontal(children: TreeNode[], spacing?: number, options?: CommonProps): Box;
     toProtocol(): Record<string, unknown>;
 }
-export type TreeNode = Hero | Card | Section | Collapsible | Item | CollapsibleItem | Meter | Copyable | Toast | ActionRow | ActionMenu | DetailGrid | EmptyState | Badge | StatusDot | Box | Row | Column | Grid | Scroll | Progress | Separator | Spinner | Label | IconWidget | Image | Button | Switch | Scale | Dropdown | Checkbox;
+export type TreeNode = Hero | Card | Section | Meter | Copyable | PropertyList | Item | ActionItem | EmptyState | Badge | StatusDot | PagerItem | PagerStrip | Box | Row | Column | Grid | Scroll | Overlay | ListBox | LevelBar | TreeExpander | MenuButton | Progress | Separator | Spinner | Label | Image | Picture | Button | LinkButton | Expander | Switch | ToggleButton | Slider | Select | Checkbox;
 export {};