carbon-components-svelte/types/TextArea/TextArea.svelte.d.ts

136 lines
2.4 KiB
TypeScript

import type { SvelteComponentTyped } from "svelte";
import type { SvelteHTMLElements } from "svelte/elements";
type RestProps = SvelteHTMLElements["textarea"];
export interface TextAreaProps extends RestProps {
/**
* Specify the textarea value
* @default ""
*/
value?: string;
/**
* Specify the placeholder text
* @default ""
*/
placeholder?: string;
/**
* Specify the number of cols
* @default undefined
*/
cols?: number;
/**
* Specify the number of rows
* @default 4
*/
rows?: number;
/**
* Specify the max character count
* @default undefined
*/
maxCount?: number;
/**
* Specify the counter mode
* @default "character"
*/
counterMode?: "character" | "word";
/**
* Set to `true` to enable the light variant
* @default false
*/
light?: boolean;
/**
* Set to `true` to disable the input
* @default false
*/
disabled?: boolean;
/**
* Set to `true` to use the read-only variant
* @default false
*/
readonly?: boolean;
/**
* Specify the helper text
* @default ""
*/
helperText?: string;
/**
* Specify the label text
* @default ""
*/
labelText?: string;
/**
* Set to `true` to visually hide the label text
* @default false
*/
hideLabel?: boolean;
/**
* Set to `true` to indicate an invalid state
* @default false
*/
invalid?: boolean;
/**
* Specify the text for the invalid state
* @default ""
*/
invalidText?: string;
/**
* Set to `true` to indicate an warning state
* @default false
*/
warn?: boolean;
/**
* Specify the warning state text
* @default ""
*/
warnText?: string;
/**
* Set an id for the textarea element
* @default "ccs-" + Math.random().toString(36)
*/
id?: string;
/**
* Specify a name attribute for the input
* @default undefined
*/
name?: string;
/**
* Obtain a reference to the textarea HTML element
* @default null
*/
ref?: null | HTMLTextAreaElement;
[key: `data-${string}`]: any;
}
export default class TextArea extends SvelteComponentTyped<
TextAreaProps,
{
change: WindowEventMap["change"];
input: WindowEventMap["input"];
keydown: WindowEventMap["keydown"];
keyup: WindowEventMap["keyup"];
focus: WindowEventMap["focus"];
blur: WindowEventMap["blur"];
paste: DocumentAndElementEventHandlersEventMap["paste"];
},
{ invalidText: {}; labelText: {}; warnText: {} }
> {}