/** Define a low dependency custom web component ECMA module that can be used as an HTML tag
*
* version 0.1 2022-05-17 Pre-release
*
* See: https://web.dev/custom-elements-v1/, https://web.dev/shadowdom-v1/
*
* See https://github.com/runem/web-component-analyzer#-how-to-document-your-components-using-jsdoc on how to document
* Use `npx web-component-analyzer ./components/button-send.js` to create/update the documentation
* or paste into https://runem.github.io/web-component-analyzer/
* Use `npx web-component-analyzer ./components/*.js --format vscode --outFile ./vscode-descriptors/ti-web-components.html-data.json`
* to generate/update vscode custom data files. See https://github.com/microsoft/vscode-custom-data/tree/main/samples/webcomponents
*
*/
/**
* Copyright (c) 2022 Julian Knight (Totally Information)
* https://it.knightnet.org.uk, https://github.com/TotallyInformation
*
* Licensed under the Apache License, Version 2.0 (the 'License');
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an 'AS IS' BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// https://frappe.io/charts
// @ts-ignore
import { Chart } from 'https://cdn.jsdelivr.net/npm/frappe-charts/dist/frappe-charts.esm.js' // eslint-disable-line import/no-unresolved
const componentName = 'chart-frappe'
const className = 'ChartFrappe'
const template = document.createElement('template')
template.innerHTML = /*html*/`
<style>
:host {
@import url(https://cdn.jsdelivr.net/npm/frappe-charts/dist/frappe-charts.min.css);
display: block; /* default is inline */
contain: content; /* performance boost */
background-color: var(--surface3);
width: 100%;
}
#chart {
max-width: 650px;
margin: 35px auto;
}
</style>
<div id="chart"></div>
<slot></slot>
`
// Define the class and make it the default export
/**
* @element chart-frappe
*
* fires chart-frappe:construction - Document object event. evt.details contains the data
* fires chart-frappe:connected - When an instance of the component is attached to the DOM. `evt.details` contains the details of the element.
* fires chart-frappe:disconnected - When an instance of the component is removed from the DOM. `evt.details` contains the details of the element.
* fires chart-frappe:attribChanged - When a watched attribute changes. `evt.details` contains the details of the change.
* NOTE that listeners can be attached either to the `document` or to the specific element instance.
*
* @property {string} name - Optional. Will be used to synthesize an ID if no ID is provided.
* attr {string} data-* - Optional. All data-* attributes are returned in the _meta prop as a _meta.data object.
*
* @slot Container contents
*
* @csspart ??? - Uses the uib-styles.css uibuilder master for variables where available.
*/
export default class ChartFrappe extends HTMLElement {
//#region ---- Class Variables ----
/** Standard _ui object to include in msgs */
_ui = {
type: componentName,
event: undefined,
id: undefined,
name: undefined,
data: undefined, // All of the data-* attributes as an object
}
/** Mini jQuery-like shadow dom selector (see constructor) */
$
/** Holds the name for this instance of the component */
name = undefined
/** Holds a count of how many instances of this component are on the page */
static _iCount = 0
//#endregion ---- ---- ---- ----
//#region ---- Utility Functions ----
//#endregion ---- ---- ---- ----
//#region ---- Event Handlers ----
/** Handle a `uibuilder:msg:_ui:update:${this.id}` custom event
* @param {CustomEvent} evt uibuilder `uibuilder:msg:_ui:update:${this.id}` custom event evt.details contains the data
*/
_uibMsgHandler(evt) {
// If there is a payload, we want to replace the slot - easiest done from the light DOM
// if ( evt['detail'].payload ) {
// const el = document.getElementById(this.id)
// el.innerHTML = evt['detail'].payload
// }
// If there is a payload, we want to replace the VALUE
// if ( evt['detail'].payload ) {
// const el = this.shadowRoot.getElementById('value')
// el.innerHTML = evt['detail'].payload
// }
}
//#endregion ---- ---- ---- ----
constructor() {
super()
this.attachShadow({ mode: 'open', delegatesFocus: true, })
.append(template.content.cloneNode(true))
this.$ = this.shadowRoot.querySelector.bind(this.shadowRoot)
this.dispatchEvent(new Event(`${componentName}:construction`, { bubbles: true, composed: true, }))
} // ---- end of constructor ----
// List all attribs we want to observe
static get observedAttributes() {
return [
'name'
]
}
// Runs when an observed attribute changes - Note: values are always strings
attributeChangedCallback(name, oldVal, newVal) {
// Don't bother if the new value same as old
if (oldVal === newVal) return
// Create a property from the value - WARN: Be careful with name clashes
this[name] = newVal
this.dispatchEvent(new CustomEvent(`${componentName}:attribChanged`, {
bubbles: true,
composed: true,
detail: {
id: this.id,
name: this.name,
attribute: name,
newVal: newVal,
oldVal: oldVal,
},
}))
} // --- end of attributeChangedCallback --- //
// Runs when an instance is added to the DOM
connectedCallback() {
++ChartFrappe._iCount // increment total instance count
// Create an id from name or calculation if needed
this.name = this.getAttribute('name')
if (!this.id) {
if (this.name) this.id = this.name.toLowerCase().replace(/\s/g, '_')
else this.id = `sc-${ChartFrappe._iCount}`
}
// Listen for a uibuilder msg that is targetted at this instance of the component
document.addEventListener(`uibuilder:msg:_ui:update:${this.id}`, this._uibMsgHandler.bind(this))
const data = {
labels: ['12am-3am', '3am-6pm', '6am-9am', '9am-12am',
'12pm-3pm', '3pm-6pm', '6pm-9pm', '9am-12am'
],
datasets: [
{
name: 'Some Data',
chartType: 'bar',
values: [25, 40, 30, 35, 8, 52, 17, -4],
},
{
name: 'Another Set',
chartType: 'line',
values: [25, 50, -10, 15, 18, 32, 27, 14],
}
],
}
const chart = new Chart(this.shadowRoot.getElementById('chart'), {
title: 'My Awesome Chart',
data: data,
type: 'axis-mixed', // or 'bar', 'line', 'scatter', 'pie', 'percentage'
height: 250,
// colors: ['#7cd6fd', '#743ee2']
})
this.dispatchEvent(new CustomEvent(`${componentName}:connected`, {
bubbles: true,
composed: true,
detail: {
id: this.id,
name: this.name,
},
}))
} // ---- end of connectedCallback ---- //
// Runs when an instance is removed from the DOM
disconnectedCallback() {
// NB: Dont decrement SimpleCard._iCount because that could lead to id nameclashes
// @ts-ignore
document.removeEventListener(`uibuilder:msg:_ui:update:${this.id}`, this._uibMsgHandler)
this.dispatchEvent(new CustomEvent(`${componentName}:disconnected`, {
bubbles: true,
composed: true,
detail: {
id: this.id,
name: this.name,
},
}))
} // ---- end of disconnectedCallback ---- //
} // ---- end of Class ---- //
/** Self register the class to global
* Enables new data lists to be dynamically added via JS
* and lets the static methods be called
*/
window[className] = ChartFrappe
// Self-register the HTML tag
customElements.define(componentName, ChartFrappe)