stimulus-nested-form

A stimulus controller for adding / removing Rails nested form dynamically.

Dependencies

• @hotwired/stimulus 3.0+

Installation

Install from npm:

$ npm install @kanety/stimulus-nested-form --save

Usage

Register controller:

1import { Application } from '@hotwired/stimulus';
2import NestedFormController from '@kanety/stimulus-nested-form';
3
4const application = Application.start();
5application.register('nested-form', NestedFormController);

Build nested form using Rails fields_for:

1<%= form_with do |f| %>
2  <div data-controller="nested-form">
3    <%= f.fields_for :assocs do |assoc_form| %>
4      <div data-nested-form-target="form">
5        <%= assoc_form.text_field :text %>
6        <button type="button" data-action="nested-form#remove">Remove</button>
7      </div>
8    <% end %>
9    <button type="button" data-action="nested-form#add">Add</button>
10  </div>
11<% end %>

New nested form will be added when the Add button is clicked. The last element of the nested forms is used as a template to be added. The index written in id and name attributes are incremented automatically as the following example:

1<form>
2  <div data-controller="nested-form">
3    <div data-nested-form-target="form">
4      <input type="text" name="model[assocs_attributes][0][text]" id="model_assocs_attributes_0_text">
5      <button type="button" data-action="nested-form#remove">Remove</button>
6    </div>
7    <div data-nested-form-target="form">
8      <input type="text" name="model[assocs_attributes][1][text]" id="model_assocs_attributes_1_text">
9      <button type="button" data-action="nested-form#remove">Remove</button>
10    </div>
11    <button type="button" data-action="nested-form#add">Add</button>
12  </div>
13</form>

The added form is handled as follows:

• The values of input and textarea elements are cleared.
• The selected options of select elements are cleared.
• The first element of radio buttons is selected.

Options

associations

You can specify name of associations by associations option. If the nested form consists of multiple associations such as assocsA and assocsB, you can set the name of associations as the following example:

1<div data-controller="nested-form"
2     data-nested-form-associations-value='["assocsA", "assocsB"]'>
3</div>

You can also specify name of primary keys as follows:

1<div data-controller="nested-form"
2     data-nested-form-associations-value='["assocsA", "assocsB"]'
3     data-nested-form-primary-keys-value='["id", "id"]'>
4</div>

max

If you want to disable Add button when the number of nested forms reached to the limit, max option is available:

1<div data-controller="nested-form"
2     data-nested-form-max-value="10">
3</div>

start

If you want to change start index of nested form, start option is available:

1<div data-controller="nested-form"
2     data-nested-form-start-value="10">
3</div>

increment

If you want to change the number of adding nested form at once, increment option is available:

1<div data-controller="nested-form"
2     data-nested-form-increment-value="3">
3</div>

tags and attributes

You can customize tags and attributes which contains index value of nested form:

1NestedFormController.tags = NestedFormController.tags.concat(['a']);
2NestedFormController.attributes = NestedFormController.attributes.concat(['onclick']);

Default tags and attributes are:

1static tags = ['input', 'textarea', 'select', 'label'];
2static attributes = ['id', 'name', 'for'];

Callbacks

Following callbacks are available to manipulate nested form elements:

1let element = document.querySelector('[data-controller="nested-form"]')
2element.addEventListener('nested-form:before-add', (e) => {
3  console.log(e.detail.form);  // form to be added
4  e.preventDefault();          // you can cancel form addition by preventDefault
5});
6element.addEventListener('nested-form:after-add', (e) => {
7  console.log(e.detail.form);  // added form
8});
9element.addEventListener('nested-form:before-remove', (e) => {
10  console.log(e.detail.form);  // form to be remove
11  e.preventDefault();          // you can cancel form removal by preventDefault
12});
13element.addEventListener('nested-form:after-remove', (e) => {
14  console.log(e.detail.form);  // removed form
15});

License

The library is available as open source under the terms of the MIT License.