@oiz/stzh-components v3.5.0-beta1

STZH Web Components

This is a project for building standalone Web Components using Stencil.

Getting Started

First install the NPM dependencies:

npm install

To start developing with hot module reloading execute the following:

npm run start

To build a static storybook that can be deployed:

npm run build

To run the unit tests for the components, run:

npm test

Assets

Icons

Place icons inside /assets/icons/mono folder. Icons should be inside a square viewport (usually 24x24px).

While developing, the icon sprite will be generated automatically. The preview will only be updated on build.

Fonts

Font files are located inside the /assets/fonts folder. If you want to add a new font file:

• Add new font file to fonts folder /assets/fonts
• Run npm run fonts:build (this will generate the font files and place it inside the src/components/stzh-fonts/assets/fonts component)
• Add font to src/components/stzh-fonts/assets/fonts.css file
• Restart the project

Media

Example media files like logos or placeholder images can be added to the /static/media folder.

Naming Components

All components have to start with the prefix stzh-.