gleamtea/spinner

A bubble: an animated spinner.

Return tick from your init, then forward every message to update — the spinner recognises only its own tick messages and keeps itself running by returning the next tick.

Types

Spinner

</>

An opaque spinner value (a beamtea beamtea_spinner model).

pub type Spinner

Style

</>

A built-in spinner style.

pub type Style {
  Line
  Dot
  Minidot
  Jump
  Points
  Moon
  Meter
  Pulse
}

Constructors

```
Line
```
```
Dot
```
```
Minidot
```
```
Jump
```
```
Points
```
```
Moon
```
```
Meter
```
```
Pulse
```

Values

new

</>

pub fn new() -> Spinner

A spinner with the default style (Dot).

styles

</>

pub fn styles() -> List(Style)

The list of built-in style names.

tick

</>

pub fn tick(spinner: Spinner) -> gleamtea.Cmd(msg)

The command that advances the animation once. Return it from init.

update

</>

pub fn update(
  msg: msg,
  spinner: Spinner,
) -> #(Spinner, gleamtea.Cmd(msg))

Advance the spinner on its own tick; ignore everything else.

view

</>

pub fn view(spinner: Spinner) -> String

The current frame, coloured if a colour was configured.

with_style

</>

pub fn with_style(style: Style) -> Spinner

A spinner with the given built-in style.