shoelace/src/components/format-number/format-number.ts

61 wiersze
2.3 KiB
TypeScript
Czysty Zwykły widok Historia

import { LitElement, property } from 'lit-element';
import { tag } from '../../internal/decorators';
2020-11-09 14:38:30 +00:00
/**
* @since 2.0
* @status stable
*/
@tag('sl-format-number')
2021-03-06 17:01:39 +00:00
export class SlFormatNumber extends LitElement {
2020-11-10 14:33:16 +00:00
/** The number to format. */
2021-03-06 17:01:39 +00:00
@property({ type: Number }) value = 0;
2020-11-09 14:38:30 +00:00
/** The locale to use when formatting the number. */
2021-03-06 17:01:39 +00:00
@property() locale: string;
2020-11-09 14:38:30 +00:00
/** The formatting style to use. */
2021-03-06 17:01:39 +00:00
@property() type: 'currency' | 'decimal' | 'percent' = 'decimal';
2020-11-09 14:38:30 +00:00
/** Turns off grouping separators. */
2021-03-06 20:18:54 +00:00
@property({ attribute: 'no-grouping', type: Boolean }) noGrouping = false;
2020-11-09 14:38:30 +00:00
/** The currency to use when formatting. Must be an ISO 4217 currency code such as `USD` or `EUR`. */
2021-03-06 17:01:39 +00:00
@property() currency = 'USD';
2020-11-09 14:38:30 +00:00
/** How to display the currency. */
2021-03-06 17:01:39 +00:00
@property({ attribute: 'currency-display' }) currencyDisplay: 'symbol' | 'narrowSymbol' | 'code' | 'name' = 'symbol';
2020-11-09 14:38:30 +00:00
/** The minimum number of integer digits to use. Possible values are 1 - 21. */
2021-03-06 17:01:39 +00:00
@property({ attribute: 'minimum-integer-digits', type: Number }) minimumIntegerDigits: number;
2020-11-09 14:38:30 +00:00
/** The minimum number of fraction digits to use. Possible values are 0 - 20. */
2021-03-06 17:01:39 +00:00
@property({ attribute: 'minimum-fraction-digits', type: Number }) minimumFractionDigits: number;
2020-11-09 14:38:30 +00:00
/** The maximum number of fraction digits to use. Possible values are 0 - 20. */
2021-03-06 17:01:39 +00:00
@property({ attribute: 'maximum-fraction-digits', type: Number }) maximumFractionDigits: number;
2020-11-09 14:38:30 +00:00
/** The minimum number of significant digits to use. Possible values are 1 - 21. */
2021-03-06 17:01:39 +00:00
@property({ attribute: 'minimum-significant-digits', type: Number }) minimumSignificantDigits: number;
2020-11-09 14:38:30 +00:00
/** The maximum number of significant digits to use,. Possible values are 1 - 21. */
2021-03-06 17:01:39 +00:00
@property({ attribute: 'maximum-significant-digits', type: Number }) maximumSignificantDigits: number;
2020-11-09 14:38:30 +00:00
render() {
2020-11-10 14:33:16 +00:00
if (isNaN(this.value)) {
2020-11-09 14:38:30 +00:00
return '';
}
return new Intl.NumberFormat(this.locale, {
style: this.type,
currency: this.currency,
currencyDisplay: this.currencyDisplay,
useGrouping: !this.noGrouping,
minimumIntegerDigits: this.minimumIntegerDigits,
minimumFractionDigits: this.minimumFractionDigits,
maximumFractionDigits: this.maximumFractionDigits,
minimumSignificantDigits: this.minimumSignificantDigits,
maximumSignificantDigits: this.maximumSignificantDigits
2020-11-10 14:33:16 +00:00
}).format(this.value);
2020-11-09 14:38:30 +00:00
}
}