shoelace/src/components/progress-ring/progress-ring.ts

85 wiersze
2.7 KiB
TypeScript

import { html, LitElement } from 'lit';
import { customElement, property, query, state } from 'lit/decorators.js';
import { LocalizeController } from '~/utilities/localize';
import styles from './progress-ring.styles';
/**
* @since 2.0
* @status stable
*
* @slot - A label to show inside the ring.
*
* @csspart base - The component's internal wrapper.
* @csspart label - The progress ring label.
*
* @cssproperty --size - The diameter of the progress ring (cannot be a percentage).
* @cssproperty --track-width - The width of the track.
* @cssproperty --track-color - The color of the track.
* @cssproperty --indicator-color - The indicator color.
*/
@customElement('sl-progress-ring')
export default class SlProgressRing extends LitElement {
static styles = styles;
private readonly localize = new LocalizeController(this);
@query('.progress-ring__indicator') indicator: SVGCircleElement;
@state() indicatorOffset: string;
/** The current progress, 0 to 100. */
@property({ type: Number, reflect: true }) value = 0;
/** A custom label for the progress ring's aria label. */
@property() label = '';
/** The locale to render the component in. */
@property() lang: string;
updated(changedProps: Map<string, unknown>) {
super.updated(changedProps);
//
// This block is only required for Safari because it doesn't transition the circle when the custom properties
// change, possibly because of a mix of pixel + unit-less values in the calc() function. It seems like a Safari bug,
// but I couldn't pinpoint it so this works around the problem.
//
if (changedProps.has('percentage')) {
const radius = parseFloat(getComputedStyle(this.indicator).getPropertyValue('r'));
const circumference = 2 * Math.PI * radius;
const offset = circumference - (this.value / 100) * circumference;
this.indicatorOffset = `${offset}px`;
}
}
render() {
return html`
<div
part="base"
class="progress-ring"
role="progressbar"
aria-label=${this.label.length > 0 ? this.label : this.localize.term('progress')}
aria-valuemin="0"
aria-valuemax="100"
aria-valuenow="${this.value}"
style="--percentage: ${this.value / 100}"
>
<svg class="progress-ring__image">
<circle class="progress-ring__track"></circle>
<circle class="progress-ring__indicator" style="stroke-dashoffset: ${this.indicatorOffset}"></circle>
</svg>
<span part="label" class="progress-ring__label">
<slot></slot>
</span>
</div>
`;
}
}
declare global {
interface HTMLElementTagNameMap {
'sl-progress-ring': SlProgressRing;
}
}