FilterButton
A toggle button that opens or closes a datatable filter area.
import { FilterButton } from "@schukai/monster/source/components/datatable/filter-button.mjs";'%3E%3Cpath style='stroke:none;fill-rule:nonzero;fill:%23f03c2e;fill-opacity:1' d='M90.156 41.965 50.036 1.848a5.918 5.918 0 0 0-8.372 0l-8.328 8.332 10.566 10.566a7.03 7.03 0 0 1 7.23 1.684 7.034 7.034 0 0 1 1.669 7.277l10.187 10.184a7.028 7.028 0 0 1 7.278 1.672 7.04 7.04 0 0 1 0 9.957 7.05 7.05 0 0 1-9.965 0 7.044 7.044 0 0 1-1.528-7.66l-9.5-9.497V59.36a7.04 7.04 0 0 1 1.86 11.29 7.04 7.04 0 0 1-9.957 0 7.04 7.04 0 0 1 0-9.958 7.06 7.06 0 0 1 2.304-1.539V33.926a7.049 7.049 0 0 1-3.82-9.234L29.242 14.272 1.73 41.777a5.925 5.925 0 0 0 0 8.371L41.852 90.27a5.925 5.925 0 0 0 8.37 0l39.934-39.934a5.925 5.925 0 0 0 0-8.371'/%3E%3C/g%3E%3C/svg%3E "View source code")
Purpose and scope
A toggle button that opens or closes a datatable filter area.
This page documents the <monster-datatable-filter-button> custom element. Use the Usage examples for a working starting point and the API tab for the complete public contract.
When to use it
Use this module when its focused responsibility matches the surrounding workflow. Prefer its public options, properties, methods and events over reaching into rendered internals.
Filter Toggle
In this example, a simple filter with two filtering options is demonstrated. The example is not yet connected to a data source.
Javascript
//import '@schukai/monster/source/components/datatable/filter.mjs';<script type="module">//import '@schukai/monster/source/components/datatable/filter.mjs';</script>HTML
<monster-datatable-filter>
<!-- the attribute "data-monster-label" is used to define the label for the select element -->
<!-- The text node inside the label is the label for the filter element -->
<label data-monster-label="Input">Input Filter
<monster-filter-input></monster-filter-input>
</label>
<!-- the next filter is hidden, because the attribute "slot" and the value "hidden" are used -->
<label slot="hidden" data-monster-label="Date Range">Date Range Filter
<monster-filter-date-range></monster-filter-date-range>
</label>
</monster-datatable-filter>Stylesheet
/** no additional stylesheet is defined **/Advanced Filter Toggle
In this example, we link the filter to a data source.
Javascript
//import '@schukai/monster/source/components/datatable/filter.mjs';<script type="module">//import '@schukai/monster/source/components/datatable/filter.mjs';</script>HTML
<monster-datatable-filter>
<!-- the attribute "data-monster-label" is used to define the label for the select element -->
<!-- The text node inside the label is the label for the filter element -->
<label data-monster-label="Input">Input Filter
<monster-filter-input></monster-filter-input>
</label>
<!-- the next filter is hidden, because the attribute "slot" and the value "hidden" are used -->
<label slot="hidden" data-monster-label="Date Range">Date Range Filter
<monster-filter-date-range></monster-filter-date-range>
</label>
</monster-datatable-filter>Stylesheet
/** no additional stylesheet is defined **/Component Design
monster-datatable-filter-button is a compact toggle for opening and closing the datatable filter surface.
Styling
The component inherits its interactive button structure from the host toggle-button contract. Use the inherited parts and state attributes for visual customization.
HTML Structure
<monster-datatable-filter-button></monster-datatable-filter-button>JavaScript Initialization
const element = document.createElement('monster-datatable-filter-button');
document.body.appendChild(element);Exported
FilterButtonDerived from
ToggleButtonOptions
The Options listed in this section are defined directly within the class. This class is derived from several parent classes, including the CustomElement class. Therefore, it inherits Options from these parent classes. If you cannot find a specific Options in this list, we recommend consulting the documentation of the ToggleButton.
- since
- deprecated
Properties and Attributes
The Properties and Attributes listed in this section are defined directly within the class. This class is derived from several parent classes, including the CustomElement class and ultimately from HTMLElement. Therefore, it inherits Properties and Attributes from these parent classes. If you cannot find a specific Properties and Attributes in this list, we recommend consulting the documentation of the ToggleButton.
data-monster-options: Sets the configuration options for the collapse component when used as an HTML attribute.data-monster-option-[name]: Sets the value of the configuration option[name]for the collapse component when used as an HTML attribute.
Methods
The methods listed in this section are defined directly within the class. This class is derived from several parent classes, including the CustomElement class and ultimately from HTMLElement. Therefore, it inherits methods from these parent classes. If you cannot find a specific method in this list, we recommend consulting the documentation of the ToggleButton.
Static methods
[instanceSymbol]()- {symbol}
instanceof operator.getCSSStyleSheet()- {CSSStyleSheet[]}
getTag()- {string}
Events
This component does not fire any public events. It may fire events that are inherited from its parent classes.