humanmade/hm-carousel-block

Lightweight carousel block using SplideJS

1.0.0 2025-02-17 10:53 UTC

Requires

• php: >=8.0

GPL-2.0-or-later

README

HM Carousel Block is a lightweight WordPress plugin designed to add a carousel block to modern WordPress sites. It uses the Splide library, which is lightweight (12kB gzipped) and accessible.

Features

• Lightweight with no dependencies
• Uses Splide library for carousel functionality
• Accessible and responsive design
• Easy to use and customize
• Allows you to put any blocks or patterns in carousel slides
• Supports using the Query Loop block to create a carousel of posts
• Supports various navigation types (button, pagination, and thumbnails)
• Bring your own styles. We only load the minimal core splide CSS needed to function. You can style everything else as you wish. More info below.

Installation

1. Download the plugin zip file.
2. In your WordPress admin panel, go to Plugins > Add New.
3. Click "Upload Plugin" and choose the downloaded zip file.
4. Click "Install Now" and then "Activate" the plugin.

Usage

1. In the WordPress editor, add a new block.
2. Search for "Carousel" and add it to your page or post.
3. Note that the view in the editor is a simplified version for ease of managing the content.
4. Add Carousel Slide blocks to the carousel. You can then add whatever content you wish to these.
5. Customize the carousel settings as needed.

Styling

The recommended approach is to register a new block stylesheet with your custom CSS. This ensures it is only loaded when the block is on the page.

This code demnstrates how to do this for a CSS file build using @wordpress/scripts.

$filename = 'custom-carousel-styles';
$asset = require get_stylesheet_directory() . "/build/css/{$filename}.css.asset.php";

wp_enqueue_block_style(
	'hm/carousel,
	[
		'handle' => "my-project-{$filename}",
		'src'    => get_theme_file_uri( "build/css/{$filename}.css.css" ),
		'path'   => get_theme_file_path( "build/css/{$filename}.css.css" ),
		'ver'    => $asset['version'],
		'deps'   => $asset['dependencies'],
	]
);

Release Process

Merges to main will automatically build to the release branch. A project may be set up to track the release branch using composer to pull in the latest built beta version.

Commits on the release branch may be tagged for installation via packagist and marked as releases in GitHub for manual download using a manually-dispatched "Tag and Release" GH Actions workflow.

To tag a new release,

1. Review the unreleased features in the Changelog and choose the target version number for the next release using semantic versioning
2. Checkout a prepare-v#.#.# branch. In that branch,
   • Add a new header into CHANGELOG.md for any unreleased features
   • Bump the version number in the hm-carousel-block.php file's PHPDoc header
3. Open a pull request from your branch titled "Prepare release v#.#.#"
4. Review and merge your "Prepare release" pull request
5. Wait for the release branch to update with the build that includes the new version number
6. On the "Tag and Release" GH Action page],
   • Click the "Run workflow" button in the "workflow_dispatch" notification banner (see screenshot below)
   • Fill out the "Version tag" field with your target version number
     • This version must match the version in hm-carousel-block.php and your newest Changelog section
     • Use the format v#.#.# for your version tag
   • Leave the "Branch to tag" field as release (we will add the tag on the release branch containing the latest built code)
   • Click "Run workflow"

Once the workflow completes, your new version should be tagged and available in the list of releases

License

This plugin is licensed under the GPL v2 or later. The Splide library used in this plugin is licensed under the MIT License.

Credits

• Splide - A lightweight, flexible, and accessible slider/carousel library.