Skip to content

Commit

Permalink
chore(docs): spinner README copyedits
Browse files Browse the repository at this point in the history
  • Loading branch information
meowgorithm committed Dec 6, 2023
1 parent c605de3 commit dcff6e0
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,10 +264,10 @@ Themes can take advantage of the full range of

[lipgloss]: https://github.com/charmbracelet/lipgloss

## Spinner
## Bonus: Spinner

Spinners come built in to `huh` for loading actions. It's useful to indicate
loading while completing an action after a form is submitted.
`huh?` ships with a standalone spinner package. Its useful for indicating
background activity after a form is submitted.

<img alt="Spinner while making a burger" width="600" src="https://vhs.charm.sh/vhs-5uVCseHk9F5C4MdtZdwhIc.gif">

Expand Down Expand Up @@ -296,6 +296,7 @@ fmt.Println("Order up!")
go makeBurger()

err := spinner.New().
Type(spinner.Line).
Title("Making your burger...").
Context(ctx).
Run()
Expand All @@ -307,6 +308,9 @@ fmt.Println("Order up!")
</tr>
</table>

For more on Spinners see the [spinner examples](./spinner/examples) and
[the spinner docs](https://pkg.go.dev/github.com/charmbracelet/huh@main/spinner).

## What about [Bubble Tea][tea]?

Huh is an abstraction built on Bubble Tea to make forms easier to code and
Expand Down

0 comments on commit dcff6e0

Please sign in to comment.