mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
8ddf2def8b* chore(deps-dev): upgrade carbon-components to v10.36.0 * feat(structured-list): add condensed, flush props * fix(structured-list): deprecate the border prop * fix(code-snippet): set min/max height for multi-line code snippet #656 Fixes #656 * fix(image-loader): make SSR compatible using a window type check guard * docs(tag): add separate disabled example for filterable/interactive tags * docs: update number of supported chart types * feat(side-nav): support rail variant * feat(ui-shell): add isSelected prop to HeaderNavItem * fix(ui-shell): default isSelected to false in SideNavMenuItem * fix(text-area): forward missing keydown event #665 Fixes #665 * feat: forward keyup event to components with inputs * feat(checkbox): make labelText slottable #563 Closes #563 * feat: make labelText slottable Related #563 * docs(component-api): account for undefined type * docs(ui-shell): link to correct rail source * fix(ui-shell): default isSelected in HeaderNavItem to false
157 lines
2.9 KiB
TypeScript
157 lines
2.9 KiB
TypeScript
/// <reference types="svelte" />
|
|
import { SvelteComponentTyped } from "svelte";
|
|
|
|
export interface ComboBoxItem {
|
|
id: string;
|
|
text: string;
|
|
}
|
|
|
|
export interface ComboBoxProps
|
|
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["input"]> {
|
|
/**
|
|
* Set the combobox items
|
|
* @default []
|
|
*/
|
|
items?: ComboBoxItem[];
|
|
|
|
/**
|
|
* Override the display of a combobox item
|
|
* @default (item) => item.text || item.id
|
|
*/
|
|
itemToString?: (item: ComboBoxItem) => string;
|
|
|
|
/**
|
|
* Set the selected item by value index
|
|
* @default -1
|
|
*/
|
|
selectedIndex?: number;
|
|
|
|
/**
|
|
* Specify the selected combobox value
|
|
* @default ""
|
|
*/
|
|
value?: string;
|
|
|
|
/**
|
|
* Specify the direction of the combobox dropdown menu
|
|
* @default "bottom"
|
|
*/
|
|
direction?: "bottom" | "top";
|
|
|
|
/**
|
|
* Set the size of the combobox
|
|
*/
|
|
size?: "sm" | "xl";
|
|
|
|
/**
|
|
* Set to `true` to disable the combobox
|
|
* @default false
|
|
*/
|
|
disabled?: boolean;
|
|
|
|
/**
|
|
* Specify the title text of the combobox
|
|
* @default ""
|
|
*/
|
|
titleText?: string;
|
|
|
|
/**
|
|
* Specify the placeholder text
|
|
* @default ""
|
|
*/
|
|
placeholder?: string;
|
|
|
|
/**
|
|
* Specify the helper text
|
|
* @default ""
|
|
*/
|
|
helperText?: string;
|
|
|
|
/**
|
|
* Specify the invalid state text
|
|
* @default ""
|
|
*/
|
|
invalidText?: string;
|
|
|
|
/**
|
|
* Set to `true` to indicate an invalid state
|
|
* @default false
|
|
*/
|
|
invalid?: boolean;
|
|
|
|
/**
|
|
* Set to `true` to indicate an warning state
|
|
* @default false
|
|
*/
|
|
warn?: boolean;
|
|
|
|
/**
|
|
* Specify the warning state text
|
|
* @default ""
|
|
*/
|
|
warnText?: string;
|
|
|
|
/**
|
|
* Set to `true` to enable the light variant
|
|
* @default false
|
|
*/
|
|
light?: boolean;
|
|
|
|
/**
|
|
* Set to `true` to open the combobox menu dropdown
|
|
* @default false
|
|
*/
|
|
open?: boolean;
|
|
|
|
/**
|
|
* Determine if an item should be filtered given the current combobox value
|
|
* @default () => true
|
|
*/
|
|
shouldFilterItem?: (item: ComboBoxItem, value: string) => boolean;
|
|
|
|
/**
|
|
* Override the default translation ids
|
|
*/
|
|
translateWithId?: (id: any) => string;
|
|
|
|
/**
|
|
* Set an id for the list box component
|
|
* @default "ccs-" + Math.random().toString(36)
|
|
*/
|
|
id?: string;
|
|
|
|
/**
|
|
* Specify a name attribute for the input
|
|
*/
|
|
name?: string;
|
|
|
|
/**
|
|
* Obtain a reference to the input HTML element
|
|
* @default null
|
|
*/
|
|
ref?: null | HTMLInputElement;
|
|
|
|
/**
|
|
* Obtain a reference to the list HTML element
|
|
* @default null
|
|
*/
|
|
listRef?: null | HTMLDivElement;
|
|
}
|
|
|
|
export default class ComboBox extends SvelteComponentTyped<
|
|
ComboBoxProps,
|
|
{
|
|
select: CustomEvent<{
|
|
selectedId: string;
|
|
selectedIndex: number;
|
|
selectedItem: ComboBoxItem;
|
|
}>;
|
|
keydown: WindowEventMap["keydown"];
|
|
keyup: WindowEventMap["keyup"];
|
|
focus: WindowEventMap["focus"];
|
|
blur: WindowEventMap["blur"];
|
|
clear: WindowEventMap["clear"];
|
|
scroll: WindowEventMap["scroll"];
|
|
},
|
|
{}
|
|
> {}
|