project-huddle-ui v0.0.6

ProjectHuddle UI Kit

This is a collection of Web Components for use with ProjectHuddle. ProjectHuddle components are just Web Components, so they work in any major framework or with no framework at all. You can even bring your own framework to customize and extend ProjectHuddle to your liking.

Getting Started

To start building a new web component using Stencil, clone this repo to a new directory:

git clone https://github.com/ProjectHuddle/ui-components

and run:

npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Naming Components

When creating new component tags for official contribution, we recommend ph in the component name (ex: <ph-datepicker>). This will help prevent conflicts with other web components that may appear on the page.

Using this component

Script tag (for quick development)

• Put a script tag similar to this <script src='https://unpkg.com/project-huddle-ui@0.0.1/dist/project-huddle-ui.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

Node Modules

• Run npm install project-huddle-ui --save
• Add an import to the npm packages import project-huddle-ui;
• Then you can use the element anywhere in your template, JSX, html etc