Initial commit

Author: guillaumebriday

.babelrc

@@ -0,0 +1,5 @@
+{
+  "plugins": [
+    "@babel/plugin-proposal-class-properties"
+  ]
+}

.eslintignore

@@ -0,0 +1 @@
+pkg

.eslintrc.js

@@ -0,0 +1,13 @@
+// https://eslint.org/docs/user-guide/configuring
+
+module.exports = {
+  env: {
+    browser: true,
+    node: true,
+    es6: true
+  },
+
+  globals: {
+    page: 'readonly'
+  }
+}

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+pkg
+build

.node-version

@@ -0,0 +1 @@
+14.13.0

.npmignore

@@ -0,0 +1,10 @@
+.github
+jest
+.babelrc
+jest.config.js
+index.html
+snowpack.config.json
+netlify.toml
+.node-version
+.eslintrc.js
+src

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "printWidth": 120
+}

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2020-10-15
+
+### Added
+
+- Adding controller

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Guillaume Briday
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,122 @@
+# Stimulus Checkbox Select All
+
+[![](https://img.shields.io/npm/dt/stimulus-checkbox-select-all.svg)](https://www.npmjs.com/package/stimulus-checkbox-select-all)
+[![](https://img.shields.io/npm/v/stimulus-checkbox-select-all.svg)](https://www.npmjs.com/package/stimulus-checkbox-select-all)
+[![](https://github.com/stimulus-components/stimulus-checkbox-select-all/workflows/Lint/badge.svg)](https://github.com/stimulus-components/stimulus-checkbox-select-all)
+[![](https://github.com/stimulus-components/stimulus-checkbox-select-all/workflows/Test/badge.svg)](https://github.com/stimulus-components/stimulus-checkbox-select-all)
+[![](https://img.shields.io/github/license/stimulus-components/stimulus-checkbox-select-all.svg)](https://github.com/stimulus-components/stimulus-checkbox-select-all)
+[![Netlify Status](https://api.netlify.com/api/v1/badges/073b5fee-358d-4dbf-b807-52034690f8ef/deploy-status)](https://stimulus-checkbox-select-all.netlify.com)
+
+## Getting started
+
+A Stimulus controller to check/uncheck all checkboxes.
+
+## Installation
+
+```bash
+$ yarn add stimulus-checkbox-select-all
+```
+
+And use it in your JS file:
+```js
+import { Application } from "stimulus"
+import CheckboxSelectAll from "stimulus-checkbox-select-all"
+
+const application = Application.start()
+application.register("checkbox-select-all", CheckboxSelectAll)
+```
+
+## Usage
+
+In your models:
+```ruby
+class User < ApplicationRecord
+  has_many :teams
+end
+
+class Team < ApplicationRecord
+  belongs_to :user
+end
+```
+
+In your controller:
+```ruby
+class UsersController < ApplicationController
+  def update
+    if user.update(user_params)
+      redirect_to users_path
+    else
+      render :edit
+    end
+  end
+
+  private
+
+  def user_params
+    params
+      .require(:user)
+       .permit(
+         team_ids: []
+       )
+  end
+end
+```
+
+In your view:
+```html
+<%= form_with model: @user, data: { controller: 'checkbox-select-all' } do |f| %>
+  <label>
+    <input type="checkbox" data-action="change->checkbox-select-all#toggle" />
+    <span>Select All / Deselect All</span>
+  </label>
+
+  <%= f.collection_check_boxes :team_ids, Team.all, :id, :name do |b| %>
+    <%= b.label do %>
+      <%= b.check_box data: { target: 'checkbox-select-all.checkbox' } %>
+      <%= b.text %>
+    <% end %>
+  <% end %>
+<% end %>
+```
+
+## Extending Controller
+
+You can use inheritance to extend the functionality of any Stimulus components.
+
+```js
+import CheckboxSelectAll from "stimulus-checkbox-select-all"
+
+export default class extends CheckboxSelectAll {
+  connect() {
+    super.connect()
+    console.log("Do what you cant here.")
+  }
+}
+```
+
+These controllers will automatically have access to targets defined in the parent class.
+
+If you override the connect, disconnect or any other methods from the parent, you'll want to call `super.method()` to make sure the parent functionality is executed.
+
+## Development
+
+### Project setup
+```bash
+$ yarn install
+$ yarn dev
+```
+
+### Linter
+[Prettier](https://prettier.io/) and [ESLint](https://eslint.org/) are responsible to lint and format this component:
+```bash
+$ yarn lint
+$ yarn format
+```
+
+## Contributing
+
+Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.
+
+## License
+
+This project is released under the [MIT](http://opensource.org/licenses/MIT) license.