Skip to content

backascout/components

Repository files navigation

Built With Stencil

Backa Scoutkår components

Getting Started

yarn install
yarn start

To build the components for production, run:

yarn build

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

There are three strategies we recommend for using web components built with Stencil.

The first step for all three of these strategies is to publish to NPM.

Script tag

  • Put a script tag similar to this <script src='https://unpkg.com/@backascout/components@0.0.1/dist/components/components.esm.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 yarn add @backascout/components --save
  • Put a script tag similar to this <script src='node_modules/@backascout/components/dist/components/components.esm.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 yarn add @backascout/components --save
  • Add an import to the npm packages import '@backascout/components';
  • Then you can use the element anywhere in your template, JSX, html etc