Skip to content

[Collection forms] Make javascript generic #14340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2020
Merged

[Collection forms] Make javascript generic #14340

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions form/form_collections.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,13 @@ the following ``data-prototype`` attribute to the existing ``<ul>`` in your temp

.. code-block:: html+twig

<ul class="tags" data-prototype="{{ form_widget(form.tags.vars.prototype)|e('html_attr') }}">
<ul class="tags" data-prototype="{{ form_widget(form.tags.vars.prototype)|e('html_attr') }}"></ul>

Now add a button just next to the ``<ul>`` to dynamically add a new tag

.. code-block:: html+twig

<button type="button" class="add_item_link" data-collection-holder-class="tags">Add a tag</button>

On the rendered page, the result will look something like this:

Expand Down Expand Up @@ -285,27 +291,18 @@ will be show next):

.. code-block:: javascript

var $collectionHolder;

// setup an "add a tag" link
var $addTagButton = $('<button type="button" class="add_tag_link">Add a tag</button>');
var $newLinkLi = $('<li></li>').append($addTagButton);

jQuery(document).ready(function() {
// Get the ul that holds the collection of tags
$collectionHolder = $('ul.tags');

// add the "add a tag" anchor and li to the tags ul
$collectionHolder.append($newLinkLi);

var $tagsCollectionHolder = $('ul.tags');
// count the current form inputs we have (e.g. 2), use that as the new
// index when inserting a new item (e.g. 2)
$collectionHolder.data('index', $collectionHolder.find('input').length);
$tagsCollectionHolder.data('index', $tagsCollectionHolder.find('input').length);

$addTagButton.on('click', function(e) {
$('body').on('click', '.add_item_link', function(e) {
var $collectionHolderClass = $(e.currentTarget).data('collectionHolderClass');
// add a new tag form (see next code block)
addTagForm($collectionHolder, $newLinkLi);
});
addFormToCollection($collectionHolderClass);
})
});

The ``addTagForm()`` function's job will be to use the ``data-prototype`` attribute
Expand All @@ -319,7 +316,10 @@ one example:

.. code-block:: javascript

function addTagForm($collectionHolder, $newLinkLi) {
function addFormToCollection($collectionHolderClass) {
// Get the ul that holds the collection of tags
var $collectionHolder = $('.' + $collectionHolderClass);

// Get the data-prototype explained earlier
var prototype = $collectionHolder.data('prototype');

Expand All @@ -341,7 +341,8 @@ one example:

// Display the form in the page in an li, before the "Add a tag" link li
var $newFormLi = $('<li></li>').append(newForm);
$newLinkLi.before($newFormLi);
// Add the new form at the end of the list
$collectionHolder.append($newFormLi)
}

.. note::
Expand Down