{"id":21926872,"url":"https://github.com/hounddd/wn-reviews-plugin","last_synced_at":"2025-04-19T17:18:49.128Z","repository":{"id":180740838,"uuid":"663179988","full_name":"Hounddd/wn-reviews-plugin","owner":"Hounddd","description":"Show reviews, ratings or testimonials of your customers.","archived":false,"fork":false,"pushed_at":"2024-04-03T16:55:56.000Z","size":197,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T10:43:45.457Z","etag":null,"topics":["plugin","reviews","wintercms"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Hounddd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-06T18:23:45.000Z","updated_at":"2024-07-09T08:26:32.000Z","dependencies_parsed_at":"2024-11-29T02:00:10.574Z","dependency_job_id":null,"html_url":"https://github.com/Hounddd/wn-reviews-plugin","commit_stats":null,"previous_names":["hounddd/wn-reviews-plugin"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hounddd%2Fwn-reviews-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hounddd%2Fwn-reviews-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hounddd%2Fwn-reviews-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hounddd%2Fwn-reviews-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hounddd","download_url":"https://codeload.github.com/Hounddd/wn-reviews-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249746605,"owners_count":21319662,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["plugin","reviews","wintercms"],"created_at":"2024-11-28T22:11:55.273Z","updated_at":"2025-04-19T17:18:49.111Z","avatar_url":"https://github.com/Hounddd.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Review plugin for WinterCMS\n\n![Blocks Plugin](https://github.com/hounddd/wn-reviews-plugin/blob/main/.github/Review-plugin.png?raw=true)\n\nShow reviews, ratings or testimonials of your customers. No other plugin dependency.\n\n## Features\n* Manage reviews from backend\n* Frontend components to display reviews\n\n## Installation\n*Let assume you're in the root of your wintercms installation*\n\n### Using composer\nJust run this command\n```bash\ncomposer require hounddd/wn-reviews-plugin\n```\n\n### Clone\nClone this repo into your winter plugins folder.\n\n```bash\ncd plugins\nmkdir hounddd \u0026\u0026 cd hounddd\ngit clone https://github.com/Hounddd/wn-reviews-plugin reviews\n```\n\n\u003e **Note**:\n\u003e In both cases, run `php artisan winter:up` command to run plugin's migrations\n\n## Components\nThis plugin offer 2 components also availables as page snippets for Winter.Page plugin.\n* **`reviews`** display a paginated list of reviews\n* **`reviewsSlider`** display reviews in a slider\n\n### Show reviews with `reviews` component\n\n```twig\ntitle = \"Our customers reviews\"\nurl = \"/reviews/:page?\"\nlayout = \"default\"\nis_hidden = 0\n\n[reviews]\npageNumber = \"{{ :page }}\"\ncategoryFilter = \"{{ :category }}\"\nreviewsPerPage = 10\nnoReviewsMessage = \"No reviews found\"\nsortOrder = \"rating desc\"\n==\n\u003ch1\u003eWhat our customers say about us?\u003c/h1\u003e\n{% component 'reviews' %}\n```\n#### **`reviews` component  properties**\n\n| Property | Type | Description |\n| --- | --- | --- |\n| `pageNumber` | String | Page parameter for pagination.\u003cbr\u003eDefault: `'{{ :page }}'` |\n| `reviewsPerPage` | String | Numbre of reviews per page.\u003cbr\u003eDefault: `'10'` |\n| `categoryFilter` | String | Either a category slug or the page parameter to use for filtering categories.\u003cbr\u003eDefault: `''` |\n| `noReviewsMessage` | String | Default: the `lang.components.general.no_reviews_default` key for translation file in use |\n| `sortOrder` | String | The sorting order to use.\u003cbr\u003ePossibles values: \u003cul\u003e\u003cli\u003etitle asc\u003c/li\u003e\u003cli\u003etitle desc\u003c/li\u003e\u003cli\u003ecreated_at asc\u003c/li\u003e\u003cli\u003ecreated_at desc\u003c/li\u003e\u003cli\u003eupdated_at asc\u003c/li\u003e\u003cli\u003eupdated_at desc\u003c/li\u003e\u003cli\u003erating asc\u003c/li\u003e\u003cli\u003erating desc\u003c/li\u003e\u003cli\u003erandom\u003c/li\u003e\u003c/ul\u003e\u003cbr\u003eDefault: `'created_at desc'` |\n| `ratingDisplay` | String | Rating display type\u003cbr\u003ePossibles values: \u003cul\u003e\u003cli\u003enone: rating is not displayed\u003c/li\u003e\u003cli\u003estars: use stars\u003c/li\u003e\u003cli\u003etext: use text\u003c/li\u003e\u003cli\u003eboth: use both stars and text\u003c/li\u003e\u003c/ul\u003e\u003cbr\u003eDefault:`'both'` |\n\n### Show reviews with `reviewsSlider` component\n\nBy default, the component lets you choose between different types of slider:\n - Using **[Tiny Slider 2](https://github.com/ganlanyuan/tiny-slider)**\n - Using **Tailwind CSS \u0026 Alpine JS**.\n\n```twig\n[reviewsSlider]\nsliderType = \"tailwind_alpine\"\nnoReviewsMessage = \"No reviews found\"\nsortOrder = \"rating desc\"\n==\n\u003ch1\u003eWhat our customers say about us?\u003c/h1\u003e\n{% component 'reviewsSlider' %}\n```\n#### **`reviewsSlider` component  properties**\n\n| Property | Type | Description |\n| --- | --- | --- |\n| `sliderType` | String | The slider type to render.\u003cbr\u003ePossibles values\u003cbr\u003ePossibles values:\u003cul\u003e\u003cli\u003etailwind_alpine\u003c/li\u003e\u003cli\u003etiny_slider\u003c/li\u003e\u003c/ul\u003e\u003cbr\u003eDefault: `'tiny_slider'` |\n| `categoryFilter` | String | Either a category slug or the page parameter to use for filtering categories.\u003cbr\u003eDefault: `''` |\n| `noReviewsMessage` | String | Default: the `lang.components.general.no_reviews_default` key for translation file in use |\n| `sortOrder` | String | The sorting order to use.\u003cbr\u003ePossibles values: \u003cul\u003e\u003cli\u003etitle asc\u003c/li\u003e\u003cli\u003etitle desc\u003c/li\u003e\u003cli\u003ecreated_at asc\u003c/li\u003e\u003cli\u003ecreated_at desc\u003c/li\u003e\u003cli\u003eupdated_at asc\u003c/li\u003e\u003cli\u003eupdated_at desc\u003c/li\u003e\u003cli\u003erating asc\u003c/li\u003e\u003cli\u003erating desc\u003c/li\u003e\u003cli\u003erandom\u003c/li\u003e\u003c/ul\u003e\u003cbr\u003eDefault: `'created_at desc'` |\n| `ratingDisplay` | String | Rating display type\u003cbr\u003ePossibles values: \u003cul\u003e\u003cli\u003enone: rating is not displayed\u003c/li\u003e\u003cli\u003estars: use stars\u003c/li\u003e\u003cli\u003etext: use text\u003c/li\u003e\u003cli\u003eboth: use both stars and text\u003c/li\u003e\u003c/ul\u003e\u003cbr\u003eDefault:`'both'` |\n| `showDots` | Boolean | Show dots navigation in review slider\u003cbr\u003eDefault: `0` |\n| `showControls` | Boolean | Show control buttons in review slider\u003cbr\u003eDefault: `0` |\n| `showCounter` | Boolean | Show a reviews counter\u003cbr\u003eDefault: `0` |\n| `autoPlay` | String |The delay in seconds before the slider must show the next review.\u003cbr\u003eDefault: `'0'` (disabled) |\n| `loadScripts` | Boolean | The required scripts must be loaded by the component.\u003cbr\u003eDefault: `1` |\n\n\nSliders make use of javascript to control the slides, the needed scripts will be loaded automatically if you set the `loadScripts` component property to `true`.\n\n\u003e **Note**:\n\u003e ⚠ As Tailwind is an utility CSS framework, it will not be loaded by the component.\n\u003e 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.\n\u003e ```js\n\u003e module.exports = {\n\u003e content: [\n\u003e         // ...\n\u003e         './../../plugins/hounddd/reviews/components/**/*.htm',\n\u003e     ],\n\u003e     // ...\n\u003e }\n\u003e ```\n\n## 🏆 Credits\n\nInspired by [Mja.Testimonials](https://github.com/MatissJanis/oc-testimonials) [VojtaSvoboda.Reviews plugin](https://github.com/vojtasvoboda/oc-reviews-plugin)\n\n***\nMake awesome sites with ❄ [WinterCMS](https://wintercms.com)!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhounddd%2Fwn-reviews-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhounddd%2Fwn-reviews-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhounddd%2Fwn-reviews-plugin/lists"}