Show:

Global Filter

Typically the global filter component would be rendered into the {{yield header}} of the main table component using the yield conditional {{#if section.isHeader}} ....

However, it can be used outside of the context of the main component if the proper properties are shared between the main component and sub-component.

  • Sent in request as: ?filter[filterProperty]=searchFilter, e.g. ?filter[username]=John.Doe2
{{ember-tabular-global-filter
   filter=filter
   filterProperty="username"
   filterPlaceholder="Search by Username"}}

Methods

filterName

()

Constructs and sets the filter Object.

filterTable

()

Debounce the filterName method.

Properties

filter

Object

Must expose the filter property on the parent ember-tabular component to be able to pass the filter object back and forth between parent and child components.

Default: null

filterProperty

String

Property to be filtered upon.

Default: null

isClearable

Unknown

Default: false

query

Object

Pass the query object from the parent component if it is different or if used outside of the context of the component, otherwise query is optional and the component will attempt to grab within the context of the parent component.

Default: null

searchFilter

String

Value of filter.

Default: ''