Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blueberryapps/react-bluekit
Automatically generating a component library from your React components (ES5, ES6, Typescript)
https://github.com/blueberryapps/react-bluekit
blueberry-opensource react react-components tooling typescript visualization
Last synced: about 7 hours ago
JSON representation
Automatically generating a component library from your React components (ES5, ES6, Typescript)
- Host: GitHub
- URL: https://github.com/blueberryapps/react-bluekit
- Owner: blueberryapps
- License: mit
- Created: 2015-11-24T13:17:51.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-10T02:28:32.000Z (over 1 year ago)
- Last Synced: 2024-11-06T20:52:13.457Z (1 day ago)
- Topics: blueberry-opensource, react, react-components, tooling, typescript, visualization
- Language: JavaScript
- Homepage: http://bluekit.blueberry.io
- Size: 2.25 MB
- Stars: 646
- Watchers: 52
- Forks: 33
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React BlueKit [](https://circleci.com/gh/blueberryapps/react-bluekit/tree/master) [](https://dependencyci.com/github/blueberryapps/react-bluekit)
BlueKit automatically generates a library from your React components with editable props and live preview.
Point BlueKit to folders with your React components and it will generate a library for you. You'll be able to browse through the components, tweak their props, and see the changes live. Furthermore, any changes that you make to your components' code will be reflected in the library.
DEMO here: [http://bluekit.blueberry.io](http://bluekit.blueberry.io)
## Install
```sh
$ npm install --save react-bluekit
```
You can use BlueKit via npm script or gulp
## Npm script
```js
"scripts": {
"bluekit": "bluekit --baseDir ./components --paths . --exclude \"./(Layout|StyledComponent).tsx\""
}
```
## Gulpfile configuration
```js
import createBlueKit from 'react-bluekit/lib/createBlueKit';
createBlueKit({
// your directory where components are located
baseDir: `${__dirname}/src/browser`,
// relative paths from base dir where to look for components
paths: ['./components/', './auth'],
// relative paths from base dir of files or directories you want to exclude from indexing
exclude: ['./components/Foo'],
// set to true when providing simple components such as `export default function MyComponent() {
Hello }`
noSpecialReplacements: true
});
```
This will provide you with two gulp tasks: `build-bluekit` and `watch-bluekit`, which perform static analysis of your components.
You can setup the build of BlueKit on application start and then watch components for changes by editing the `default` task to:
```js
// from gulp.task('default', ['server']); to:
gulp.task('default', ['build-bluekit', 'server', 'watch-bluekit']);
```
Do not forget to add it to build process (for example on stage or production):
```js
gulp.task('build', ['build-bluekit', 'build-webpack']);
// make sure that component build is before webpack
```
It will be built when needed.
## Add it to your project
Look at the `example` directory, you only need to add:
```js
import BlueKit from 'react-bluekit';
import componentsIndex from '../componentsIndex';
import React, { Component } from 'react';
export default class PageWithBlueKit extends Component {
render() {
return (
);
}
}
```
You can also pass `children` to BlueKit, which will be displayed above the search field (e.g. for themes or other stuff).
To add jsdoc **descriptions** see example [example_components/Checkbox.react.js](https://github.com/blueberryapps/react-bluekit/blob/master/example_components/Checkbox.react.js).
## Typescript support
Bluekit automatically finds `.tsx` files and uses [react-docgen-typescript](https://github.com/imtoo/react-docgen-typescript) parser for it.
## BlueKit development
```
npm install
cd ./example
npm install
gulp
open http://localhost:3000
```
This will start the development server and then you can play with components in BlueKit.
## Gulp tasks
```
# generate svg icons from src/icons directory
gulp svg-icon
# run unit tests
gulp ava
# run eslint
gulp eslint
```
## Additional info
BlueKit automatically hides props that don’t affect the component’s look.
If you get some kind of weird error and BlueKit doesn't load at all, try to reset localStorage by running `localStorage.clear();`.
## Made with love by
[](https://www.blueberry.io)