riclep/laravel-storyblok-previews

Artisan command for creating component preview images for Storyblok

0.0.6 2024-12-06 09:55 UTC

Requires

• php: ^8.0
• ext-curl: *
• hammerstone/sidecar: ^0.6.1
• riclep/laravel-storyblok-cli: ^2.0
• storyblok/php-client: ^2.2
• wnx/sidecar-browsershot: ^2.3

MIT

• Richard Le Poidevin

• cli
• laravel-storyblok
• riclep
• storyblok cli
• laravel cli
• artisan storyblok
• stryblok

README

Artisan commands for working with the Storyblok API in Laravel.

Installation

You can install the package via composer:

composer require riclep/laravel-storyblok-previews

Make sure you publish the config file with the following command:

php artisan vendor:publish --provider="Riclep\StoryblokPreviews\StoryblokPreviewsServiceProvider" --tag="config"

Please ensure you have configured the Laravel Storyblok or Laravel Storyblok CLI package before using this package.

You will also need to set up Sidecar Browsershot.

If you would like to use a different screenshot driver, feel free to submit a PR.

Usage

This is a package you may wish you install outside of your main project and use it simply to generate screenshots of your Storyblok components for various websites or projects but adjust the configuration to suit your needs.

To specify the components you would like to generate screenshots for modify your storyblok-previews.php config file.

Each component will need an entry in the components item. The item’s key should match the component name in Storyblok. Each component should have a selector to target the component in the HTML. Optionally, you can specify a filename for the screenshot, a URL to navigate to and a delay in milliseconds to wait before taking the screenshot. If you leave the filename empty, the component name will be used. If you don't specify a URL it will try and find a published page in Storyblok that contains the component.

Example:

    [
        'hero' => [
            'selector' => '.hero',
        ],
        'grid' => [
            'delay' => 500,
            'filename' => 'grid.jpg',
            'selector' => ':has(> .grid),
            'url' => '/about',
        ],
    ];

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Richard Le Poidevin
• All Contributors

License

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

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.