README

Spark Plugin for Craft CMS

A real-time, template-driven hypermedia framework for Craft CMS.

This plugin is in alpha and its API may change.

Spark is a free plugin for Craft CMS that allows you to create real-time front-ends driven by Twig templates. It aims to replace the need for front-end frameworks such as React, Vue.js and Alpine.js + htmx, and instead lets you manage state and run logic all within your Twig templates.

With Spark, you have the ability to define state and manipulate the DOM in real-time on the front-end, and modify parts of the DOM with templates rendered on the back-end. Use-cases for Spark are:

Live searching elements
Loading more elements / Infinite scroll
Paginating, ordering and filtering lists of elements
Submitting forms and running actions
Pretty much anything to do with reactive front-ends

Spark is lightweight, performant and strongly opinionated about embracing hypermedia and removing front-end complexity. It can be used for anything from simple to complex use-cases.

Read The Case for Spark and join in the discussion.

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

To install the plugin, search for “Spark” in the Craft Plugin Store, or install manually using composer.

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

Created by PutYourLightsOn.

putyourlightson / craft-spark

Maintainers

Details