README

Spark Module for Craft CMS

This module provides the core functionality for the Spark plugin, a real-time, template-driven hypermedia framework for Craft CMS. If you are developing a Craft plugin/module and would like to use Spark in the control panel, you can require this package to give you its functionality, without requiring that the Spark plugin is installed.

First require the package in your plugin/module’s composer.json file.

{
  "require": {
    "putyourlightson/craft-spark-module": "^1.0.0-alpha.1"
  }
}

Then bootstrap the module from within your plugin/module’s init method.

use craft\base\Plugin;
use putyourlightson\spark\Spark;

class MyPlugin extends Plugin
{
    public function init()
    {
        parent::init();

        Spark::bootstrap();
    }
}

Then use the Spark function and tags as normal in your control panel templates.

<button data-on-click="{{ spark('_spark/search') }}">Search</button>

Spark plugin issues should be reported to https://github.com/putyourlightson/craft-spark/issues

The Spark plugin changelog is at https://github.com/putyourlightson/craft-spark/blob/develop/CHANGELOG.md

Documentation

Learn more and read the documentation at putyourlightson.com/plugins/spark »

License

This plugin is licensed for free under the MIT License.

Requirements

This plugin requires Craft CMS 5.0.0 or later.

Installation

Install this package via composer.

composer require putyourlightson/craft-spark-module:^1.0.0-alpha.1

Created by PutYourLightsOn.