drupal 模块 libraries.yml 文件配置讲解

Drupal 中,模块库是可以由其他模块或主题加载的 JavaScript 和 CSS 文件的集合。该libraries.yml文件是一个 YAML 格式的文件,它定义了模块库中包含的资产,并提供了有关应如何加载这些资产的元数据。
 
这是一个示例libraries.yml文件:
 
yaml
 
复制代码
my_module:
  version: 1.x
  css:
    theme:
      css/my_module.css: {}
  js:
    js/my_module.js: {}
    dependencies:
      - core/jquery
      - core/drupal
在此示例中,库已命名my_module且版本号为1.x. 和css键js分别表示库中包含的 CSS 和 JavaScript 文件。每个文件都由其在模块目录中的相对路径标识。
 
该css键包含一个子键theme,表示 CSS 文件应作为主题资产而不是模块资产加载。这意味着 CSS 文件可以被主题覆盖,从而允许更灵活的样式。
 
该js键包含一个子键dependencies,其中列出了库所依赖的 JavaScript 文件。在此示例中,库需要在加载其自己的 JavaScript 文件之前加载核心 jQuery 和 Drupal JavaScript 文件。
 
文件中还可以提供其他元数据libraries.yml,例如weight库的(确定加载顺序),以及库是否应该异步加载。
 
总的来说,该libraries.yml文件提供了一种清晰和结构化的方式来定义和管理 Drupal 中的模块库,使开发人员更容易确保正确有效地加载他们的资产。