Input

The FilterInput component is used to show and handle the filter values.

Import

import { Input } from "@schukai/monster/source/components/datatable/filter/input.mjs";

Source

View source code

Package

@schukai/monster

Since

1.0.0

Purpose and scope

The FilterInput component is used to show and handle the filter values.

This page documents the <monster-filter-input> 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.

Input Filter

In this example, a simple filter with two filtering options is demonstrated. The example is not yet connected to a data source.

Input Filter Date Range Filter

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 **/

Open in playground

Stored Input Filters

in diesem beispiel schalten wir die speicherfähigkeit für die filterung ein. dazu muss man das html attribut data-monster-option-features-storedConfig auf true setzen. und die ID des Tabs Controls in das Attribut data-monster-option-storedConfig-selector setzen.

Input Filter Date Range Filter

Javascript

//import '@schukai/monster/source/components/form/input-group.mjs';<script type="module">//import '@schukai/monster/source/components/form/input-group.mjs';</script>

HTML

<monster-tabs>



<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>


</monster-tabs>

Stylesheet

/** no additional stylesheet is defined **/

Open in playground

Component Design

monster-filter-input presents a compact text entry surface that writes its normalized value into the datatable filter model.

Interaction

Keep the visible label and surrounding table context available to assistive technology. The exported control wrapper is the stable styling boundary.

HTML Structure

<monster-filter-input></monster-filter-input>

JavaScript Initialization

const element = document.createElement('monster-filter-input');
document.body.appendChild(element);

Exported

Input

Derived from

AbstractBase

Options

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 AbstractBase.

Option

Type

Default

Description

templates

object

Template definitions

templates.main

string

undefined

Main template

datasource

object

undefined

The datasource

autoLoad

boolean

undefined

If true, the datasource is called immediately after the control is created.

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 AbstractBase.

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 AbstractBase.

State query methods

value(value)

Parameters

value {*}: value

This is a method of [internal api](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals)

value()

Returns

No description available.

Static methods

[instanceSymbol]()

Returns

{symbol}

This method is called by the instanceof operator.

getCSSStyleSheet()

Returns

Array<CSSStyleSheet>

No description available.

getTag()

Returns

{string}

No description available.

Lifecycle methods

Lifecycle methods are called by the environment and are usually not intended to be called directly.

[assembleMethodSymbol]()

Returns

{FilterButton}

No description available.

Events

This component does not fire any public events. It may fire events that are inherited from its parent classes.

The current width of the area is too small to display the content correctly.