https://github.com/stillat/antlers-components
Makes it easy to integrate Blade and Livewire components into an Antlers template, and create isolated, reusable Antlers components utilizing partials.
https://github.com/stillat/antlers-components
Last synced: 11 months ago
JSON representation
Makes it easy to integrate Blade and Livewire components into an Antlers template, and create isolated, reusable Antlers components utilizing partials.
- Host: GitHub
- URL: https://github.com/stillat/antlers-components
- Owner: Stillat
- License: mit
- Created: 2023-03-03T19:56:12.000Z (over 3 years ago)
- Default Branch: main-v2
- Last Pushed: 2023-09-14T23:45:48.000Z (almost 3 years ago)
- Last Synced: 2024-03-15T09:22:32.188Z (over 2 years ago)
- Language: PHP
- Size: 176 KB
- Stars: 14
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license.md
Awesome Lists containing this project
README
Antlers Components is a Statamic addon that makes creating isolated, reusable Antlers partials easy and integrating existing Blade and Livewire components a breeze using a familiar syntax.
## Installation
You may install Antlers Components using composer:
```bash
composer require stillat/antlers-components
```
## Requirements
Antlers Components requires at least PHP 8.1 and:
* Statamic version `3.4.*` or higher
* Laravel `9.36` or higher
This package provides a familiar syntax for Livewire components, and it is compiled into the Antlers tags provided by this package:
[https://github.com/marcorieser/statamic-livewire](https://github.com/marcorieser/statamic-livewire)
In order to use the Livewire/Flux syntax, you will also need to install it using the following command:
```bash
composer require marcorieser/statamic-livewire
```
For support/reporting issues related to the Livewire functionality beyond compilation errors, please use the following GitHub link:
[https://github.com/marcorieser/statamic-livewire/issues](https://github.com/marcorieser/statamic-livewire/issues)
## Using Blade Components
You may use Blade Components within your Antlers template using the syntax you are familiar with.
For example, to include a `card` Blade component we may use the `` syntax. This package supports Blade component slots; you may use Antlers within the slot:
```antlers
{{ collection:articles }}
{{ title }}
{{ content | safe_truncate(120) }}
...
{{ /collection:articles }}
```
Using Antlers inside parameter values is acceptable.
## Livewire Components
We can integrate existing Livewire components in our Antlers templates using the `` syntax like so:
```antlers
{{ collection:articles }}
{{ /collection:articles }}
```
## Flux Components
If you'd like to use [Flux](https://fluxui.dev/) components, ensure you've also installed the Livewire addon.
### Flux v1 Styles and Scripts
Once you have Livewire and Flux installed in your site, you can use the `flux` tag to add the required styles and scripts to your layout:
```antlers
{{ flux:styles /}}
{{ template_content /}}
{{ flux:scripts /}}
```
You may now use Flux components directly within your Antlers templates (or within your Livewire components if you are using Antlers for those).
### Flux v2 Styles and Scripts
Once you have Livewire and Flux installed in your site, you can use the `flux` tag to add the required styles and scripts to your layout:
```antlers
{{ flux:appearance /}}
{{ template_content /}}
{{ flux:scripts /}}
```
You may now use Flux components directly within your Antlers templates (or within your Livewire components if you are using Antlers for those).
## Supported Parameter Types
This package supports the following parameter types when compiling component tags to Antlers:
**Shorthand Variables**:
```antlers
{{ title = 'The title'; }}
```
**Variable References**:
```antlers
{{ title = 'The title'; }}
```
**Name/Value**:
```antlers
{{ title = 'The title'; }}
```
**Attribute**:
```antlers
```
## Antlers Components
This package also supports the concept of Antlers "components", which are really just syntax sugar on top of partials (with a few special behaviors).
As an example, we could include a partial named `partial-name.antlers.html` using this library like so:
```antlers
```
**Very Important**: When using this syntax, the partials **will not** inherit the scope they were included in (except for the general Cascade). This means that if we want current data to be supplied to our partial, we must explicitly pass it in via. parameters.
The behavior of slots is also slightly different when using this syntax, and is closer to anonymous Blade components.
Let us consider an Antlers partial named `_card.antlers.html`:
```antlers
{{ title }}
{{ slot }}
{{ footer }}
```
we can render this Antlers partial in our main template like so:
```antlers
{{ collection:articles }}
{{ title }}
...
{{ content | safe_truncate(120) }}
{{ /collection:articles }}
```
> Note: We have to explicitly allow the current article's title and content values by supplying them via. parameters. Without this, it will default to the current page's values.
When using this syntax, we do not need to prefix named slots with `slot:` inside our partial. Additionally, we also have access to an attributes bag. Parameters supplied to named slots will be available within the partial, as well:
```antlers
{{ collection:articles }}
{{ title }}
...
{{ content | safe_truncate(120) }}
{{ /collection:articles }}
```
### Nesting Antlers Component Partials
We may also nest partial components by including them within other components. Like with regular components, we must specify what values we want to be passed along to our nested components:
```antlers
```
We can check if we are inside a nested/child component using the `__is_nested` variable:
```antlers
{{ if __is_nested }}
I am a nested partial.
{{ else }}
I am not nested.
{{ /if }}
```
We can also see how deeply nested we are using the `__depth` variable:
```antlers
The current nested partial depth is: {{ __depth }}.
```
And finally, we may access data from the parent partial if we are nested by referencing the `__parent` variable:
```antlers
{{ __parent.title }}
```
If that parent has a parent, we can keep on going:
```antlers
{{ __parent.__parent.title }}
```
## License
This addon is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).