# @classly/classly-business-webcomponents

> Classly website widgets

Latest version **0.0.129** (published 2024-08-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @classly/classly-business-webcomponents
pnpm add @classly/classly-business-webcomponents
yarn add @classly/classly-business-webcomponents
bun add @classly/classly-business-webcomponents
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.129 |
| Published | 2024-08-21 |
| First published | 2021-12-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 708.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Eliel A. Gordon |
| Maintainers | gordonelielclassly |

## Links

- npm: https://www.npmjs.com/package/@classly/classly-business-webcomponents
- Repository: https://github.com/classly/classly-widgets
- Homepage: https://github.com/classly/classly-widgets#readme
- Issues: https://github.com/classly/classly-widgets/issues
- npm.io page: https://npm.io/package/@classly/classly-business-webcomponents

## Dependencies (4)

- [urql](https://npm.io/package/urql.md) ^2.2.0
- [dayjs](https://npm.io/package/dayjs.md) ^1.11.0
- [graphql](https://npm.io/package/graphql.md) ^15.7.2
- [@stencil/core](https://npm.io/package/@stencil/core.md) ^2.18.0

## Recent versions

- 0.0.129 (latest) — 2024-08-21
- 0.0.128 — 2023-12-12
- 0.0.127 — 2023-10-30
- 0.0.126 — 2023-09-14
- 0.0.125 — 2023-08-23
- 0.0.124 — 2023-08-22
- 0.0.123 — 2023-08-22
- 0.0.120 — 2023-08-22
- 0.0.119 — 2023-08-22
- 0.0.118 — 2023-08-22
- 0.0.117 — 2023-08-22
- 0.0.116 — 2023-08-19
- 0.0.115 — 2023-08-19
- 0.0.114 — 2023-08-19
- 0.0.113 — 2023-08-17
- … 106 more at https://npm.io/package/@classly/classly-business-webcomponents/versions

## README

![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)

# 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`:

```html
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:

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

and run:

```bash
npm install
npm start
```

To build the component for production, run:

```bash
npm run build
```

To run the unit tests for the components, run:

```bash
npm test
```

Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component).

## 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](https://docs.npmjs.com/getting-started/publishing-npm-packages).

### 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

---
_Source: https://npm.io/package/@classly/classly-business-webcomponents · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._