@luzmo/lucero 1.0.1-alpha.39 → 1.0.1-alpha.40

package/components/number-field/number-field.d.ts

@@ -12,9 +12,26 @@ export declare const remapMultiByteCharacters: Record<string, string>;
  * @slot negative-help-text - negative help text to associate to your form element when `invalid`
  */
 export declare class LuzmoNumberField extends LuzmoTextFieldBase {
+    /**
+     * The styles for the number field.
+     * @internal
+     */
     static get styles(): CSSResultArray;
+    /**
+     * The buttons for the number field.
+     * @internal
+     */
     private buttons;
+    /**
+     * Whether the number field is focused.
+     * @default false
+     * @type {boolean}
+     */
     focused: boolean;
+    /**
+     * The forced unit for the number field.
+     * @internal
+     */
     _forcedUnit: string;
     /**
      * An `<luzmo-number-field>` element will process its numeric value with
@@ -27,43 +44,147 @@ export declare class LuzmoNumberField extends LuzmoTextFieldBase {
     formatOptions: Intl.NumberFormatOptions;
     /**
      * Whether the stepper UI is hidden or not.
+     * @attribute {boolean} hide-stepper
+     * @default false
+     * @type {boolean}
      */
     hideStepper: boolean;
+    /**
+     * Whether the number field should grow to fit the content.
+     * @default false
+     * @type {boolean}
+     */
+    grows: boolean;
+    /**
+     * Whether the number field is indeterminate (temporary UI state)
+     * @default false
+     * @type {boolean}
+     */
     indeterminate: boolean;
+    /**
+     * Whether the number field is keyboard focused.
+     * @default false
+     * @type {boolean}
+     */
     keyboardFocused: boolean;
+    /**
+     * The maximum value for the number field.
+     * @default undefined
+     * @type {number}
+     */
     max?: number;
+    /**
+     * The minimum value for the number field.
+     * @default undefined
+     * @type {number}
+     */
     min?: number;
     /**
      * The distance by which to alter the value of the element when taking a "step".
      *
      * When `this.formatOptions.style === 'percentage'` the default step will be
      * set to 0.01 unless otherwise supplied to the element.
+     * @default undefined
+     * @type {number}
      */
     step?: number;
+    /**
+     * Whether the number field is managed input.
+     * @internal
+     */
     managedInput: boolean;
+    /**
+     * The modifier for the step.
+     * @default 10
+     * @type {number}
+     */
     stepModifier: number;
     set value(rawValue: number);
     get value(): number;
     private get inputValue();
+    /**
+     * The value of the number field.
+     * @internal
+     */
     _value: number;
+    /**
+     * The value of the number field being tracked.
+     * @internal
+     */
     private _trackingValue;
+    /**
+     * The last committed value of the number field.
+     * @internal
+     */
     private lastCommitedValue?;
+    /**
+     * Set the value of the number field.
+     * @internal
+     */
     private setValue;
     /**
      * Retreive the value of the element parsed to a Number.
+     * @internal
      */
     get valueAsString(): string;
+    /**
+     * Set the value of the number field as a string.
+     * @internal
+     */
     set valueAsString(value: string);
+    /**
+     * The formatted value of the number field.
+     */
     get formattedValue(): string;
+    /**
+     * The decimals characters for the number field.
+     * @internal
+     */
     private decimalsChars;
+    /**
+     * The value before focus of the number field.
+     * @internal
+     */
     private valueBeforeFocus;
+    /**
+     * Whether the number field is intenting to use a decimal separator.
+     * @internal
+     */
     private isIntentDecimal;
+    /**
+     * Convert the input value to a number.
+     * @internal
+     */
     private convertValueToNumber;
+    /**
+     * The step for the number field.
+     * @internal
+     */
     private get _step();
+    /**
+     * The next change for the number field.
+     * @internal
+     */
     private nextChange;
+    /**
+     * The change count for the number field.
+     * @internal
+     */
     private changeCount;
+    /**
+     * The find change for the number field.
+     * @internal
+     */
     private findChange;
+    /**
+     * The change for the number field.
+     * @internal
+     */
     private change;
+    /**
+     * The safty for the number field.
+     * @internal
+     */
     private safty;
     private languageResolver;
     private handlePointerdown;
@@ -97,12 +218,36 @@ export declare class LuzmoNumberField extends LuzmoTextFieldBase {
     protected get numberFormatter(): NumberFormatter;
     protected clearValueFormatterCache(): void;
     protected get valueFormatter(): NumberFormatter;
+    /**
+     * The number formatter for the number field.
+     * @internal
+     */
     private _numberFormatter?;
+    /**
+     * The number formatter for the number field when focused.
+     * @internal
+     */
     private _numberFormatterFocused?;
+    /**
+     * The value formatter for the number field.
+     * @internal
+     */
     private _valueFormatter?;
+    /**
+     * The number parser for the number field.
+     * @internal
+     */
     protected get numberParser(): NumberParser;
     applyFocusElementLabel: (value?: string) => void;
+    /**
+     * The number parser for the number field.
+     * @internal
+     */
     private _numberParser?;
+    /**
+     * The number parser for the number field when focused.
+     * @internal
+     */
     private _numberParserFocused?;
     protected renderField(): TemplateResult;
     protected update(changes: PropertyValues): void;