Documentation
Spinner

Spinner

Spinner provides a visual cue that an action is processing, awaiting a change or a result.

Usage Example

local spinner_formats = require("nui-components.utils.spinner-formats")
 
local signal = n.create_signal({ 
  is_loading = false 
})
 
n.spinner({
  is_loading = signal.is_loading,
  frames = spinner_formats.bouncing_ball,
})

Properties

frames

Default value
spinner_formats.dots
Type
string[]

interval

Default value
100
Type
number

is_loading

Default value
false
Type
boolean

Highlight Groups

  • NuiComponentsSpinner

Formats

local spinner_formats = require("nui-components.utils.spinner-formats")
  • classic
  • spin
  • spin_2
  • spin_3
  • spin_4
  • pulse
  • pulse_2
  • pulse_3
  • pulse_4
  • dots
  • dots_2
  • dots_3
  • dots_4
  • dots_5
  • dots_6
  • dots_7
  • dots_8
  • dots_9
  • dots_10
  • dots_11
  • arrow
  • arrow_pulse
  • triangle
  • arc
  • pipe
  • bouncing
  • bouncing_ball
  • bounce
  • box_bounce
  • box_bounce_2
  • star
  • toggle
  • balloon
  • balloon_2
  • balloon_3
  • flip
  • toss
  • lighthouse
  • points
  • points_2
  • burger
  • dance
  • shark
  • pong