octobercms
TypeScript icon, indicating that this package has built-in type declarations

1.3.2 • Public • Published

October AJAX Framework

This repository contains the AJAX framework of October CMS. If you want to build a website using October CMS, visit the main October CMS repository.

Installation outside October CMS

Your application can use the octobercms npm package to install the AJAX Framework as a module for build tools like webpack.

  1. Add the octobercms package to your application.
npm install --save octobercms
  1. Require and start the Framework in your JavaScript bundle.
import oc from 'octobercms';

// Make an AJAX request
oc.ajax('onSomething', { data: someVar });

// Serialize an element with the request
oc.request('.some-element', 'onSomething', { data: someVar });

jQuery Adapter

If jQuery is found, the traditional API can also be used.

// AJAX request with jQuery
$.request('onSomething', { data: someVar });

// Serialized request with jQuery
$('.some-element').request('onSomething', { data: someVar });

Documentation

Read the complete documentation on the October CMS website.

License

The October CMS platform is licensed software, see End User License Agreement (EULA) for more details.

Package Sidebar

Install

npm i octobercms

Weekly Downloads

256

Version

1.3.2

License

SEE LICENSE IN LICENSE.md

Unpacked Size

1.67 MB

Total Files

80

Last publish

Collaborators

  • daftspunk