Files
hinode/content/en/docs/0.8/components/spinner.md
2023-01-11 15:20:27 +01:00

39 lines
1.2 KiB
Markdown

---
author: "Mark Dumay"
title: "Spinner"
date: 2023-01-05
description: "Use the spinner shortcode to indicate the loading state of a component or page."
group: components
layout: docs
---
## Overview
Use the `spinner` shortcode to indicate the loading state of a component or page. The inner content is used as alternative description.
## Arguments
The shortcode supports the following arguments:
| Argument | Required | Description |
|-------------|----------|-------------|
| color | No | Optional theme color of the spinner, either "primary" (default), "secondary", "success", "danger", "warning", "info", "light", "dark", "white" or "black". |
| grow | No | Optional flag to indicate the spinner is growing instead of rotating, defaults to false. |
| class | No | Optional class attribute of the spinner wrapping element, e.g. “text-center”. |
{.table}
## Example
As an example, the following shortcode displays a centered spinner.
```html
{{</* spinner color="info" class="text-center" */>}}
Loading...
{{</* /spinner */>}}
```
The result looks like this:
{{< spinner color="info" class="text-center" >}}
Loading...
{{< /spinner >}}