@ecl/file

中文文档
5.4.1发布于 2026/11/10EUPL-1.2ESM + CJS近 30 天下载 3617

ECL 文件

中文使用文档
文档目录3 节
  1. 参数
  2. 折旧
  3. 示例

欧共体 文件组件

npm 软件包 : @ecl/file

npm install --save @ecl/file

参数

  • 编号 (字符串)(默认:随机) 文件组件独有的 ID
  • 漫画 (对象)(默认: ): 类型图标的对象; 表示文件类型( 文件类型也应作为标题)
  • "标题" (字符串==object) (默认为:") 纯文本标题,或 ECL 链接结构后的链接对象
  • "描述" (字符串)(默认为:")描述文本
  • "语言" (字符串)(默认为:")文件的语言标签
  • "meta" (英语) (字符串)(默认:")文件元数据(大小,格式等)
  • "初级" (阵列) (默认: []) 文件的初级元
  • "下载" (对象)(默认: ): 下载链接, 遵循ECL 链接结构
  • “ 下载属性” (boolean) (默认:虚假) 添加 HTML 下载属性到下载链接
  • "画面" (关联数组) (默认: ): 缩略图图像, 遵循 ECL 图片结构
  • "标签" (阵列) (默认: []) ECL 标签对象的阵列(也作为单一标签对象支持)
  • "标签" (字符串)(默认为:""):标签区域的Aria标签
  • "名单" (阵列) (默认: []) ECL 描述列表对象的矩阵
  • "翻译" (阵列) (默认: []) 多语种版本的翻译面板:
    • "sr toggle"(字符串)(默认为:"): 附加切换标签; 屏幕阅读器
    • “ 下载属性” (布尔)(默认: 假) 在所有翻译链接中添加下载属性
    • “项目”(阵列)(默认:[]) 翻译项目:
      • "title" (字符串)(默认:") 语言标签
      • "meta" (字符串)(默认为:") 此语言版本的文件元数据
      • "lang" (字符串)(默认:") 语言代码(ISO 639-1)
      • (object) 此语言的下载链接覆盖( 回到父下载)
      • 下载此语言的属性覆盖
  • "超级" (字符串)(默认为:") 额外类(空格分隔)
  • “外部属性” (阵列) (默认: []) 额外属性
    • 名称 (字符串) 属性名称, 如“ 数据测试 ”
    • 值 (字符串) 属性值, 如 : “ data- test-1 ”

折旧

  • "变相" (字符串) (默认 : “ 默认 ” ) 显示变量; 可以是“ 默认 ” 或“ thumbnail ” ; 不使用更多
  • "详细信息" (阵列) (默认: []) 缩略图变量的额外元数据;被“ prime meta” 取代
  • "翻译.toggle" (对象)(默认: ): 切换按钮, 遵循 ECL 按钮结构; 现在直接设置在模板中

示例

{% include '@ecl/file/file.html.twig' with {
  title: 'File title',
  language: 'English',
  meta: '(16.2 MB - PDF)',
  primary_meta: ['Meta info', 'DD Month YYYY'],  
  description: 'File description',
  label: [
    {
      variant: 'highlight',
      label: 'Highlight',
    },
  ],
  labels_aria: 'Labels',
  icon: {
    name: 'file-pdf',
    family: 'phosphor',
    title: 'pdf',
  },
  download: {
    link: {
      label: 'Download',
      path: '/example',
    },
  },
  translation: {
    sr_toggle: 'Translations',
    items: [
      {
        title: 'български',
        meta: '(15.7 MB - PDF)',
        lang: 'bg',
        download: {
          link: {
            label: 'Download',
            path: '/example#bg',
          },
        },
      },
      ...
    ],
  },
} %}

版本与发布记录

@ecl/file 共发布 45 个版本,首次发布于 2025/01/22;过去 12 个月发布了 24 个版本。

版本发布日期距今
5.4.1latest2026/11/103 天前
5.4.02026/10/2222 天前
5.3.22026/10/081 个月前
5.3.12026/09/211 个月前
5.3.02026/09/151 个月前
5.2.22026/09/082 个月前

关于 @ecl/file 的常见问题

@ecl/file 是什么?

ECL 文件

如何安装 @ecl/file?

在项目目录运行 npm install @ecl/file,或使用 pnpm add / yarn add / bun add。

@ecl/file 支持 TypeScript 吗?

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

@ecl/file 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@ecl/file 可以商用吗?

@ecl/file 使用 EUPL-1.2 许可。声明的许可为 EUPL-1.2,请阅读许可原文确认使用条件。以上为概括,不构成法律意见,请以许可原文为准。

@ecl/file 的下载量有多少?

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

@ecl/file 还在维护吗?

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