lit-service-status-component
v0.0.3
Published
Service status component built with lit
Downloads
11
Maintainers
vdvgiomReadme
lit-service-status-component
This is a web component built with Lit that reveals the status of a service.
The component provides a simple overview of the availability of the service. This by querying the health check of the service.
The following properties of the component are adjustable:
Properties
| Property | Attribute | Description | Type | Default |
| ------------------------- | --------------- | ----------- | -------- | ----------- |
| apiToCheck (required) | api-to-check | | string | undefined |
| offlineColor | offline-color | | string | 'red' |
| offlineText | offline-text | | string | 'Offline' |
| onlineColor | online-color | | string | 'green' |
| onlineText | online-text | | string | 'Online' |
| status | status | | string | undefined |
Getting Started
To use the component, first install this package
npm i lit-service-status-componentThen you add the component in your HTML page and reference the script. Change the necessary attributes as you wish.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Test</title>
<script type="module" src="/node_modules/d09-service-status/dist/d09-service-status/d09-service-status.esm.js"></script>
</head>
<body>
<d09-service-status-component
api-to-check="https://apidgdv.gent.be/supporting/communication-platform-core/v1/status/am-i-up"
online-text="Up"
offline-text="Down"
online-color="#BDD68D"
offline-color="#E89393"
></d09-service-status-component>
</body>
</html>Production & Development
There are a number of points of attention when using lit elements read : https://lit.dev/docs/tools/development/ The component was tested with the web dev server approach :
Local dev servers Permalink to “Local dev servers”# Lit is packaged as JavaScript modules, and it uses bare module specifiers that are not yet natively supported in most browsers. Bare specifiers are commonly used, and you may want to use them in your own code as well. For example:
import {LitElement, html, css} from 'lit';To run this code in the browser, the bare specifier ('lit') needs to be transformed to a URL that the browser can load (such as '/node_modules/lit/lit.js').
There are many development servers that can deal with module specifiers. If you already have a dev server that does this and integrates with your build process, that should be sufficient.
If you need a dev server, we recommend Web Dev Server.