@statuspage/status-widget
v1.0.5
Published
A [Skate](https://github.com/skatejs/skatejs)-based web component for showing an embeddable status.
Downloads
4,376
Readme
status-widget
A Skate-based web component for showing an embeddable status.
Usage
Include the webcomponents.js polyfill loader (for browsers who don't natively support web components), then import status-widget
:
<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/[email protected]/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.
<statuspage-widget src="https://metastatuspage.com"></statuspage-widget>
*** Properties ***
src
(required): url of Statuspage to be queriedappearance
(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.
yarn
To start a local web server which hosts the demo page and assets:
yarn start
To run unit tests locally:
yarn test