Interface OmakaseDropdownListApi

Omakase dropdown component API

interface OmakaseDropdownListApi {
    selectedAction$: Observable<OmakaseDropdownListItem>;
    selectedOption$: BehaviorSubject<OmakaseDropdownListItem | undefined>;
    get type(): OmakaseDropdownListType;
    set type(type: OmakaseDropdownListType): void;
    get width(): number;
    set width(width: number): void;
    setOptions(options: OmakaseDropdownListItem[]): void;
}

Implemented by

OmakaseDropdownList

Index

Properties

selectedAction$ selectedOption$

Accessors

Methods

Properties

selectedAction$

selectedAction$: Observable<OmakaseDropdownListItem>

Observable that emits the dropdown list item whenever the action icon on the right side of the dropdown list item is clicked.

selectedOption$

selectedOption$: BehaviorSubject<OmakaseDropdownListItem | undefined>

Observable that emits the currently selected dropdown list item whenever the selection changes. Emits undefined if no item is selected.

Accessors

type

get type(): OmakaseDropdownListType
Type of icons displayed next to each dropdown list item. Can be 'radio' for radio button icons, 'checkbox' for checkbox icons, or 'default' for no icons. Default value is 'default'.

Returns OmakaseDropdownListType
- Defined in src/chroming/chroming-api.ts:332
set type(type: OmakaseDropdownListType): void
Parameters
- type: OmakaseDropdownListType
Returns void
- Defined in src/chroming/chroming-api.ts:333

width

get width(): number
Width of the dropdown list in pixels. If the width is not set, the dropdown list will have a default width defined in CSS.

Returns number
- Defined in src/chroming/chroming-api.ts:326
set width(width: number): void
Parameters
- width: number
Returns void
- Defined in src/chroming/chroming-api.ts:327

Methods

setOptions

setOptions(options: OmakaseDropdownListItem[]): void
Sets the dropdown list items and their configuration. The configuration includes the label to display for each item, the internal value of each item, and whether the item is active (selected) or not. The internal value can be used to determine which item is selected when subscribing to the selectedOption$ observable.
Parameters
- options: OmakaseDropdownListItem[]
  Array of dropdown list items and their configuration
Returns void
- Defined in src/chroming/chroming-api.ts:349