@synergy-design-system/components
Version:
This package provides the base of the Synergy Design System as native web components. It uses [lit](https://www.lit.dev) and parts of [shoelace](https://shoelace.style/). Synergy officially supports the latest two versions of all major browsers (as define
246 lines (245 loc) • 12.7 kB
TypeScript
/**
* ---------------------------------------------------------------------
* 🔒 AUTOGENERATED BY VENDORISM
* Removing this comment will prevent it from being managed by it.
* ---------------------------------------------------------------------
*/
import SynergyElement from '../../internal/synergy-element.js';
import SynIcon from '../icon/icon.component.js';
import SynDivider from '../divider/divider.component.js';
import type { CSSResultGroup } from 'lit';
import type { SynergyFormControl } from '../../internal/synergy-element.js';
import { type NumericStrategy } from './strategies.js';
/**
* @summary Inputs collect data from the user.
* @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-input--docs
* @status stable
* @since 2.0
*
* @dependency syn-icon
* @dependency syn-divider
*
* @slot label - The input's label. Alternatively, you can use the `label` attribute.
* @slot prefix - Used to prepend a presentational icon or similar element to the input.
* @slot suffix - Used to append a presentational icon or similar element to the input.
* @slot clear-icon - An icon to use in lieu of the default clear icon.
* @slot show-password-icon - An icon to use in lieu of the default show password icon.
* @slot hide-password-icon - An icon to use in lieu of the default hide password icon.
* @slot help-text - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.
* @slot increment-number-stepper - An icon to use in lieu of the default increment number stepper icon.
* @slot decrement-number-stepper - An icon to use in lieu of the default decrement number stepper icon.
*
* @event syn-blur - Emitted when the control loses focus.
* @event syn-change - Emitted when an alteration to the control's value is committed by the user.
* @event syn-clear - Emitted when the clear button is activated.
* @event syn-focus - Emitted when the control gains focus.
* @event syn-input - Emitted when the control receives input.
* @event syn-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
* @event syn-clamp - Emitted if the numeric strategy allows autoClamp and the value is clamped to the min or max attribute.
*
* @csspart form-control - The form control that wraps the label, input, and help text.
* @csspart form-control-label - The label's wrapper.
* @csspart form-control-input - The input's wrapper.
* @csspart form-control-help-text - The help text's wrapper.
* @csspart base - The component's base wrapper.
* @csspart input - The internal `<input>` control.
* @csspart prefix - The container that wraps the prefix.
* @csspart clear-button - The clear button.
* @csspart password-toggle-button - The password toggle button.
* @csspart suffix - The container that wraps the suffix.
* @csspart stepper - The container that wraps the number stepper.
* @csspart decrement-number-stepper - The decrement number stepper button.
* @csspart increment-number-stepper - The increment number stepper button.
* @csspart divider - The divider between the increment and decrement number stepper buttons.
*
* @cssproperty --syn-input-autofill-shadow - The shadow to apply when the input is autofilled.
* @cssproperty --syn-input-autofill-readonly-shadow - The shadow to apply when the input is readonly and autofilled.
* @cssproperty --syn-input-autofill-text-fill-color - The text fill color to apply when the input is autofilled.
* @cssproperty --syn-input-autofill-caret-color - The caret color to apply when the input is autofilled.
*/
export default class SynInput extends SynergyElement implements SynergyFormControl {
#private;
static styles: CSSResultGroup;
static dependencies: {
'syn-icon': typeof SynIcon;
'syn-divider': typeof SynDivider;
};
private readonly formControlController;
private readonly hasSlotController;
private readonly localize;
input: HTMLInputElement;
private hasFocus;
title: string;
private __numberInput;
private __dateInput;
/**
* The type of input. Works the same as a native `<input>` element, but only a subset of types are supported. Defaults
* to `text`.
*/
type: 'date' | 'datetime-local' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'text' | 'time' | 'url';
/** The name of the input, submitted as a name/value pair with form data. */
name: string;
/** The current value of the input, submitted as a name/value pair with form data. */
value: string;
/** The default value of the form control. Primarily used for resetting the form control. */
defaultValue: string;
/** The input's size. */
size: 'small' | 'medium' | 'large';
/** The input's label. If you need to display HTML, use the `label` slot instead. */
label: string;
/** The input's help text. If you need to display HTML, use the `help-text` slot instead. */
helpText: string;
/** Adds a clear button when the input is not empty. */
clearable: boolean;
/** Disables the input. */
disabled: boolean;
/** Placeholder text to show as a hint when the input is empty. */
placeholder: string;
/** Makes the input readonly. */
readonly: boolean;
/** Adds a button to toggle the password's visibility. Only applies to password types. */
passwordToggle: boolean;
/** Determines whether or not the password is currently visible. Only applies to password input types. */
passwordVisible: boolean;
/** Hides the increment/decrement spin buttons for number inputs. */
noSpinButtons: boolean;
/**
* By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you
* to place the form control outside of a form and associate it with the form that has this `id`. The form must be in
* the same document or shadow root for this to work.
*/
form: string;
/** Makes the input a required field. */
required: boolean;
/** A regular expression pattern to validate input against. */
pattern: string;
/** The minimum length of input that will be considered valid. */
minlength: number;
/** The maximum length of input that will be considered valid. */
maxlength: number;
/** The input's minimum value. Only applies to date and number input types. */
min: number | string;
/** The input's maximum value. Only applies to date and number input types. */
max: number | string;
/**
* Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is
* implied, allowing any numeric value. Only applies to date and number input types.
*/
step: number | 'any';
/** Controls whether and how text input is automatically capitalized as it is entered by the user. */
autocapitalize: 'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters';
/** Indicates whether the browser's autocorrect feature is on or off. */
autocorrect: 'off' | 'on';
/**
* Specifies what permission the browser has to provide assistance in filling out form field values. Refer to
* [this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.
*/
autocomplete: string;
/** Indicates that the input should receive focus on page load. */
autofocus: boolean;
/** Used to customize the label or icon of the Enter key on virtual keyboards. */
enterkeyhint: 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send';
/** Enables spell checking on the input. */
spellcheck: boolean;
/**
* Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual
* keyboard on supportive devices.
*/
inputmode: 'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url';
/**
* Optional options that should be passed to the `NumberFormatter` when formatting the value.
* This is used to format the number when the input type is `number`.
* Note this can only be set via `property`, not as an `attribute`!
*/
numberFormatterOptions: Intl.NumberFormatOptions;
/**
* The minimal amount of fraction digits to use for numeric values.
* Used to format the number when the input type is `number`.
*/
minFractionDigits: number;
/**
* The maximal amount of fraction digits to use for numeric values.
* Used to format the number when the input type is `number`.
*/
maxFractionDigits: number;
/**
* Defines the strategy for handling numbers in the numeric input.
* This is used to determine how the input behaves when the user interacts with it.
*
* Includes the following configuration options:
*
* - **autoClamp**: If true, the input will clamp the value to the min and max attributes.
* - **noStepAlign**: If true, the input will not align the value to the step attribute.
* - **noStepValidation**: If true, the input will not validate the value against the step attribute.
*
* You may provide this as one of the following values:
*
* - 'native': Uses the native browser implementation.
* - 'modern': Uses a more intuitive implementation:
* - Values are clamped to the nearest min or max value.
* - Stepping is inclusive to the provided min and max values.
* - Provided stepping is no longer used in validation.
* - An object that matches the `NumericStrategy` type. Note this can only be set via `property`, not as an `attribute`!
*/
set numericStrategy(value: 'native' | 'modern' | Partial<NumericStrategy>);
/**
* @default nativeNumericStrategy
* @todo: This must be changed to "modern" in Synergy@3
*/
get numericStrategy(): 'native' | 'modern' | Partial<NumericStrategy>;
/**
* Gets or sets the current value as a `Date` object. Returns `null` if the value can't be converted. This will use the native `<input type="{{type}}">` implementation and may result in an error.
*/
get valueAsDate(): Date | null;
set valueAsDate(newValue: Date | null);
/** Gets or sets the current value as a number. Returns `NaN` if the value can't be converted. */
get valueAsNumber(): number;
set valueAsNumber(newValue: number);
/** Gets the validity state object */
get validity(): ValidityState;
/** Gets the validation message */
get validationMessage(): string;
firstUpdated(): void;
private handleBlur;
private handleStep;
private handleStepUp;
private handleStepDown;
private isDecrementDisabled;
private isIncrementDisabled;
private handleNumericStrategyAutoClamp;
private handleChange;
private handleClearClick;
private handleFocus;
private handleInput;
private handleInvalid;
private handleKeyDown;
private handlePasswordToggle;
handleDisabledChange(): void;
handleStepChange(): void;
handleValueChange(): Promise<void>;
/** Sets focus on the input. */
focus(options?: FocusOptions): void;
/** Removes focus from the input. */
blur(): void;
/** Selects all the text in the input. */
select(): void;
/** Sets the start and end positions of the text selection (0-based). */
setSelectionRange(selectionStart: number, selectionEnd: number, selectionDirection?: 'forward' | 'backward' | 'none'): void;
/** Replaces a range of text with a new string. */
setRangeText(replacement: string, start?: number, end?: number, selectMode?: 'select' | 'start' | 'end' | 'preserve'): void;
/** Displays the browser picker for an input element (only works if the browser supports it for the input type). */
showPicker(): void;
/** Increments the value of a numeric input type by the value of the step attribute. */
stepUp(): void;
/** Decrements the value of a numeric input type by the value of the step attribute. */
stepDown(): void;
/** Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid. */
checkValidity(): boolean;
/** Gets the associated form, if one exists. */
getForm(): HTMLFormElement | null;
/** Checks for validity and shows the browser's validation message if the control is invalid. */
reportValidity(): boolean;
/** Sets a custom validation message. Pass an empty string to restore validity. */
setCustomValidity(message: string): void;
render(): import("lit").TemplateResult<1>;
}