Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: describe-the-bug
attributes:
label: Describe the bug
description: A clear and concise description of the bug.
placeholder: Tell us what went wrong.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What did you expect to happen?
placeholder: Describe the expected result.
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: What actually happened?
placeholder: Describe the actual result.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: How can we reproduce this behavior?
placeholder: |
1. Go to '...'
2. Click on '...'
3. See error
validations:
required: true
- type: textarea
id: environment-information
attributes:
label: Environment information
description: Share your operating environment details.
placeholder: |
OS:
Browser:
Plugin version:
validations:
required: false
- type: textarea
id: wordpress-environment
attributes:
label: WordPress Environment
description: Share your WordPress environment details.
placeholder: |
WordPress version:
PHP version:
Active theme:
Active plugins:
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Contribution Guidelines
description: By submitting this issue, you agree to follow our [contribution guidelines](https://github.com/rtCamp/rt-carousel/blob/main/docs/CONTRIBUTING.md).
options:
- label: I have read the contribution guidelines
required: true
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: false

contact_links:
- name: Report a security vulnerability
url: https://github.com/rtCamp/rt-carousel/security/policy
about: Please use GitHub Security Advisories to privately report vulnerabilities
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Enhancement
description: Suggest an idea for this project.
title: "[Enhancement]: "
labels: ["enhancement"]
body:
- type: textarea
id: feature-description
attributes:
label: Feature description
description: Describe the feature or improvement you'd like.
validations:
required: true
- type: textarea
id: problem
attributes:
label: Problem it solves
description: Explain the problem this feature would solve.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: Describe any alternative solutions or approaches you've considered.
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional context
description: Add any context, examples, or screenshots.
validations:
required: false
53 changes: 53 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## Summary

Describe the change and why it is needed.

## Type of change

- [ ] Bug fix
- [ ] New feature
- [ ] Enhancement/refactor
- [ ] Documentation update
- [ ] Test update
- [ ] Build/CI/tooling

## Related issue(s)

<!-- 'Closes' will automatically close the linked issue when this PR is merged. -->
<!-- 'Relates to' is for issues that are relevant but won't be closed by this PR. -->
Closes #<issue-number>
Relates to #<issue-number> (if applicable)

## What changed

- <change summary 1>
- <change summary 2>
- <change summary 3>

## Breaking changes

Does this introduce a breaking change? If yes, describe the impact and migration path below.

- [ ] Yes — migration path: <!-- describe here -->
- [ ] No

## Testing

Describe how this was tested.

- [ ] Unit tests
- [ ] Manual testing
- [ ] Cross-browser testing (if UI changes)

Test details:

## Screenshots / recordings

If applicable, add screenshots or short recordings.

## Checklist

- [ ] I have self-reviewed this PR
- [ ] I have added/updated tests where needed
- [ ] I have updated docs where needed
- [ ] I have checked for breaking changes
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
tag_name: v${{ steps.get_version.outputs.VERSION }}
name: v${{ steps.get_version.outputs.VERSION }}
generate_release_notes: true
files: carousel-kit.zip
files: rt-carousel.zip
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ phpstan.neon
# Build
build/
tsconfig.tsbuildinfo
carousel-kit.zip
rt-carousel.zip
6 changes: 6 additions & 0 deletions .wp-env.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"$schema": "https://schemas.wp.org/trunk/wp-env.json",
"plugins": [ "." ],
"testsEnvironment": false,
"phpmyadminPort": 9000
}
29 changes: 27 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
# Changelog

## [2.0.0](https://github.com/rtCamp/rt-carousel/compare/v1.0.4...v2.0.0) (2026-04-13)


### Bug Fixes

* add initialized state to CarouselContext to track carousel initialization ([#92](https://github.com/rtCamp/rt-carousel/issues/92)) ([71de050](https://github.com/rtCamp/rt-carousel/commit/71de050aae8ff55f82b61a02440f8ccd42b63d76))
* exclude composer.json and composer.lock from distribution package ([#99](https://github.com/rtCamp/rt-carousel/issues/99)) ([a1308c6](https://github.com/rtCamp/rt-carousel/commit/a1308c6581faa68e7b68a4c2e29c78110a1670f9))
* restore vertical scroll for Query Loop carousel ([#104](https://github.com/rtCamp/rt-carousel/issues/104)) ([1d16ee6](https://github.com/rtCamp/rt-carousel/commit/1d16ee6f6ac068524998f33c20fdab39638ead3f))
* **controls:** block toolbar persists when selected block moves out of view in carousel ([#106](https://github.com/rtCamp/rt-carousel/issues/106)) ([dec79c8](https://github.com/rtCamp/rt-carousel/commit/dec79c8))


### Features

* add support for the carousel progress bar ([#88](https://github.com/rtCamp/rt-carousel/issues/88)) ([edc8699](https://github.com/rtCamp/rt-carousel/commit/edc8699))
* support vertical alignment on carousel slide ([#87](https://github.com/rtCamp/rt-carousel/issues/87)) ([f73890e](https://github.com/rtCamp/rt-carousel/commit/f73890e))
* add wp-env configuration for WP development setup ([#109](https://github.com/rtCamp/rt-carousel/issues/109)) ([dcccaf7](https://github.com/rtCamp/rt-carousel/commit/dcccaf79747cf84811a7907e68df01d2aaeb7030))


### Refactors

* rename plugin from "Carousel Kit" to "rtCarousel" with automatic block content migration ([#101](https://github.com/rtCamp/rt-carousel/pull/101)) ([9788ed7](https://github.com/rtCamp/rt-carousel/commit/9788ed7))


## [1.0.4](https://github.com/rtCamp/carousel-kit/compare/v1.0.3...v1.0.4) (2026-03-09)

### Bug Fixes
Expand Down Expand Up @@ -60,14 +85,14 @@
* slide appender and setup ([a42331d](https://github.com/rtCamp/carousel-kit/commit/a42331d10b225379408ddf8c0649e83484496a1e))


# [1.0.1](https://github.com/rtCamp/carousel-kit/compare/v1.0.0...v1.0.1) (2026-02-16)
## [1.0.1](https://github.com/rtCamp/carousel-kit/compare/v1.0.0...v1.0.1) (2026-02-16)

### Bug Fixes

* **carousel:** resolve spacing issues in loop mode where gaps were missing between last and first slide
* **carousel:** allow infinite loop in editor viewport to match frontend behavior

# 1.0.0 (2026-02-03)
## 1.0.0 (2026-02-03)


### Bug Fixes
Expand Down
50 changes: 48 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,52 @@ make dev
npm start
```

## Local WordPress Environment

To test this plugin, you’ll need a working WordPress installation. If you already have a local WordPress environment set up, you can use this build like any standard plugin—simply place the plugin directory inside your wp-content/plugins/ folder and activate it from the admin dashboard.

If you don’t already have a local environment, you can quickly set one up using Docker and wp-env by following the steps below.

### Using Docker and wp-env

Install the wp-env package globally:

```bash
npm install -g @wordpress/env
```

Ensure Docker is running, then start wp-env from within the plugin directory:

```bash
wp-env start
```

This command spins up a Docker-based WordPress environment using the latest image and mounts your local plugin code into it as a volume. As a result, any changes you make locally are instantly reflected in the running WordPress instance, and are persisted.

If the setup completes successfully, you should see output similar to the following in your terminal:

```bash
WordPress development site started at http://localhost:8888
MySQL is listening on port 61440
phpMyAdmin started at http://localhost:9000

✔ Done! (in 23s 90ms)
```

To stop the running environment:

```bash
wp-env stop
```

#### Accessing the Environment

The WordPress site should now be accessible at <http://localhost:8888>

You can access the Dashboard at: <http://localhost:8888/wp-admin/> using Username: admin, Password: password. You'll notice that the plugin is installed and activated. This is your local build. Any changes you make to the plugin code will be reflected here.

You can read more about wp-env and its configuration in the [official documentation](https://github.com/WordPress/gutenberg/blob/trunk/packages/env/README.md).

## Available Commands

### Build & Watch
Expand Down Expand Up @@ -48,7 +94,7 @@ npm start
| :--- | :--- |
| `npm run changelog` | Generates/Updates `CHANGELOG.md` based on commits. |
| `npm run version` | Internal hook used by `npm version` to update changelog and stage it. |
| `npm version [major|minor|patch]` | Bumps version in `package.json`, updates `CHANGELOG.md`, and creates a git tag. |
| `npm version [major\|minor\|patch]` | Bumps version in `package.json`, updates `CHANGELOG.md`, and creates a git tag. |

## Local GitHub Actions (act)

Expand All @@ -69,7 +115,7 @@ npm run test:actions
## Directory Structure

- `src/` - Source code for blocks (React/TypeScript/SCSS).
- `inc/` - PHP classes and traits (PSR-4 `Carousel_Kit`).
- `inc/` - PHP classes and traits (PSR-4 `Rt_Carousel`).
- `build/` - Compiled assets (generated by `npm run build`).
- `docs/` - Documentation files.
- `examples/` - Block patterns and examples.
4 changes: 1 addition & 3 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Configuration
PLUGIN_SLUG := carousel-kit
PLUGIN_SLUG := rt-carousel
BUILD_DIR := build-dist
ZIP_NAME := $(PLUGIN_SLUG).zip

Expand Down Expand Up @@ -61,8 +61,6 @@ dist:
--exclude='package-lock.json' \
--exclude='blueprint.json' \
--exclude='tsconfig.json' \
--exclude='composer.json' \
--exclude='composer.lock' \
--exclude='Makefile' \
--exclude='CHANGELOG.md' \
--exclude='DEVELOPMENT.md' \
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Carousel Kit
# rtCarousel

![Build Status](https://github.com/rtCamp/carousel-kit/actions/workflows/release.yml/badge.svg?branch=main)
![Latest Release](https://img.shields.io/github/v/release/rtCamp/carousel-kit)
![Build Status](https://github.com/rtCamp/rt-carousel/actions/workflows/release.yml/badge.svg?branch=main)
![Latest Release](https://img.shields.io/github/v/release/rtCamp/rt-carousel)

**A modular, high-performance carousel block for WordPress, powered by the Interactivity API and Embla Carousel.**

Expand Down Expand Up @@ -37,7 +37,7 @@ Easily create dynamic, accessible, and customizable carousels for any content ty

## Browser Support

Carousel Kit supports all modern browsers:
rtCarousel supports all modern browsers:

| Browser | Minimum Version |
| ------- | --------------- |
Expand All @@ -62,7 +62,7 @@ The plugin provides a suite of blocks that work together:

### Does it work with Full Site Editing (FSE)?

Yes! Carousel Kit is fully compatible with Full Site Editing. You can use the carousel block in templates, template parts, and anywhere blocks are supported.
Yes! rtCarousel is fully compatible with Full Site Editing. You can use the carousel block in templates, template parts, and anywhere blocks are supported.

### Can I nest other blocks inside slides?

Expand All @@ -82,19 +82,19 @@ Yes. Each carousel instance maintains its own independent state.

### What data is removed on uninstall?

On uninstall, Carousel Kit removes its cached pattern transient (`carousel_kit_patterns_cache`). It does not remove your posts or block content.
On uninstall, rtCarousel removes its cached pattern transient (`rt_carousel_patterns_cache`). It does not remove your posts or block content.

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for full release history.

## Live Demo

[**🚀 Try the Interactive Demo in WordPress Playground**](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/rtCamp/carousel-kit/main/blueprint.json)
[**🚀 Try the Interactive Demo in WordPress Playground**](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/rtCamp/rt-carousel/main/blueprint.json)

## Feature Request

Have a feature request? [Open an issue](https://github.com/rtCamp/carousel-kit/issues) on GitHub.
Have a feature request? [Open an issue](https://github.com/rtCamp/rt-carousel/issues) on GitHub.

## Contributors

Expand Down
Loading
Loading