Material Storybook

A Storybook for Angular Material.

Based on amcdnl/material-storybook but reworked to the ground up (as Storybook for Angular now requires an existing Angular project to be present) with Storybook v6 and Angular v10.

View the Storybook here.

---

Available Components

Name	Has Stories?	Has Docs Examples Stories?
Autocomplete	✅	~ (Form-related examples not included)
Badge	❎	❎
Bottom Sheet	❎	❎
Button	✅	✅
Button Toggle	✅	✅
Card	❎	❎
Checkbox	❎	❎
Chips	❎	❎
Datepicker	❎	❎
Dialog	❎	❎
Divider	❎	❎
Expansion Panel	❎	❎
Form Field	❎	❎
Grid List	❎	❎
Icon	❎	❎
Input	❎	❎
List	❎	❎
Menu	✅	✅
Paginator	❎	❎
Progress Bar	❎	❎
Progress Spinner	❎	❎
Radio Button	❎	❎
Ripples	❎	❎
Select	❎	❎
Sidenav	❎	❎
Slide Toggle	❎	❎
Slider	❎	❎
Snack Bar	❎	❎
Sort Header	❎	❎
Stepper	❎	❎
Table	❎	❎
Tabs	❎	❎
Toolbar	❎	❎
Tooltip	❎	❎

---

Dev setup

Clone the project locally using the typical git clone command.

Run locally

1. Run npm install in the project's root to install the project's dependencies.
2. Run npm run start-storybook to generate the documentation (which currently doesn't work) and to locally serve the Storybook.
3. Fire up your browser to localhost:6006 if the Storybook CLI did not auto-open the locally-served Storybook.

Deploying the project

1. Run npm run build-storybook to build the Storybook.
2. The contents of the built Storybook can then be found in the generated storybook-static directory.

Contributing

This project follows Angular's commit guidelines.

---

License

This project is licensed with the MIT license.