hounddd/wn-reviews-plugin

Reviews and testimonials plugin for Winter CMS

v1.0.3 2024-04-03 16:55 UTC

This package is auto-updated.

Last update: 2024-11-03 18:31:46 UTC


README

Blocks Plugin

Show reviews, ratings or testimonials of your customers. No other plugin dependency.

Features

  • Manage reviews from backend
  • Frontend components to display reviews

Installation

Let assume you're in the root of your wintercms installation

Using composer

Just run this command

composer require hounddd/wn-reviews-plugin

Clone

Clone this repo into your winter plugins folder.

cd plugins
mkdir hounddd && cd hounddd
git clone https://github.com/Hounddd/wn-reviews-plugin reviews

Note: In both cases, run php artisan winter:up command to run plugin's migrations

Components

This plugin offer 2 components also availables as page snippets for Winter.Page plugin.

  • reviews display a paginated list of reviews
  • reviewsSlider display reviews in a slider

Show reviews with reviews component

title = "Our customers reviews"
url = "/reviews/:page?"
layout = "default"
is_hidden = 0

[reviews]
pageNumber = "{{ :page }}"
categoryFilter = "{{ :category }}"
reviewsPerPage = 10
noReviewsMessage = "No reviews found"
sortOrder = "rating desc"
==
<h1>What our customers say about us?</h1>
{% component 'reviews' %}

reviews component properties

Show reviews with reviewsSlider component

By default, the component lets you choose between different types of slider:

[reviewsSlider]
sliderType = "tailwind_alpine"
noReviewsMessage = "No reviews found"
sortOrder = "rating desc"
==
<h1>What our customers say about us?</h1>
{% component 'reviewsSlider' %}

reviewsSlider component properties

Sliders make use of javascript to control the slides, the needed scripts will be loaded automatically if you set the loadScripts component property to true.

Note: ⚠ As Tailwind is an utility CSS framework, it will not be loaded by the component. If you're using Tailwind CSS and Alpine JS slider, you may need to add the component's path to the content property of your theme's tailwind.config.js file.

module.exports = {
content: [
        // ...
        './../../plugins/hounddd/reviews/components/**/*.htm',
    ],
    // ...
}

🏆 Credits

Inspired by Mja.Testimonials VojtaSvoboda.Reviews plugin

Make awesome sites with ❄ WinterCMS!