Home Reference Source
import {TfChecklistElement} from 'tablefilter/src/components/tf-checklist.js'
public class | source

TfChecklistElement

Extends:

HTMLElement → TfChecklistElement

Static Member Summary

Static Public Members
public static get

Constructor Summary

Public Constructor
public

Method Summary

Public Methods
public
public
public

Get the values of the selected options, in option order.

public

setLabel(label: *)

Set the trigger's accessible name, rendered as aria-label.

public

setListboxLabel(label: *)

Set the listbox's accessible name, rendered as aria-label.

public

setOpen(open: Boolean)

Expand or collapse the popover.

public

setOptions(options: Array<*>)

Replace the option list.

public

setSelectedValues(values: Array<*>)

Select the options whose value matches an entry in values, and clear the selection of the rest.

public

setText(text: *)

Set the trigger text, rendered into the trigger-text part.

Static Public Members

public static get observedAttributes: string[] source

Public Constructors

public constructor() source

Public Methods

public attributeChangedCallback() source

public connectedCallback() source

public getSelectedValues(): Array<String> source

Get the values of the selected options, in option order.

Return:

Array<String>

Selected values

public setLabel(label: *) source

Set the trigger's accessible name, rendered as aria-label.

Params:

NameTypeAttributeDescription
label *

Accessible name

public setListboxLabel(label: *) source

Set the listbox's accessible name, rendered as aria-label.

Params:

NameTypeAttributeDescription
label *

Accessible name

public setOpen(open: Boolean) source

Expand or collapse the popover.

Params:

NameTypeAttributeDescription
open Boolean

Whether the popover is expanded

public setOptions(options: Array<*>) source

Replace the option list. Entries are primitives or objects with value, text, disabled and selected. The previous selection is cleared.

Params:

NameTypeAttributeDescription
options Array<*>

Option entries

public setSelectedValues(values: Array<*>) source

Select the options whose value matches an entry in values, and clear the selection of the rest.

Params:

NameTypeAttributeDescription
values Array<*>

Selected values

public setText(text: *) source

Set the trigger text, rendered into the trigger-text part.

Params:

NameTypeAttributeDescription
text *

Trigger text