innoweb/silverstripe-requirements-resolver

Helper module to resolve the path to global requirements like jQuery and the like.

2.0.0 2023-03-16 11:03 UTC

Requires

• silverstripe/cms: ^5
• silverstripe/vendor-plugin: ^2

Suggests

• innoweb/silverstripe-bundled-userforms: Bundles the requirements for UserForms using the requirements-resolver module.

BSD-3-Clause

• Florian Thoma

• jquery
• silverstripe
• resolve
• global
• requirements

README

Overview

Helper module to resolve the path to global requirements like jQuery, and the like.

It helps making sure that only one version of a certain library is included for a site.

It also makes sure that when a JS requirement is called twice, once with defer/async and once without, the requirement is included without async/defer to make sure all js code works.

Requirements

SilverStripe CMS 5, see composer.json

Note: this version is compatible with Silverstripe 5. For Silverstripe 4, please see the 1 release line.

Installation

Install the module using composer:

composer require innoweb/silverstripe-requirements-resolver dev-master

Then run dev/build.

Usage

In PHP

Requirements::javascript(
    RequirementsResolver::get('jquery')
);

In template

<% require javascript($ResolveRequirement("jquery")) %>

Configuration

The following requirements are pre-configured in the module's config:

'jquery': '//code.jquery.com/jquery-3.3.1.min.js'
'jquery-validate': '//cdnjs.cloudflare.com/ajax/libs/jquery-validate/1.13.1/jquery.validate.min.js'
'jqueryui-js': '//code.jquery.com/ui/1.12.1/jquery-ui.min.js'

Additional requirements can be added the the module's config:

Innoweb\RequirementsResolver\RequirementsResolver:
  requirements:
    '{key}': '{URL}'

Once configured, the key can be used to load the Requirements path.

License

BSD 3-Clause License, see License