glimpse-custom-applet-sdk 0.1.0

package/dist/src/widgets.d.ts

@@ -0,0 +1,351 @@
+import { Icon, MenuItem } 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 interface WidgetNode {
+    toProtocol(): Record<string, unknown>;
+}
+export interface CommonProps {
+    id?: string;
+    visible?: boolean;
+    hexpand?: boolean;
+    vexpand?: boolean;
+    halign?: Align;
+    valign?: Align;
+    tooltip?: string;
+    variant?: Variant;
+}
+declare abstract class WidgetBase implements WidgetNode {
+    protected readonly common: CommonProps;
+    protected constructor(common?: CommonProps);
+    protected withCommon(payload: Record<string, unknown>): Record<string, unknown>;
+    abstract toProtocol(): Record<string, unknown>;
+}
+export declare class Label extends WidgetBase {
+    readonly text: string;
+    private readonly options;
+    constructor(text: string, options?: CommonProps & {
+        wrap?: boolean;
+        xalign?: number;
+        selectable?: boolean;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Image extends WidgetBase {
+    readonly icon: Icon;
+    private readonly options;
+    constructor(icon: Icon, options?: CommonProps & {
+        pixel_size?: number;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class IconWidget extends WidgetBase {
+    readonly icon: Icon;
+    private readonly options;
+    constructor(icon: Icon, options?: CommonProps & {
+        pixel_size?: number;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Progress extends WidgetBase {
+    private readonly options;
+    constructor(options: CommonProps & {
+        value: number;
+        max?: number;
+        show_text?: boolean;
+        text?: string;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Button extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        label?: string;
+        icon?: Icon;
+        child?: TreeNode;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Switch extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        label?: string;
+        active?: boolean;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Scale extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        min?: number;
+        max?: number;
+        step?: number;
+        value?: number;
+        orientation?: Orientation;
+        draw_value?: boolean;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Checkbox extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        label?: string;
+        active?: boolean;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class DropdownItem {
+    readonly id: string;
+    readonly label: string;
+    constructor(id: string, label: string);
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Dropdown extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        items?: DropdownItem[];
+        selected?: number;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Separator extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        orientation?: Orientation;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Scroll extends WidgetBase {
+    private readonly child;
+    constructor(child: TreeNode, options?: CommonProps);
+    toProtocol(): Record<string, unknown>;
+}
+export declare class GridChild {
+    readonly row: number;
+    readonly column: number;
+    readonly child: TreeNode;
+    readonly width: number;
+    readonly height: number;
+    constructor(row: number, column: number, child: TreeNode, width?: number, height?: number);
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Grid extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        children?: GridChild[];
+        row_spacing?: number;
+        column_spacing?: number;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Hero extends WidgetBase {
+    private readonly options;
+    constructor(options: CommonProps & {
+        title: string;
+        subtitle: string;
+        icon?: Icon;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Card extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        children?: TreeNode[];
+    });
+    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>;
+}
+export declare class Meter extends WidgetBase {
+    private readonly options;
+    constructor(options: CommonProps & {
+        icon?: Icon;
+        label?: string;
+        value: number;
+        min?: number;
+        max?: number;
+        step?: number;
+        text?: string;
+        interactive?: boolean;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Copyable extends WidgetBase {
+    private readonly options;
+    constructor(options: CommonProps & {
+        label?: string;
+        value: string;
+    });
+    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 & {
+        spacing?: number;
+        children?: TreeNode[];
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Column extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        spacing?: number;
+        children?: TreeNode[];
+    });
+    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 {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        header?: string;
+        items?: ActionMenuItem[];
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Spinner extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        spinning?: boolean;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class DetailGridItem {
+    readonly key: string;
+    readonly value: string;
+    constructor(key: string, value: string);
+    toProtocol(): Record<string, unknown>;
+}
+export declare class DetailGrid extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        rows?: DetailGridItem[];
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class EmptyState extends WidgetBase {
+    private readonly options;
+    constructor(options: CommonProps & {
+        title: string;
+        subtitle?: string;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Badge extends WidgetBase {
+    private readonly options;
+    constructor(options: CommonProps & {
+        label: string;
+    });
+    toProtocol(): Record<string, unknown>;
+}
+export declare class StatusDot extends WidgetBase {
+    constructor(options?: CommonProps);
+    toProtocol(): Record<string, unknown>;
+}
+export declare class Box extends WidgetBase {
+    private readonly options;
+    constructor(options?: CommonProps & {
+        orientation?: Orientation;
+        spacing?: number;
+        children?: TreeNode[];
+    });
+    static vertical(children: TreeNode[], spacing?: number, options?: CommonProps): Box;
+    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 {};