@nolebase/ui-rive-canvas/README.md

Wrapper of `@rive-app/canvas` for VitePress documentation sites.

# `@nolebase/ui-rive-canvas`

Wrapper of `@rive-app/canvas` for VitePress documentation sites.

> [!CAUTION]
>
> This package is in Alpha stage.
>
> This package is still in the Alpha stage, and it is not recommended to use it in production. The API may change in the future, and there may be bugs in the current version. Please use it with caution.

> [!IMPORTANT]
>
> ## For users who imported VitePress related components
>
> If you are using VitePress, you will need to add the following configurations to your `vite.config.ts` file like this:
>
> ```typescript
> export default defineConfig(() => {
>   return {
>     ssr: {
>       noExternal: [
>         // Add this line to your vite.config.ts
>         '@nolebase/ui-rive-canvas',
>       ],
>     },
>   }
> })
> ```
>
> For more information about why configure this, please refer to the [Server-Side Rendering | Vite](https://vitejs.dev/guide/ssr.html#ssr-externals) documentation.

## Install

### Npm

```shell
npm i @nolebase/ui-rive-canvas -D
```

### Yarn

```shell
yarn add @nolebase/ui-rive-canvas -D
```

### Pnpm

```shell
pnpm add @nolebase/ui-rive-canvas -D
```

## Documentation

Please refer to [Rive Canvas](https://nolebase-integrations.ayaka.io/pages/en/ui/lazy-teleport-rive-canvas/) for more information.