Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
An ExpressionEngine extension that lets you to retrieve EE settings and resources from client side JavaScript libraries.
JavaScript PHP
branch: master

README.textile

EEJS, for ExpressionEngine

EEJS is a javascript library that helps you to develop ExpressionEngine add-ons by giving
you easy access to EE settings and channel information from within your javascript library.

Currently early in development, the aim of this library is to open up information within
the ExpressionEngine installation so that it can be easily consumed by JS libraries.

Examples:

//EE PHP Configurations & Constants
eejs.config('webmaster_email');             // webmaster@example.com
eejs.action('Member', 'register_member');   // 10 

//URLs
eejs.url('foo/bar')                         // http://example.com/foo/bar/
eejs.templateUrl('foo/bar')                 // http://example.com/index.php/foo/bar/
eejs.actionUrl('Member', 'member_login')    // http://example.com/?ACT=15

Installation

The library is packaged as an ExpressionEngine extension.

  1. Copy the system/expressionengine/third_party/eejs folder to the same
    location in your EE installation
  2. Install the extension by logging into your EE control panel and going to
    Add-ons → Extensions and then installing the Eejs extension.

Documentation

Sorry, but this is still to be done.

If you have time on your hands, or are insanely interested, you can have a look through the
behaviour tests system/expressionengine/third_party/eejs/tests/spec/EejsSpec.js to see
how the module currently works!

If you’re feeling super helpful you could even fork, write some documentation and submit
a pull request!

Something went wrong with that request. Please try again.