@skilld/kaizen-cg v2.0.0-beta.0

kaizen-cg

    _/                       _/
   _/  _/       _/_/_/             _/_/_/_/       _/_/       _/_/_/
  _/_/       _/    _/      _/         _/       _/_/_/_/     _/    _/
 _/  _/     _/    _/      _/       _/         _/           _/    _/
_/    _/     _/_/_/      _/     _/_/_/_/       _/_/_/     _/    _/

What is it?

• This is a component generator for kaizen-tg

Usage

Once kaizen-tg is installed, use: 1. cd [themename_dir] 2. yarn cc and follow instructions

Structure

1. *.js to store javascript code related to the component
2. *.json to store modifiers of the component, such as default content for example
3. *.css to store css code related to the component
4. *.html.twig for templating
5. *.stories.js for storybook initiation

Should know

1. Every component's js uses Drupal.behaviors structure and it works in storybook same way as in Drupal.

Recommendations

1. Please follow BEM methodology when you are creating component. More about BEM's namings here
2. Avoid jQuery inside of component as much as possible. Try to not use external libraries with jQuery dependency. Here is a useful link how to make one or another thing without jQuery on vanilla javascript
3. Don't worry now about IE11 browser - kaizen-tg doesn't support it
4. Use argTypes as much as possible if your component is not static and have different modifiers, try to avoid a lot of component's variations if it's possible to replace them by argTypes
5. Don't hardcode content in component-name.twig or component-name.stories.js of the component, you should build re-usable components. All default content should be stored into component-name.json file, and then this content can be modified using args from any other component.

Other kaizen's packages

1. kaizen-tg
2. kaizen-core
3. kaizen-breakpoints

License

This project is licensed under the MIT open source license.