alsur-components

alsur-components

This is a starter project for building a standalone Web Component using Stencil.

Getting Started

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

git clone http://gitl.alsur.es:8102/gis/ui-components alsur-components
cd alsur-components

and run:

npm install
npm start

To build the components 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/alsur-components@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 alsur-components --save
• Put a script tag similar to this <script src='node_modules/alsur-components/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 installalsur-components --save
• Add an import to the npm packages import alsur-components;
• Then you can use the element anywhere in your template, JSX, html etc