Function subclass

subclass<T extends new (...args: any[]) => Widget, Props>(
Base: T,
typename?: string,
): <Attr>(props: BaseProps<Instance<Attr>, Props, Attr>) => Instance<Attr>
Creates a subclassed AGS widget factory from a GTK widget class.

Registers the subclass as a GObject and returns a factory function that creates instances with AGS widget features (binding, hooking, etc.).

Also serves as the default export namespace containing all built-in widget factories (e.g., Widget.Box, Widget.Label).
Type Parameters
- T extends new (...args: any[]) => Widget
  The base GTK widget class
- Props
  The constructor props type for the base class
Parameters
- Base: T
  The GTK widget class to subclass
- typename: string = Base.name
  GObject type name (defaults to the class name)
Returns <Attr>(props: BaseProps<Instance<Attr>, Props, Attr>) => Instance<Attr>
A factory function that creates widget instances
Example
```
// Create a custom widget from a GTK class
const MyWidget = Widget(Gtk.DrawingArea, 'MyDrawingArea');

// Use built-in widget factories
const box = Widget.Box({ children: [Widget.Label({ label: 'hello' })] });
```
- Defined in src/widget.ts:60

Properties

Box

Box: <Child extends Widget = Widget, Attr = unknown>(
    ...props: [
        propsOrChildren: Child[]
        | BoxProps<Child, Attr, Box<Child, Attr>>,
        ...children: Widget[],
    ],
) => Box<Child, Attr>

Type Declaration

- <Child extends Widget = Widget, Attr = unknown>(
      ...props: [
          propsOrChildren: Child[]
          | BoxProps<Child, Attr, Box<Child, Attr>>,
          ...children: Widget[],
      ],
  ): Box<Child, Attr>
- Create a new Box container widget.
  Type Parameters
  - Child extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [
        propsOrChildren: Child[]
        | BoxProps<Child, Attr, Box<Child, Attr>>,
        ...children: Widget[],
    ]
  Returns Box<Child, Attr>
  Example
```
const myBox = newBox({ vertical: true, children: [child1, child2] });
const hBox = newBox([child1, child2]);
```

Button

Button: <Child extends Widget = Widget, Attr = unknown>(
    ...props: [
        props: ButtonProps<Child, Attr, Button<Child, Attr>>,
        child?: Child,
    ],
) => Button<Child, Attr>

Type Declaration

- <Child extends Widget = Widget, Attr = unknown>(
      ...props: [
          props: ButtonProps<Child, Attr, Button<Child, Attr>>,
          child?: Child,
      ],
  ): Button<Child, Attr>
- Create a new Button widget.
  Type Parameters
  - Child extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [props: ButtonProps<Child, Attr, Button<Child, Attr>>, child?: Child]
  Returns Button<Child, Attr>
  Example
```
const btn = newButton({ label: 'Click me', on_clicked: (self) => print('clicked') });
```

Calendar

Calendar: <Attr = unknown>(
...props: [props: CalendarProps<Attr, Calendar<Attr>>],
) => Calendar<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: CalendarProps<Attr, Calendar<Attr>>],
  ): Calendar<Attr>
- Create a new Calendar date picker widget.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: CalendarProps<Attr, Calendar<Attr>>]
  Returns Calendar<Attr>

CenterBox

CenterBox: <
    StartWidget extends Widget = Widget,
    CenterWidget extends Widget = Widget,
    EndWidget extends Widget = Widget,
    Attr = unknown,
>(
    ...props: [
        props: CenterBoxProps<
            StartWidget,
            CenterWidget,
            EndWidget,
            Attr,
            CenterBox<StartWidget, CenterWidget, EndWidget, Attr>,
        >,
        startWidget?: StartWidget,
        centerWidget?: CenterWidget,
        endWidget?: EndWidget,
    ],
) => CenterBox<StartWidget, CenterWidget, EndWidget, Attr>

Type Declaration

- <
      StartWidget extends Widget = Widget,
      CenterWidget extends Widget = Widget,
      EndWidget extends Widget = Widget,
      Attr = unknown,
  >(
      ...props: [
          props: CenterBoxProps<
              StartWidget,
              CenterWidget,
              EndWidget,
              Attr,
              CenterBox<StartWidget, CenterWidget, EndWidget, Attr>,
          >,
          startWidget?: StartWidget,
          centerWidget?: CenterWidget,
          endWidget?: EndWidget,
      ],
  ): CenterBox<StartWidget, CenterWidget, EndWidget, Attr>
- Create a new CenterBox layout widget.
  Type Parameters
  - StartWidget extends Widget = Widget
  - CenterWidget extends Widget = Widget
  - EndWidget extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [
        props: CenterBoxProps<
            StartWidget,
            CenterWidget,
            EndWidget,
            Attr,
            CenterBox<StartWidget, CenterWidget, EndWidget, Attr>,
        >,
        startWidget?: StartWidget,
        centerWidget?: CenterWidget,
        endWidget?: EndWidget,
    ]
  Returns CenterBox<StartWidget, CenterWidget, EndWidget, Attr>

CircularProgress

CircularProgress: <Child extends Widget = Widget, Attr = unknown>(
    ...props: [
        props: CircularProgressProps<
            Child,
            Attr,
            CircularProgress<Child, Attr>,
        >,
        child?: Child,
    ],
) => CircularProgress<Child, Attr>

Type Declaration

- <Child extends Widget = Widget, Attr = unknown>(
      ...props: [
          props: CircularProgressProps<
              Child,
              Attr,
              CircularProgress<Child, Attr>,
          >,
          child?: Child,
      ],
  ): CircularProgress<Child, Attr>
- Create a new CircularProgress indicator widget.
  Type Parameters
  - Child extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [
    props: CircularProgressProps<Child, Attr, CircularProgress<Child, Attr>>,
    child?: Child,
    ]
  Returns CircularProgress<Child, Attr>

ColorButton

ColorButton: <Child extends Widget = Widget, Attr = unknown>(
    ...props: [
        props: ColorButtonProps<Child, Attr, ColorButton<Child, Attr>>,
        child?: Child,
    ],
) => ColorButton<Child, Attr>

Type Declaration

- <Child extends Widget = Widget, Attr = unknown>(
      ...props: [
          props: ColorButtonProps<Child, Attr, ColorButton<Child, Attr>>,
          child?: Child,
      ],
  ): ColorButton<Child, Attr>
- Create a new ColorButton for selecting colors.
  Type Parameters
  - Child extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [props: ColorButtonProps<Child, Attr, ColorButton<Child, Attr>>, child?: Child]
  Returns ColorButton<Child, Attr>

DrawingArea

DrawingArea: <Attr = unknown>(
...props: [props: DrawingAreaProps<Attr, DrawingArea<Attr>>],
) => DrawingArea<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: DrawingAreaProps<Attr, DrawingArea<Attr>>],
  ): DrawingArea<Attr>
- Create a new DrawingArea for custom Cairo drawing.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: DrawingAreaProps<Attr, DrawingArea<Attr>>]
  Returns DrawingArea<Attr>

Entry

Entry: <Attr = unknown>(
...props: [props: EntryProps<Attr, Entry<Attr>>],
) => Entry<Attr>

Type Declaration

- <Attr = unknown>(...props: [props: EntryProps<Attr, Entry<Attr>>]): Entry<Attr>
- Create a new Entry text input widget.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: EntryProps<Attr, Entry<Attr>>]
  Returns Entry<Attr>
  Example
```
const input = newEntry({
  placeholder_text: 'Type here...',
  on_accept: (self) => print(self.text),
});
```

EventBox

EventBox: <Child extends Widget = Widget, Attr = unknown>(
    ...props: [
        props: EventBoxProps<Child, Attr, EventBox<Child, Attr>>,
        child?: Child,
    ],
) => EventBox<Child, Attr>

Type Declaration

- <Child extends Widget = Widget, Attr = unknown>(
      ...props: [
          props: EventBoxProps<Child, Attr, EventBox<Child, Attr>>,
          child?: Child,
      ],
  ): EventBox<Child, Attr>
- Create a new EventBox for capturing input events on a child widget.
  Type Parameters
  - Child extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [props: EventBoxProps<Child, Attr, EventBox<Child, Attr>>, child?: Child]
  Returns EventBox<Child, Attr>

FileChooserButton

FileChooserButton: <Child extends Widget = Widget, Attr = unknown>(
    ...props: [
        props: FileChooserButtonProps<
            Child,
            Attr,
            FileChooserButton<Child, Attr>,
        >,
        child?: Child,
    ],
) => FileChooserButton<Child, Attr>

Type Declaration

- <Child extends Widget = Widget, Attr = unknown>(
      ...props: [
          props: FileChooserButtonProps<
              Child,
              Attr,
              FileChooserButton<Child, Attr>,
          >,
          child?: Child,
      ],
  ): FileChooserButton<Child, Attr>
- Create a new FileChooserButton for selecting files.
  Type Parameters
  - Child extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [
        props: FileChooserButtonProps<
            Child,
            Attr,
            FileChooserButton<Child, Attr>,
        >,
        child?: Child,
    ]
  Returns FileChooserButton<Child, Attr>

Fixed

Fixed: <Attr = unknown>(
...props: [props: FixedProps<Attr, Fixed<Attr>>],
) => Fixed<Attr>

Type Declaration

- <Attr = unknown>(...props: [props: FixedProps<Attr, Fixed<Attr>>]): Fixed<Attr>
- Create a new Fixed container for placing children at exact positions.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: FixedProps<Attr, Fixed<Attr>>]
  Returns Fixed<Attr>

FlowBox

FlowBox: <Attr = unknown>(
...props: [props: FlowBoxProps<Attr, FlowBox<Attr>>],
) => FlowBox<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: FlowBoxProps<Attr, FlowBox<Attr>>],
  ): FlowBox<Attr>
- Create a new FlowBox that dynamically reflows its children.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: FlowBoxProps<Attr, FlowBox<Attr>>]
  Returns FlowBox<Attr>

FontButton

FontButton: <Child extends Widget = Widget, Attr = unknown>(
    ...props: [
        props: FontButtonProps<Child, Attr, FontButton<Child, Attr>>,
        child?: Child,
    ],
) => FontButton<Child, Attr>

Type Declaration

- <Child extends Widget = Widget, Attr = unknown>(
      ...props: [
          props: FontButtonProps<Child, Attr, FontButton<Child, Attr>>,
          child?: Child,
      ],
  ): FontButton<Child, Attr>
- Create a new FontButton for selecting fonts.
  Type Parameters
  - Child extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [props: FontButtonProps<Child, Attr, FontButton<Child, Attr>>, child?: Child]
  Returns FontButton<Child, Attr>

Icon

Icon: <Attr = unknown>(
...props: [props: Ico | IconProps<Attr, Icon<Attr>>],
) => Icon<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: Ico | IconProps<Attr, Icon<Attr>>],
  ): Icon<Attr>
- Create a new Icon from a named icon, file path, or Pixbuf.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: Ico | IconProps<Attr, Icon<Attr>>]
  Returns Icon<Attr>

Label

Label: <Attr = unknown>(
...props: [props: string | LabelProps<Attr, Label<Attr>>],
) => Label<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: string | LabelProps<Attr, Label<Attr>>],
  ): Label<Attr>
- Create a new Label for displaying text.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: string | LabelProps<Attr, Label<Attr>>]
  Returns Label<Attr>
  Example
```
const lbl = newLabel({ label: 'Hello, world!' });
const simple = newLabel('Hello, world!');
```

LevelBar

LevelBar: <Attr = unknown>(
...props: [props: LevelBarProps<Attr, LevelBar<Attr>>],
) => LevelBar<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: LevelBarProps<Attr, LevelBar<Attr>>],
  ): LevelBar<Attr>
- Create a new LevelBar for displaying a value within a range.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: LevelBarProps<Attr, LevelBar<Attr>>]
  Returns LevelBar<Attr>

ListBox

ListBox: <Attr = unknown>(
...props: [props: ListBoxProps<Attr, ListBox<Attr>>],
) => ListBox<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: ListBoxProps<Attr, ListBox<Attr>>],
  ): ListBox<Attr>
- Creates a new ListBox widget for displaying selectable rows.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: ListBoxProps<Attr, ListBox<Attr>>]
  Returns ListBox<Attr>

Menu: <MenuItem extends MenuItem = MenuItem, Attr = unknown>(
    ...props: [
        props: MenuProps<MenuItem, Attr, Menu<MenuItem, Attr>>,
        ...children: MenuItem[],
    ],
) => Menu<MenuItem, Attr>

Type Declaration

- <MenuItem extends MenuItem = MenuItem, Attr = unknown>(
      ...props: [
          props: MenuProps<MenuItem, Attr, Menu<MenuItem, Attr>>,
          ...children: MenuItem[],
      ],
  ): Menu<MenuItem, Attr>
- Creates a new Menu popup widget containing menu items.
  Type Parameters
  - MenuItem extends MenuItem = MenuItem
  - Attr = unknown
  Parameters
  - ...props: [
    props: MenuProps<MenuItem, Attr, Menu<MenuItem, Attr>>,
    ...children: MenuItem[],
    ]
  Returns Menu<MenuItem, Attr>

MenuBar

MenuBar: <Attr = unknown>(
...props: [props: MenuBarProps<Attr, MenuBar<Attr>>],
) => MenuBar<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: MenuBarProps<Attr, MenuBar<Attr>>],
  ): MenuBar<Attr>
- Creates a new MenuBar widget for displaying a horizontal menu bar.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: MenuBarProps<Attr, MenuBar<Attr>>]
  Returns MenuBar<Attr>

MenuItem

MenuItem: <Child extends Widget = Widget, Attr = unknown>(
    ...props: [
        props: MenuItemProps<Child, Attr, MenuItem<Child, Attr>>,
        child?: Child,
    ],
) => MenuItem<Child, Attr>

Type Declaration

- <Child extends Widget = Widget, Attr = unknown>(
      ...props: [
          props: MenuItemProps<Child, Attr, MenuItem<Child, Attr>>,
          child?: Child,
      ],
  ): MenuItem<Child, Attr>
- Creates a new MenuItem widget for use inside a Menu.
  Type Parameters
  - Child extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [props: MenuItemProps<Child, Attr, MenuItem<Child, Attr>>, child?: Child]
  Returns MenuItem<Child, Attr>

Overlay

Overlay: <
    Child extends Widget = Widget,
    OverlayChild extends Widget = Widget,
    Attr = unknown,
>(
    ...props: [
        props: OverlayProps<
            Child,
            OverlayChild,
            Attr,
            Overlay<Child, OverlayChild, Attr>,
        >,
        child?: Child,
        ...overlays: Widget[],
    ],
) => Overlay<Child, OverlayChild, Attr>

Type Declaration

- <
      Child extends Widget = Widget,
      OverlayChild extends Widget = Widget,
      Attr = unknown,
  >(
      ...props: [
          props: OverlayProps<
              Child,
              OverlayChild,
              Attr,
              Overlay<Child, OverlayChild, Attr>,
          >,
          child?: Child,
          ...overlays: Widget[],
      ],
  ): Overlay<Child, OverlayChild, Attr>
- Creates a new Overlay widget for stacking children on top of each other.
  Type Parameters
  - Child extends Widget = Widget
  - OverlayChild extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [
        props: OverlayProps<
            Child,
            OverlayChild,
            Attr,
            Overlay<Child, OverlayChild, Attr>,
        >,
        child?: Child,
        ...overlays: Widget[],
    ]
  Returns Overlay<Child, OverlayChild, Attr>

ProgressBar

ProgressBar: <Attr = unknown>(
...props: [props: ProgressBarProps<Attr, ProgressBar<Attr>>],
) => ProgressBar<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: ProgressBarProps<Attr, ProgressBar<Attr>>],
  ): ProgressBar<Attr>
- Creates a new ProgressBar widget for displaying progress as a filled bar.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: ProgressBarProps<Attr, ProgressBar<Attr>>]
  Returns ProgressBar<Attr>

register

register: <T extends new (...args: any[]) => Widget>(
    klass: T,
    config?: {
        cssName?: string;
        properties?: { [prop: string]: [type?: PspecType, handle?: PspecFlag] };
        signals?: { [signal: string]: PspecType[] };
        typename?: string;
    } & { cssName?: string },
) => T

Type Declaration

- <T extends new (...args: any[]) => Widget>(
      klass: T,
      config?: {
          cssName?: string;
          properties?: { [prop: string]: [type?: PspecType, handle?: PspecFlag] };
          signals?: { [signal: string]: PspecType[] };
          typename?: string;
      } & { cssName?: string },
  ): T
- Registers a GTK widget class as an AGS widget.
  
  Mixes in all AgsWidget prototype methods and registers the class as a GObject with AGS-specific properties (class-name, css, cursor, etc.).
  Type Parameters
  - T extends new (...args: any[]) => Widget
  Parameters
  - klass: T
    The GTK widget class to register
  - Optionalconfig: {
        cssName?: string;
        properties?: { [prop: string]: [type?: PspecType, handle?: PspecFlag] };
        signals?: { [signal: string]: PspecType[] };
        typename?: string;
    } & { cssName?: string }
    Registration options including GObject signals, properties, and CSS name
  Returns T
  The registered class

Revealer

Revealer: <Child extends Widget = Widget, Attr = unknown>(
    ...props: [
        props: RevealerProps<Child, Attr, Revealer<Child, Attr>>,
        child?: Child,
    ],
) => Revealer<Child, Attr>

Type Declaration

- <Child extends Widget = Widget, Attr = unknown>(
      ...props: [
          props: RevealerProps<Child, Attr, Revealer<Child, Attr>>,
          child?: Child,
      ],
  ): Revealer<Child, Attr>
- Creates a new Revealer widget that animates showing and hiding its child.
  Type Parameters
  - Child extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [props: RevealerProps<Child, Attr, Revealer<Child, Attr>>, child?: Child]
  Returns Revealer<Child, Attr>
  Example
```
const revealer = newRevealer({
    transition: 'slide_down',
    reveal_child: true,
    child: Widget.Label({ label: 'Hello' }),
});
```

Scrollable

Scrollable: <Child extends Widget = Widget, Attr = unknown>(
    ...props: [
        props: ScrollableProps<Child, Attr, Scrollable<Child, Attr>>,
        child?: Child,
    ],
) => Scrollable<Child, Attr>

Type Declaration

- <Child extends Widget = Widget, Attr = unknown>(
      ...props: [
          props: ScrollableProps<Child, Attr, Scrollable<Child, Attr>>,
          child?: Child,
      ],
  ): Scrollable<Child, Attr>
- Creates a new Scrollable widget that adds scrollbars to its child.
  Type Parameters
  - Child extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [props: ScrollableProps<Child, Attr, Scrollable<Child, Attr>>, child?: Child]
  Returns Scrollable<Child, Attr>
  Example
```
const scrollable = newScrollable({
    hscroll: 'never',
    vscroll: 'automatic',
    child: Widget.Box({ children: [...items] }),
});
```

Separator

Separator: <Attr = unknown>(
...props: [props: SeparatorProps<Attr, Separator<Attr>>],
) => Separator<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: SeparatorProps<Attr, Separator<Attr>>],
  ): Separator<Attr>
- Creates a new Separator widget for visually dividing content.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: SeparatorProps<Attr, Separator<Attr>>]
  Returns Separator<Attr>

Slider

Slider: <Attr = unknown>(
...props: [SliderProps<Attr, Slider<Attr>>?],
) => Slider<Attr>

Type Declaration

- <Attr = unknown>(...props: [SliderProps<Attr, Slider<Attr>>?]): Slider<Attr>
- Creates a new Slider widget for selecting a numeric value within a range.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [SliderProps<Attr, Slider<Attr>>?]
  Returns Slider<Attr>
  Example
```
const slider = newSlider({
    min: 0,
    max: 100,
    value: 50,
    on_change: (self) => print(self.value),
});
```

SpinButton

SpinButton: <Attr = unknown>(
...props: [props: SpinButtonProps<Attr, SpinButton<Attr>>],
) => SpinButton<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: SpinButtonProps<Attr, SpinButton<Attr>>],
  ): SpinButton<Attr>
- Creates a new SpinButton widget for numeric input with increment/decrement buttons.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: SpinButtonProps<Attr, SpinButton<Attr>>]
  Returns SpinButton<Attr>

Spinner

Spinner: <Attr = unknown>(
...props: [props: BaseProps<Spinner<Attr>, ConstructorProps, Attr>],
) => Spinner<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: BaseProps<Spinner<Attr>, ConstructorProps, Attr>],
  ): Spinner<Attr>
- Creates a new Spinner widget that displays a loading animation.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: BaseProps<Spinner<Attr>, ConstructorProps, Attr>]
  Returns Spinner<Attr>

Stack

Stack: <
    Children extends { [name: string]: Widget } = { [name: string]: Widget },
    Attr = unknown,
>(
    ...props: [
        props: StackProps<Children, Attr, Stack<Children, Attr>>,
        children?: Children,
    ],
) => Stack<Children, Attr>

Type Declaration

- <
      Children extends { [name: string]: Widget } = { [name: string]: Widget },
      Attr = unknown,
  >(
      ...props: [
          props: StackProps<Children, Attr, Stack<Children, Attr>>,
          children?: Children,
      ],
  ): Stack<Children, Attr>
- Creates a new Stack widget that shows one child at a time with transitions.
  Type Parameters
  - Children extends { [name: string]: Widget } = { [name: string]: Widget }
  - Attr = unknown
  Parameters
  - ...props: [props: StackProps<Children, Attr, Stack<Children, Attr>>, children?: Children]
  Returns Stack<Children, Attr>

subclass

subclass: typeof subclass

Switch

Switch: <Attr = unknown>(
...props: [props: SwitchProps<Attr, Switch<Attr>>],
) => Switch<Attr>

Type Declaration

- <Attr = unknown>(
  ...props: [props: SwitchProps<Attr, Switch<Attr>>],
  ): Switch<Attr>
- Creates a new Switch widget for toggling a boolean state.
  Type Parameters
  - Attr = unknown
  Parameters
  - ...props: [props: SwitchProps<Attr, Switch<Attr>>]
  Returns Switch<Attr>

ToggleButton

ToggleButton: <Child extends Widget = Widget, Attr = unknown>(
    ...props: [
        props: ToggleButtonProps<Child, Attr, ToggleButton<Child, Attr>>,
        child?: Child,
    ],
) => ToggleButton<Child, Attr>

Type Declaration

- <Child extends Widget = Widget, Attr = unknown>(
      ...props: [
          props: ToggleButtonProps<Child, Attr, ToggleButton<Child, Attr>>,
          child?: Child,
      ],
  ): ToggleButton<Child, Attr>
- Creates a new ToggleButton widget that retains its pressed state.
  Type Parameters
  - Child extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [
    props: ToggleButtonProps<Child, Attr, ToggleButton<Child, Attr>>,
    child?: Child,
    ]
  Returns ToggleButton<Child, Attr>

Window

Window: <Child extends Widget = Widget, Attr = unknown>(
    ...props: [
        WindowProps<Child, Attr, Window<Child, Attr>>?,
        child?: Child,
    ],
) => Window<Child, Attr>

Type Declaration

- <Child extends Widget = Widget, Attr = unknown>(
      ...props: [
          WindowProps<Child, Attr, Window<Child, Attr>>?,
          child?: Child,
      ],
  ): Window<Child, Attr>
- Creates a new Window widget as a Wayland layer shell surface.
  Type Parameters
  - Child extends Widget = Widget
  - Attr = unknown
  Parameters
  - ...props: [WindowProps<Child, Attr, Window<Child, Attr>>?, child?: Child]
  Returns Window<Child, Attr>
  Example
```
const window = newWindow({
    name: 'my-bar',
    anchor: ['top', 'left', 'right'],
    exclusivity: 'exclusive',
    layer: 'top',
    child: Widget.Box({ children: [...] }),
});
```

Function subclass

Type Parameters

Parameters

Returns <Attr>(props: BaseProps<Instance<Attr>, Props, Attr>) => Instance<Attr>

Example

Index

Properties

Properties

Box

Type Declaration

Type Parameters

Parameters

Returns Box<Child, Attr>

Example

Button

Type Declaration

Type Parameters

Parameters

Returns Button<Child, Attr>

Example

Calendar

Type Declaration

Type Parameters

Parameters

Returns Calendar<Attr>

CenterBox

Type Declaration

Type Parameters

Parameters

Returns CenterBox<StartWidget, CenterWidget, EndWidget, Attr>

CircularProgress

Type Declaration

Type Parameters

Parameters

Returns CircularProgress<Child, Attr>

ColorButton

Type Declaration

Type Parameters

Parameters

Returns ColorButton<Child, Attr>

DrawingArea

Type Declaration

Type Parameters

Parameters

Returns DrawingArea<Attr>

Entry

Type Declaration

Type Parameters

Parameters

Returns Entry<Attr>

Example

EventBox

Type Declaration

Type Parameters

Parameters

Returns EventBox<Child, Attr>

FileChooserButton

Type Declaration

Type Parameters

Parameters

Returns FileChooserButton<Child, Attr>

Fixed

Type Declaration

Type Parameters

Parameters

Returns Fixed<Attr>

FlowBox

Type Declaration

Type Parameters

Parameters

Returns FlowBox<Attr>

FontButton

Type Declaration

Type Parameters

Parameters

Returns FontButton<Child, Attr>

Icon

Type Declaration

Type Parameters

Parameters