# @previewjs/api

Latest version **16.1.0** (published 2024-12-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @previewjs/api
pnpm add @previewjs/api
yarn add @previewjs/api
bun add @previewjs/api
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 16.1.0 |
| Published | 2024-12-15 |
| First published | 2022-02-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 11.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1935 |
| Author | François Wouts |
| Maintainers | fwouts |

## Links

- npm: https://www.npmjs.com/package/@previewjs/api
- Repository: https://github.com/fwouts/previewjs
- Homepage: https://previewjs.com
- Issues: https://github.com/fwouts/previewjs/issues
- npm.io page: https://npm.io/package/@previewjs/api

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^1.7.9
- [@previewjs/type-analyzer](https://npm.io/package/@previewjs/type-analyzer.md) ^10.1.5
- [@previewjs/serializable-values](https://npm.io/package/@previewjs/serializable-values.md) ^9.0.6

## Recent versions

- 16.1.0 (latest) — 2024-12-15
- 16.0.6 — 2024-12-10
- 16.0.5 — 2024-11-11
- 16.0.4 — 2024-02-01
- 16.0.3 — 2023-11-30
- 16.0.2 — 2023-10-29
- 16.0.1 — 2023-09-12
- 16.0.0 — 2023-09-12
- 15.0.1 — 2023-09-12
- 15.0.0 — 2023-09-10
- 14.0.0 — 2023-08-04
- 13.0.0 — 2023-06-23
- 12.0.1 — 2023-06-12
- 12.0.0 — 2023-05-24
- 11.0.3 — 2023-05-03
- … 43 more at https://npm.io/package/@previewjs/api/versions

## README

> [!WARNING]
> **This project is no longer maintained.**
>
> Life got busy — work, kids, and the usual chaos. I no longer have the time or energy to keep up with issues, PRs, or framework updates. Preview.js has been effectively abandoned.
>
> The code is still here and you're welcome to fork it, but don't expect updates or support.

# Preview.js

Preview.js lets you preview React components and Storybook stories instantly in your IDE.

[![Demo](assets/previewjs-overview.gif)](https://previewjs.com)

## Get started

Preview.js is available for [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=zenclabs.previewjs).

## Documentation

[Read the docs to learn more](https://previewjs.com)

## Contributing

Please see the [contributing guide](./CONTRIBUTING.md).

## License

Preview.js is divided into multiple packages, each licensed under either AGPL-3.0 or MIT.

Preview.js Pro is proprietary and not available under an open source license.

Please refer to LICENSE under each directory to find out which license applies.

Copyright (c) 2022-present Zenc Labs Pty Ltd

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