# @justeattakeaway/pie-spinner
[Source Code](https://github.com/justeattakeaway/pie/tree/main/packages/components/pie-spinner) | [Design Documentation](https://pie.design/components/spinner) | [NPM](https://www.npmjs.com/package/@justeattakeaway/pie-spinner)

<p>
  <a href="https://www.npmjs.com/@justeattakeaway/pie-spinner">
    <img alt="GitHub Workflow Status" src="https://img.shields.io/npm/v/@justeattakeaway/pie-spinner.svg">
  </a>
</p>

`@justeattakeaway/pie-spinner` is a Web Component built using the Lit library. It offers a simple and accessible spinner component for web applications.

## Table of Contents

- [Installation](#installation)
- [Documentation](#documentation)
  - [Properties](#properties)
  - [Slots](#slots)
  - [CSS Variables](#css-variables)
  - [Events](#events)
- [Usage Examples](#usage-examples)
- [Questions and Support](#questions-and-support)
- [Contributing](#contributing)

## Installation

> To install any of our web components in your application, we would suggest following the [getting started guide](https://webc.pie.design/?path=/docs/introduction-getting-started--docs) to set up your project.

Ideally, you should install the component using the **`@justeattakeaway/pie-webc`** package, which includes all of the components. Or you can install the individual component package.

## Documentation
### Properties
| Prop     | Options                                      | Description                                                                                      | Default     |
|----------|----------------------------------------------|--------------------------------------------------------------------------------------------------|-------------|
| `size`   | `"xsmall"`, `"small"`, `"medium"`, `"large"`, `"xlarge"` | Size of the spinner.                                                                             | `medium`    |
| `variant`| `"brand"`, `"secondary"`, `"secondary-dark"`, `"inverse"`, `"inverse-light"` | Variant of the spinner.                                                                          | `brand`     |
| `isCentered` | `true`, `false`                            | When true, positions the spinner absolutely and centers it within its nearest relative ancestor. | `false`     |
| `aria`   | —                                            | An object representing the ARIA attributes such as `label`.                                      | `undefined` |

### Slots
This component does not have any slots. All content is controlled through properties.

### CSS Variables
This component does not expose any CSS variables for style overrides.

### Events
This component does not emit any custom events. In order to add event listening to this component, you can treat it like a native HTML element in your application.

## Usage Examples

**For HTML:**

```js
// import as module into a js file e.g. main.js
import '@justeattakeaway/pie-webc/components/spinner.js';
```

```html
<pie-spinner size="medium" variant="brand" aria="{ label: 'Loading' }"></pie-spinner>

<script type="module" src="/main.js"></script>
```

**For Native JS Applications, Vue, Angular, Svelte etc.:**

```js
// Vue templates (using Nuxt 3)
import '@justeattakeaway/pie-webc/components/spinner.js';

<pie-spinner size="medium" variant="brand" aria="{ label: 'Loading' }"></pie-spinner>
```

**For React Applications:**

```jsx
import { PieSpinner } from '@justeattakeaway/pie-webc/react/spinner.js';

<PieSpinner size="medium" variant="brand" aria={{ label: 'Loading' }} />
```

## Questions and Support

If you work at Just Eat Takeaway.com, please contact us on **#help-designsystem**. Otherwise, please raise an issue on [Github](https://github.com/justeattakeaway/pie/issues).

## Contributing

Check out our [contributing guide](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide) for more information on [local development](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide#local-development) and how to run specific [component tests](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide#testing).