Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

react-demo-tab-cli

mkosir13MIT1.3.2TypeScript support: included

CLI tool for creating demos of React components

react, react-component, demo-component, demo, react-demo-tab-cli, demo-tab-cli, demotab, demo-tab, cli, cli-tool, documentation, documentation-tool, oclif, code-generator, code-example

readme

React DemoTab CLI 📑

npm version CI oclif semantic-release prettier TypeScript

Easily create demos of React components

Maintaining example code and demo separately makes it painful, it's easy to get them out of sync 🙅

Code can't lie, documentation can 💥

DemoTab CLI keeps your code up to date with demo 💪

Install

npm install -D react-demo-tab react-demo-tab-cli

Demo

DemoTab example

Usage 🚀

To create demos out of React components:

  1. Name files as [component_name].demotab.jsx
  2. Run $ npx react-demo-tab-cli generate

Use created demos 🎉

Generated Demos

  • By default generated demo files will be prefixed with _ for example:
    MyComponent.demotab.jsx → _MyComponent.jsx
  • You can set custom prefix with --prefix flag:
    $ demotab generate --prefix=CustomPrefix

Built with DemoTab

Manually create demos

To manually create demos instead via CLI just React DemoTab component.

Contributing

All contributions are welcome!