mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-22 20:25:44 +00:00
04432835f9
* feat: add field.tsx and update blocks * feat: add input group * feat: implement button group * fix * fix * wip * fix: button group * feat: update field * fix * feat * feat: cooked * fix * chore: build registry * feat: add kbd component * chore: update input group demo * feat: update kbd component * feat: add empty * feat: add spinner * refactor: input group * feat: blocks * fix * fix: app sidebar * feat: add label to app sidebar * fix * fix * fix * fix * fix * feat * feat * fix * docs: button group * feat: add docs * docs: kbd * docs: empty * fix * docs * docs * feat: add sink link * fix * fix * docs * feat: add new page * fix * fix * fix * fix * fix * fix * feat: add registration form * fix: chat settings * fix * fix preview * fix examples * feat: add changelog * fix * fix * fix * fix * fix * feat(www): add t3 versions * chore: build registry * fix * fix * fix * feat: inline code examples for llm * fix * feat: home * fix * fix * fix * fix * fix * chore: changelog * fix * fix * fix * fix: callout * fix
131 lines
2.3 KiB
Plaintext
131 lines
2.3 KiB
Plaintext
---
|
|
title: Spinner
|
|
description: An indicator that can be used to show a loading state.
|
|
component: true
|
|
---
|
|
|
|
<ComponentPreview name="spinner-demo" className="[&_.preview]:p-6" />
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">CLI</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add spinner
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps>
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource name="spinner" title="components/ui/spinner.tsx" />
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { Spinner } from "@/components/ui/spinner"
|
|
```
|
|
|
|
```tsx
|
|
<Spinner />
|
|
```
|
|
|
|
## Customization
|
|
|
|
You can replace the default spinner icon with any other icon by editing the `Spinner` component.
|
|
|
|
<ComponentPreview name="spinner-custom" />
|
|
|
|
```tsx showLineNumbers title="components/ui/spinner.tsx"
|
|
import { LoaderIcon } from "lucide-react"
|
|
|
|
import { cn } from "@/lib/utils"
|
|
|
|
function Spinner({ className, ...props }: React.ComponentProps<"svg">) {
|
|
return (
|
|
<LoaderIcon
|
|
role="status"
|
|
aria-label="Loading"
|
|
className={cn("size-4 animate-spin", className)}
|
|
{...props}
|
|
/>
|
|
)
|
|
}
|
|
|
|
export { Spinner }
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Size
|
|
|
|
Use the `size-*` utility class to change the size of the spinner.
|
|
|
|
<ComponentPreview name="spinner-size" />
|
|
|
|
### Color
|
|
|
|
Use the `text-` utility class to change the color of the spinner.
|
|
|
|
<ComponentPreview name="spinner-color" />
|
|
|
|
### Button
|
|
|
|
Add a spinner to a button to indicate a loading state. The `<Button />` will handle the spacing between the spinner and the text.
|
|
|
|
<ComponentPreview name="spinner-button" />
|
|
|
|
### Badge
|
|
|
|
You can also use a spinner inside a badge.
|
|
|
|
<ComponentPreview name="spinner-badge" />
|
|
|
|
### Input Group
|
|
|
|
Input Group can have spinners inside `<InputGroupAddon>`.
|
|
|
|
<ComponentPreview name="spinner-input-group" />
|
|
|
|
### Empty
|
|
|
|
<ComponentPreview name="spinner-empty" />
|
|
|
|
### Item
|
|
|
|
Use the spinner inside `<ItemMedia>` to indicate a loading state.
|
|
|
|
<ComponentPreview name="spinner-item" />
|
|
|
|
## API Reference
|
|
|
|
### Spinner
|
|
|
|
Use the `Spinner` component to display a spinner.
|
|
|
|
| Prop | Type | Default |
|
|
| ----------- | -------- | ------- |
|
|
| `className` | `string` | `` |
|
|
|
|
```tsx
|
|
<Spinner />
|
|
```
|