# @aki77/vite-plugin-preview

> Get previews of your components

Latest version **0.2.0** (published 2021-11-18) · 0 weekly downloads

## Install

```sh
npm install @aki77/vite-plugin-preview
pnpm add @aki77/vite-plugin-preview
yarn add @aki77/vite-plugin-preview
bun add @aki77/vite-plugin-preview
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2021-11-18 |
| First published | 2021-09-26 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 29.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | aki77 |

## Links

- npm: https://www.npmjs.com/package/@aki77/vite-plugin-preview
- npm.io page: https://npm.io/package/@aki77/vite-plugin-preview

## Dependencies (1)

- [sass](https://npm.io/package/sass.md) ^1.42.1

## Recent versions

- 0.2.0 (latest) — 2021-11-18
- 0.1.2 — 2021-10-01
- 0.1.1 — 2021-09-26
- 0.1.0 — 2021-09-26

## README

# vite-plugin-preview

![demo](https://i.gyazo.com/c19f905288bde120e192b137a4768747.png)

## Installation

```
yarn add -D @aki77/vite-plugin-preview
```

```typescript
// vite.config.ts
import { PreviewPlugin } from '@aki77/vite-plugin-preview'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [PreviewPlugin(/*options*/)],
})
```

## Usage

```
yarn vite --open /__preview
```

## Options Examples

### Chakra UI + Next.js

```typescript
// vite.config.ts
import path from 'path'
import { PreviewPlugin } from '@aki77/vite-plugin-preview'
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'

export default defineConfig({
  resolve: {
    alias: [
      {
        find: '@/',
        replacement: `${path.resolve(__dirname, 'src')}/`,
      },
    ],
  },
  define: {
    'process.env': {},
  },
  plugins: [
    react(),
    PreviewPlugin({
      pattern: './src/**/*.preview.tsx',
      wrapper: path.resolve(__dirname, '__preview__/Wrapper.tsx'),
      framework: 'react',
    }),
  ],
})
```

```typescript
// __preview__/Wrapper.tsx
import { Center, ChakraProvider } from '@chakra-ui/react'
import React, { ReactNode, VFC } from 'react'
import { chakraTheme } from '../src/chakraTheme'

type WrapperProps = {
  children: ReactNode
}

const Wrapper: VFC<WrapperProps> = ({ children }) => {
  return (
    <ChakraProvider theme={chakraTheme}>
      <Center p="4">
        {children}
      </Center>
    </ChakraProvider>
  )
}

export default Wrapper
```

### Vue3

```typescript
//vite.config.ts
import path from 'path'
import { PreviewPlugin } from '@aki77/vite-plugin-preview'
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

export default defineConfig({
  resolve: {
    alias: [
      {
        find: '@/',
        replacement: `${path.resolve(__dirname, 'src')}/`,
      },
    ],
  },
  plugins: [
    PreviewPlugin({
      pattern: './src/**/*.preview.vue',
      head: '@/previews/head',
      wrapper: '@/previews/Wrapper.vue',
      framework: 'vue',
    }),
    vue(),
  ],
})
```

```typescript
// src/previews/head.ts
import '@/stylesheets/main.scss'
```

```vue
// src/previews/Wrapper.vue
<template>
  <div class="p-4">
    <slot></slot>
  </div>
</template>

<script lang="ts">
import { defineComponent } from 'vue'

export default defineComponent({})
</script>
```


### Vue2

```typescript
//vite.config.ts
import path from 'path'
import { PreviewPlugin } from '@aki77/vite-plugin-preview'
import { defineConfig } from 'vite'
import { createVuePlugin } from 'vite-plugin-vue2'

export default defineConfig({
  resolve: {
    alias: [
      {
        find: '@/',
        replacement: `${path.resolve(__dirname, 'src')}/`,
      },
    ],
  },
  plugins: [
    PreviewPlugin({
      pattern: './src/**/*.preview.vue',
      head: '@/previews/head',
      wrapper: '@/previews/Wrapper.vue',
      framework: 'vue2',
    }),
    createVuePlugin(),
  ],
})
```

```typescript
// src/previews/head.ts
import VueCompositionApi from '@vue/composition-api'
import Vue from 'vue'

import '@/stylesheets/main.scss'

Vue.use(VueCompositionApi)
```

```vue
// src/previews/Wrapper.vue
<template>
  <div class="p-4">
    <slot></slot>
  </div>
</template>

<script lang="ts">
import { defineComponent } from '@vue/composition-api'

export default defineComponent({})
</script>
```

---
_Source: https://npm.io/package/@aki77/vite-plugin-preview · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
