@nospamproxy/core
    Preparing search index...

    Control that provides a standard text filter.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    activity: ActivityManager = ...
    allowExactMatch: boolean = false
    applyCallback?: (text: string, exactMatch: boolean) => void
    containerClass?: string

    If specified, this class will be used for the dropdown container.

    By default, the dropdown container width is limited.

    // example.css
    .textFilterContainer {
      max-width: 25rem;
      min-height: 10rem;
    }
    
    <!-- example.html -->
    <list-text-filter container-class.bind="styles.textFilterContainer">...
    ea: IEventAggregator = ...
    filter?: (text: string, exactMatch: boolean) => unknown[]
    filterId: string = ...
    filterName: string
    header?: string

    A custom header name.

    The filter name is used by default.

    labelledBy: string = ''
    labelText?: string
    model?: ListFilterModel<unknown>
    validationController: IValidationController = ...
    value: string = ''

    The current text box value.

    This may differ from the currently filtered value.

    Custom validation rules can be added by referencing the view model. When adding custom validation rules, ensure that an empty value is allowed.

    <!-- example.html -->
    <list-text-filter component.ref="myTextFilter">...
    // example.ts
    class Example {
    private myTextFilter: ListTextFilter;

    private bind() {
    this.validationRules
    .on(this.myTextFilter)
    .ensure("value")
    ...
    }
    }

    Methods

    • Parameters

      • OptionalnewValue: string

      Returns void

    • Returns void

    • Parameters

      Returns void

    • Returns void

    • Returns void