Install

This repository is distributed with npm. After installing npm, you can install wafflecss with this command:

    npm install --save wafflecss

Documentation

WaffleCSS documentation is developed under Docs, which is not currently stable. You can run storybook to access documentation and APIs. Run,

    npm run build-storybook

in your terminal and view on http://localhost:6006/ in your browser.

Testing

UI Testing

UI testing is done using storybook. After installing storybook, you can run storybook using.

    npm run storybook

Storybook can be build as an UI. Use

    npm run build-storybook

Current version of storybook is deployed to Vercel can be found [here](https://wafflecss-jithinqw.vercel.app/.

Unit Testing

Unit testing is done using Jest. After installing Jest, you can run Jest test suits using.

    run run unittest

Style Accessibility Guide

WaffleCSS follows A11y for accessibility features.

Contributing

We invite PRs if you're interested in contributing to WaffleCSS. Moreover, if your pull request contains patches or features, you must include relevant unit tests (Storybook and Jest). Please try not to lower performance for a component by testing component aganist Storybook performance addon.

WaffleCSS always take following metrics before merging PRs.

• Initial Render
• Re Render
• Hydrate
• Complete Render

If your pull request is a candidate for release, please add [Release candidate] tag as starting name of PR.

Version

WaffleCSS is maintained under the Semantic Versioning guidelines.

Bundle Analysis

Please access bundle analysis for WaffleCSS here.

License

MIT © Jithin Zacharia.

Package Contents

Components

You can find a list of component published here.

You can also use unstyled components.

Utilities

Here is a list of Utilities here.

Hooks

Here is a list of Hooks here.