sushidev/fairu-statamic

There is no license information available for the latest version (v1.7.0) of this package.

v1.7.0 2025-04-29 08:23 UTC

Requires

• laravel/prompts: ^0.3.5
• statamic/cms: ^5.51

Requires (Dev)

• orchestra/testbench: ^9.0

Unknown License

README

This is the official Fairu addon for Statamic.

Fairu is your new powerful image and file proxy with the goal in mind to deliver your files in an optimized way.

Features

This addon provides:

• Import all your assets into fairu.app using our commands
• Antlers tags making image handling smooth sailing.
• Fieldset to easily embed Fairu hosted files into your new or existing project

How to use

You can install this addon via Composer:

composer require sushidev/fairu-statamic

Add env variables

Find your tenant ID in the tenant settings and create an API key for your application.

FAIRU_TENANT=[YOUR_TENANT_ID]
FAIRU_TENANT_SECRET=[YOUR_API_KEY_SECRET]

Import

On an existing project, you can run the following command which will automatically import all the connected assets into your fairu account. Depending on on the amount of files it might take some time.

php please fairu:setup

After the initial import, file paths will be transformed into the new Fairu-ID format dynamically.

Antlers tags

There are several tags available to generate different code.

Metadata

Note

The tags generally don't fetch metadata from the Fairu server and build the file path locally. Use the fetchMeta parameter to fetch the asset information from Fairu.

You can fetch metadata by passing fetchMeta="true" to the tags, which makes the metadata accessible:

• alt
• caption
• description
• copyrights
• focal_point (x-y-zoom e.g. 40-30-1)
• focus_css (e.g. 40% 30%)
• name
• size
• is_image | is_video | is_pdf | is_audio | mime | extension
• width | height
• ...

Available parameters

Field	Description	fairu	:url	:image	:images
⁠id	The file ID	✓	✓	✓	✓
⁠name	Custom filename	✓	✓	✓	✓
alt	Custom alt	✓		✓	✓
⁠width	Resize image width	✓		✓	✓
⁠height	Resize image height	✓		✓	✓
⁠quality	Image quality (default: 90)	✓		✓	✓
⁠sources	Semicolon separated srcset entries	✓		✓	✓
ratio	Aspect ratio for sources	✓		✓	✓
⁠format	Convert image format	✓		✓	✓
⁠focal_point	Focal point for cropping	✓		✓	✓

{{ fairu }}

Get the file and get access to image properties.

{{ fairu id="ID" alt="Alt text" }}
    <img
        src="{{ url }}"
        alt="{{ alt }}" />
{{ /fairu }}

{{ fairu:url }}

Get the URL of a file.

{{ fairu:url id="ID" name="filename.webp" }}

<!-- Outputs -->
https://fairu.app/files/[UUID]/filename.webp

{{ fairu:image }}

Generate a complete HTML image tag.

{{ fairu:image id="ID" width="800" height="600" class="my-image" alt="Image description" }}

<!-- Outputs -->

<img
    src="https://fairu.app/files/[UUID]/filename.webp?width=800&height=600"
    alt="Image description"
    class="my-image" />

{{ fairu:images }}

Generate multiple HTML image tags (see [[#{{ fairu image }}]])

{{ fairu:images ids="[IDS]" width="800" height="600" class="my-image" alt="Image description" }}

<!-- Outputs -->

<img
    src="https://fairu.app/files/[UUID1]/filename1.webp?width=800&height=600"
    alt="Image description" />
<img
    src="https://fairu.app/files/[UUID2]/filename2.webp?width=800&height=600"
    alt="Image description" />
...

Responsive Images

With most of our tags you have easy access to implementing responsive images using the native srcset and sizes properties to define when which source (version of the image) should be used. See the mdn documentation for a great introduction into implementing responsive images.

Implementation

The sources attribute provides a way to easily pass an array of widths, breakpoints and optionally heights to generate a srcset property that includes all listed sources.

This allows you to pass the sources property and use the calculated srcset property along with a fitting sizes to define which sources should be used when:

{{ fairu id="ID" sources="100,100w;512,512w" }}
<img
    src="{{ url }}"
    srcset="{{srcset}}"
    sizes="(min-width: 800px) 100vw; 800px" />
{{ /fairu }}

<!-- Outputs -->
<img
    src="https://fairu.app/files/[UUID1]/filename1.webp"
    srcset="
        https://fairu.app/files/[UUID1]/filename1.webp?width=100 100w,
        https://fairu.app/files/[UUID1]/filename1.webp?width=512 512w
    "
    sizes="(min-width: 800px) 100vw; 800px" />

Formats

Each pair consists of:

• A width value (in pixels) that defines the image width at that breakpoint
• A height value (in pixels) that defines the image height at that breakpoint (optional)
• A breakpoint value (with 'w' suffix) that corresponds to the viewport width

sources="[width1],[breakpoint1]w;[width2],[breakpoint2]w"

<!--
Example:
"320,320w;480,800w;768,1200w;1200,1600w;1920,2400w" 
-->

sources="[width1],[height1],[breakpoint1]w;[width2],[height2],[breakpoint2]w"

<!--
Example:
"320,150,320w;480,280,800w,768,1200w;1200,1600w,1920:2400w"
-->

Ratio

If all sources should have the same aspect ratio, you can use the ratio attribute as a shortcut without height:

{{ fairu id="ID" sources="320,320w;480,800w;768,1200w;1200,1600w;1920,2400w" ratio="16/9" }}

This calculates all heights accordingly.

The sizes attribute

The ⁠sizes attribute tells the browser how large the image will be displayed at different viewport widths. If not provided, it will be auto-generated based on the breakpoints in the ⁠sources parameter.

For a full-width responsive image, you can leave the sizes property empty or you can use:

sizes="100vw"

For more complex layouts, add media queries and a default or fallback value as last value:

sizes="(min-width: 1200px) 1200px, (min-width: 768px) 800px, 100vw"

Details

For more information, visit the documentation at https://docs.fairu.app/docs/addons/statamic to find out what else you can do with Fairu.