Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kanety/stimulus-checklist


https://github.com/kanety/stimulus-checklist

Last synced: 8 days ago
JSON representation

Awesome Lists containing this project

README

        

# stimulus-checklist

A stimulus controller for checkbox list which responds to ctrl and shift click.

## Dependencies

* @hotwired/stimulus 3.0

## Installation

Install from npm:

$ npm install @kanety/stimulus-checklist --save

## Usage

Register controller:

```javascript
import { Application } from '@hotwired/stimulus';
import ChecklistController from '@kanety/stimulus-checklist';

const application = Application.start();
application.register('checklist', ChecklistController);
```

Import css:

```css
@import '@kanety/stimulus-checklist';
```

Build html as follows:

```html




  • text 1



  • text 2


```

### Options

#### filter

Filter checkboxes by css selector:

```html




  • text 1



```

## License

The library is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).