Skip to content

Latest commit

 

History

History
113 lines (83 loc) · 2.49 KB

README.md

File metadata and controls

113 lines (83 loc) · 2.49 KB

Carousel Slider Block for WordPress

A responsive and customizable carousel slider block for the WordPress Gutenberg editor. Add any blocks to slides and customize the carousel behavior to your needs.

Features

  • Add unlimited slides
  • Support for any WordPress blocks within slides
  • Live preview in the editor
  • Responsive and touch-enabled
  • RTL support
  • Flexible layout options
  • Customizable navigation arrows
  • Adjustable dots navigation position
  • Theme color integration

Settings

General

  • Slides to show (1-10)
  • Slides to scroll at a time (1-10)
  • Animation speed (100-3000ms)
  • Navigation arrows with customizable:
    • Arrow color
    • Arrow background
    • Hover states for both color and background
    • Uses theme colors if available
  • Dot indicators with:
    • Adjustable bottom spacing (-100px to 100px)
    • Custom styling
  • Infinite loop
  • Autoplay with customizable speed
  • RTL support

Responsive

  • Breakpoint width (320-1200px)
  • Mobile slides to show (1-5)
  • Mobile slides to scroll (1-5)

Installation

Via Composer

composer require imagewize/carousel-block

Manual Installation

  1. Download or clone this repository
  2. Run npm install to install dependencies
  3. Run npm run build to build the block
  4. Activate the plugin in WordPress

Development

# Start development mode
npm run start

# Build production version
npm run build

# Format code
npm run format

# Lint JavaScript
npm run lint:js

# Lint CSS/SCSS
npm run lint:css

Important Notes

Experimental Features

This plugin uses experimental features from WordPress core:

  • __experimentalColorGradientSettingsDropdown
  • __experimentalUseMultipleOriginColorsAndGradients

These features might change or be removed in future WordPress versions, which could require updates to maintain compatibility.

Requirements

  • WordPress 6.1+
  • PHP 8.0+
  • Node.js for development

Usage

  1. Add the "Carousel Slider" block from the Design category
  2. Click the + button to add slides
  3. Add any blocks within the slides
  4. Customize settings in the block sidebar
  5. Preview your carousel in the editor

Block Structure

Carousel Block (Parent)
└── Slide Block (Child)
    └── Any WordPress Blocks

Support

  • WordPress 6.1 and above
  • Modern browsers
  • Touch devices

Note: This plugin is based on the original work from the Carousel Block Plugin by Virgiliu Diaconu, enhanced with additional features and improvements.