https://github.com/putyourlightson/craft-sprig-core
A reactive Twig component framework for Craft CMS.
https://github.com/putyourlightson/craft-sprig-core
Last synced: 4 months ago
JSON representation
A reactive Twig component framework for Craft CMS.
- Host: GitHub
- URL: https://github.com/putyourlightson/craft-sprig-core
- Owner: putyourlightson
- License: mit
- Created: 2021-09-27T09:58:41.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2025-09-14T15:12:22.000Z (9 months ago)
- Last Synced: 2025-10-22T15:55:54.626Z (7 months ago)
- Language: PHP
- Size: 722 KB
- Stars: 4
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
[]((https://packagist.org/packages/putyourlightson/craft-sprig-core))
[](https://packagist.org/packages/putyourlightson/craft-sprig-core)
# Sprig Core Module for Craft CMS
This module provides the core functionality for the [Sprig plugin](https://github.com/putyourlightson/craft-sprig), a reactive Twig component framework for [Craft CMS](https://craftcms.com/). If you are developing a Craft plugin/module and would like to use Sprig in the control panel, then you can require this package to give you its functionality, without requiring that the site has the Sprig plugin installed.
First require the package in your plugin/module’s `composer.json` file.
```json
{
"require": {
"putyourlightson/craft-sprig-core": "^2.0"
}
}
```
Then bootstrap the module from within your plugin/module’s `init` method.
```php
use craft\base\Plugin;
use putyourlightson\sprig\Sprig;
class MyPlugin extends Plugin
{
public function init()
{
parent::init();
Sprig::bootstrap();
}
}
```
Then use the Sprig function and tags as normal in your control panel templates.
```twig
{{ sprig('_components/search') }}
```
If your plugin/module registers an asset bundle that depends on htmx being loaded, ensure that you specify the `HtmxAssetBundle` class as a dependency.
```php
use craft\web\AssetBundle;
use putyourlightson\sprig\assets\HtmxAssetBundle;
class MyAssetBundle extends AssetBundle
{
public $depends = [
HtmxAssetBundle::class,
];
}
```
Sprig plugin issues should be reported to https://github.com/putyourlightson/craft-sprig/issues
The Sprig plugin changelog is at https://github.com/putyourlightson/craft-sprig/blob/develop/CHANGELOG.md
## Documentation
Learn more and read the documentation at [putyourlightson.com/plugins/sprig »](https://putyourlightson.com/plugins/sprig)
To see working examples and video tutorials, visit the [learning resources](https://putyourlightson.com/sprig).
## License
This package is licensed for free under the MIT License.
## Requirements
This module requires [Craft CMS](https://craftcms.com/) 3.1.19 or later, or 4.0.0 or later, or 5.0.0 or later.
## Installation
Install this package via composer.
```shell
composer require putyourlightson/craft-sprig-core
```
---
Created by [PutYourLightsOn](https://putyourlightson.com/).