feat!: TextInput v11 Styles (#1889)

* Initial commit

* Fixes [FluidForm] TextInput error icon is misplaced #1667

* Contributes to [TextInput] helperText enhancements #1633

* Adopts Standardize props and events #1621

* Added slots for Standardize props and events #1621

* Added pointer events, updated skeleton TextInput v11 #1888

* Address a bug in the word counter regex

* Update src/TextInput/TextInput.svelte

Correcting type attribute definition for HTML attributes

Co-authored-by: Enrico Sacchetti <esacchetti@gmail.com>

* Update src/TextInput/TextInput.svelte

Correcting type attribute definition for HTML attributes

Co-authored-by: Enrico Sacchetti <esacchetti@gmail.com>

* Update src/TextInput/TextInput.svelte

Explicitly define default value for `size`

Co-authored-by: Enrico Sacchetti <esacchetti@gmail.com>

* Adopted suggested changes

* Updated `TextInput.test`; added forgotten files from previous

---------

Co-authored-by: Samuel Janda <hi@simpleprogramming.com.au>
Co-authored-by: Enrico Sacchetti <esacchetti@gmail.com>
This commit is contained in:
Sam 2024-01-18 02:48:25 +11:00 committed by Eric Liu
commit 9efe5255d2
9 changed files with 838 additions and 520 deletions

View file

@ -1,24 +1,25 @@
import type { SvelteComponentTyped } from "svelte";
import type { SvelteHTMLElements } from "svelte/elements";
type RestProps = SvelteHTMLElements["input"];
export interface TextInputProps extends RestProps {
export interface TextInputProps {
/**
* Set the size of the input
* @default undefined
*/
size?: "sm" | "lg";
/**
* Specify the input value.
*
* `value` will be set to `null` if type="number"
* and the value is empty.
* Specify the input value
* `value` will be set to `null` if `typeof value === "number"` and `value` is empty
* @default ""
*/
value?: null | number | string;
/**
* Obtain a reference to the input HTML element
* @default null
*/
ref?: null | HTMLInputElement;
/**
* Set the size of the input
* @default "md"
*/
size?: "sm" | "md" | "lg";
/**
* Specify the placeholder text
* @default ""
@ -27,6 +28,9 @@ export interface TextInputProps extends RestProps {
/**
* Set to `true` to enable the light variant
* For use on $ui-01 backgrounds only. Don't use this to make tile background color same as container background color
* The light prop for `TextInput` has been deprecated in favor of the new `Layer` Layer component. It will be removed in the next major release
* @deprecated
* @default false
*/
light?: boolean;
@ -37,24 +41,6 @@ export interface TextInputProps extends RestProps {
*/
disabled?: boolean;
/**
* Specify the helper text
* @default ""
*/
helperText?: string;
/**
* Set an id for the input element
* @default "ccs-" + Math.random().toString(36)
*/
id?: string;
/**
* Specify a name attribute for the input
* @default undefined
*/
name?: string;
/**
* Specify the label text
* @default ""
@ -67,6 +53,25 @@ export interface TextInputProps extends RestProps {
*/
hideLabel?: boolean;
/**
* Specify the helper text
* @default ""
*/
helperText?: string;
/**
* Set to `true` to enable display the character counter. Requires `maxCount` to be set.
* @default false
*/
counter?: boolean;
/**
* Specify the maximum number of characters/words allowed
* This is needed in order for `counter` to display
* @default undefined
*/
maxCount?: number;
/**
* Set to `true` to indicate an invalid state
* @default false
@ -92,16 +97,16 @@ export interface TextInputProps extends RestProps {
warnText?: string;
/**
* Obtain a reference to the input HTML element
* @default null
* Set an id for the input element
* @default "ccs-" + Math.random().toString(36)
*/
ref?: null | HTMLInputElement;
id?: string;
/**
* Set to `true` to mark the field as required
* @default false
* Specify a name attribute for the input
* @default undefined
*/
required?: boolean;
name?: string;
/**
* Set to `true` to use the inline variant
@ -109,29 +114,46 @@ export interface TextInputProps extends RestProps {
*/
inline?: boolean;
/**
* Set to `true` to mark the field as required
* @default false
*/
required?: boolean;
/**
* Set to `true` to use the read-only variant
* @default false
*/
readonly?: boolean;
[key: `data-${string}`]: any;
/**
* Set HTML attributes on the `label` element
* @default {}
*/
labelAttributes?: import("svelte/elements").HTMLLabelAttributes;
/**
* Set HTML attributes on the `input` element
* @default {}
*/
inputAttributes?: import("svelte/elements").HTMLInputAttributes;
}
export default class TextInput extends SvelteComponentTyped<
TextInputProps,
{
change: CustomEvent<null | number | string>;
input: CustomEvent<null | number | string>;
click: WindowEventMap["click"];
mouseover: WindowEventMap["mouseover"];
mouseenter: WindowEventMap["mouseenter"];
mouseleave: WindowEventMap["mouseleave"];
pointerup: WindowEventMap["pointerup"];
pointerover: WindowEventMap["pointerover"];
pointerenter: WindowEventMap["pointerenter"];
pointerleave: WindowEventMap["pointerleave"];
change: WindowEventMap["change"];
input: WindowEventMap["input"];
keydown: WindowEventMap["keydown"];
keyup: WindowEventMap["keyup"];
focus: WindowEventMap["focus"];
blur: WindowEventMap["blur"];
paste: DocumentAndElementEventHandlersEventMap["paste"];
},
{ labelText: {} }
{ helperText: {}; invalidText: {}; labelText: {}; warnText: {} }
> {}