@classly/classly-business-webcomponents

Classly Widgets

A collection of webcomponents used by businesses on Classly.

Building locally

1. Run npm run start-dev. Make sure you follow install instructions below.

Deploying to production

1. Bump build number in package.json
2. Run npmR build --prod or npm run build --prod
3. Run npm publish --access public

Vendoring Web Components to Websites

These components are designed to be loaded externally on websites through npm & unpkg.com.

To grab the latest version and load unto a website, use this url as source of the script tag with a type of module:

https://unpkg.com/@classly/classly-business-webcomponents

Eg.

<link rel="stylesheet" href="https://unpkg.com/@classly/classly-business-webcomponents/dist/classly-business-webcomponents/classly-business-webcomponents.css">

<script type="module" src="https://unpkg.com/@classly/classly-business-webcomponents">

To add widgets to a website, see examples at https://classly.dev/widgets.

<upcoming-courses env="staging" organization-id="128f9263-ecd3-4362-b526-26d1bf8a589c" class="hydrated">
  <a href="https://classly.com" target="_blank" class="classly-link"><span>Powered by</span><img src="https://classly.com/images/logo-mark.svg"/></a>
</upcoming-courses>

Adding a new component

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

git clone https://github.com/ionic-team/stencil-component-starter.git my-component
cd my-component
git remote rm origin

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

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