mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 02:11:05 +00:00
9198ed5474Closes #1491 * feat(pagination): dispatch "change" event when interacting with previous/next buttons, page/page size dropdowns * breaking(select): rename dispatched "change" event to "update" * breaking(select): forward `change` event to `Select`
119 lines
2.2 KiB
TypeScript
119 lines
2.2 KiB
TypeScript
/// <reference types="svelte" />
|
|
import type { SvelteComponentTyped } from "svelte";
|
|
|
|
export interface SelectProps
|
|
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["div"]> {
|
|
/**
|
|
* Specify the selected item value
|
|
* @default undefined
|
|
*/
|
|
selected?: string | number;
|
|
|
|
/**
|
|
* Set the size of the select input
|
|
* @default undefined
|
|
*/
|
|
size?: "sm" | "xl";
|
|
|
|
/**
|
|
* Set to `true` to use the inline variant
|
|
* @default false
|
|
*/
|
|
inline?: boolean;
|
|
|
|
/**
|
|
* Set to `true` to enable the light variant
|
|
* @default false
|
|
*/
|
|
light?: boolean;
|
|
|
|
/**
|
|
* Set to `true` to disable the select element
|
|
* @default false
|
|
*/
|
|
disabled?: boolean;
|
|
|
|
/**
|
|
* Set an id for the select element
|
|
* @default "ccs-" + Math.random().toString(36)
|
|
*/
|
|
id?: string;
|
|
|
|
/**
|
|
* Specify a name attribute for the select element
|
|
* @default undefined
|
|
*/
|
|
name?: string;
|
|
|
|
/**
|
|
* Set to `true` to indicate an invalid state
|
|
* @default false
|
|
*/
|
|
invalid?: boolean;
|
|
|
|
/**
|
|
* Specify the invalid state text
|
|
* @default ""
|
|
*/
|
|
invalidText?: string;
|
|
|
|
/**
|
|
* Set to `true` to indicate an warning state
|
|
* @default false
|
|
*/
|
|
warn?: boolean;
|
|
|
|
/**
|
|
* Specify the warning state text
|
|
* @default ""
|
|
*/
|
|
warnText?: string;
|
|
|
|
/**
|
|
* Specify the helper text
|
|
* @default ""
|
|
*/
|
|
helperText?: string;
|
|
|
|
/**
|
|
* Set to `true` to not render a label
|
|
* @default false
|
|
*/
|
|
noLabel?: boolean;
|
|
|
|
/**
|
|
* Specify the label text
|
|
* @default ""
|
|
*/
|
|
labelText?: string;
|
|
|
|
/**
|
|
* Set to `true` to visually hide the label text
|
|
* @default false
|
|
*/
|
|
hideLabel?: boolean;
|
|
|
|
/**
|
|
* Obtain a reference to the select HTML element
|
|
* @default null
|
|
*/
|
|
ref?: null | HTMLSelectElement;
|
|
|
|
/**
|
|
* Set to `true` to mark the field as required
|
|
* @default false
|
|
*/
|
|
required?: boolean;
|
|
}
|
|
|
|
export default class Select extends SvelteComponentTyped<
|
|
SelectProps,
|
|
{
|
|
/** The selected value. */ update: CustomEvent<string | number>;
|
|
change: WindowEventMap["change"];
|
|
input: WindowEventMap["input"];
|
|
focus: WindowEventMap["focus"];
|
|
blur: WindowEventMap["blur"];
|
|
},
|
|
{ default: {}; labelText: {} }
|
|
> {}
|