Widget Setup

This guide covers setting up and configuring widgets in eKomi Reviews. Widgets let you display customer reviews anywhere on your store - sidebars, homepages, product pages, or any CMS content. You can choose from simple review lists to full-featured sliders with autoplay and responsive breakpoints.

Location: Content → Widgets → Add Widget

The extension provides two widget types:

Widget	Best For
Ekomi Review Widget	Sidebars, small content areas, simple review displays
Ekomi Slider Widget	Homepages, landing pages, full-width sections

Go to Content → Widgets
Click Add Widget
Select Type: Choose either "Ekomi Review Widget" or "Ekomi Slider Widget"
Select Design Theme: Your store's theme
Click Continue
Configure the widget options (see sections below)
Set Layout Updates to define where the widget appears
Click Save

A flexible review display with four layout modes.

Display Modes

Mode	Description	Best For
Sidebar	Full layout with header, review list, and footer	Sidebars, wide content areas
Small	Compact display with logo and rating	Small widgets, footer areas
Plain	Minimal text-based rating display	Inline content, minimal designs
Custom	Base template for custom development	Theme customization

Configuration Options

Basic Settings

Option	Description
Review Mode	Select the display mode (Sidebar, Small, Plain, Custom)

Sidebar Mode Options

These options appear when Review Mode is set to "Sidebar":

Option	Description	Recommended
Display Reviews	Show individual reviews or just summary	Yes
Display Slider	Enable carousel for reviews (requires Display Reviews)	Yes for 5+ reviews
Number of Reviews	How many reviews to display	3-5
Reviews Filter	Sort by "Latest Reviews" or "Max Rating"	Latest Reviews

What Each Mode Shows

Sidebar Mode:

Account name and logo
Total review count and average rating
Individual reviews with comment, rating, and date
Optional slider/carousel functionality
Link to full reviews page

Small Mode:

Compact logo
Average rating display
Total review count
Link to reviews page

Plain Mode:

Text-based rating (e.g., "4.5 / 5.0")
Total reviews count
Minimal styling

Custom Mode:

Base template with documented variables
For developers to create custom layouts

A full-featured reviews carousel with multiple themes and extensive customization.

Themes

Theme	Description
Default	Standard slider with clean presentation
Extended	Enhanced layout with quote styling and alternative logo
Full Width	Spans the full width of the container

Configuration Options

Display Settings

Option	Description	Recommended
Theme	Visual theme for the slider	Match your site design
Title	Heading above the slider	"Customer Reviews" or similar
Show Summary	Display total reviews and average rating	Yes
Number of Reviews	Total reviews to fetch from database	10-20
Reviews Filter	Sort by "Latest Reviews" or "Max Rating"	Latest Reviews

Slider Behavior

Option	Description	Recommended
Reviews to Show	Number of reviews visible at once	3-5
Reviews to Scroll	How many reviews advance per click/swipe	1-3
Dots	Show navigation dots below slider	Yes
Arrows	Show left/right navigation arrows	Yes

Autoplay Settings

Option	Description	Recommended
Autoplay	Automatically rotate through reviews	Yes for homepages
Autoplay Speed	Milliseconds between slides (1000 = 1 second)	5000-7000

Responsive Settings

Option	Description
Custom Breakpoints	Enable responsive breakpoint configuration
Custom Breakpoints Value	Define how many reviews show at each screen width

Breakpoint Format: width=slides;width=slides;width=slides

Example: 480=1;768=2;1024=3;1200=5

At 480px and below: Show 1 review
At 768px: Show 2 reviews
At 1024px: Show 3 reviews
At 1200px and above: Show 5 reviews

Common Placements

Location	Layout Update	Container
Homepage	CMS Home Page	Main Content Area
All Pages Sidebar	All Pages	Sidebar Main
Category Pages	Catalog Category	Sidebar or Content
Product Pages	Catalog Product View	After Main Content
Footer	All Pages	Footer

Setting Up Layout Updates

In the widget form, go to Layout Updates
Click Add Layout Update
Configure:
- Display on: Where the widget should appear (All Pages, Specific Pages, etc.)
- Container: Which page section (Sidebar, Main Content, Footer, etc.)

Example: Homepage Slider

Display on: Specified Page → CMS Home Page
Container: Main Content Bottom

Example: Sidebar on All Pages

Display on: All Pages
Container: Sidebar Main

Best Practices

✅ Use Sidebar mode for sidebars - It's designed for narrow columns

✅ Enable slider for 5+ reviews - Saves space and adds interactivity

✅ Show 3-5 reviews - Enough to be convincing, not overwhelming

✅ Use "Latest Reviews" filter - Shows your most recent feedback

❌ Don't use too many reviews - Long lists are hard to read

❌ Don't forget mobile - Test on small screens

✅ Use on homepage - Great first impression with social proof

✅ Enable autoplay for passive viewing - Visitors see reviews without clicking

✅ Set autoplay speed to 5-7 seconds - Enough time to read each review

✅ Enable both dots and arrows - Some users prefer clicking, others swiping

✅ Configure responsive breakpoints - Ensure good mobile experience

✅ Use "Extended" theme for emphasis - Quote styling draws attention

❌ Don't set autoplay too fast - Users can't read reviews if they change too quickly

❌ Don't show too many at once - 3-5 visible reviews is optimal

Responsive Configuration

For the Slider Widget, responsive design ensures good display on all devices.

Recommended Breakpoints

480=1;768=2;1024=3;1200=4

This means:

Mobile (≤480px): 1 review visible
Tablet Portrait (768px): 2 reviews visible
Tablet Landscape (1024px): 3 reviews visible
Desktop (1200px+): 4 reviews visible

Testing Responsiveness

Add the widget with custom breakpoints
Clear cache: bin/magento cache:flush
Open your store in a browser
Use browser dev tools (F12) to test different screen sizes
Verify reviews display correctly at each breakpoint

Troubleshooting

Check widget is enabled - Edit widget, verify it's saved correctly
Verify layout updates - Ensure container and page selection are correct
Clear cache - bin/magento cache:flush
Check for reviews - Widget needs approved reviews to display

Slider Not Working

Check JavaScript console - Look for errors (F12 → Console)
Verify Slick library loads - The slider requires JavaScript
Check for conflicts - Other sliders may conflict

Reviews Not Showing

Verify reviews exist - Check Marketing → eKomi → Reviews
Check review status - Only "Approved" reviews display
Verify account is selected - In system config, accounts must be selected

Custom Development

The Custom mode in the Review Widget provides a base template with documented variables for theme developers.

Available variables:

$block->getAccountsInfo() - Array of account data
$block->getReviews() - Array of review data
$block->getReviewsUrl() - Link to full reviews page

Create a custom template in your theme:

app/design/frontend/[Vendor]/[Theme]/Magmodules_EkomiSR/templates/widget/review/custom.phtml

Need More Help?

Documentation:

All Help Articles - Complete documentation overview

Support:

Contact Support - Get help from our team

eKomi Reviews

Available Widget Types

Adding a Widget

Ekomi Review Widget

Display Modes

Configuration Options

Basic Settings

Sidebar Mode Options

What Each Mode Shows

Ekomi Slider Widget

Themes

Configuration Options

Display Settings

Slider Behavior

Autoplay Settings

Responsive Settings

Widget Placement

Common Placements

Setting Up Layout Updates

Best Practices

Review Widget

Slider Widget

Responsive Configuration

Recommended Breakpoints

Testing Responsiveness

Troubleshooting

Widget Not Displaying

Slider Not Working

Reviews Not Showing

Custom Development

Need More Help?