README

This plugin allows you to output all static translation messages into Javascript object and to easily transfer any Twig variables into Javascript.

Requirements

This plugin requires Craft CMS 5.0.0 or later.

Installation

To install the plugin, follow these instructions.

Open your terminal and go to your Craft project:
```
 cd /path/to/project
```

Then tell Composer to load the plugin:

 composer require craftsnippets/javascript-helpers

In the Control Panel, go to Settings → Plugins and click the “Install” button for Javascript helpers.

Javascript helpers Overview

Javascript helpers plugin provides two Twig variables and one filter.

Twig variables

craft.jsHelpers.getMessages('locale_code') - returns all static message translations as Twig array. By default it returns them for current site locale, but you can pass specific locale code as optional paramater to overwrite it.
craft.jsHelpers.outputMessages('array_name', 'locale_code') - outputs static message translations into Template as Javascript array, at the end of <body> tag. First parameter specifies Javascript array name. By default static message translations are returned for current site locale, but you can pass specific locale code as optional second paramater to overwrite it.

Twig filters

jsVar('variable_name') - outputs Twig variable as Javascript variable, at the end of <body> tag. For example:

{{someTwigVariable|jsVar('some_js_variable')}}

Will output Javascript variable named some_js_variable into template, containing contents of someTwigVariable. Works both for variables with single value and for arrays or objests.

Hint: you can also achieve the same effect without this plugin, by using

{% do view.registerJsVar('some_js_variable', someTwigVariable, POS_END) %}

Disclaimer

Brought to you by Piotr Pogorzelski

Plugin icon by Benjamin J sperry.

craftsnippets / javascript-helpers

Maintainers

Details