2021-03-24 14:21:21 +00:00
|
|
|
import { LitElement } from 'lit';
|
2021-05-27 21:00:43 +00:00
|
|
|
import { customElement, property } from 'lit/decorators.js';
|
2022-03-24 12:01:09 +00:00
|
|
|
import { LocalizeController } from '../../utilities/localize';
|
2020-11-09 14:38:30 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @since 2.0
|
|
|
|
* @status stable
|
|
|
|
*/
|
2021-03-18 13:04:23 +00:00
|
|
|
@customElement('sl-format-number')
|
2021-03-09 00:14:32 +00:00
|
|
|
export default class SlFormatNumber extends LitElement {
|
2022-01-16 05:47:14 +00:00
|
|
|
private readonly localize = new LocalizeController(this);
|
2021-12-07 18:20:27 +00:00
|
|
|
|
2020-11-10 14:33:16 +00:00
|
|
|
/** The number to format. */
|
2021-07-01 00:04:46 +00:00
|
|
|
@property({ type: Number }) value = 0;
|
2020-11-09 14:38:30 +00:00
|
|
|
|
|
|
|
/** The locale to use when formatting the number. */
|
2021-12-02 15:29:04 +00:00
|
|
|
@property() lang: 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-07-01 00:04:46 +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-07-01 00:04:46 +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 '';
|
|
|
|
}
|
|
|
|
|
2021-12-07 18:20:27 +00:00
|
|
|
return this.localize.number(this.value, {
|
2020-11-09 14:38:30 +00:00
|
|
|
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
|
2021-12-07 18:20:27 +00:00
|
|
|
});
|
2020-11-09 14:38:30 +00:00
|
|
|
}
|
|
|
|
}
|
2021-03-12 14:07:38 +00:00
|
|
|
|
2021-03-12 14:09:08 +00:00
|
|
|
declare global {
|
|
|
|
interface HTMLElementTagNameMap {
|
|
|
|
'sl-format-number': SlFormatNumber;
|
|
|
|
}
|
|
|
|
}
|