putyourlightson/craft-datastar-module

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

1.0.0-beta.2 2024-12-17 12:24 UTC

Requires

• php: ^8.2
• craftcms/cms: ^5.0
• starfederation/datastar-php: 1.0.0-beta.3

Requires (Dev)

• craftcms/ecs: dev-main
• craftcms/phpstan: dev-main
• markhuot/craft-pest-core: ^2.0.4
• nystudio107/craft-autocomplete: ^1.12

mit

README

Datastar Module for Craft CMS

This module provides the core functionality for the Datastar plugin. If you are developing a Craft plugin/module and would like to use Datastar in the control panel, you can require this package to give you its functionality, without requiring that the Datastar plugin is installed.

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

{
  "require": {
    "putyourlightson/craft-datastar-module": "^1.0.0-beta.1"
  }
}

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

use craft\base\Plugin;
use putyourlightson\datastar\Datastar;

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

        Datastar::bootstrap();
    }
}

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

<button data-on-click="{{ datastar.sse('_datastar/search') }}">Search</button>

Datastar plugin issues should be reported to https://github.com/putyourlightson/craft-datastar/issues

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

Documentation

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

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-datastar-module:^1.0.0-beta.1

Created by PutYourLightsOn.