symfony-collection's Introduction

A2LiX JS - symfony-collection

Manage your Symfony Form collection simply with vanilla JS

Install

As first thing you need to pull the package using yarn or npm

yarn add @a2lix/symfony-collection

npm install @a2lix/symfony-collection

Then you can either import it in your files using ES6

import a2lix_lib from '@a2lix/symfony-collection/src/a2lix_sf_collection';

or symlink/copy/move it in a folder and reference it directly in a script tag

How to

After you loaded the dist version of a2lix_sf_collection.min.js file or imported through ES6 method, init a2lix_lib.sfCollection, optionnaly with custom configuration.

Default configuration:

a2lix_lib.sfCollection.init({
    collectionsSelector: 'form div[data-prototype]',
    manageRemoveEntry: true,
    lang: {
      add: 'Add',
      remove: 'Remove'
    }
})

Example

<script src="__PATH_TO__a2lix_sf_collection.min.js"></script>

<script>
// A global initialization on all Symfony Form collection with manageRemoveEntry feature enable
a2lix_lib.sfCollection.init()


// OR a custom initialization with restricted scope of Symfony Form collection with manageRemoveEntry feature disable
a2lix_lib.sfCollection.init({
    collectionsSelector: 'form div[data-a2lix-collection]',
    manageRemoveEntry: false
})
</script>

Contribute help

docker run -it --rm --user $(id -u):$(id -g) --name a2lix_nodejs -v "$PWD":/usr/src/app -w /usr/src/app node:alpine npm install
docker run -it --rm --user $(id -u):$(id -g) --name a2lix_nodejs -v "$PWD":/usr/src/app -w /usr/src/app node:alpine npm run build