overlay

Overlay container widget builder (children stacked on z-axis).

Types

Opt

Option type for overlay properties.

pub type Opt {
  Position(OverlayPosition)
  Gap(Float)
  OffsetX(Float)
  OffsetY(Float)
  Flip(Bool)
  Align(OverlayAlign)
  Width(length.Length)
  A11y(a11y.A11y)
}

Constructors

```
Position(OverlayPosition)
```
```
Gap(Float)
```
```
OffsetX(Float)
```
```
OffsetY(Float)
```
```
Flip(Bool)
```
```
Align(OverlayAlign)
```
```
Width(length.Length)
```
```
A11y(a11y.A11y)
```

Overlay

opaque </>

pub opaque type Overlay

OverlayAlign

</>

pub type OverlayAlign {
  AlignStart
  AlignCenter
  AlignEnd
}

Constructors

```
AlignStart
```
```
AlignCenter
```
```
AlignEnd
```

OverlayPosition

</>

pub type OverlayPosition {
  Below
  Above
  OverlayLeft
  OverlayRight
}

Constructors

```
Below
```
```
Above
```
```
OverlayLeft
```
```
OverlayRight
```

Values

</>

pub fn a11y(o: Overlay, a: a11y.A11y) -> Overlay

Set accessibility properties for this widget.

align

</>

pub fn align(o: Overlay, a: OverlayAlign) -> Overlay

Set the alignment.

build

</>

pub fn build(o: Overlay) -> node.Node

Build the overlay into a renderable Node. Overlay requires exactly 2 children (base and overlay content).

extend

</>

pub fn extend(o: Overlay, children: List(node.Node)) -> Overlay

Add multiple child nodes.

flip

</>

pub fn flip(o: Overlay, f: Bool) -> Overlay

Set whether the overlay flips when near viewport edges.

gap

</>

pub fn gap(o: Overlay, g: Float) -> Overlay

Set the gap between elements.

new

</>

pub fn new(id: String) -> Overlay

Create a new overlay builder.

offset_x

</>

pub fn offset_x(o: Overlay, x: Float) -> Overlay

Set the horizontal offset.

offset_y

</>

pub fn offset_y(o: Overlay, y: Float) -> Overlay

Set the vertical offset.

position

</>

pub fn position(o: Overlay, p: OverlayPosition) -> Overlay

Set the position.

push

</>

pub fn push(o: Overlay, child: node.Node) -> Overlay

Add a child node.

width

</>

pub fn width(o: Overlay, w: length.Length) -> Overlay

Set the width.

with_opts

</>

pub fn with_opts(o: Overlay, opts: List(Opt)) -> Overlay

Apply a list of options to an overlay builder.