Frosty - a Statamic Addon

Frosty provides easy access to fetch Ajax content in Statamic.

Requirements

PHP 8.0 or higher
Statamic 3.1 or higher

Installation

You can install the package via composer:

composer require handmadeweb/frosty

Copy the package config to your local config with the publish command:

php artisan vendor:publish --tag="config" --provider="HandmadeWeb\Frosty\ServiceProvider"

Prepare for Usage

Native Method

If you aren't using Alpine Js in your application then you'll need to load handmadeweb/datafetcher.js in your footer, you can either do this manually, or via the provided helpers for Alpine: {{ frosty:scripts }}, Blade: @frostyScripts or PHP: \HandmadeWeb\Frosty\Frosty::scripts();

This method uses the native.blade.php view, you are free to override it in resources/vendor/frosty/, you will have access to the content, endpoint and mode variables.

Alpine.Js Method

If you are using Alpine.Js in your application then you may update your Frosty configuration to use Alpine.

/*
* Mode
*
* Which mode to use?
*
* native: uses https://github.com/handmadeweb/datafetcher.js
* - If you aren't using Alpine Js in your application then you'll need to load handmadeweb/datafetcher.js in your footer.
* - You can either do this manually, or via the provided helpers for Alpine: `{{ frosty:scripts }}`
* - Blade: `@frostyScripts` or PHP: `\HandmadeWeb\Frosty\Frosty::scripts();`
*
* alpine: uses Alpine.Js, be sure to load it.
*/
'mode' => 'alpine',

This method uses the alpine.blade.php view, you are free to override it in resources/vendor/frosty/, you will have access to the content, endpoint and mode variables.

Custom Method

You are free to use a custom method, you may do so by defining a new view template for Frosty to use under resources/vendor/frosty, the filenames alpine, native and not-found are considered to be reserved, although you may override them if you wish.

Once you have created a new view for your mode, you will have access to the content, endpoint and mode variables, you may then use this to provide the content or endpoint to your custom method.

Then it is just a matter of updating the mode to use the name of your new method/view.

Lets say we created a file called myCustomVueMode.blade.php which might contain something like,

<vue-fetcher endpoint="{{ $endpoint }}" initial-content="{!! $content !!}" />

You would then update your mode to:

'mode' => 'myCustomVueMode',

In the event that your custom method/mode doesn't have a corresponding view file, then Frosty will insert some HTML comments in the location of where it would have rendered your method.

<!-- Frosty could not be rendered, Mode not found -->

<!-- If the page is being viewed by a Super Administrator, then the below will also be inserted as a comment. -->
<!-- Mode: {{ $mode }} -->
<!-- Endpoint: {{ $endpoint }} -->

Antlers Usage

Using Frosty in Antlers can be done by using the frosty tag or if you are using an .antlers.php template file by using the class (see class instructions)

You can use the tag as either frosty:fetch or just frosty, I like frosty:fetch a little more though as it describes what it is doing.

Pulling in content from a url.

The url can be anywhere.

{{ frosty:fetch url="/ajax/signup-form" }}

{{ frosty:fetch endpoint="/ajax/signup-form" }}

Pulling in content from a route.

Routes must be a GET route and cannot currently accept parameters.

{{ frosty:fetch route="ajax.signup-form" }}

Please note that the above three examples cannot be combined into a single tag call.

{{ frosty:fetch endpoint="/ajax/signup-form" url="/ajax/signup-form" route="ajax.signup-form" }}
{{ frosty:fetch route="ajax.signup-form" endpoint="/ajax/signup-form" url="/ajax/signup-form" }}

The first found parameter will be used, parameters are checked in the order: endpoint, url, route.

Using initial content then pulling new content.

This works with both the route and url options.

{{ frosty:fetch route="ajax.news" }}
    <p>Finding something juicy!</p>
{{ /frosty:fetch }}

Using a different mode/view.

You are free to use any other mode/view that might be available for Frosty to use, separately to whatever you might have set as the config default. You can do this by passing the mode parameter, which will relate to the name of a view file located in resources/vendor/frosty/

{{ frosty:fetch route="ajax.news" mode="myCustomVueMode" }}
    <p>Finding something juicy!</p>
{{ /frosty:fetch }}

Blade Usage

Using Frosty in Blade can be done by using the frosty blade directive or by using the class (see class instructions) The blade directive currently doesn't accept providing content or context, If you need to use that functionality the you'll need to use the class chaining method.

@frosty(string $endpoint = null)

You can also use named arguments in PHP 8+ to specify particular parameters.

@frosty(endpoint: '/ajax/sponsors')

Pulling in content from a url.

@frosty('/ajax/sponsors')

Pulling in content from a route.

@frosty(route('ajax.sponsors', 'featured'))

Using a different mode/view.

@frosty(route('ajax.sponsors', 'featured'), 'myCustomVueMode')

Class Usage

New up the class.

new Frosty(string $endpoint = null)

Or use the make method.

Frosty::make(string $endpoint = null)

You can also use named arguments in PHP 8+ to specify particular parameters.

$frosty = Frosty::make(endpoint: '/ajax/random-quote');

You are free to use any other mode/view that might be available for Frosty to use, separately to whatever you might have set as the config default. You can do this by passing the mode (or second) parameter, which will relate to the name of a view file located in resources/vendor/frosty/

$frosty = Frosty::make('/ajax/random-quote', 'myCustomVueMode');
// You are free to use the named argument style of mode: 'myCustomVueMode'

Aditional methods can be chained to add content and context, or to set the endpoint.

$frosty = Frosty::make();
$frosty->withContent($content); // string
$frosty->withContext($context); // \Statamic\Tags\Context or \Illuminate\Support\Collection (Used to provide Cascaded variables to the content)
$frosty->withEndpoint($endpoint); // string

When using the tag, you'll specify if the endpoint is a url or a route, however when using the class directly, the endpoint is assumed to be a url string, if you wish to pass a route to it instead, then you are welcome to do that.

Unlike when using the Frosty tag, the Frosty class can directly accept parameters on the route below.

Frosty::make(route('ajax.cart', $user->id())
// or
Frosty::make()->withEndpoint(route('ajax.cart', $user->id())

When you are ready to output the content, then you may call the render method.

Frosty::make()
    ->withContent($content) // Optional
    ->withContext($context) // Optional
    ->withEndpoint($endpoint) // Optional (could be set on class or make), If no endpoint has been set, then we won't bother trying to render.
    ->render();

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.