packages/ecl/components/ecl-multiselect/ecl-multiselect-option/ecl-multiselect-option.component.ts
Component representing a single selectable option in the multiselect dropdown.
EclMultiselectOption
OnChanges
OnDestroy
OnInit
| HostDirectives |
EclCheckboxDirective
|
| selector | div[eclMultiselectOption] |
| imports |
BoldTextPipe
EUI_ECL_CHECKBOX
|
| templateUrl | ./ecl-multiselect-option.component.html |
Properties |
Methods |
Inputs |
Outputs |
HostBindings |
Accessors |
| disabled |
Type : boolean
|
Default value : false
|
|
Disables the option when true. |
| isChecked |
Type : boolean
|
|
Indicates whether the option is selected. |
| label |
Type : string
|
|
Display label for the option. |
| value |
Type : string
|
| class |
Type : string
|
| e2eAttr |
Type : any
|
| tabindex |
Type : number
|
| optionClick |
Type : EventEmitter
|
|
Emits when the option is clicked. |
| optionKeydown |
Type : EventEmitter
|
|
Emits when a key is pressed while focused on the option. |
| class |
Type : string
|
| style.display |
Type : string
|
Default value : 'flex'
|
| hide |
hide()
|
|
Hides the option from view.
Returns :
void
|
| highlightSearchText | ||||||
highlightSearchText(keyword: string)
|
||||||
|
Sets the keyword for search highlighting.
Parameters :
Returns :
void
|
| onFocus |
onFocus()
|
|
Focuses the checkbox input.
Returns :
void
|
| onOptionClick |
onOptionClick()
|
|
Toggles the selected state and emits the optionClick event.
Returns :
void
|
| onOptionKeydown | ||||||
onOptionKeydown(evt: KeyboardEvent)
|
||||||
|
Emits the optionKeydown event when a key is pressed.
Parameters :
Returns :
void
|
| show |
show()
|
|
Makes the option visible.
Returns :
void
|
| getCssClasses | ||||||
getCssClasses(rootClass: string)
|
||||||
|
Parameters :
Returns :
string
|
| changes |
Type : unknown
|
Default value : new Subject()
|
| eclCheckboxInput |
Type : ElementRef
|
Decorators :
@ViewChild('checkboxInput')
|
| keyword |
Type : string
|
Default value : ''
|
| value | ||||||
getvalue()
|
||||||
setvalue(value: string)
|
||||||
|
Parameters :
Returns :
void
|
| cssClasses |
getcssClasses()
|
| isChecked | ||||||
getisChecked()
|
||||||
|
Indicates whether the option is selected.
Returns :
boolean
|
||||||
setisChecked(value: boolean)
|
||||||
|
Parameters :
Returns :
void
|
| id |
getid()
|
|
Returns the unique identifier for the option.
Returns :
string
|
| isActive |
getisActive()
|
|
Indicates whether the option is active (visible and not disabled).
Returns :
boolean
|