@a2lix/symfony-collection

中文文档
0.6.1发布于 2023/01/02MITCommonJS零依赖近 30 天下载 1858

Manage your Symfony Form collection simply with vanilla JS

原始使用文档
文档目录5 节
  1. Install
  2. Basic use
  3. Advanced use
  4. Nested collection(s)
  5. Contribute help

A2LiX JS - symfony-collection

Manage your Symfony Form collection simply with vanilla JS

npm version

image

Install

npm install @a2lix/symfony-collection

Basic use

See Symfony Encore example (https://github.com/a2lix/Demo/blob/master/assets/app.js)

import a2lix_lib from '@a2lix/symfony-collection/dist/a2lix_sf_collection.min'

a2lix_lib.sfCollection.init()

Advanced use

Default configuration https://github.com/a2lix/symfony-collection/blob/master/src/a2lix_sf_collection.ts#L3-L45 can be customized globally in javascript during init

a2lix_lib.sfCollection.init({
  entry: {
    add: {
        label: 'Add entry'
    },
}}

Or/And more precisely on each collection by using DOM attributes:

  ...
    ->add('categories', CollectionType::class, [
        ...
        'attr' => [
          'data-entry-add-label' => 'Add Category',
        ],
    ])

Nested collection(s)

As advised by SF in this case, you must override the default 'prototype_name' option (https://symfony.com/doc/current/reference/forms/types/collection.html#prototype-name) of the nested collection with a custom name. Then, set this same custom name in a 'data-prototype-name' DOM attribute.

Example of a 'tags' collection nested in a 'categories' collection:

  ...
    ->add('tags', CollectionType::class, [
        'entry_type' => TextType::class,
        'allow_add' => true,
        'allow_delete' => true,
        'delete_empty' => true,
        'by_reference' => false,
        'prototype_name' => '__name2__',  // Advised by Symfony
        'attr' => [
            'data-prototype-name' => '__name2__'  // Required by a2lix_sf_collection
        ],
        'entry_options' => [
            'label' => false,
        ],

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

Demo

See Demo project.

版本与发布记录

@a2lix/symfony-collection 共发布 10 个版本,首次发布于 2018/04/09;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.6.1latest2023/01/023 年前
0.6.02023/01/023 年前
0.5.22022/10/064 年前
0.5.12022/08/194 年前
0.5.02022/08/194 年前
0.4.02020/04/026 年前

关于 @a2lix/symfony-collection 的常见问题

@a2lix/symfony-collection 是什么?

Manage your Symfony Form collection simply with vanilla JS

如何安装 @a2lix/symfony-collection?

在项目目录运行 npm install @a2lix/symfony-collection,或使用 pnpm add / yarn add / bun add。

@a2lix/symfony-collection 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/a2lix__symfony-collection 是否存在。

@a2lix/symfony-collection 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@a2lix/symfony-collection 可以商用吗?

@a2lix/symfony-collection 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@a2lix/symfony-collection 的下载量有多少?

根据 npm 官方下载统计,@a2lix/symfony-collection 在 2026/10/05 – 2026/11/03 这 30 天内被下载 1,858 次,日均约 62 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@a2lix/symfony-collection 还在维护吗?

最新版本 0.6.1 发布于 2023/01/02(3 年前);至今共发布 10 个版本,其中过去 12 个月发布了 0 个;首次发布于 2018/04/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。