eui documentation
  1. Directives
  2. EclMultiselectOptionDirective

File

packages/ecl/components/ecl-multiselect/ecl-multiselect-option.directive.ts

Description

Directive used to decorate elements within a multiselect. Adds support for value, label, disabled, selected states and styling.

Extends

ECLBaseDirective

Metadata

Selector optgroup[eclMultiselectOptgroup], option[eclMultiselectOption]

Index

Properties
Methods
Inputs
HostBindings
Accessors

Inputs

disabled
Type : boolean

Indicates that the option is disabled.
label
Type : string

Label displayed for the option.
selected
Type : boolean

Indicates that the option is selected.
value
Type : string

Value assigned to the option.
class
Type : string
e2eAttr
Type : any
tabindex
Type : number

HostBindings

class
Type : string

Applies ECL checkbox styling class to the option.

Methods

isOptGroup
isOptGroup()

Returns true if this directive is applied to an element.

Returns : boolean
getCssClasses
getCssClasses(rootClass: string)
Parameters :
Name Type Optional
rootClass string No
Returns : string

Properties

changes
Type : unknown
Default value : new Subject()

Emits whenever the option's state changes (used internally).
eclOptionItems
Type : QueryList<EclMultiselectOptionDirective>
Decorators :
@ContentChildren(undefined)

Nested option directives (used for optgroups).

Accessors

disabled
getdisabled()

Indicates that the option is disabled.

Returns : boolean
setdisabled(value: BooleanInput)
Parameters :
Name Type Optional
value BooleanInput No
Returns : void
selected
getselected()

Indicates that the option is selected.

Returns : boolean
setselected(value: unknown)
Parameters :
Name Type Optional
value unknown No
Returns : void
cssClasses
getcssClasses()

Applies ECL checkbox styling class to the option.

Returns : string

results matching ""

    No results matching ""