From the command line, run the following command:
npm run yo-componentFirst, you'll be prompted for what kind of component to create:
| Choice | Description |
|---|---|
| Stateless function | A stateless functional React component |
| Component class | A class-based React component |
Next, you'll reply to a series of prompts.
Yeoman will ask you what to name the file. It expects you to provide the name in snake case. Yeoman will automatically add file extensions and a "oui" prefix so you should leave those out.
The path to the directory where the files should live. Defaults to the last directory you specified for this prompt, or to OUI's components directory if you haven't specified one.
If you want Yeoman to automatically generate a directory to organize the files, that directory will be created inside of the location you specify (see next prompt).
This will automatically generate a directory with the same name as the file, but without a "oui" prefix. This defaults to YES.
Yeoman will generate the files you need in your project's folder system.
For your convenience, it will also output some snippets you can tweak to import and re-export the generated JS and SCSS files.
From the command line, run the following command:
npm run yo-docFirst, you'll be prompted for what kind of documentation to create:
| Choice | Description |
|---|---|
| Component documentation page | A new page for documenting a component |
| Add example to an existing page | A new subsection of an existing documentation page |
| Sandbox | An empty document where you can do pretty much anything |
Follow the prompts and your documentation files will be created. You can use the snippets that are printed to the terminal to integrate these files into the OUI documentation site.
The script will ask you for the name of the component you'd like to document, then create some files in src-docs/src/views/. If the name you provide isn't the exact name of a component, you might need to adjust the import in the generated files. Otherwise simply add the document to the src-docs/src/services/routes/routes.js file to make it available in the browser.