@public-ui/components
Version:
Contains all web components that belong to KoliBri - The accessible HTML-Standard.
171 lines (162 loc) • 15.9 kB
JavaScript
/*!
* KoliBri - The accessible HTML-Standard
*/
'use strict';
var index = require('./index-BrhW8s5h.js');
var variantQuote = require('./variant-quote-DpNzmCtr.js');
var i18n = require('./i18n-Cjy0vgJA.js');
require('./common-DPb6NWR4.js');
var label = require('./label-DRrPbj-j.js');
var valueNumberClamped = require('./value-number-clamped-Ahfs15Fl.js');
var normalizers = require('./normalizers-BCLslVaT.js');
var baseController = require('./base-controller-DAzsTqX9.js');
require('./i18n-CgUN6lev.js');
require('./_Uint8Array-BAQUGozM.js');
require('./isArray-BOIOdEQh.js');
const progressVariantOptions = ['bar', 'cycle'];
const variantProgressProp = normalizers.createPropDefinition('variant', 'bar', (value) => {
const str = normalizers.normalizeString(value);
if (progressVariantOptions.includes(str)) {
return str;
}
throw new Error(`Invalid progress variant: ${str}`);
}, () => true);
const FULL_CIRCLE = 342;
const CycleSvg = ({ max, value }) => (index.h("svg", { width: "100", viewBox: "0 0 120 120", xmlns: "http://www.w3.org/2000/svg" }, index.h("circle", { class: "kol-progress__cycle-background", cx: "60", cy: "60", r: "54.5", fill: "currentColor", stroke: "currentColor", "stroke-width": "8" }), index.h("circle", { class: "kol-progress__cycle-whitespace", cx: "60", cy: "60", r: "59", fill: "currentColor", stroke: "currentColor", "stroke-width": "3" }), index.h("circle", { class: "kol-progress__cycle-border", cx: "60", cy: "60", r: "59", fill: "currentColor", stroke: "currentColor", "stroke-width": "1" }), index.h("circle", { class: "kol-progress__cycle-whitespace", cx: "60", cy: "60", r: "51", fill: "currentColor", stroke: "currentColor", "stroke-width": "1" }), index.h("circle", { class: "kol-progress__cycle-border", cx: "60", cy: "60", r: "50", fill: "currentColor", stroke: "currentColor", "stroke-width": "1" }), index.h("circle", { class: "kol-progress__cycle-progress", fill: "currentColor", stroke: "currentColor", "stroke-linecap": "round", "stroke-dasharray": `${Math.round((value / max) * FULL_CIRCLE)}px ${FULL_CIRCLE}px`, "stroke-width": "6", cx: "60", cy: "60", r: "54.5" })));
const BarSvg = ({ max, value }) => {
const percentage = 100 * (value / max);
return (index.h("svg", { xmlns: "http://www.w3.org/2000/svg", width: "100%", height: "12", overflow: "visible" }, index.h("rect", { class: "kol-progress__bar-background", x: "1", y: "1", height: "11", rx: "5", fill: "currentColor", stroke: "currentColor", "stroke-width": "3", width: "100%" }), index.h("rect", { class: "kol-progress__bar-border", x: "1", y: "1", height: "11", rx: "5", fill: "currentColor", stroke: "currentColor", "stroke-width": "1", width: "100%" }), index.h("rect", { class: "kol-progress__bar-progress", x: "3", y: "3", height: "7", rx: "3.5", fill: "currentColor", stroke: "currentColor", "stroke-width": "3", style: { width: `calc(${percentage}% - 4px)` } })));
};
const createProgressSVG = (variant, max, value) => {
switch (variant) {
case 'cycle':
return index.h(CycleSvg, { max: max, value: value });
case 'bar':
return index.h(BarSvg, { max: max, value: value });
default:
throw new Error(`Progress variant ${variant} not implemented.`);
}
};
const ProgressFC = (props) => {
const { label, max, unit, value, variant, liveValue } = props;
const isPercentage = unit === '%';
const liveProgressValue = isPercentage ? `${Math.round((liveValue / max) * 100)}` : liveValue;
const displayValue = isPercentage ? Math.round((value / max) * 100) : value;
const valueColumnWidth = `${`${(isPercentage ? 100 : max) + 1}`.length}ch`;
const liveValueText = isPercentage
? i18n.translate('kol-live-value', { placeholders: { value: String(liveProgressValue), unit } })
: i18n.translate('kol-live-value-bounded', { placeholders: { value: String(liveProgressValue), max: String(max), unit } });
return (index.h("div", { class: "kol-progress" }, index.h("div", { "aria-hidden": "true", class: {
'kol-progress__cycle': variant === 'cycle',
'kol-progress__bar': variant === 'bar',
} }, variant === 'bar' && label && index.h("div", { class: "kol-progress__bar-label" }, label), createProgressSVG(variant, max, value), variant === 'cycle' && (index.h("div", { class: "kol-progress__cycle-text" }, label && index.h("div", { class: "kol-progress__cycle-label" }, label), index.h("div", { class: "kol-progress__cycle-value" }, `${displayValue} ${unit}`))), variant === 'bar' && (index.h("div", { class: "kol-progress__bar-value", style: { width: valueColumnWidth } }, displayValue)), variant === 'bar' && index.h("div", { class: "kol-progress__bar-unit" }, unit)), index.h("progress", { class: "visually-hidden", "aria-busy": value < max ? 'true' : 'false', max: max, value: value }), index.h("span", { "aria-live": "polite", "aria-relevant": "removals text", class: "visually-hidden" }, liveValueText)));
};
const progressPropsConfig = {
optional: [label.labelProp, valueNumberClamped.unitProp, variantProgressProp],
required: [valueNumberClamped.maxProp, valueNumberClamped.clampedNumberValueProp],
};
class ProgressController extends baseController.BaseController {
constructor(stateAccess) {
super(stateAccess, progressPropsConfig);
}
componentWillLoad(props) {
const { label, max, unit, value, variant } = props;
this.watchLabel(label);
this.watchMax(max);
this.watchUnit(unit);
this.watchValue(value);
this.watchVariant(variant);
this.setState('liveValue', this.getRenderProp('value'));
this.startLiveValueInterval();
}
watchLabel(value) {
label.labelProp.apply(value, (v) => {
this.setRenderProp('label', v);
});
}
watchMax(value) {
valueNumberClamped.maxProp.apply(value, (v) => {
this.setRenderProp('max', v);
this.watchValue(this.getRawProp('value'));
});
}
watchUnit(value) {
valueNumberClamped.unitProp.apply(value, (v) => {
this.setRenderProp('unit', v);
});
}
watchValue(value) {
this.setRawProp('value', value);
valueNumberClamped.clampedNumberValueProp.apply(value, (v) => {
this.setRenderProp('value', v);
}, { min: 0, max: this.getRenderProp('max') });
}
watchVariant(value) {
variantProgressProp.apply(value, (v) => {
this.setRenderProp('variant', v);
});
}
startLiveValueInterval() {
this.interval = setInterval(() => {
const value = this.getRenderProp('value');
this.setState('liveValue', value);
}, 5000);
}
destroy() {
if (this.interval) {
clearInterval(this.interval);
this.interval = undefined;
}
}
}
const defaultStyleCss = "/* forward the rem function */\n/*\n* This file defines the layer order for all CSS layers used in KoliBri.\n* The order is important as it determines the cascade priority.\n*\n* Layer order (lowest to highest priority):\n* 1. kol-a11y - Accessibility defaults and requirements\n* 2. kol-global - Global component styles and resets\n* 3. kol-component - Component-specific styles\n* 4. kol-theme-global - Theme-specific global styles\n* 5. kol-theme-component - Theme-specific component styles\n*/\n@layer kol-a11y, kol-global, kol-component, kol-theme-global, kol-theme-component;\n/*\n * This file contains all rules for accessibility.\n */\n@layer kol-a11y {\n :host {\n /*\n * Minimum size of interactive elements.\n */\n --a11y-min-size: calc(44 * 1rem / var(--kolibri-root-font-size, 16));\n /*\n * No element should be used without verifying the contrast ratio of its background and font colors.\n * By initially setting the background color to white and the font color to black,\n * the contrast ratio is ensured and explicit adjustment is forced.\n */\n color: black;\n background-color: white;\n /*\n * Verdana is an accessible font that can be used without requiring additional loading time.\n */\n font-family: Verdana;\n /*\n * Letter spacing is required for all texts.\n */\n letter-spacing: inherit;\n /*\n * Word spacing is required for all texts.\n */\n word-spacing: inherit;\n /*\n * Text should be aligned left by default to provide a predictable starting point.\n */\n text-align: left;\n }\n * {\n /*\n * This rule enables the word dividing for all texts. That is important for high zoom levels.\n */\n hyphens: auto;\n /*\n * This rule enables the word dividing for all texts. That is important for high zoom levels.\n */\n word-break: break-word;\n }\n /*\n * All interactive elements should have a minimum size of to-rem(44).\n */\n /* input:not([type='checkbox'], [type='radio'], [type='range']), */\n /* option, */\n /* select, */\n /* textarea, */\n button,\n .kol-input .input {\n min-width: var(--a11y-min-size);\n min-height: var(--a11y-min-size);\n }\n /*\n * Some interactive elements should not inherit the font-family and font-size.\n */\n a,\n button,\n h1,\n h2,\n h3,\n h4,\n h5,\n h6,\n input,\n option,\n select,\n textarea {\n /*\n * All elements should inherit the text color from his parent element.\n */\n color: inherit;\n /*\n * All elements should inherit the font family from his parent element.\n */\n font-family: inherit;\n /*\n * All elements should inherit the font size from his parent element.\n */\n font-size: inherit;\n /*\n * Letter spacing is required for all texts.\n */\n letter-spacing: inherit;\n /*\n * Word spacing is required for all texts.\n */\n word-spacing: inherit;\n }\n /**\n * Sometimes we need the semantic element for accessibility reasons,\n * but we don't want to show it.\n *\n * - https://www.a11yproject.com/posts/how-to-hide-content/\n */\n .visually-hidden {\n position: fixed;\n top: 0;\n left: 0;\n width: 1px;\n height: 1px;\n overflow: hidden;\n white-space: nowrap;\n clip-path: inset(50%);\n }\n}\n@layer kol-global {\n /*\n * Dieses CSS stellt sicher, dass der Standard-Style\n * von A und Button resettet werden.\n */\n :is(a, button) {\n background-color: transparent;\n width: 100%;\n margin: 0;\n padding: 0;\n border: none;\n /* 100% needed for custom width from outside */\n }\n /*\n * Ensure elements with hidden attribute to be actually not visible\n * @see https://meowni.ca/hidden.is.a.lie.html\n */\n [hidden] {\n display: none !important;\n }\n .badge-text-hint {\n color: black;\n background-color: white;\n }\n}\n@layer kol-global {\n :host {\n /*\n * The max-width is needed to prevent the table from overflowing the\n * parent node, if the table is wider than the parent node.\n */\n max-width: 100%;\n font-size: calc(16 * 1rem / var(--kolibri-root-font-size, 16));\n }\n * {\n /*\n * We prefer to box-sizing: border-box for all elements.\n */\n box-sizing: border-box;\n }\n .kol-span {\n /* KolSpan is a layout component with icons in all directions and a label text in the middle. */\n display: flex;\n flex-flow: column;\n align-items: center;\n justify-content: center;\n /* The sub span in KolSpan is the horizontal span with icon left and right and the label text in the middle. */\n }\n .kol-span__container {\n display: flex;\n align-items: center;\n }\n a,\n button {\n cursor: pointer;\n }\n .kol-span .kol-span__label--hide-label .kol-span__label {\n display: none;\n }\n /* Reset browser agent style. */\n button:disabled {\n color: unset;\n }\n .disabled label,\n .disabled:focus-within label,\n [aria-disabled=true],\n [aria-disabled=true]:focus,\n [disabled],\n [disabled]:focus {\n outline: none;\n cursor: not-allowed;\n }\n [aria-disabled=true]:focus .kol-span,\n [disabled]:focus .kol-span {\n outline: none !important;\n }\n .hastooltip {\n z-index: 900 !important;\n }\n}\n@layer kol-component {\n .kol-progress {\n --color-bar: var(--kol-progress-color-bar, #0075ff);\n }\n .kol-progress__bar {\n display: grid;\n align-items: center;\n grid-template-areas: \"LABEL LABEL LABEL\" \"BAR VALUE UNIT\";\n grid-template-columns: 1fr auto;\n }\n .kol-progress__bar-label {\n grid-column-end: 2;\n grid-area: LABEL;\n }\n .kol-progress__bar svg {\n grid-area: BAR;\n }\n .kol-progress__bar-value {\n grid-area: VALUE;\n text-align: right;\n }\n .kol-progress__bar-unit {\n grid-area: UNIT;\n }\n .kol-progress__bar-border {\n fill: transparent;\n stroke: black;\n }\n .kol-progress__bar-background {\n fill: white;\n stroke: white;\n }\n .kol-progress__bar-progress {\n fill: var(--color-bar);\n stroke: transparent;\n }\n @media (prefers-reduced-motion: no-preference) {\n .kol-progress__bar-progress {\n transition: 250ms ease-in-out 50ms;\n }\n }\n .kol-progress__cycle {\n display: grid;\n align-content: center;\n justify-items: center;\n grid-template-areas: \"ALL\";\n grid-template-columns: auto;\n }\n .kol-progress__cycle > * {\n grid-area: ALL;\n }\n .kol-progress__cycle-text {\n display: flex;\n flex-direction: column;\n justify-content: center;\n font-size: x-small;\n text-align: center;\n }\n .kol-progress__cycle-text * {\n background-color: white;\n }\n .kol-progress__cycle-background {\n fill: transparent;\n stroke: white;\n }\n .kol-progress__cycle-border {\n fill: transparent;\n stroke: black;\n }\n .kol-progress__cycle-whitespace {\n fill: transparent;\n stroke: white;\n }\n .kol-progress__cycle-progress {\n transform: rotate(-90deg);\n transform-origin: 50% 50%;\n fill: transparent;\n stroke: var(--color-bar);\n }\n @media (prefers-reduced-motion: no-preference) {\n .kol-progress__cycle-progress {\n transition: 250ms ease-in-out 50ms;\n }\n }\n}";
const KolProgress = class extends variantQuote.BaseWebComponent {
constructor(hostRef) {
super();
index.registerInstance(this, hostRef);
this.ctrl = new ProgressController(this.stateAccess);
this.liveValue = 0;
}
watchLabel(value) {
this.ctrl.watchLabel(value);
}
watchMax(value) {
this.ctrl.watchMax(value);
}
watchUnit(value) {
this.ctrl.watchUnit(value);
}
watchValue(value) {
this.ctrl.watchValue(value);
}
watchVariant(value) {
this.ctrl.watchVariant(value);
}
componentWillLoad() {
this.ctrl.componentWillLoad({
label: this._label,
max: this._max,
unit: this._unit,
value: this._value,
variant: this._variant,
});
}
disconnectedCallback() {
this.ctrl.destroy();
}
render() {
return (index.h(index.Host, { key: '875e3cb3b7b18f3a73be1115a577e7681e7f2c6d' }, index.h(ProgressFC, { key: '89fc086cc42ec754a47faf0ee6ba99800aac90dd', label: this.ctrl.getRenderProp('label'), max: this.ctrl.getRenderProp('max'), unit: this.ctrl.getRenderProp('unit'), value: this.ctrl.getRenderProp('value'), variant: this.ctrl.getRenderProp('variant'), liveValue: this.liveValue })));
}
static get watchers() { return {
"_label": ["watchLabel"],
"_max": ["watchMax"],
"_unit": ["watchUnit"],
"_value": ["watchValue"],
"_variant": ["watchVariant"]
}; }
};
KolProgress.style = {
default: defaultStyleCss
};
exports.kol_progress = KolProgress;
//# sourceMappingURL=kol-progress.entry.cjs.js.map