greg-minshall / zoo-web-components

Web-components library.

Home Page:https://zooplus.github.io/zoo-web-components/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Dependencies Size Downloads
David npm bundle size (scoped) npm
David npm bundle size (scoped)

Intro

  • Set of web-components which can be used in any modern UI framework (or without any).
  • The web-component set implements Z+ shop style guide.
  • Built with Vanilla JS

Installation

To use this library install it by running:

npm i @zooplus/zoo-web-components --save

and import the library in your main module/component/index.html:

import 'node_modules/@zooplus/zoo-web-components/dist/zoo-components-esm.js';

Examples integrating with various frameworks

Documentation

Landing page is available here: https://zooplus.github.io/zoo-web-components/
Documentation page is here: https://zooplus.github.io/zoo-web-components-docs/index.html

Dev area

Run

Run landing page

Run npm start and go to localhost:5000.

Run storybook

Run npm run storybook, after compilation browser should automatically open localhost:6006 page with storybook.

Test

This project uses Mocha and Chai for writing tests. The tests are run using Puppeteer. Run npm test to run the tests.

About

Web-components library.

https://zooplus.github.io/zoo-web-components/

License:MIT License


Languages

Language:JavaScript 77.0%Language:CSS 18.5%Language:HTML 4.5%