# @statuspage/status-widget

> A [Skate](https://github.com/skatejs/skatejs)-based web component for showing an embeddable status.

Latest version **1.0.5** (published 2024-06-26) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @statuspage/status-widget
pnpm add @statuspage/status-widget
yarn add @statuspage/status-widget
bun add @statuspage/status-widget
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2024-06-26 |
| First published | 2018-11-16 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10.13.0 |
| Dependencies | 5 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Atlassian Pty Ltd |
| Maintainers | Lee S |
| Keywords | statuspage, webcomponent, ui |

## Links

- npm: https://www.npmjs.com/package/@statuspage/status-widget
- Repository: https://bitbucket.org/atlassian/statuspage-status-widget
- npm.io page: https://npm.io/package/@statuspage/status-widget

## Dependencies (5)

- [skatejs](https://npm.io/package/skatejs.md) ^5.2.4
- [lit-html](https://npm.io/package/lit-html.md) ^0.13.0
- [whatwg-fetch](https://npm.io/package/whatwg-fetch.md) ^3.0.0
- [@skatejs/renderer-lit-html](https://npm.io/package/@skatejs/renderer-lit-html.md) ^0.2.2
- [@webcomponents/custom-elements](https://npm.io/package/@webcomponents/custom-elements.md) ^1.2.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2024-06-26
- 1.0.4 — 2019-07-02
- 1.0.3 — 2018-12-06
- 1.0.2 — 2018-12-03
- 1.0.1 — 2018-11-16
- 1.0.0 — 2018-11-16

## README

# status-widget

A [Skate](https://github.com/skatejs/skatejs)-based web component for showing an embeddable status.

## Usage

Include the [webcomponents.js](http://webcomponents.org/polyfills/) polyfill loader (for browsers who don't natively support web components), then import `status-widget`:

```html
<head>
  <!-- Required for IE11 Only -->
  <script src="https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js"></script>

  <!-- Standard dependencies -->
  <script src="https://unpkg.com/@webcomponents/webcomponentsjs@2.1.3/webcomponents-bundle.js"></script>
  <script src="https://unpkg.com/@statuspage/status-widget/dist/index.js"></script>
</head>
```

Then add the `statuspage-widget` to your page, providing a `src` attribute to the Statuspage you want to show the status for.

```html
<statuspage-widget src="https://metastatuspage.com"></statuspage-widget>
```

*** Properties ***

* `src` (required): url of Statuspage to be queried
* `appearance` (optional): the template to select for rendering (default: 'basic')
* `title` (optional): used by some templates as a heading or display text (default: 'system status')

## Developing, Testing, and Contributing

After cloning the repository, run `yarn` to install dependencies.

```shell
yarn
```

To start a local web server which hosts the demo page and assets:

```shell
yarn start
```

To run unit tests locally:

```shell
yarn test
```

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