ayo/lion
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(form-core): align on common Intl type formatOptions

Browse source
This commit is contained in:
Joren Broekema 2020-09-14 18:36:07 +02:00 committed by Thomas Allmer
parent b01cacbded
commit b9327627c6
3 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.changeset/tiny-ears-agree.md Normal file
View file

@ -0,0 +1,6 @@
---
'@lion/form-core': patch
'@lion/localize': patch
---
These packages were using out of sync type definitions for FormatOptions, and the types were missing a bunch of options that Intl would normally accept. We now extend Intl's NumberFormatOptions and DateTimeFormatOptions properly, so we always have the right types and are more consistent on it.

5
packages/form-core/src/FormatMixin.js
View file

@ -7,7 +7,7 @@ import { ValidateMixin } from './validate/ValidateMixin.js';
/** /**
* @typedef {import('../types/FormatMixinTypes').FormatMixin} FormatMixin * @typedef {import('../types/FormatMixinTypes').FormatMixin} FormatMixin
* @typedef {import('../types/FormatMixinTypes').FormatOptions} FormatOptions * @typedef {import('@lion/localize/types/LocalizeMixinTypes').FormatNumberOptions} FormatOptions
*/ */
// For a future breaking release: // For a future breaking release:
@ -357,8 +357,7 @@ const FormatMixinImplementation = superclass =>
constructor() { constructor() {
super(); super();
this.formatOn = 'change'; this.formatOn = 'change';
/** @type {FormatOptions} */ this.formatOptions = /** @type {FormatOptions} */ ({});
this.formatOptions = {};
} }
connectedCallback() { connectedCallback() {

12
packages/form-core/types/FormatMixinTypes.d.ts vendored
View file

@ -1,24 +1,20 @@
import { Constructor } from '@open-wc/dedupe-mixin'; import { Constructor } from '@open-wc/dedupe-mixin';
import { LitElement } from '@lion/core'; import { LitElement } from '@lion/core';
import { FormatNumberOptions } from '@lion/localize/types/LocalizeMixinTypes';
import { ValidateHost } from './validate/ValidateMixinTypes'; import { ValidateHost } from './validate/ValidateMixinTypes';
import { FormControlHost } from './FormControlMixinTypes'; import { FormControlHost } from './FormControlMixinTypes';
export declare interface FormatOptions {
locale?: string;
decimalSeparator?: string;
}
export declare class FormatHost { export declare class FormatHost {
formattedValue: string; formattedValue: string;
serializedValue: string; serializedValue: string;
formatOn: string; formatOn: string;
formatOptions: FormatOptions; formatOptions: FormatNumberOptions;
value: string; value: string;
__preventRecursiveTrigger: boolean; __preventRecursiveTrigger: boolean;
__isHandlingUserInput: boolean; __isHandlingUserInput: boolean;
parser(v: string, opts: FormatOptions): unknown; parser(v: string, opts: FormatNumberOptions): unknown;
formatter(v: unknown, opts: FormatOptions): string; formatter(v: unknown, opts: FormatNumberOptions): string;
serializer(v: unknown): string; serializer(v: unknown): string;
deserializer(v: string): unknown; deserializer(v: string): unknown;