candeo-web-components

Candeo Web Components

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
candeo-web-components
0.1.14-14 years ago4 years agoMinified + gzip package size for candeo-web-components in KB

Readme

Candeo Web Components
TODO Elements
  • Content
  • Carousel
  • Gallery
  • Hero
  • Contact Information
  • Side By Side
  • x Lazy Img
  • x Ratio Container
  • Youtube Video Container
  • Algolia Search
  • Google maps
  • Slider

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

Need help? Check out our docs here.

Naming Components

When creating new component tags, we recommend not using stencil in the component name (ex: <stencil-datepicker>). This is because the generated component has little to nothing to do with Stencil; it's just a web component!
Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix ion.

Using this component

Script tag

  • Publish to NPM
  • Put a script tag similar to this <script src='https://unpkg.com/my-component@0.0.1/dist/mycomponent.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 my-component --save
  • Put a script tag similar to this <script src='node_modules/my-component/dist/mycomponent.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

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