README

Sprig Plugin for Craft CMS

A reactive Twig component framework for Craft CMS.

Sprig is a free plugin for Craft CMS that allows you to create reactive components from Twig templates and/or PHP classes. These components can re-render themselves on user-triggered events (clicks, changes to input fields, form submissions, etc.) using AJAX requests, without requiring you to write a single line of JavaScript.

Sprig enables common use-cases such as the following while completely avoiding full page refreshes:

• Live searching
• Loading more elements (with a button or infinite scroll)
• Pagination, ordering and filtering elements
• Adding products to a cart
• Submitting forms

Documentation

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

To see working examples and video tutorials, visit the learning resources.

License

This plugin is licensed for free under the MIT License.

Requirements

This plugin requires Craft CMS 3.1.19 or later, or 4.0.0 or later, or 5.0.0 or later.

Installation

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

composer require putyourlightson/craft-sprig

Created by PutYourLightsOn.