stimulus-filter v1.0.0

Stimulus filter controller

Installation

1. Add package yarn add stimulus-filter
2. Import package in your application

import { Application } from 'stimulus'
const application = Application.start()

import FilterController from 'stimulus-filter'
application.register('filter', FilterController)

Configuration

<div data-controller="filter"
     data-filter-class-to-toggle="class_to_toggle"> <!-- 'dnone' by default -->

Example

<div data-controller="filter">
  <input data-target="filter.source"
         data-action="input->filter#filter"
         type="text"
         placeholder="Search..." />

  <div data-target="filter.filterable" data-filter-key="article 1 to.downcase">
    <h2>Article 1</h2>
    ...
  </div>

  <div data-target="filter.filterable" data-filter-key="article 2 to.downcase">
    <h2>Article 2</h2>
    ...
  </div>
</div>

  <p data-target="filter.count"></p> <!-- Optional. Not working properly -->
</div>

Publish new version

1. Run yarn build
2. Update CHANGELOG.md
3. Run yarn publish