Metro Page Builder: building pages
Metro Page Builder builds a page from sections that hold rows, rows that hold columns, and columns that hold blocks - a heading, a picture, a form, a price table. You can start from one of the ready-made page templates, copy a page you already have, or start from a blank page. This guide covers all three, and then describes every one of the 99 add-ons you can put on a page, setting by setting.
1. Start from a ready-made template
The quickest way to a finished page. Every template is a real page, not a picture of one: you get all of its sections and can change or delete any of them.
- Go to Components → Metro Page Builder → Pages and click New.
- The chooser opens on the On this site tab. Pick a category along the top (Business, Health, Hospitality, Shop, Resume and so on), then a group inside it, or type in the search box to find a template by name or by what is on it.
- Click a template. The page opens in the editor with the template's content already in place.
- Replace the words and pictures with your own, then click Save.
Templates that come as multi-page sets - a home page, an about page, a contact page and so on - are named as a family, for example Metro Aurelia - Home and Metro Aurelia - Contact. Create each page from its own template so the set matches.
2. Copy a page you already have
Once one page looks right, the fastest way to the next one is to copy it and change the words.
- On the Pages screen, find the page you want to copy.
- In the Actions column, click the copy button (two sheets of paper). Confirm when asked.
- The copy opens in the editor straight away. It is titled "… (copy)", has its own web address, and is unpublished until you publish it - so a half-finished copy is never live.
- Change the title, the words and the pictures, then Save.
The copy gets its own copies of any pictures you uploaded to the original, so editing one page never changes the other.
Copying into another language. If your site has more than one language installed, the Copy to language… dropdown in the same column makes a translation of the page instead: choose the language and click the translate button beside it. That copy is also created unpublished.
3. Build a page from scratch
- Click New, then choose Blank Page (it is in the Start category).
- Give the page a Title. The Alias - the page's web address - is filled in from the title if you leave it empty.
- Click + Add Section on the canvas. A section is a full-width band of the page; it is where a background colour or picture belongs.
- Inside the section, click Add row, then pick a column layout from the row's dropdown - one column, two halves, three thirds, a wide-and-narrow split, and so on.
- With a column selected, open the Add-on blocks panel on the left and click the block you want - or use Add block… inside the column itself.
- Fill the block in using the Properties panel on the right.
- Repeat for each band of the page, then Save.
A workable order for most pages: a hero section at the top (a heading, a line of text and a button), two or three sections of content, something that builds trust (numbers, reviews or logos), and a section at the end asking the visitor to do one thing.
4. The editor, part by part
| Part | What it is for |
|---|---|
| Canvas (middle) | The page itself. Click anything to select it; what you select is what the Properties panel edits. |
| Add-on blocks (left) | Every block you can add, grouped by kind, with a search box. Click one to drop it into the selected column. |
| Properties (right) | The settings of whatever is selected, in tabs: General, Style, Motion and Advanced. |
| Toolbar (above the canvas) | Undo and redo, the desktop / tablet / phone buttons, copy and paste, and Page design. |
| Save, Preview, Close (top right) | Joomla's own toolbar. Preview shows the saved page exactly as a visitor sees it. |
Both side panels can be collapsed with the arrow in their corner, or floated with the button beside it if you would rather drag them out of the way.
5. Adding and arranging blocks
- Select - click a block. Click the arrow in its little toolbar to select what contains it (the column, then the row, then the section).
- Move - drag the cross-arrows handle, or use the up and down arrows.
- Duplicate - the two-sheets button on the block's toolbar.
- Copy and paste - copy a block, column, row or whole section, then paste it into another place, including another page: the clipboard survives leaving the screen. Everything it carries - colours, spacing, its own custom CSS - comes with it.
- Delete - the cross button. Undo (Ctrl+Z) brings it back.
Undo and redo: Ctrl+Z and Ctrl+Y, or the arrows in the toolbar. They go back many steps, and they cover structure as well as settings.
6. Colours, spacing and page design
- A section holds the band's background colour, gradient or picture, its padding, and the shape of its top and bottom edges (a curve, a wave, a tilt).
- A row holds the column layout and the gap between columns.
- A column can have its own background, corner radius, padding and shadow - this is how you make a card.
- A block holds its own content and type settings.
- Page design (in the toolbar) is the page as a whole: the background behind every section, the width of the content area, and the space above and below it.
Any element can take your own CSS in the Advanced tab. Write & to mean "this element", for example & p { letter-spacing: 1px; }.
7. Checking phones and tablets
Use the desktop / tablet / phone buttons in the toolbar as you build. Some settings have their own phone and tablet values - column widths, for instance, so three columns side by side can become one under another. Any element can also be hidden on one size and shown on another from the Advanced tab.
Every effect in the builder already stands down for visitors who have asked their device to reduce motion, so you do not need to do anything about that.
8. Publishing, and putting the page in a menu
- In the editor, set Status to Published and choose the Access level, then Save.
- To give the page a place in your site's navigation, go to Menus → (your menu) → Add New Menu Item.
- For Menu Item Type choose Metro Page Builder → Metro Page Builder Page, then pick your page from the list.
- Save. The page is now on the site at that menu item's address.
A page does not need a menu item to exist - the view button on the Pages screen opens it either way - but a menu item gives it a tidy address and puts it in the navigation.
9. Making your pages findable in the site's search
Joomla has one search - Smart Search - and it finds only what has been added to its index. Metro ships the piece that puts your pages there, and it has to be switched on once:
- Go to System → Plugins, search for Smart Search - Metro Page Builder and enable it. (Enable Smart Search - Content too if you want articles found.)
- Go to Components → Smart Search and press Index in the toolbar. Let it finish.
You only ever do this once. Enabling the plugin does not go back and read the pages you already have - that is what the Index button is for. From then on it keeps itself up to date: save a page, publish one, unpublish one or delete one, and the search index changes with it. The only other time to press Index again is after importing a lot of pages at once.
What is searchable: the page's title, its description from the Search & sharing tab, and the words on the page itself - a heading, a card, an FAQ answer, a price list. You do not have to list anything anywhere; whatever a visitor can read, a visitor can search for.
What is not: unpublished and trashed pages, and templates you uploaded or downloaded - those are starting points in the New page chooser, not pages of your site. Access levels and languages are respected, so a search shows somebody exactly the pages they would have been allowed to open.
Results can be narrowed by type, by collection and by language, under Smart Search → Search Filters. One thing to watch there: a filter you saved before enabling this plugin has Metro pages unticked, because the type did not exist yet. If your pages are indexed but a particular search page still will not show them, open that filter and tick Metro Page.
Metro's own Search add-on posts to this same search, so a search box you build on a Metro page starts finding Metro pages the moment the index is built.
10. Editing on the live page
Open the page on your site while logged in as an administrator and click Edit this page, bottom right. The editor opens on the real page, inside your own template, so what you are adjusting is exactly what a visitor sees - useful for spacing, colours and anything that depends on your template's own fonts and widths.
You can select any element, change its settings, move it, duplicate it and add blocks, then Save & close. Adding whole new sections is still done in the main editor.
11. The Pages screen, column by column
| Column | What it shows |
|---|---|
| Title / Alias | The page's name and its web address. Click the title to edit the page. |
| Collection | An optional group - "Admissions", "Newsletters" - so a long list stays findable. A page belongs to at most one. |
| Status | Published or unpublished. Click to change it. |
| Hits | How many times the page has been viewed. |
| Versions | Saved snapshots - see below. |
| Lock | Who has the page open. The padlock button releases a lock left behind by a browser that closed unexpectedly. |
The buttons in the Actions column, left to right:
| Eye | View the page on the site, in a new tab. |
| Pencil and paper | Edit the page. |
| Two sheets | Copy the page to a new, unpublished page and open it. |
| Translate | With the dropdown beside it: make a copy of the page in another language. |
| Download arrow | Export the page to a file, so it can be moved to another site - see below. |
| Bin | Delete the page permanently. You are asked to confirm. |
Above the list, the filters narrow it by search text, collection, language, status, and whether you are looking at pages or at imported templates.
12. Moving a page to another site: export and import
A page can be taken off one site and put on another - a staging site to a live one, a page built for one client reused for the next.
- Export: the download arrow in the Actions column saves that one page to a file. It carries the page's whole structure and every setting.
- Import: the Import a page panel at the top of the Pages screen takes that file back in. Choose the file and click Import.
Two file kinds are accepted: a .json page on its own, or a .zip holding the page and its pictures. Use the zip when the pictures do not already exist on the other site; the pictures are unpacked into your media folder and the page is pointed at them.
Pictures that the page refers to but the file does not carry - a logo already on the other site, an image from a Joomla folder - keep their addresses. If a picture is missing after an import, upload it to the same path, or point the block at the new one.
13. Snapshots: going back to an earlier version
Every time you save, the previous version is kept. In the Versions column, pick a moment from the Saved snapshots… dropdown and click the restore button beside it. The version you are replacing is itself kept, so restoring can be undone by restoring the other way.
14. Text formatting, links, lists and pictures inside panels
Text fields take simple bracket formatting, so you can emphasise part of a line without needing a separate block:
[b]bold[/b] |
Bold. Also [i], [u], [s]. |
[c=#b3121b]word[/c] |
One word in a colour. |
[hl=#ffe08a]word[/hl] |
A highlight behind the words. |
[br] |
A line break exactly where you want one. |
[size=140], [w=800], [up] |
Bigger, bolder, upper case. |
Inside a tab panel, an accordion answer or a timeline entry you can also add a picture, a link and a list:
[img=images/team/office.jpg\|Our office\|320\|right]
We have been on the same street since 1994.[br][br]
[ul][li]Open six days[/li][li]Free parking[/li][/ul]
[a=/contact]Get in touch[/a]- The picture's parts are file, alt text, maximum width in pixels and left or right to put it beside the words. It is sized to fit the panel and loads only when needed. On a phone it goes full width.
- Write
\|- a backslash then a pipe - for the pipes inside a tag when you are in one of these list-style fields, because a plain pipe separates that row's own columns. - Panels are one line each: use
[br]rather than pressing Enter. - Links accept a path on your site, an anchor,
http://,https://,mailto:ortel:.
Typed HTML is shown as text, not rendered - that is deliberate, and it is why a pasted script can never end up on your page.
15. If something looks wrong
| A setting seems to do nothing | Check what is selected. Section settings and block settings look alike but belong to different things - the breadcrumb above the Properties panel tells you which you are editing. |
| The page is locked | Someone has it open, or a browser closed without letting go. Use the padlock button in the Lock column to release it. |
| Three columns do not line up | Give every picture in the row the same Crop to a shape setting. Pictures of different shapes will not align on their own. |
| I changed my mind after saving | Restore the snapshot from just before, in the Versions column of the Pages screen. |
| The page looks different on the site | Your Joomla template's own fonts and content width apply to the page. Use Edit this page on the live site to adjust it in its real surroundings. |
16. The Properties panel: settings every add-on shares
Every add-on is edited the same way. Select it on the canvas and the Properties panel on the right fills with its settings, divided into tabs:
| General | The content: the words, the pictures, the list of items, the links. |
| Style | How it looks: colours, sizes, alignment, fonts, corners, spacing. |
| Motion | Animation as it scrolls into view, what happens on hover, animated backgrounds and scroll effects. The same settings on every add-on - they are described once, below. |
| Advanced | Free position, stacking order, and custom CSS for this one block. |
Three things are worth knowing before you read any of the tables in this guide:
- Empty usually means "inherit". A blank colour or font size takes the value from your Joomla template, or from the section around it. Clearing a field is the way to undo it, not typing a value you hope matches.
- Settings appear when they apply. Fields that depend on another one stay hidden until it is set - the gradient colours appear only once the overlay is a gradient, the loop times only when a video plays as a background.
- The defaults are a finished look. Every add-on renders something sensible the moment you drop it in; you are adjusting, not assembling.
17. Lists: items, one per line, and rich panels
Add-ons that show several things - team members, tabs, prices, callouts - keep them in a list field. There are two kinds:
- Repeaters (labelled Slides, Cards, People, Items): each entry has its own little form. Use Add to make another, the handle to drag it up or down, and the cross to remove it.
- One per line fields: a plain box where each line is one entry and
|separates that entry's parts, exactly as the field's label says - for exampleOpening hours | 9 to 5. An empty line is skipped, so you can leave a gap while you work.
Text inside either kind takes the bracket formatting described in Text formatting, including pictures and lists inside a tab or accordion panel. In a one-per-line field, write \| for a pipe that belongs inside a bracket tag, so it is not mistaken for the next column.
18. Typography controls
Any add-on that shows words of its own carries the same set of type settings, in its Style tab:
| Font | One of the bundled families, or Inherit to use your Joomla template's font. Bundled fonts are loaded only on pages that actually use them. |
| Font size (px) | Leave blank to inherit. Headings scale down on small screens on their own. |
| Weight | Thin to black. A weight the chosen family does not have is drawn with its nearest one. |
| Line height | A number, not pixels: 1.2 for headlines, 1.6 for paragraphs. |
| Letter spacing (px) | Negative values tighten. Large display headings usually want a little less than the font's own spacing. |
| Capitalisation | Leave the words as typed, or draw them upper case, lower case or with capitals on each word - without changing what you typed or what a screen reader says. |
| First-line indent | In characters, for long passages set like a book. |
19. Motion: animation, hover, scroll effects, animated backgrounds
These live in the Motion tab of every add-on, and of every section, row and column. All of them are off until you choose one.
Animation - how the block arrives when the visitor reaches it:
| Animation | Fade, rise, slide from a side, zoom, flip, and a few display effects. Pick one and the rest of this group appears. |
| …starts | When it scrolls into view (the usual choice), as soon as the page loads, or on hover. |
| …what moves | The whole block, or each item in it one after another - the cards in a grid, the rows of a list. |
| …gap between each one | Milliseconds between items when they arrive one after another. 80 to 150 reads well; more than 300 feels slow. |
| …speed / exact duration | A named speed, or a number of milliseconds that overrides it. |
| …wait before starting | Milliseconds. Useful for letting a heading land before its picture follows. |
| …plays / each time it scrolls into view | Once, or every time the visitor comes back to it. |
| …easing | The shape of the movement: even, soft at the end, or with a little overshoot. |
| …on phones | Keep it, make it plainer, or skip it. Skipping is often the right answer for long pages. |
On hover - what happens under the mouse, and on a tap on a touch screen: a movement (lift, sink, grow, tilt), a background fill with its own two colours, and the speed of both.
Animated background - a slow moving pattern behind the block's own content: its two colours, how strong it is as a percentage, its speed, its size, and whether it keeps playing or pauses when it is off screen.
As the page scrolls - a parallax drift, a wipe or a takeover as the block passes through the middle of the screen, with a strength and, for the wipe and the takeover, a colour.
20. Free position: placing a block anywhere
Normally blocks stack down a column. The Advanced tab lets one break out of that and sit where you like - a badge over a photograph, a signature across a corner, a price tag on a product.
| Placement | In the flow (the default), or free. |
| Measured from | Which corner or edge the two numbers below count from. |
| Across / Down | Percentages of the section, so the placement holds at every screen width. |
| Width | A percentage, or 0 to leave the block its natural width. |
| Stacking order | Higher numbers sit on top. Use this when a free block is hidden behind a picture. |
| Rotation | Degrees. A degree or two is enough to look deliberate. |
| On a phone | Keep the free placement, return the block to the flow, or hide it. Returning it to the flow is the safe choice. |
Also in the Style tab of every block: Position the whole block across and down, which nudges a block inside its column without leaving the flow.
21. Shadows and edges
Blocks, columns and sections that can carry a shadow offer the same scale, from a hairline to a deep float, with an optional colour. Soft shadows suit light pages; on a dark background a shadow usually wants a colour taken from the background itself rather than black.
22. Custom CSS on one element
The Advanced tab of every section, row, column and block has a Custom CSS box. Write & to mean this element:
& { border-top: 3px solid #b3121b; }
&:hover { transform: translateY(-3px); }
& h3 { letter-spacing: .04em; }The rules are scoped to that one element, so nothing can leak into the rest of the page or into your Joomla template. This travels with the element when you copy and paste it, including to another page.
Add-on reference
Every add-on on the site, grouped as the blocks panel groups them and listed by name. Each one gives what it is for, how to fill it in, and a table of its own settings - the shared motion, position and custom CSS settings are described once, above, and apply to all of them.
A blank setting means "leave it as it is"; where a setting starts out with a value, it is given as the default.
Content add-ons
Words, lists, cards, forms and numbers - the add-ons most pages are built from.
Accordion / FAQ
Blocks panel → Content · add-on key accordion
The Accordion add-on shows a list of questions or headings whose answers open one at a time. It keeps long, optional detail - an FAQ, a returns policy, course details - available without pushing the rest of the page down.
- Any number of items, one per line as
Question | Answer. - Answers with formatting, links, lists and pictures.
- The first item open by default, if chosen.
- Content that most visitors need to read - hidden text is read less.
When to use it
- Frequently asked questions.
- Terms, policies and specifications that a minority of visitors will open.
When to choose another add-on
- Content divided into parallel categories → use Tabs Pro.
- A sequence of steps or events → use Timeline.
Procedure
- Write one item per line: the question, a vertical bar, then the answer.
- Use bracket formatting inside answers for lists, links and pictures; write a pipe inside an answer as
\|. - Choose whether the first item opens by default.
Behaviour on the page
- Items open and close with a click, a tap, or the keyboard, and announce their open state to screen readers.
- The answers are part of the page, so search engines index them even when closed.
- Phrase questions as visitors would ask them.
- Open the first item only when it is the answer most visitors want.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| An answer is cut off. | A plain vertical bar inside the answer is read as a column separator. Write it as \|. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Items — one per line: Question | Answer | The items, one per line as Question | Answer. |
Several lines of text | What are the school timings? | Classes run 8:00 AM to 2:30 PM, Monday to Friday. How do… |
| Open the first item by default | Shows the first item open when the page loads. | On or off | on |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Alert / Notice
Blocks panel → Content · add-on key alert
The Alert add-on shows a short notice in a coloured band: information, success, warning or an important notice, with an optional icon.
- One message in one of four styles, with an optional icon.
- A notice that interrupts the page or can be dismissed and remembered - use the Popup or the Cookie Notice.
When to use it
- Holiday opening hours, a deadline, a change of address, a service interruption.
When to choose another add-on
Procedure
- Type the message.
- Choose the style and, optionally, an icon.
Behaviour on the page
- Warning and important styles are announced to screen readers as alerts.
- Remove the alert when it no longer applies, or schedule its section with the section's show-from and stop-showing dates.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Message | The message. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | School reopens on 1 April. |
| Style | The kind of notice, which sets its colour: information, success, warning or important. |
|
Info |
| Icon | The icon, chosen in the icon picker from the built-in icon set. | An icon | bi-info-circle |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Animated Heading
Blocks panel → Content · add-on key animated_heading
The Animated Heading add-on is a heading in which one word or phrase changes in place - "Built for schools", "Built for clinics", "Built for studios" - using one of eight effects. It carries attention in a hero section without a video, while remaining a real heading for the page outline.
- Fixed text before and after, and any number of rotating words.
- Eight effects (typewriter, slide, flip, fade and others) and a display time per word.
- Separate colour, weight, typeface, size, spacing and case for the rotating words, and an entrance for the text before them.
- Animating a whole paragraph.
When to use it
- A hero heading that names several audiences, products or places.
When to choose another add-on
- A static heading → use Heading.
- A title as a visual effect → use Special Heading.
Procedure
- Fill in the text before and, optionally, after the rotating words.
- Enter the rotating words, one per line.
- Choose the heading level, the effect and the seconds each word is shown.
- On the Style tab, style the rotating words apart from the rest of the heading.
Behaviour on the page
- Screen readers read the heading with the first word, not every change.
- With reduced motion, the words change without animation.
- Only the current word takes up space, so text after the rotating words moves as their length changes.
- Keep the rotating words to a similar length, or place them at the end of the heading, so the line does not shift as they change.
- Two to five words; more than that is not read.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Text before | The text before. | Text | A school that builds |
| Rotating words — one per line | The words or phrases that replace each other, one per line. | Several lines of text | confidence curiosity character |
| Text after | The text after. | Text | none |
| Heading level | Chooses the heading level. Each value is described under Values. |
|
H2 |
| Effect | How each word replaces the last. |
|
Slide up |
| Seconds per word | How long each word is shown, in seconds. | A whole number | 2 |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Center |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Text before entrance | An entrance, played once, for the text before the rotating words. |
|
No entrance effect |
| Text before colour | Sets the text before colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text before weight | Chooses the text before weight. Each value is described under Values. |
|
none |
| Rotating word colour | Sets the rotating word colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Rotating word weight | Chooses the rotating word weight. Each value is described under Values. |
|
none |
| Rotating word font | Chooses the rotating word font. Each value is described under Values. |
|
none |
| Rotating word size (% of the heading) | The rotating words' size as a percentage of the heading, so they scale with it. 100 is the same size. | A whole number, as a percentage | none |
| Rotating word letter spacing (px) | The rotating word letter spacing. | Text | none |
| Rotating word case | Chooses the rotating word case. Each value is described under Values. |
|
none |
| Rotating word in italics | Switches on or off: rotating word in italics. | On or off | off |
| Underline the rotating word | Switches on or off: underline the rotating word. | On or off | off |
Advanced tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Show this to | Chooses the show this to. Each value is described under Values. |
|
none |
| CSS id (for anchors and custom CSS) | The cSS id. | Text | none |
| Extra CSS classes | The extra CSS classes. | Text | none |
| Hide on mobile | Switches on or off: hide on mobile. | On or off | off |
| Hide on tablet | Switches on or off: hide on tablet. | On or off | off |
| Hide on desktop | Switches on or off: hide on desktop. | On or off | off |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Block Number
Blocks panel → Content · add-on key block_number
The Block Number add-on shows a row of large figures - students taught, years open, projects delivered - that count up as they arrive. Each figure has a label, a prefix and suffix, an optional icon, note and colour, and the set can be separated by lines, cards, outlines or panels.
- Any number of figures, decimals included, with prefix, suffix, label, note and icon.
- Five separators, three label positions, three arrival motions and thousands grouping.
- Live figures - numbers are typed in.
When to use it
- A band of three or four statistics under a hero or in an about page.
When to choose another add-on
- A single statistic beside text → use Counter.
- Percentages as shapes → use Progress Bar Pro.
Procedure
- Add a row per figure: number, label and, optionally, prefix, suffix, note, icon and colour.
- Set how many sit across on desktop and on phones.
- Choose the separator, the label position and the arrival motion.
- Tick Group thousands with a comma for figures above 999.
- On the Style tab, set the sizes, weight, alignment and colours.
Behaviour on the page
- Counting starts as the row scrolls into view and runs once.
- Decimals in the number are kept while counting, so 4.8 counts as 0.0 to 4.8.
- The final figures are in the page from the start for search engines and screen readers; with reduced motion they are shown immediately.
- Typefaces with equal-width digits stop figures from shifting while they count.
- Four figures across is the most that can be read at a glance.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Numbers | The figures. Each row has the number, a label, text before and after the number, a small note, an optional icon and an optional colour for that figure alone. | Each row, in order:
|
none |
| Across — desktop | Figures across on desktop screens. | A whole number | 4 |
| Across — mobile | Figures across on phones. | A whole number | 2 |
| Separated by | What separates one figure from the next. |
|
Nothing between them |
| Label position | Chooses the label position. Each value is described under Values. |
|
Under the number |
| How it arrives | How each figure arrives. |
|
Count up to it |
| Count lasts (ms) | How long counting lasts, in milliseconds. | A whole number, in milliseconds | 1600 |
| Group thousands with a comma | Writes thousands with a comma, for example 12,000. | On or off | on |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Number size (px) | Sets the number size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 54 |
| Number weight | Chooses the number weight. Each value is described under Values. |
|
Extra bold |
| Label size (px) | Sets the label size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 15 |
| Gap between them (px) | Sets the gap between them, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 28 |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Center |
| Number colour | Sets the number colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Label colour | Sets the label colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Card / panel background | The background of cards and panels, for those separators. | Any colour | none |
| Divider / outline colour | Sets the divider / outline colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
| Padding inside a card (px) | Sets the padding inside a card, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 26 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Button
Blocks panel → Content · add-on key button
The Button add-on is a single call to action: words, a link, an optional icon, a style and a size. It can span the full width of its column, or do so only on phones, where a full-width button is easier to tap.
- Five styles (primary, secondary, outline, ghost, plain link) and four sizes.
- An icon before or after the words, or an icon-only button.
- Custom colours for normal and hover states, corner radius, shadow and capitals.
- Several buttons in one row with shared styling - use the Button Group.
- Opening a popup by itself - point the button at a popup's trigger, or use a popup's click trigger on the button.
When to use it
- The main action of a section: book, buy, contact, download.
- A single link that must stand out more than a text link.
When to choose another add-on
- Two or more buttons side by side → use Button Group.
- A floating set of actions that follows the visitor → use Metro FAB.
Procedure
- Type the words and set the link. Tick Open in new tab only for links to other websites.
- Optionally choose an icon and its position.
- Choose the style, size and alignment.
- For phones, tick Full width on mobile only.
- On the Style tab, set custom colours if the template's do not suit the section.
Behaviour on the page
- An icon-only button is announced by its text to screen readers, so the text should still be filled in.
- Links to
#namescroll smoothly to that section on the same page.
- One primary button per section. A second action should use the outline or ghost style so the first stays clear.
- Write the words as the action: "Book a table", not "Click here".
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The button does nothing. | The link is empty or points at a section name that does not exist on the page. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Button text | The button text. | Text | Click here |
| Link | Where the link leads: a page on this site, a full https:// address, or #name for a section on the same page. |
A link | # |
| Open in new tab | Switches on or off: open in new tab. | On or off | off |
| Icon | The icon, chosen in the icon picker from the built-in icon set. | An icon | none |
| Icon position | Where the icon sits relative to the words, or "Icon only" for a compact button. |
|
Before the text |
| Style | The button's visual weight: filled (primary, secondary), outlined, text only (ghost), or a plain link. |
|
Primary |
| Size | Chooses the size. Each value is described under Values. |
|
Medium |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Left |
| Full width | Stretches the button to the width of its column on every screen. | On or off | off |
| Full width on mobile only | Stretches the button to the width of its column on phones only. | On or off | off |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Background | Sets the background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Border colour | Sets the border colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Hover background | Sets the hover background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Hover text colour | Sets the hover text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Shadow | Chooses the shadow. Each value is described under Values. |
|
none |
| UPPERCASE | Switches on or off: uPPERCASE. | On or off | off |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Button Group
Blocks panel → Content · add-on key button_group
The Button Group add-on places two or more buttons together with consistent spacing, size and style. Each button can override the group's style, so a primary action and a secondary action sit side by side correctly.
- Any number of buttons, each with words, a link, an icon and a style.
- Side-by-side, joined (segmented) or stacked arrangements.
- Shared size, alignment, gap, radius and colours; full width on mobile.
- A navigation menu - use the Site Header or Joomla Menu, which provide a drawer on phones and mark the current page.
When to use it
- A primary and a secondary action together, such as "Book now" and "See prices".
- Store badges or download options.
When to choose another add-on
- A single call to action → use Button.
- Navigation between pages → use Site Header.
Procedure
- Add a row per button: words, link, icon and style.
- Set the default style, size, alignment and arrangement for the group.
- Set the gap and whether buttons go full width on mobile.
Behaviour on the page
- On phones, full-width buttons stack one above the other.
- Give the first button the primary style and the others outline or ghost.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Buttons | The buttons. Each row has the words, the link, an optional icon and an optional style that overrides the group's. | Each row, in order:
|
none |
| Default style | The style used by every button that does not set its own. |
|
Primary |
| Size | Chooses the size. Each value is described under Values. |
|
Medium |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Left |
| Arrangement | Whether the buttons sit side by side with gaps, joined as one segmented control, or one above the other. |
|
Side by side |
| Gap between buttons (px) | Sets the gap between buttons, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 10 |
| Full width on mobile | Switches on or off: full width on mobile. | On or off | on |
| Open links in a new tab | Switches on or off: open links in a new tab. | On or off | off |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Circle Menu
Blocks panel → Content · add-on key circle_menu
The Circle Menu add-on arranges items around a ring with a label in the middle. Selecting an item turns the ring (or moves a marker) and shows that item's note in the centre. It presents a small set of related items - services, stages, departments - as a whole, which a list does not.
- Items with a label, link and a note shown in the middle; step arrows; automatic advance; a turning ring or a moving marker.
- More than about eight items - they crowd the ring.
When to use it
- Four to eight parts of one whole: a service cycle, a curriculum, a process that repeats.
When to choose another add-on
- A sequence with a start and an end → use Timeline.
- A list of services → use Feature Box.
Procedure
- Add a row per item: label, link and the note shown in the middle when selected.
- Write the small line above the middle label.
- Choose whether the ring turns or stays still, and whether arrows show.
- Set the automatic advance, or 0 to advance only on click.
- On the Style tab, set the size and colours.
Behaviour on the page
- Items are selected by click, tap, arrows or the keyboard.
- Automatic advance stops for good at the visitor's first interaction, so the wheel never moves away from an item someone has chosen.
- Keep labels to one or two words; notes to one sentence.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Menu items | The items. Each row has a label, a link, and a note shown in the middle when the item is selected. | Each row, in order:
|
none |
| Small line above the middle label | A small line shown above the label in the middle. | Text | NOW BROWSING |
| Show the step arrows | Switches on or off: show the step arrows. | On or off | on |
| How it moves | Whether selecting an item turns the whole ring, or keeps it still and moves a marker. |
|
Turn the whole ring |
| Advance on its own every (seconds, 0 = never) | Advances to the next item every so many seconds. 0 advances only when clicked. | A whole number, in seconds | 0 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Wheel size (px) | Sets the wheel size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 460 |
| Selected item | Sets the selected item colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Item background | Sets the item background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Item text | Sets the item text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| The ring line | Sets the the ring line colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Middle circle outline | The outline colour of the middle circle. | Any colour | none |
| Middle label size (px) | Sets the middle label size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 34 |
| Glow around the selected item | Switches on or off: glow around the selected item. | On or off | on |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Coming soon screen
Blocks panel → Content · add-on key coming_soon
The Coming Soon Screen add-on is a complete full-screen holding page for a site or section that is not open yet: logo, eyebrow, headline, sub-heading, a countdown, a button with small print, and links to your profiles, over a background picture or colour.
- Logo image or text, headline, countdown with arrangement and seconds, button, note, links, background image with overlay, minimum height and alignment.
- Taking the site offline - use Joomla's offline mode or make this page the home page.
When to use it
- A pre-launch page.
- A page for a product or event not yet available.
When to choose another add-on
- A countdown inside a finished page → use Countdown.
Procedure
- Set the logo, or type the logo text, and its height.
- Write the eyebrow, headline and sub-heading.
- Enter the date being counted to, or leave it empty for no clock, and the message once it arrives.
- Set the button, its link and the small print.
- Add links one per line as
Label | URL. - On the Style tab, set the background image, overlay, colours and minimum height.
Behaviour on the page
- The date follows the same rules as the Countdown: UTC unless an offset is given.
- The screen fills the window height set under Minimum height.
- Give visitors something to do: a way to be notified or to get in touch.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Logo image | The picture used for the logo image. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Or logo text | Text used as the logo when no logo image is set. | Text | none |
| Logo height (px) | Sets the logo height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 56 |
| Eyebrow | The eyebrow. | Text | none |
| Headline | The headline. | Text | Something new is coming |
| Sub-heading | The sub-heading. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| Counting down to | The date and time being counted to, in the Countdown's format. Leave empty for no clock. | Text | none |
| Message once it arrives | The message once it arrives. | Text | We are live |
| Countdown arrangement | How the countdown units are arranged. |
|
Separate boxes |
| Show seconds | Switches on or off: show seconds. | On or off | on |
| Button wording | The button wording. | Text | none |
| Button URL | The button URL. | Text | none |
| Small print under the button | Small print under the button. | Text | none |
| Links - one per line: Label | URL | Links shown at the foot, one per line as Label | URL. |
Several lines of text | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Background image | The picture used for the background image. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Background colour | Sets the background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Overlay over the image | A colour laid over the background image to keep the text readable. Use a transparent colour. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Accent colour | Sets the accent colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Minimum height (vh) | The screen's minimum height, as a percentage of the window height (100 fills it). | A whole number (vh) | 100 |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Center |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Contact Form
Blocks panel → Content · add-on key contact_form
The Contact Form add-on is a working enquiry form: name, email and, optionally, phone, subject and message. Submissions are emailed to the address you give, using the site's mail settings; nothing is stored in the database. Spam is filtered by hidden checks, and optionally by the site's captcha or a proof-of-work challenge that needs nothing from the visitor.
- Name and email always; phone, subject and message optionally.
- A consent line with a link, custom button and thank-you wording.
- Stacked, two-column or inline (email capture) layouts, and three field styles.
- Spam protection by honeypot and timing, captcha or proof of work.
- Custom fields, file uploads or multi-step forms.
- Storing submissions - keep the emails, or use a form extension.
When to use it
- A contact page or a "talk to us" section.
- A distributor or trade enquiry form.
- A single-line email capture (inline layout).
When to choose another add-on
- A form from another extension → use Joomla Module.
- A booking with times and availability → use Court booking board.
Procedure
- Enter the address that receives the messages, and the subject line of those emails.
- Write the heading and sub-heading.
- Choose which optional fields to include.
- Choose the spam protection. Leave at least the built-in checks.
- Write the consent line if needed, the button words and the thank-you message.
- On the Style tab, choose the layout and field style and set the colours.
- Send a test message from the live page to confirm it arrives.
Behaviour on the page
- The message is sent by the site's own mail settings (System → Global Configuration → Server). If those are not working, no form on the site can send.
- The visitor's address is set as the reply-to, so replying to the email answers the visitor.
- Proof of work runs in the visitor's browser for a moment before sending; the visitor sees nothing to solve.
- "The site captcha, and refuse if none is configured" rejects submissions until a captcha plugin is enabled.
- Leave spam protection on; an unprotected form is found by bots within days.
- Send to an address on the site's own domain; some mail servers reject mail sent on behalf of another domain.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Messages do not arrive. | Check the site's mail settings with Joomla's "Send Test Mail", and the spam folder of the receiving address. |
| Every message is refused. | The protection is set to "The site captcha" but no captcha plugin is enabled. Choose "Add a challenge" or enable a captcha. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Send messages to | The email address that receives each submission. | Text | none |
| Subject line | The subject line of the email you receive. | Text | Website enquiry |
| Heading | The heading. | Text | none |
| Sub-heading | The sub-heading. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| Ask for a phone number | Switches on or off: ask for a phone number. | On or off | off |
| Let them write their own subject | Adds a subject field for the visitor to fill in. | On or off | off |
| Include a message box | Switches on or off: include a message box. | On or off | on |
| Spam protection | The spam protection used in addition to the built-in hidden checks. |
|
Add a challenge - the site captcha if there is one, otherwise proof of work |
| Consent line (leave empty for none) | A sentence the visitor must tick before sending. Bracket formatting may be used for a link to your privacy page. | Text | none |
| Button | The button. | Text | Send |
| Message after sending | The message shown in place of the form after sending. | Text | Thank you — we will reply shortly. |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Layout | The arrangement of the fields. |
|
Two columns — name and email side by side |
| Field style | How each field is drawn. |
|
Boxed fields |
| Accent colour | Sets the accent colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Field background | Sets the field background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Field text colour | Sets the field text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 10 |
| Gap between fields (px) | Sets the gap between fields, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Full-width button | Switches on or off: full-width button. | On or off | off |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Cookie notice
Blocks panel → Content · add-on key cookie_notice
The Cookie Notice add-on shows a consent bar or card with Accept and Reject buttons, a link to your policy and an optional Manage link. The visitor's answer is remembered in their browser, and the notice does not appear again until the storage key is changed.
- Title, message, policy link, three buttons, five positions, colours and a preview mode for building.
- Blocking or releasing scripts according to the answer - the answer is recorded for your scripts to read.
- A cookie-by-cookie preferences screen - Manage links to a page you provide.
When to use it
- Any site that sets non-essential cookies and needs consent.
When to choose another add-on
- A marketing message over the page → use Popup.
- A notice inside the page → use Alert / Notice.
Procedure
- Write the title, message and button wording.
- Point the policy link at your privacy or cookie policy page.
- Optionally add a Manage button and its page.
- Choose the position.
- While styling, tick Always show while building; it affects the builder only.
Behaviour on the page
- The notice is placed on top of the page wherever it sits in the layout, so it can be put in the footer section.
- The answer is stored in the visitor's browser under the storage key. Changing the key asks everyone again.
- Once answered, the notice does not appear again in that browser. To see it again, clear the site's data or use a private window.
- Make Reject as easy to find as Accept; several regulators require it.
- Place it on every page, for example in a shared footer.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The notice does not appear. | Your browser has already answered it. Open a private window, or change the storage key. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Title | The title. | Text | This site uses cookies |
| Message | The message. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | We use cookies that are needed to run the site, and - only with your agreement - others… |
| Policy link wording | The policy link wording. | Text | Cookie policy |
| Policy link URL | The policy link URL. | Text | none |
| Accept button | The accept button. | Text | Accept all |
| Reject button | The reject button. | Text | Essential only |
| Manage button (blank to hide) | The Manage button's wording. Leave empty to hide it; show it only when you have a preferences page. | Text | none |
| Manage link URL | The page the Manage button opens. | Text | none |
| Where it appears | Where the notice appears on the screen. |
|
Bar across the bottom |
| Storage key | The name under which the answer is remembered in the browser. Change it to ask everyone again. | Text | mpbConsent |
| Always show while building | Keeps the notice visible in the builder after you have answered it. No effect on the live site. | On or off | on |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Background | Sets the background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Accept button colour | Sets the accept button colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Accept button text | Sets the accept button text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Countdown
Blocks panel → Content · add-on key countdown
The Countdown add-on counts days, hours, minutes and seconds to a date and time, and replaces the clock with a message once it arrives. It is used for early-bird deadlines, events and term starts inside a finished page.
- A target date and time with time zone, labels in any language, four arrangements, optional days and seconds, and a message on arrival.
- A whole holding page for a site that is not open - use Coming Soon.
When to use it
- An offer that ends, an event that starts, an admissions deadline.
When to choose another add-on
- A site not yet open → use Coming soon screen.
Procedure
- Enter the date and time, for example
2026-04-18 19:30. Add the offset for local time, for example+0530. - Write the small heading and the message shown once the date arrives.
- Choose which units to show and their labels.
- Choose the arrangement and alignment; on the Style tab, set sizes, colours and separator.
Behaviour on the page
- The date is read as UTC unless an offset is given.
- The clock runs in the visitor's browser; after the date, the message is shown in place of the clock.
- Omit the seconds for a date weeks away; a ticking second hand on a distant date looks restless.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The count is out by some hours. | The date has no offset and is read as UTC. Add the offset of your time zone. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Counting down to | The date and time being counted to, as YYYY-MM-DD HH:MM, with an optional offset such as +0100. |
Text | none |
| Small heading above | A small line above the clock. | Text | none |
| Message once it arrives | The message shown in place of the clock once the date arrives. | Text | Under way |
| Show days | Switches on or off: show days. | On or off | on |
| Show seconds | Switches on or off: show seconds. | On or off | on |
| Label: days | The label: days. | Text | Days |
| Label: hours | The label: hours. | Text | Hrs |
| Label: minutes | The label: minutes. | Text | Min |
| Label: seconds | The label: seconds. | Text | Sec |
| Arrangement | How the units are arranged. |
|
Separate boxes |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Center |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Number size (px) | Sets the number size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 44 |
| Number colour | Sets the number colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Label colour | Sets the label colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Box background | Sets the box background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Box corner radius (px) | Sets the box corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Gap between units (px) | Sets the gap between units, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Separator between units | Characters placed between the units, such as a colon. | Text | none |
| Pulse the seconds | Makes the seconds pulse as they change. | On or off | none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Counter
Blocks panel → Content · add-on key counter
The Counter add-on shows one number with a caption, counting up from zero when it scrolls into view. A prefix and suffix frame the number (a currency sign, a plus, a per cent sign), and an optional shape - a circle, blob, square or ring - can sit behind it.
- One number, with prefix, suffix and caption, stacked or side by side.
- An optional count-up animation on scroll.
- An optional shape behind the number.
- Several numbers in a row - use the Block Number add-on.
- Live or changing figures - the number is typed in.
When to use it
- A single headline statistic beside a paragraph.
When to choose another add-on
- Three or four statistics in a row → use Block Number.
- A figure shown as a filled bar or ring → use Progress Bar Pro.
Procedure
- Enter the number, and a prefix or suffix if needed.
- Write the caption and choose whether it sits under the number or beside it.
- Choose the alignment and colour, and whether it animates.
- Optionally choose a shape and its colour on the Style tab.
Behaviour on the page
- The count starts when the counter scrolls into view and runs once.
- Visitors who ask their device for reduced motion see the final number immediately.
- The final number is in the page from the start, so search engines and screen readers read the real value.
- Round large figures: "12,000+" is read faster than "12,347".
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Number | Sets the number. Leave it empty to use the add-on's default. | A whole number | 250 |
| Prefix (e.g. ₹) | The prefix. | Text | none |
| Suffix (e.g. + or %) | The suffix. | Text | + |
| Caption | The caption. | Text | Students |
| Number colour | Sets the number colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Center |
| Arrangement | Whether the caption sits under the number or beside it. |
|
Number above caption |
| Animate on scroll | Counts up from zero when the counter scrolls into view. | On or off | on |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Shape behind the number | A shape drawn behind the number. |
|
none |
| Shape colour | Sets the shape colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Court booking board
Blocks panel → Content · add-on key booking
The Court Booking Board add-on shows time slots with their availability and price - courts, studios, treatment rooms, tutors - grouped by time or by resource. An open slot can link to a booking page or jump to a booking form on the same page, or the board can show availability only.
- Slots typed one per line with a status of open, few or full; grouping; prices with a note; a legend; link or anchor per open slot.
- Taking bookings or updating availability - the board displays what is typed; bookings happen on the linked page or form.
When to use it
- A sports club, studio or clinic showing this week's availability.
When to choose another add-on
- A timetable without availability → use Table.
- An enquiry form → use Contact Form.
Procedure
- Write the heading and sub-heading.
- Enter one slot per line:
Time | Court | Status | Price, where status is open, few or full. - Choose how slots are grouped, and the price prefix and note.
- Choose what an open slot does and give the booking page address or the section anchor.
- On the Style tab, set colours and cards per row.
Behaviour on the page
- Full slots are shown but not linked.
- Any status other than few or full is treated as open.
- Update the slots when availability changes, or link to a live booking system.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Heading | The heading. | Text | Book a court |
| Sub-heading | The sub-heading. | Text | none |
| Slots - one per line: Time | Court | Status | Price | The slots, one per line as Time | Court | Status | Price. Status is open, few or full. |
Several lines of text | 06:00 - 07:00 | Table 1 | open | 400 06:00 - 07:00 | Table 2 | few | 400 07:00 - 08:00 … |
| Group slots by | Whether slots are grouped by time, by court, or not grouped. |
|
Time |
| Price prefix | Written before every price. | Text | Rs |
| Note under the price | A small note under each price, such as "per hour". | Text | per hour |
| What an open slot does | What happens when an open slot is clicked. |
|
Jump to a form on this page |
| Booking page URL | The booking page, for "Link each open slot to a booking page". | Text | none |
| Anchor on this page | The section name on this page, for "Jump to a form on this page". | Text | #enquire |
| Wording on an open slot | The wording shown on each open slot. | Text | Book |
| Show the legend | Shows a key explaining the open, few and full colours. | On or off | on |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Accent colour | Sets the accent colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Card background | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
| Cards per row (desktop) | Chooses the cards per row. Each value is described under Values. |
|
4 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Feature Box
Blocks panel → Content · add-on key featurebox
The Feature Box add-on presents one feature, service or benefit as an icon, a title, a short description and an optional link, on an optional card background. Three or four side by side form the familiar row of services.
- One icon, title, description and link, aligned left, centre or right, with or without a card.
- A picture instead of an icon - use the Image & Content or Flip Box.
When to use it
- A row of three or four services, benefits or steps.
- Cards that lead to detail pages.
When to choose another add-on
- A card that turns over to show more → use Flip Box.
- A picture beside a paragraph → use Image & Content.
- A list of short points with icons → use Icon List.
Procedure
- Choose the icon and write the title and description.
- Optionally add a link and its words.
- Choose the alignment and icon colour, and whether a card background is shown.
- Place three or four Feature Boxes in equal columns of one row.
Behaviour on the page
- With a link, the whole box is clickable; the link words are shown at the bottom.
- Give every box in a row a similar amount of text; uneven lengths make a row of cards look untidy.
- When the column itself is styled as a card, switch off the box's own card background so the card is not drawn twice.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Icon | The icon, chosen in the icon picker from the built-in icon set. | An icon | bi-book |
| Title | The title. | Text | Feature title |
| Description | The description. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | Say what this feature offers. |
| Link (optional) | Where the link leads: a page on this site, a full https:// address, or #name for a section on the same page. |
A link | none |
| Link text | The words of the link shown at the bottom of the box. | Text | Learn more |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Center |
| Icon colour | Sets the icon colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Show card background | Draws the box on a card background with padding and a corner radius. | On or off | on |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Fixtures & results
Blocks panel → Content · add-on key fixture
The Fixtures & Results add-on lists matches for a team: competition, date and venue, the two sides with scores and details, the result, and buttons for a highlights video and a match report. Choosing the sport adjusts the wording and icons.
- Upcoming fixtures and results in one list, fourteen sports, cards or compact rows, and per-side colours.
- Live scores or league tables read from a feed.
When to use it
- A club, school or league page showing recent results and the next matches.
When to choose another add-on
- A league table → use Table.
Procedure
- Write the heading and sub-heading.
- Enter one match per line:
Competition | When | Venue | Home | Home score | Away | Away score | Result | Video link | Report link | Home detail | Away detail. Leave any part empty. - Choose the sport and the arrangement.
- Set the video and report button wording.
- On the Style tab, set the colours for cards, the result banner and each side.
Behaviour on the page
- A match without scores is shown as a fixture; with scores, as a result.
- Buttons appear only when their link is filled in.
- Use the detail fields for cricket innings or goal scorers.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Details land in the wrong place. | A separator is missing. Every line must keep the same order of parts; leave empty parts between bars. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Heading | The heading. | Text | none |
| Sub-heading | The sub-heading. | Text | none |
| Matches - one per line | The matches, one per line, parts separated by vertical bars in the order given under the field. | Several lines of text | League | Sat 13 Apr, 19:30 | Harbour Oval | Harbour Kings | | Desert Falcons | | | … |
| Sport | Adjusts the wording and icons to the sport. |
|
Any sport |
| Arrangement | Cards with the two sides facing each other, or compact rows. |
|
Cards, with the two sides facing |
| Video button wording | The video button wording. | Text | Highlights |
| Report button wording | The report button wording. | Text | Report |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Accent | Sets the accent colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Card background | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Result banner background | The background of the banner stating the result. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Detail colour | Sets the detail colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Home side panel | The background of the home side's panel. | Any colour | none |
| Away side panel | The background of the away side's panel. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
| Gap between matches (px) | Sets the gap between matches, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Flip Box
Blocks panel → Content · add-on key flipbox
The Flip Box add-on is a card with two faces: a front with an icon or picture, a title and a short text, and a back with further detail and a button. The card turns over on hover, on focus, or on a tap.
- A front and a back, five flip directions including a fade, a fixed height and separate colours per face.
- Several cards from one list - use Flip Box Pro.
When to use it
- A small set of services or products where a short teaser leads to a little more detail.
When to choose another add-on
- A row of flip cards from one list → use Flip Box Pro.
- A card that shows everything at once → use Feature Box.
Procedure
- Fill in the front: icon or image, title and text.
- Fill in the back: title, text, button words and link.
- Choose the flip direction and set a height that holds the longer face.
- Set the colours for each face on the Style tab.
Behaviour on the page
- With a mouse, the card turns while the pointer is over it. A tap, a click, or Enter or Space on the keyboard turns it and keeps it turned; moving the keyboard focus away turns it back.
- For visitors who ask their device for reduced motion, the faces swap instantly without rotating.
- Both faces are in the page, so their text is read by search engines and screen readers.
- Keep the back short; a face that needs scrolling defeats the effect.
- Give every card in a row the same height.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Text is cut off on the back. | The height is too small for the back's text. Raise the height or shorten the text. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Front — icon | The front — icon, chosen in the icon picker from the built-in icon set. | An icon | bi-mortarboard |
| Front — image (used instead of the icon) | A picture for the front, used instead of the icon. | A picture | none |
| Front — title | The front — title. | Text | Our approach |
| Front — text | The front — text. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | Hover or tap to read more. |
| Back — title | The back — title. | Text | What that means |
| Back — text | The back — text. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | Put the detail here. |
| Back — button link | The back — button link. | Text | none |
| Back — button text | The back — button text. | Text | none |
| Flip direction | The direction the card turns, or a fade without rotation. |
|
Flip left |
| Height (px) | The card's fixed height, in pixels. Both faces use it. | A whole number, in pixels | 280 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Front background | Sets the front background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #eef5fb |
| Front text colour | Sets the front text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Back background | Sets the back background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #14385c |
| Back text colour | Sets the back text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Icon colour | Sets the icon colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Icon size (px) | Sets the icon size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 42 |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Text alignment inside the card | Chooses the text alignment inside the card. Each value is described under Values. |
|
Center |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Flip Box Pro
Blocks panel → Content · add-on key flipbox_pro
The Flip Box Pro add-on presents several two-sided cards from one list, as a grid with columns set per screen size. Every card has a front (an icon or picture, a title and text) and a back (a title, text and a button), and the row shares one height and colour scheme. Seven effects decide how a card changes face - a classic flip, a 3D card whose edge shows as it turns, a lift-and-flip on a spring, a page peeled from its corner, a door on a hinge, the back sliding up, a zoom through - and three triggers decide what turns it: pointing at it, a click or tap only, or a button on each face. A picture can fill each card, a glare can sweep across it, a reflection can sit below it, and the front icon can ride a coloured badge that moves on its own.
- Any number of cards; one to six columns on desktop, tablet and phone.
- Seven effects and five directions; for the door, the direction is the side of its hinge.
- Three triggers, with the wording of the two buttons.
- A full picture behind each card on the front, the back or both, darkened so words read over it.
- A glare, a reflection, a shadow; an icon badge in three shapes with seven motions.
- Different colours per card - place separate Flip Box add-ons for that.
When to use it
- A grid of services, programmes, products or phases, each with a teaser and a little more on the back.
- A range of products shown by picture, with the details and a button behind.
When to choose another add-on
- One flip card with its own colours → use Flip Box.
- Cards that show everything at once → use Feature Box.
Procedure
- Add a row per card: front icon or picture, front title and text, back title and text, button link and words, and optionally a full picture behind the card.
- Set the columns for desktop, tablet and phone.
- Choose the effect, its direction, and what turns a card.
- Set the card height and the gap.
- On the Style tab, set the colours of each face, the picture's darkening, the shine, the shadow and the icon badge and its motion.
Behaviour on the page
- Pointing: a card turns while the pointer is over it. A tap, a click, or Enter or Space turns it and keeps it turned; moving the keyboard focus away turns it back.
- Click only: nothing happens under a passing pointer; the card turns on a click, a tap or the keyboard.
- Buttons: only the button turns the card, so a link on the back can be used without turning it back. The button on the hidden face is out of the tab order, and focus moves to the button on the face that turns towards the visitor.
- For visitors who ask their device for less motion, the faces swap instantly, whatever the effect; the icon motions stop.
- Peel from the corner: at rest the corner is turned down. On the turn the front peels away like a sticker - the corner folds back over the card, the fold sweeps up to the far corner in about half a second, and the flap lifts away - with the back underneath. (Redrawn in 2.42.1; before, the front was wiped away towards one corner.)
- The reflection is drawn by browsers that support reflections (Chrome, Edge, Safari); elsewhere the card simply has none.
- Every default reproduces the card as it was before 2.42.0.
- Set the height from the card with the longest back text.
- Use the button trigger when the back holds a link.
- A picture behind a card wants light words: set the front text colour to white, or leave it blank for white.
- One moving element per card is plenty: an icon motion or a glare, not both.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The back text is cut off. | Raise the card height or shorten the text; every card uses the same height. |
| A card turns when a link on its back is clicked. | That is the pointing and click triggers working as designed. Choose the button trigger. |
| The picture does not show. | The path holds a quote, a bracket or a backslash, which cannot be used in a background picture. Rename the file. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Cards | The cards. Each row has a front icon, an optional front picture used instead of the icon, a front title and text, a back title and text, the back button's link and words, and an optional full picture behind the card. | Each row, in order:
|
none |
| Columns — desktop | Cards per row on desktop screens. |
|
3 |
| Columns — tablet | Cards per row on tablets. |
|
2 |
| Columns — mobile | Cards per row on phones. |
|
1 |
| Effect | How a card changes from its front to its back. |
|
Classic flip |
| Flip direction | For the flip, 3D card and lift, the way the card turns; for the door, the side its hinge is on. |
|
Flip left |
| What turns it | What turns a card: pointing at it, a click or tap only, or a button on each face. |
|
Pointing at it (tap on a phone) |
| Button on the front | The words of the button on the front, for the button trigger. Offered only when What turns it is "A button on each face". | Text | Details |
| Button on the back | The words of the button on the back, for the button trigger. Offered only when What turns it is "A button on each face". | Text | Back |
| Card height (px) | The height of every card, in pixels. | A whole number, in pixels | 300 |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 20 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Front background | Sets the front background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #eef5fb |
| Front text colour | Sets the front text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Back background | Sets the back background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #14385c |
| Back text colour | Sets the back text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Icon colour | Sets the icon colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Icon size (px) | Sets the icon size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 44 |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Text alignment inside each card | Chooses the text alignment inside each card. Each value is described under Values. |
|
Center |
| Card thickness (px) | For the 3D card, its thickness in pixels. Offered only when Effect is "3D card - the edge shows as it turns". | A whole number, in pixels | 14 |
| The picture shows on | Which face shows the full picture. |
|
The front |
| Darken the picture (%) | How much the picture is darkened, as a percentage, so words read over it. | A whole number, as a percentage | 45 |
| Shine | A glare sweeping across on hover, a reflection below the card, or both. |
|
None |
| Shadow under each card | Draws a soft shadow under each card. | On or off | off |
| Icon badge | Puts the front icon on a coloured badge of this shape. |
|
No badge - the icon alone |
| Badge colour | The badge's colour. Offered only when Icon badge is "Circle" or "Rounded square" or "Blob". | Any colour | none |
| Icon animation | A motion the badge keeps up on its own: rising bubbles, a ripple, a float, a slow turn, a pop or a heartbeat. |
|
Still |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Heading
Blocks panel → Content · add-on key heading
The Heading add-on sets a page or section title at a chosen level (H1 to H6). Part of the heading can take its own colour and weight, and the letters can have an outline and a shadow. The level describes the heading's place in the page outline - which search engines and screen readers rely on - and is independent of its size.
- A single heading at levels H1 to H6, aligned left, centre or right.
- Inline formatting: a word in another colour, bold or italic, a highlight, a gradient fill.
- An outline around the letters and a directional shadow or glow.
- Paragraphs of text - use the Text add-on.
- Rotating words - use the Animated Heading.
- Decorative display effects such as neon, 3D or letters in a circle - use the Special Heading.
When to use it
- The main title of a page (H1) and the title of each section (H2).
- Sub-headings inside a section (H3 and below).
When to choose another add-on
- A heading with one word that keeps changing → use Animated Heading.
- A title as a visual effect rather than as text → use Special Heading.
- A very large decorative word behind a section → use Ghost Word.
Procedure
- Type the heading under Text. To colour one word, select it and use the colour button, or write
[c=#e11d48]word[/c]. - Choose the Level: H1 for the page title, H2 for section titles, H3 and below for sub-headings.
- Set the alignment and colour; set the size and typeface under the shared typography settings.
- Optionally add an outline or a shadow on the General tab.
Behaviour on the page
- The level is written into the page as a real heading element, so it forms the page outline used by screen readers and search engines.
- The size can be set independently of the level; an H2 may be displayed larger than the H1 where the design calls for it.
- Use exactly one H1 per page, at the top. Choose levels by structure, not by appearance.
- Keep outlines to two or three pixels; a thick outline on small text fills in the letters.
- An eight-digit hex colour carries transparency:
#00000059gives a soft shadow rather than a solid one.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The heading is the right level but the wrong size. | The template sets a size per level. Set the size explicitly with the typography settings. |
| The second half does not take its colour. | The older "Second half" field is used only when filled in. Colour the words inside Text instead. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Text | The text. | Text | Heading text |
| Second half, in its own colour | The older way to give the end of the heading its own colour. The Text field does the same with inline formatting and is preferred. | Text | none |
| ...its colour | Sets the its colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| ...its weight | Chooses the its weight. Each value is described under Values. |
|
none |
| ...on a new line | Starts the second half on a new line. | On or off | on |
| Level | The heading's level in the page outline, from H1 (the page title) to H6. |
|
H2 |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Left |
| Colour | Sets the colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Outline width (px) | Draws an outline of this width, in pixels, around the letters. Leave it empty for none. | A whole number, in pixels | none |
| Outline colour | Sets the outline colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Shadow direction | The direction the shadow falls, or "All round" for a glow. Choose "No shadow" for none. |
|
none |
| Shadow distance (px) | How far the shadow is offset from the letters, in pixels. | A whole number, in pixels | 4 |
| Shadow softness (px) | How soft the shadow's edge is, in pixels. 0 is a hard-edged copy. | A whole number, in pixels | 6 |
| Shadow colour | Sets the shadow colour. Leave it empty to use the colour the section or the site template already gives. An eight-digit hex carries opacity: #00000059 is a soft shadow rather than a solid one. | Any colour | none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Icon
Blocks panel → Content · add-on key icon
The Icon add-on places a single icon from the built-in icon set, or a small image of your own, at a chosen size, colour and alignment, optionally linked.
- One icon or small image, sized, coloured and aligned, with an optional link.
- Icons with text beside them - use the Icon List or Feature Box.
When to use it
- A decorative mark above a heading.
- A single linked symbol, such as a download or phone icon.
When to choose another add-on
- An icon with a title and a paragraph → use Feature Box.
- A list where every row has an icon → use Icon List.
- Links to social profiles → use Social Icons.
Procedure
- Choose between the built-in icon set and your own image.
- Pick the icon or the image; for an image, write a description.
- Set the size, colour (icons only), alignment and optional link.
Behaviour on the page
- An icon without a link is decorative and hidden from screen readers; a linked icon is announced by its description.
- Use one icon style per page; mixing outline and filled icons looks inconsistent.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Use | Whether the add-on shows an icon from the built-in set or an image of your own. |
|
Bootstrap icon |
| Icon | The icon, chosen in the icon picker from the built-in icon set. | An icon | bi-star-fill |
| Image (used when "My own image" is selected) | The picture used for the image. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Image description (for screen readers) | What the image shows, read aloud by screen readers. Used for your own image. | Text | none |
| Size (px) | Sets the size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 40 |
| Colour (icons only) | The icon's colour. Does not apply to your own image. | Any colour | none |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Center |
| Link (optional) | Where the link leads: a page on this site, a full https:// address, or #name for a section on the same page. |
A link | none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Icon List
Blocks panel → Content · add-on key icon_list
The Icon List add-on is a list in which every row has an icon, text, an optional line of sub-text and an optional link. It runs in one to eight columns, and icons can sit on coloured chips.
- Rows of icon, text, sub-text and link; a fallback icon; one to eight columns; chips, colours, sizes and dividers.
- Paragraphs per item - use Feature Boxes.
When to use it
- What is included, what to bring, opening hours, contact details, certifications.
When to choose another add-on
- Items with a paragraph each → use Feature Box.
- A timed sequence → use Timeline.
Procedure
- Add a row per item: icon, text, optional sub-text and link.
- Set the icon used by rows that name none, and the number of columns.
- On the Style tab, set the icon colour and size, an optional chip background, and dividers.
Behaviour on the page
- Columns collapse to one on phones.
- The icons are decorative and hidden from screen readers; the text carries the meaning.
- A chip background (icon on a small coloured circle) makes short lists read as a set.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Items | The rows. Each has an icon, the text, optional sub-text in smaller type, and an optional link. | Each row, in order:
|
none |
| Icon for rows that set none | The icon used by rows that do not set one. | An icon | bi-check-circle-fill |
| Columns (desktop) | Chooses the columns. Each value is described under Values. |
|
1 |
| Row spacing (px) | Sets the row spacing, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 12 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Icon colour | Sets the icon colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Icon size (px) | Sets the icon size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
| Icon background (makes a chip) | A background colour behind each icon, turning it into a chip. Leave empty for plain icons. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Line between rows | Switches on or off: line between rows. | On or off | off |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Image & Content
Blocks panel → Content · add-on key image_content
The Image & Content add-on sets a picture beside a block of content: a small label, a title, a paragraph, bullet points and a button. The split between picture and content, the picture's shape, and which comes first on a phone are all controlled here, which makes it the most widely used section layout.
- One picture and one block of content, picture left or right.
- Five splits (50/50 to 30/70), a gap, and vertical alignment.
- A picture shape (wide, photo, classic, square, portrait, tall or natural), crop or fit, width, radius and shadow.
- The order on phones: picture first or content first.
- Several pictures - use a Gallery, Carousel or Mosaic beside a Text add-on.
When to use it
- Explaining one idea with one picture: an about-us band, a service, a product feature.
- A sequence of such bands down a page, alternating the picture side.
When to choose another add-on
- A picture with labelled points on it → use Product Callouts.
- Three short features in a row → use Feature Box.
Procedure
- Choose the picture and describe it for screen readers.
- Fill in the label, title, text, bullet points (one per line) and button.
- Choose the picture side, the split and the gap.
- Choose which comes first on a phone.
- On the Style tab, choose the picture shape and how it fills that shape, and the colours.
Behaviour on the page
- On phones the picture and content stack in the order chosen under On mobile, show.
- The picture shape crops the image to a consistent proportion, so a series of bands aligns even when the source images differ.
- Shapes may also be written as
4x3,16x9and so on.
- Alternate the picture side down the page.
- Use the same picture shape for every band on a page.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The picture is cropped badly. | Choose "Fit inside (no crop)" or a shape closer to the source image. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Image | The picture used for the image. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Image description (for screen readers) | The image description. | Text | none |
| Small label above the title | A short label above the title, shown in the accent colour. | Text | none |
| Title | The title. | Text | A heading for this section |
| Text | The text. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | Say what matters here. |
| Bullet points — one per line | Bullet points, one per line, shown with accent-coloured markers. | Several lines of text | none |
| Button text | The button text. | Text | none |
| Button link | The button link. | Text | none |
| Image side (desktop) | Which side the picture sits on, on desktop screens. |
|
Left |
| On mobile, show | Which comes first when the picture and content stack on a phone. |
|
Image first |
| Split | How the width is divided between the picture and the content. |
|
Half and half |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 36 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Vertical alignment | How the picture and content align vertically when their heights differ. |
|
Centred |
| Image shape | The shape the picture is cropped to. "Natural" keeps the file's own proportions. |
|
none |
| How the image fills that shape | Whether the picture fills its shape by cropping, or fits inside it without cropping. |
|
Crop to fill |
| Image width (% of its column) | The picture's width as a percentage of its half of the layout. | A whole number, as a percentage | none |
| Centre the image in its column | Switches on or off: centre the image in its column. | On or off | off |
| Image corner radius (px) | Sets the image corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Image shadow | Switches on or off: image shadow. | On or off | off |
| Title colour | Sets the title colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Accent (label + bullets) | The colour of the label and the bullet markers. | Any colour | none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Liquid Glass
Blocks panel → Content · add-on key glass
The Liquid Glass add-on draws a pane of glass - frosted, clear or liquid - in the shape required: a button, a card, a wide panel, an icon tray like a dock, or an icon capsule like a switch. The page behind shows through, blurred and tinted, with a bright edge.
- Five shapes; words, icon and link, or a list of icons with a highlighted one; three looks; tint, blur, roundness, edge light, shadow and hover.
- Glass over a flat colour - it then appears as a tint only.
When to use it
- A card or buttons laid over a photograph or video.
- An icon tray of shortcuts over a hero.
When to choose another add-on
- Buttons that stay on screen → use Metro FAB.
- A plain card → use Feature Box.
Procedure
- Choose the shape.
- For a button, card or panel, fill in the title, text, icon and link. For a tray or capsule, add the icons and choose the highlighted one.
- Choose the alignment and whether it spans the full width.
- On the Style tab, choose the look and set tint, blur, roundness, edge light, shadow and text colour.
- Place it on a section with a picture, or position it over another block (Advanced → Position).
Behaviour on the page
- Browsers without background blur show a translucent tint instead.
- Icon names are read by screen readers and shown on hover.
- Check the text colour against the brightest part of what shows through.
- Keep the tint strength below 60%; above that it no longer reads as glass.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| It looks like a grey box. | There is nothing behind it but a flat colour. Put a picture behind it, and raise the edge light. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Shape | The form the glass takes. |
|
Card |
| Title / button text | The title / button text. Offered only when Shape is "Button" or "Card" or "Wide panel (a glass section)". | Text | See through it |
| Text | The text. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. Offered only when Shape is "Card" or "Wide panel (a glass section)". |
Several lines of text | A pane of glass over whatever sits behind it. |
| Icon | The icon, chosen in the icon picker from the built-in icon set. Button: in the round badge after the text. Card and panel: above the title. Offered only when Shape is "Button" or "Card" or "Wide panel (a glass section)". | An icon | bi-chevron-right |
| Link | Where the link leads: a page on this site, a full https:// address, or #name for a section on the same page. Offered only when Shape is "Button" or "Card" or "Wide panel (a glass section)". |
A link | none |
| Link text | The link text. Offered only when Shape is "Card" or "Wide panel (a glass section)". | Text | Learn more |
| Icons | For the tray and capsule: the icons. Each row has an icon, a name, a link and an optional tile colour. Offered only when Shape is "Icon tray (dock)" or "Icon capsule (switch)". | Each row, in order:
|
5 sample entries |
| Highlighted icon (number) | Which icon sits in the raised bubble, counting from 1. 0 for none. Offered only when Shape is "Icon capsule (switch)". | A whole number (number) | 1 |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Centre |
| Full width | Switches on or off: full width. Offered only when Shape is "Card" or "Wide panel (a glass section)" or "Icon tray (dock)". | On or off | off |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Look | Frosted (blurred), clear (glossy) or liquid (a thick lens). |
|
Frosted |
| Tint | Sets the tint colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Tint strength (%) | How much of the tint colour is in the glass. | A whole number, as a percentage | 18 |
| Blur (px) | Sets the blur, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Roundness (px, empty = the shape's own) | Sets the roundness, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Edge light (%) | The strength of the bright rim that makes the pane read as glass. | A whole number, as a percentage | 45 |
| Shadow | Chooses the shadow. Each value is described under Values. |
|
Soft |
| Text and icon colour | The text and icon colour. Empty keeps the section's text colour. | Any colour | none |
| Badge colour (button) | The colour of the round badge on the button shape. Offered only when Shape is "Button". | Any colour | #111111 |
| Icon size (px) | Sets the icon size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| On hover | Chooses the on hover. Each value is described under Values. |
|
Lift |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Metro EMI Calculator
Blocks panel → Content · add-on key emi
The Metro EMI Calculator add-on lets a visitor estimate a loan: they choose a model (and a region, where prices differ), set a down payment, an interest rate and a term, and see the loan amount, the total interest and the monthly instalment (EMI). Interest may be calculated on a reducing balance, as banks do, or at a flat rate.
- Prices per model and region, with a picture per model.
- Starting values and limits for down payment, rate and term.
- Reducing balance or flat rate, optionally switchable by the visitor.
- Indian, international or spaced number grouping.
- Enquiry, brochure and finance buttons, and a note under the result.
- Quotations or approvals - the result is an estimate.
When to use it
- Vehicle, appliance, property or course-fee pages where buyers pay in instalments.
When to choose another add-on
- Fixed prices without finance → use Pricing / Fee Card.
Procedure
- Add a line per model and region with its price in numbers only, and optionally a picture.
- Leave the region empty on every line if the price is the same everywhere.
- Set the picker labels, currency symbol and number style.
- Set the starting down payment, rate and term and their limits.
- Choose how interest is charged and whether visitors can switch.
- Set the button words and links, and keep a note under the result.
- On the Style tab, choose the layout and colours.
Behaviour on the page
- Every change recalculates immediately in the visitor's browser.
- With no region on any line, the region picker is not shown.
- A brochure link to a PDF downloads the file. An empty link hides its button.
- The picture changes with the chosen model where one is given.
- Keep the note under the result: a calculator that looks like a quotation will be read as one.
- Use the method your lender quotes; the same rate gives a higher EMI when flat.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The price shows as 0. | The price contains a currency symbol or letters. Enter numbers only. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Heading | The heading. | Text | EMI Calculator |
| Prices | One line per model and region: the model, the region (optional), the price in numbers only and an optional picture. | Each row, in order:
|
6 sample entries |
| Model picker label | The model picker label. | Text | Variant |
| Region picker label | The region picker label. | Text | State |
| Price line (before the region) | The words before the price line, for example "Ex-showroom price in". | Text | *Ex-showroom |
| Currency symbol | The currency symbol. | Text | ₹ |
| Number style | How large numbers are grouped. |
|
Indian (1,97,003) |
| Down payment to start with (% of the price) | The starting down payment, as a percentage of the price. | A whole number, as a percentage | 10 |
| Largest down payment allowed (% of the price) | The largest down payment allowed on the slider, as a percentage. | A whole number, as a percentage | 90 |
| Interest rate to start with (% a year) | Sets the interest rate to start with, as a percentage. Leave it empty to use the add-on's default. | A whole number, as a percentage | 9 |
| Lowest rate on the slider | Sets the lowest rate on the slider. Leave it empty to use the add-on's default. | A whole number | 0 |
| Highest rate on the slider | Sets the highest rate on the slider. Leave it empty to use the add-on's default. | A whole number | 24 |
| How interest is charged | Reducing balance (interest on the outstanding amount) or flat rate (interest on the whole loan for the whole term). |
|
Reducing balance - EMI as banks work it out |
| Let visitors switch between reducing balance and flat rate | Lets visitors switch between the two methods. | On or off | off |
| Term to start with (months) | Sets the term to start with (months). Leave it empty to use the add-on's default. | A whole number (months) | 24 |
| Shortest term (months) | Sets the shortest term (months). Leave it empty to use the add-on's default. | A whole number (months) | 6 |
| Longest term (months) | Sets the longest term (months). Leave it empty to use the add-on's default. | A whole number (months) | 84 |
| Main button | The main button's words. | Text | Enquire now |
| ...its link | Where the its link leads: a page on this site, a full https:// address, or #name for a section on the same page. |
A link | #enquire |
| Second link | A second link's words, for example a brochure. | Text | Get brochure |
| ...its link | Where the its link leads: a page on this site, a full https:// address, or #name for a section on the same page. A PDF opens as a download. Empty hides the link. |
A link | none |
| Finance button | A finance button's words. Empty link hides it. | Text | Avail finance |
| ...its link | Where the its link leads: a page on this site, a full https:// address, or #name for a section on the same page. Empty hides the button. |
A link | none |
| Picture on the result | A picture shown with the result when the model has none of its own. | A picture | none |
| Note under the result | Text under the result, such as "Indicative only. Subject to lender approval." | Several lines of text | Figures are indicative. The final amount depends on the lender, fees and insurance. |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Layout | Chooses the layout. Each value is described under Values. |
|
Calculator and result side by side |
| Button and slider colour | Sets the button and slider colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #e11d24 |
| Calculator background | Sets the calculator background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Result background | Sets the result background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Result text colour | Sets the result text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Metro FAB
Blocks panel → Content · add-on key fab
The Metro FAB (floating action buttons) add-on keeps buttons on screen while the page scrolls: a rail of shortcuts on an edge, a round call button in a corner, a speed dial that opens into several actions, or a bar along the bottom of a phone. Each button has an icon, words and a link - a page, a section, a phone number, an email address or a WhatsApp chat.
- Any number of buttons with per-button colours and link targets.
- Rails, pills, round buttons and a speed dial; six looks from solid to neon.
- Eleven positions, labels always, on hover or hidden, three sizes.
- Appearing after scrolling, per-device display, a separate phone behaviour and an entrance.
- A navigation menu - use the Site Header.
When to use it
- Call, WhatsApp and enquiry shortcuts on a service business site.
- A bar of key actions on phones.
When to choose another add-on
- A button in the page → use Button.
- Share buttons that float → use Social Share.
Procedure
- Add a row per button: icon, words, link and, optionally, colours and how it opens.
- Choose the design, look and position.
- Choose how the words show and the size.
- For a speed dial, set the icon and words of the button that opens it.
- Choose when it shows, on which screens, and what happens on a phone.
- On the Style tab, set the colours, the first button's highlight, spacing, distance from the edges and shadow.
Behaviour on the page
- It floats wherever the block sits in the layout, so one FAB in the footer covers the page.
- The buttons form a labelled navigation region for screen readers; hidden words are still read aloud.
- "A bar along the bottom" replaces the chosen design on screens narrower than 768 pixels, with the buttons sharing the width equally.
- Three or four buttons at most.
- Keep the first button for the most important action; it takes the accent colour.
- Raise the stacking order only if another element covers it.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The buttons are hidden behind another element. | Raise Stacking order. |
| A WhatsApp button opens a web page. | Use a https://wa.me/ number link; it opens the app where installed. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Buttons | The buttons. Each row has an icon, words, a link, optional background and text colours and how the link opens. | Each row, in order:
|
3 sample entries |
| Design | The arrangement and shape of the buttons. |
|
Side rail - joined tiles, icon over label |
| Look | The surface treatment of every button. |
|
Solid (regular) |
| Where it sits on the screen | Where on the screen the buttons sit. |
|
Right edge, middle |
| Words on the buttons | Whether the words show always, on hover, or not at all. |
|
none |
| Size | Chooses the size. Each value is described under Values. |
|
Medium |
| Speed dial - the button that opens it | For the speed dial, the icon of the button that opens it. Offered only when Design is "Speed dial - one button opens the others". | An icon | bi-plus-lg |
| Speed dial - its words | For the speed dial, the words of the button that opens it. Offered only when Design is "Speed dial - one button opens the others". | Text | Contact us |
| Name for screen readers | The name of the button group read by screen readers. | Text | Quick actions |
| When it shows | Whether the buttons show from the start or after scrolling. |
|
Always |
| ...after scrolling this far (px) | The scroll distance, in pixels, before they appear. Offered only when When it shows is "After the visitor scrolls down a little". | A whole number, in pixels | 300 |
| Screens it shows on | Which screen sizes show the buttons. |
|
Every screen |
| On a phone | What the buttons become on phones. |
|
The same as on a large screen |
| How it arrives | Chooses the how it arrives. Each value is described under Values. |
|
Slide in from its edge |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #1c1f26 |
| Icon and text colour | Sets the icon and text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| First button - background | The first button's background. Clear it to make all buttons alike. | Any colour | #e11d24 |
| First button - icon and text | Sets the first button - icon and text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Edge colour (outline and neon looks) | Sets the edge colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px, blank = the design's own) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Space between buttons (px, blank = the design's own) | Sets the space between buttons, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Distance from the side of the screen (px) | The distance from the side of the screen. | A whole number, in pixels | none |
| Distance from the top or bottom of the screen (px) | The distance from the top or bottom of the screen. | A whole number, in pixels | none |
| Stacking order (raise it if something covers the buttons) | The stacking order. Raise it if something covers the buttons. | A whole number (raise it if something covers the buttons) | 80 |
| Shadow | Chooses the shadow. Each value is described under Values. |
|
none |
| ...shadow colour (blank = navy) | Sets the shadow colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Shadow is "Subtle" or "Medium" or "Strong" or "Soft: hairline edge" or "Soft: card (iOS style)" or "Soft: floating (macOS window)" or "Soft: raised sheet" or "Soft: deep (dialog)" or "Soft: pressed in". | Any colour | none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Popup
Blocks panel → Content · add-on key popup
The Popup add-on shows a message over the page when a condition you set is met: after a delay, after scrolling a distance, when the visitor appears to be leaving, after inactivity, or when an element is clicked. It is used for offers, newsletter invitations and announcements. How often a visitor sees it is controlled per visit or per number of days, and a popup can be shown on this page only or across the whole site.
- Three purposes: an offer with words and buttons, a picture with text, or a request for a reply.
- Five triggers, three frequency rules, auto-close and close controls.
- Nine positions, six entrances, width, colours, a dimmed and blurred background.
- Showing on every page of the site, with the Metro Popup plugin enabled.
- Cookie consent - use the Cookie Notice, which records the answer.
- A form with custom fields - buttons link to a page or close the popup.
When to use it
- A seasonal offer or sale announcement.
- An invitation to subscribe, shown once the visitor has read some of the page.
- Detail opened from a button, such as terms or a video.
When to choose another add-on
- A notice that stays in the page → use Alert / Notice.
- Cookie consent → use Cookie notice.
- Buttons that stay on screen → use Metro FAB.
Procedure
- Choose the purpose; this only decides which settings are shown.
- Write the eyebrow, heading and body, add an icon or picture, and add buttons. A button with no link closes the popup.
- Choose where it may appear: this page, or the whole site.
- Choose what makes it appear and set its delay, scroll percentage or clicked element.
- Choose how often a visitor sees it.
- On the Style tab, set the position, entrance, width, colours and background dimming.
- Test it in a private browser window, since the frequency rule remembers that you have seen it.
Behaviour on the page
- The popup is moved to the top level of the page when it opens, so it covers everything regardless of which section holds it.
- It opens as a true dialog: the Escape key and the close button close it, and the keyboard stays inside it while it is open.
- The frequency is remembered in the visitor's browser, so a different browser or a private window sees it again.
- Leaving the page is detected by the pointer moving out through the top of the window. Touch screens have no pointer, so there the exit trigger falls back to the inactivity timer, using the delay set (at least five seconds).
- "Everywhere on the site" requires the Metro Popup plugin to be enabled and the page holding the popup to be published.
- Once per visitor per week is sufficient for an offer.
- A popup on arrival, before anything has been read, is closed without being read. Use a delay of at least ten seconds or a scroll trigger.
- Use "Every time" only while building.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The popup never appears. | The frequency rule has recorded that you have seen it. Open the page in a private window, or set How often to "Every time" while testing. |
| The click trigger does nothing. | Clicked thing is empty or does not match any element. Give the button a class under its Advanced tab and enter it here, for example .open-offer. |
| The site-wide popup appears only on its own page. | Enable the Metro Popup plugin and publish the page that holds the popup. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| What this popup is for | Which settings are shown: those for an offer, a picture, or a reply. Changing it deletes nothing. |
|
An offer or announcement - words and buttons |
| Icon above the heading | The icon above the heading, chosen in the icon picker from the built-in icon set. Offered only when What this popup is for is "An offer or announcement - words and buttons" or "Ask the visitor for a reply". | An icon | none |
| Small line above | The small line above. Offered only when What this popup is for is "An offer or announcement - words and buttons" or "Ask the visitor for a reply". | Text | none |
| Heading | The heading. | Text | Before you go |
| Body | The body. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | One line that says what they get, and why it is worth the interruption. |
| Picture | The picture used for the picture. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Picture width (%) | The picture's width as a percentage of the popup. Offered only when What this popup is for is "A picture, with a little text". | A whole number, as a percentage | 100 |
| Buttons | The buttons. Each row has words, a link (empty closes the popup) and a style. Offered only when What this popup is for is "An offer or announcement - words and buttons" or "A picture, with a little text". | Each row, in order:
|
none |
| Where it may appear | Whether the popup shows only on this page or on every page of the site. |
|
Only on this page |
| What makes it appear | The condition that opens the popup. |
|
When the page opens, after a delay |
| Delay (seconds) | Seconds to wait before opening, for the page-opens and inactivity triggers. | A whole number, in seconds | 5 |
| Scrolled this far down (%) | The percentage of the page scrolled before it opens, for the scroll trigger. | A whole number, as a percentage | 50 |
| Clicked thing (CSS selector) | A CSS selector, such as .my-button or #offer. Clicking any matching element opens the popup. |
Text | none |
| How often | How often the same visitor sees it. |
|
Once per visit |
| ...not again for this many days | The number of days before it is shown again, for "Once, then not again for a while". | A whole number | 7 |
| Show a close button | Switches on or off: show a close button. | On or off | on |
| Clicking outside closes it | Closes the popup when the visitor clicks the dimmed area outside it. | On or off | on |
| Close by itself after (seconds, 0 = never) | Closes the popup after this many seconds. 0 leaves it open. | A whole number, in seconds | 0 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Where it sits | Where on the screen the popup sits. |
|
Centred |
| How it arrives | Chooses the how it arrives. Each value is described under Values. |
|
Rise from below |
| Width (px) | Sets the width, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 480 |
| Text alignment | Chooses the text alignment. Each value is described under Values. |
|
Left |
| Background | Sets the background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Accent - the icon and the eyebrow | Sets the accent - the icon and the eyebrow colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Icon size (px) | Sets the icon size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 34 |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
| Padding (px) | Sets the padding, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 32 |
| Drop shadow | Switches on or off: drop shadow. | On or off | on |
| Dim behind it (%) | How much the page behind is dimmed, as a percentage. | A whole number, as a percentage | 55 |
| Dim colour | Sets the dim colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Blur behind it (px) | How much the page behind is blurred, in pixels. | A whole number, in pixels | 0 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Price List
Blocks panel → Content · add-on key price_list
The Price List add-on presents many items with a price each, as a clean list: a treatment menu, a rate card, services and fees. Each item has a name, a description, a price, an optional badge and an optional thumbnail, and a dotted leader can join the name to the price as in a printed menu.
- Any number of items in one or two columns, with badges, thumbnails, leaders and dividing lines.
- Courses, dietary marks and two sizes per item - use the Restaurant Menu.
- Plans with feature lists - use Pricing.
When to use it
- Salon and spa treatments, repair charges, tuition fees, hire rates.
When to choose another add-on
- A restaurant or cafe menu → use Restaurant Menu.
- Two to four plans compared → use Pricing / Fee Card.
- A table with several prices per row → use Table.
Procedure
- Add a row per item: name, description, price and, optionally, a badge such as "New" and a thumbnail.
- Choose one or two columns, whether the dotted leader and thumbnails show, and the row spacing.
- On the Style tab, set the colours and whether a line separates the rows.
Behaviour on the page
- Two columns become one on phones.
- The price is written exactly as typed, so any currency and format may be used.
- Write prices consistently: all with the currency symbol, or none.
- Use badges on one or two items at most.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Items | The items. Each row has a name, a description, a price, an optional badge and an optional thumbnail. | Each row, in order:
|
none |
| Columns (desktop) | Chooses the columns. Each value is described under Values. |
|
1 |
| Dotted leader between name and price | Draws a dotted line from each item's name to its price. | On or off | on |
| Show thumbnails | Switches on or off: show thumbnails. | On or off | off |
| Row spacing (px) | Sets the row spacing, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Item colour | Sets the item colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Price colour | Sets the price colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Description colour | Sets the description colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Badge background | Sets the badge background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Line between rows | Draws a line between rows. | On or off | off |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Pricing / Fee Card
Blocks panel → Content · add-on key pricing
The Pricing add-on presents one plan or fee as a card: its name, price, period, a list of what is included and a button. It supports a special price shown beside the struck-through original, a saving note that calculates the percentage, a highlighted state for the recommended plan, and a badge in five styles.
- Plan name, price, period, features and a button.
- An original price struck through in one of four styles, and an automatically calculated saving.
- A highlighted card and a badge (eleven presets or your own wording) in five styles.
- Taking payment - the button links wherever you choose.
- Many items with two numbers each - use the Price List.
When to use it
- Two to four plans side by side, with the recommended one highlighted.
- A course or membership fee with an offer price.
When to choose another add-on
- A menu, a rate card or a treatment list → use Price List.
- A detailed comparison across many features → use Table.
Procedure
- Enter the plan name, the price and the period (for example "per month").
- List the features, one per line.
- Set the button words and link.
- For an offer, enter the original price; it is shown struck through. Optionally write a saving note such as "Save {percent}" - the percentage is calculated from the two prices.
- Tick Highlight this card for the recommended plan and choose a badge.
- Place the cards in equal columns of one row.
Behaviour on the page
- The struck-through original price is announced as the original price to screen readers.
- The saving percentage is calculated from the first number in each price, whatever currency symbol or wording surrounds it, for example "$19.99 / mo".
- If either price cannot be read, or the price is not lower than the original, the saving note is left out rather than shown with a wrong or empty figure.
- Three cards with the middle one highlighted is the arrangement read fastest.
- Use one badge per row; several badges cancel each other out.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The saving note does not appear. | Either price contains no number, or the price is not lower than the original price. Both need a figure, and the original must be the higher. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Plan name | The plan name. | Text | Primary |
| Price | The price. | Text | ₹24,000 |
| Original price, shown struck out (optional) | The original price, shown struck through beside the price. Fill it in only for an offer. | Text | none |
| Saving note (optional) | A note under the prices. {percent} is replaced by the saving calculated from the two prices. |
Text | none |
| Period | The period. | Text | per year |
| Features — one per line | The features — one per line. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | Classes I to V All textbooks included Transport optional |
| Button link | Where the button link leads: a page on this site, a full https:// address, or #name for a section on the same page. |
A link | none |
| Button text | The button text. | Text | Enquire |
| Highlight this card | Draws the card as the recommended plan: raised, with the accent colour. | On or off | off |
| Badge | A label on the card. Choose "My own wording" to write your own. |
|
none |
| Badge wording (blank = the preset's own) | Replaces the preset badge's words. Leave it empty to use the preset's. | Text | none |
| Accent colour | Sets the accent colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Badge style | Where and how the badge is drawn on the card. |
|
Pill above the plan name |
| Badge colour (blank = the preset's) | Sets the badge colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Badge text colour (blank = the preset's) | Sets the badge text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Strike-through style | The line drawn through the original price. |
|
Single line |
| Strike-through colour (blank = the price's own) | Sets the strike-through colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Saving note colour | Sets the saving note colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Saving note text colour | Sets the saving note text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Progress Bar
Blocks panel → Content · add-on key progress
The Progress Bar add-on shows labelled horizontal bars that fill to a percentage as they scroll into view. It is the simple form of Progress Bar Pro.
- Bars typed one per line as
Label | Percent, in one colour, with or without the percentage.
- Rings, arcs, shapes, patterns or per-bar colours - use Progress Bar Pro.
When to use it
- Progress towards a target, capacity, or a set of proportions.
When to choose another add-on
- Rings, arcs, shapes or a different colour per bar → use Progress Bar Pro.
- Large headline numbers → use Block Number.
Procedure
- Write one bar per line: the label, a vertical bar, then the percentage.
- Set the bar colour and whether the percentage shows.
Behaviour on the page
- Bars fill when they scroll into view; with reduced motion they appear full at once.
- Each bar is announced as a progress bar with its value.
- Use bars for real measurements. Invented skill percentages undermine credibility.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Bars — one per line: Label | Percent | The bars, one per line as Label | Percent. |
Several lines of text | Board results | 98 Attendance | 94 Parent satisfaction | 91 |
| Bar colour | Sets the bar colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Show percentage | Shows the percentage at the end of each bar. | On or off | on |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Progress Bar Pro
Blocks panel → Content · add-on key progress_pro
The Progress Bar Pro add-on shows percentages as shapes: bars, vertical bars, circles, arcs and gauges, waves, spirals, and outlines such as hearts, stars and hexagons. Fills can be solid, gradients, stripes or patterns, and a continuous sweep is available for activity with no percentage.
- Any number of bars, each with its own colour and a note.
- Over twenty shapes, side by side or stacked, one to six across.
- Eight fill styles, including a tiled image, with optional moving patterns.
- A fill animation on scroll, and a never-ending sweep.
- Live data - percentages are typed in.
When to use it
- Fund-raising or capacity figures as rings or gauges.
- A decorative loading or activity indicator.
When to choose another add-on
- Simple horizontal bars → use Progress Bar.
- Large numbers → use Block Number.
- A goal with donation links → use Support Box.
Procedure
- Add a row per bar: label, percentage, optional colour and a small note.
- Choose the shape, the arrangement and how many across.
- Choose where the label sits and whether the percentage shows.
- Choose whether it fills on scroll, or sweeps continuously.
- On the Style tab, set the thickness, size, ends, fill style, colours and the track.
Behaviour on the page
- Shapes are drawn as vector graphics and stay sharp at any size.
- Each shape is read to screen readers as its label and percentage, for example "Funded: 72%".
- Moving patterns and sweeps stop for visitors who ask for reduced motion.
- Use the same shape for every bar in a set.
- Reserve the continuous sweep for genuine activity; as decoration it is distracting.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Bars | The bars. Each row has a label, a percentage from 0 to 100, an optional fill colour and a small note under the label. | Each row, in order:
|
none |
| Shape | The shape the percentage is drawn as. |
|
Horizontal bar |
| Arrangement | Chooses the arrangement. Each value is described under Values. |
|
Side by side |
| Across — desktop | Chooses the across — desktop. Each value is described under Values. |
|
3 |
| Where the label goes | Where the label sits relative to the shape. |
|
In the middle of the shape |
| Show the percentage | Switches on or off: show the percentage. | On or off | on |
| Fill it as it scrolls into view | Switches on or off: fill it as it scrolls into view. | On or off | on |
| Never-ending sweep, with no percentage | Replaces the percentage with a continuous sweep, for activity with no measurable progress. | On or off | off |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Arc sweep (degrees, 30-360) | For arcs and gauges, the angle the shape spans, from 30 to 360 degrees. | A whole number, in degrees | 240 |
| Waves — or turns, for a spiral | For wave shapes, the number of waves; for the spiral, the number of turns. |
|
4 |
| Wave height (2-45) | For wave shapes, the height of each wave. | A whole number (2-45) | 22 |
| Thickness | Sets the thickness. Leave it empty to use the add-on's default. | A whole number | 10 |
| Ends | The shape of the ends of the line. |
|
Rounded ends |
| Size (px) | Sets the size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 180 |
| What the fill is made of | What the filled part is made of. |
|
Solid colour |
| Fill colour | Sets the fill colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Second colour (gradient, stripes, behind a pattern) | The second colour of a gradient or stripes, or the colour behind a pattern. | Any colour | none |
| Pattern size | Sets the pattern size. Leave it empty to use the add-on's default. | A whole number | 16 |
| Stripe angle (degrees) | Sets the stripe angle, in degrees. Leave it empty to use the add-on's default. | A whole number, in degrees | 45 |
| Image to tile (for the image fill) | The picture used for the image to tile. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Keep the pattern moving | Keeps stripes and patterns moving along the fill. | On or off | off |
| Track colour | The colour of the unfilled part. | Any colour | none |
| Track opacity (%) | Sets the track opacity, as a percentage. Leave it empty to use the add-on's default. | A whole number, as a percentage | 18 |
| Fill the shape in as well as tracing it | For outline shapes such as the heart, fills the inside as well as tracing the outline. | On or off | off |
| Shape fill opacity (%) | Sets the shape fill opacity, as a percentage. Leave it empty to use the add-on's default. | A whole number, as a percentage | 14 |
| Percentage size (px) | Sets the percentage size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 26 |
| Label colour | Sets the label colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Gap between bars (px) | Sets the gap between bars, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 28 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Restaurant Menu
Blocks panel → Content · add-on key menu_card
The Restaurant Menu add-on presents a restaurant, cafe or bar menu: dishes with descriptions, one or two prices with size labels, a picture, dietary marks and a chef's pick flag, divided into courses. Five layouts range from a plain printed-menu style with leader dots to a picture-led grid.
- Dishes, course headings (a line with no prices), two sizes, dietary marks (v, vg, gf, hot, new) and a chef's pick.
- Five layouts, picture sizes and shapes, hover effects and an arrival animation.
- An order or enquiry button on every dish.
- Online ordering or a basket.
When to use it
- A restaurant or cafe menu page.
- A featured dishes section on a home page.
When to choose another add-on
- A treatment or service price list → use Price List.
Procedure
- Add a row per dish. To start a course, add a row with a name and no prices.
- For two sizes, fill in both prices and size labels.
- Add dietary marks, separated by commas, and mark the chef's pick.
- Choose the layout, currency symbol and, optionally, a button on every dish.
- On the Style tab, set picture size and shape, hover effect and colours.
Behaviour on the page
- Dietary marks are shown as short labels (V, VG, GF and so on); pointing at one shows its full meaning.
- A dish with its own link sends its button there; otherwise the button uses the shared link.
- Keep descriptions to the main ingredients.
- Mark one chef's pick per course at most.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| A dish is shown as a course heading. | Its price fields are empty. Enter a price. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Dishes (leave every price empty to start a new course) | The dishes. A row with every price empty becomes a course heading. | Each row, in order:
|
none |
| Layout | How dishes are arranged, and whether pictures are shown. |
|
One column, picture on the left |
| Heading | The heading. | Text | none |
| Sub-heading | The sub-heading. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| Currency symbol | The symbol written before every price. | Text | none |
| Button on every dish (blank = no button) | Words of a button shown on every dish. Leave empty for no button. | Text | none |
| Where the button goes when a dish has no link of its own | Where the button goes for dishes without a link of their own. | Text | none |
| Wording of the chef's pick flag | The wording of the chef's pick flag. | Text | Chef's pick |
| Dishes arrive by | How dishes appear as they scroll into view. |
|
Already there |
| Delay between dishes arriving (ms) | Sets the delay between dishes arriving, in milliseconds. Leave it empty to use the add-on's default. | A whole number, in milliseconds | 70 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Picture size | Chooses the picture size. Each value is described under Values. |
|
Medium - 96px |
| Picture shape | Chooses the picture shape. Each value is described under Values. |
|
Rounded |
| On hover | Chooses the on hover. Each value is described under Values. |
|
Lift |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 22 |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
| Dish background | Sets the dish background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Dish name colour | Sets the dish name colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Description colour | Sets the description colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Price colour | Sets the price colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Accent (courses, flags, buttons) | Sets the accent colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Leader dots and rules | The colour of leader dots and course rules. | Any colour | none |
| Dish name size (px) | Sets the dish name size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 19 |
| Price size (px) | Sets the price size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Search
Blocks panel → Content · add-on key search
The Search add-on places a search box for your site. It can be a bar, a large hero band with a heading and suggested searches, a compact field with an icon, or a button that opens the search in a dialog. It searches Joomla Smart Search, Joomla basic search, or the Adhrit LMS course catalogue, and detects which is available.
- Four layouts, with placeholder, button, icons and suggestions.
- Collapsing to an icon that opens a dialog on phones.
- Full control of the field, button and dialog colours and sizes.
- Indexing content - the site's Smart Search index must be built in Joomla.
- Showing results on the same page - results open in the search component.
When to use it
- A help centre or knowledge base hero: "How can we help?".
- A search field in the header.
- A course search on an education site.
When to choose another add-on
- A single question answered in the page → use Accordion / FAQ.
Procedure
- Choose what to search; "Detect automatically" uses Smart Search if it is enabled.
- Choose the layout. For the hero layout, write the heading and sub-heading.
- Write the placeholder, the button words and an accessible label.
- Add suggested searches, one per line.
- Choose the field and button icons and where the button sits.
- On the Style tab, set the width, the phone behaviour and the colours.
Behaviour on the page
- Suggested searches are shown as links under the field; each runs that search.
- Below the collapse width, the icon-only phone option replaces the field with an icon that opens a full-screen dialog.
- The accessible label is read by screen readers even when no visible label is shown.
- The suggestions make a search band useful: list the three things visitors look for most.
- In a header, use the compact or modal layout; the bar and hero layouts are for page content.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Searches return nothing. | Smart Search has no index. In Joomla, open Smart Search and choose Index, or choose "Joomla basic search". |
| The dialog text is unreadable. | Set the modal panel background and text colours; the dialog does not inherit the header's colours. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Search | Which search engine runs the search. "Detect automatically" prefers Smart Search. |
|
Detect automatically |
| Layout | Chooses the layout. Each value is described under Values. |
|
Search bar |
| Heading (hero layout) | The heading. | Text | none |
| Sub-heading (hero layout) | The sub-heading. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| Placeholder text | The placeholder text. | Text | Search… |
| Button text | The button text. | Text | Search |
| Suggested searches, one per line | Searches shown under the field as links, one per line. | Several lines of text | none |
| Accessible label for the input | The field's name for screen readers. | Text | Search this site |
| Show an icon in the field | Switches on or off: show an icon in the field. | On or off | on |
| Field icon | The field icon, chosen in the icon picker from the built-in icon set. Offered only when Show an icon in the field is "1" or "true" or "". | An icon | bi-search |
| Field icon sits | Chooses the field icon sits. Each value is described under Values. Offered only when Show an icon in the field is "1" or "true" or "". |
|
At the start |
| Button shows | Whether the button shows words, an icon, both, or is omitted (Enter still searches). |
|
Text only |
| Button icon | The button icon, chosen in the icon picker from the built-in icon set. Offered only when Button shows is "Icon only" or "Icon and text". | An icon | bi-search |
| Button icon sits | Chooses the button icon sits. Each value is described under Values. Offered only when Button shows is "Icon and text". |
|
Before the text |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Center |
| Largest width (px, 0 = full) | Sets the largest width, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 620 |
| On a phone | Whether the field stays a bar on phones or collapses to an icon that opens a dialog. |
|
Stay a full-width bar |
| Collapse below (px) | The screen width, in pixels, below which the field collapses. | A whole number, in pixels | 782 |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 999 |
| Field background | Sets the field background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Field text colour | Sets the field text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Modal panel background | Sets the modal panel background colour. Leave it empty to use the colour the section or the site template already gives. The panel behind the field when the search opens as a modal. Blank gives a light panel, because it sits over a dark scrim rather than on the header the field lives on. | Any colour | none |
| Modal panel text colour | Sets the modal panel text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Field border colour | Sets the field border colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button placement | Where the button sits relative to the field. |
|
After the field |
| Button alignment (below the field) | The button's alignment when placed below the field. Offered only when Button placement is "Below the field". |
|
Centre |
| Field height (px, 0 = automatic) | Sets the field height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Text size in the field (px) | Sets the text size in the field, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Space between field and button (px) | Sets the space between field and button, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 8 |
| Button size | Chooses the button size. Each value is described under Values. |
|
Medium |
| Button padding, top and bottom (px, blank = by size) | Sets the button padding, top and bottom, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Button padding, left and right (px, blank = by size) | Sets the button padding, left and right, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Button corner radius (px, blank = same as field) | Sets the button corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Field icon colour | Sets the field icon colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Field icon size (px, blank = automatic) | Sets the field icon size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Social Icons
Blocks panel → Content · add-on key social_icons
The Social Icons add-on links to your profiles on social networks, and to email, phone and a website, as a row of icons. Each profile is written as the network and your handle, number or address; the add-on builds the correct link.
- Facebook, Instagram, X, LinkedIn, YouTube, WhatsApp, email, phone and website.
- Plain icons, circles or rounded squares; brand colours, one colour, or grey turning to brand colour on hover.
- Sharing the current page - use Social Share.
When to use it
- A footer or contact section linking to your profiles.
When to choose another add-on
- Buttons that share this page → use Social Share.
- Contact details with text → use Icon List.
Procedure
- Add a row per profile: the network and your handle, email address, phone number or full address.
- Choose the alignment and the shape.
- On the Style tab, choose between brand colours and your own, and set the size and gap.
Behaviour on the page
- A handle is turned into the network's profile address; a full address is used as given.
- An email opens the visitor's mail program, a phone number dials on phones, and WhatsApp opens a chat.
- Each icon is announced by its network name to screen readers.
- List only the profiles you keep up to date.
- "Grey, turning brand colour on hover" keeps a footer calm while still identifying each network.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| An icon links to the wrong page. | Write only the handle (without @) or the complete address beginning with https://. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Profiles | The profiles. Each row has the network and your handle, email address, phone number or full web address. | Each row, in order:
|
none |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Left |
| Shape | Whether each icon stands alone or sits on a circle or rounded square. |
|
Icon only |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Icon size (px) | Sets the icon size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 20 |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 10 |
| Use each network's own colour | Whether each icon takes its network's own colour, the icon colour set below, or grey until the pointer is over it. |
|
none |
| Icon colour | Sets the icon colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Background | Sets the background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Hover colour | Sets the hover colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Social Share
Blocks panel → Content · add-on key social_share
The Social Share add-on gives visitors buttons to share the current page on social networks, by email, by the device's own share sheet, by printing or by copying the link. It can sit in the page, float at a screen edge, stick under the top of the window, or run as a bar along the bottom of a phone.
- Thirteen targets, in the order you set, including the device's share sheet and copy link.
- Five placements, four shapes and four colourings.
- Sharing a different address or text from the current page.
- Share counts.
- Links to your own profiles - use Social Icons.
When to use it
- Articles, events and offers that visitors are likely to pass on.
When to choose another add-on
- Links to your profiles → use Social Icons.
Procedure
- Add a row per network in the order they should appear.
- Optionally write a small heading, and an address or text to share instead of the current page.
- On the Style tab, choose the placement, shape and colouring, and the sizes.
Behaviour on the page
- With the address and text empty, the current page's address and title are shared.
- "native" opens the device's own share sheet where the browser supports it, and is hidden where it does not.
- "copy" copies the address and confirms it on the button.
- Share links open in a small window; no network scripts are loaded, so nothing tracks visitors.
- Three or four networks your audience uses is better than all thirteen.
- On phones, "native" alone covers every app the visitor has installed.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Networks, in order | The share buttons, in order. Each row names one network. | Each row, in order:
|
none |
| Small heading above the row | The small heading above the row. | Text | none |
| Share this address instead of the current page | An address to share instead of the current page. | Text | none |
| Share this text instead of the page title | Text to share instead of the page title. | Text | none |
| Show the network name beside the icon | Switches on or off: show the network name beside the icon. | On or off | off |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Where it sits | Whether the buttons sit in the page, float at an edge, stick at the top, or form a bar along the bottom. |
|
In the page, where the block is |
| Shape | Chooses the shape. Each value is described under Values. |
|
Circle |
| Colouring | How the buttons are coloured. |
|
Each network in its own brand colour |
| Stack them vertically | Switches on or off: stack them vertically. | On or off | off |
| Alignment (when in the page) | Chooses the alignment. Each value is described under Values. |
|
Left |
| Icon size (px) | Sets the icon size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
| Button size (px) | Sets the button size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 42 |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 10 |
| Corner radius (px, square shape) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 12 |
| The one colour (match / outlined / mono) | The colour used by the match, outline and mono colourings. | Any colour | none |
| Icon colour | Sets the icon colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Distance from the edge (px, floating) | For floating placements, the distance from the screen edge. | A whole number, in pixels | 18 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Special Heading
Blocks panel → Content · add-on key special_heading
The Special Heading add-on sets text with a typographic effect: 3D sugar letters, a sliced split, vertical writing, a multi-colour gradient, a retro layered shadow, neon, text around a circle, a picture inside the letters, an outline echo, a peeled sticker, bouncing letters or a neon tube. It can be a heading in the outline, or large ghost text behind a section.
- Twelve effects, each with up to four colours and a depth.
- A heading level or a paragraph, or ghost text placed behind the section.
- An optional animation per effect and a separate size on phones.
- Long headings - effects are designed for a few words.
When to use it
- A campaign or event title that must be memorable.
- A single statement in a hero.
When to choose another add-on
- A standard heading → use Heading.
- Large faded text behind a section → use Ghost Word.
- Rotating words → use Animated Heading.
Procedure
- Type the text and choose the effect.
- Choose whether it is shown as a heading or behind the section, and the level.
- For the picture effect, choose the picture; for the circle effect, the icon and circle size; for vertical writing, whether letters stand upright.
- On the Style tab, set up to four colours, the depth and the gradient angle, and the typography.
- Set a size for phones; the text scales between that and the desktop size.
Behaviour on the page
- The text remains real text, read by search engines and screen readers.
- Animations stop for visitors who ask for reduced motion.
- Behind the section, it is decorative and hidden from screen readers.
- One special heading per page is a statement; three is noise.
- Glowing effects need a dark background.
- For the picture effect, use a heavy typeface so more of the picture shows.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The effect looks flat. | The colours are too close together, or the depth is 1. Increase the contrast or depth. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Text | The text. | Text | Make it special |
| Effect | The typographic effect. |
|
Multi-colour gradient |
| Show | Whether the text is a heading in the page, or large ghost text behind the section. |
|
As a heading |
| Level | Chooses the level. Each value is described under Values. Offered only when Show is "As a heading". |
|
H2 |
| Text alignment | Chooses the text alignment. Each value is described under Values. Offered only when Show is "As a heading". |
|
Centre |
| Where it sits | Where ghost text sits in the section. Offered only when Show is "Behind the section (like Ghost Word)". |
|
Centred |
| Strength behind the section (%) | How strongly ghost text shows, as a percentage. Offered only when Show is "Behind the section (like Ghost Word)". | A whole number, as a percentage | 18 |
| Picture inside the letters | The picture shown inside the letters, for that effect. Offered only when Effect is "Picture inside the letters". | A picture | none |
| Icon in the middle | The icon in the middle, for the circle effect. Offered only when Effect is "Text in a circle". | An icon | bi-star-fill |
| Circle size (px across) | The diameter of the circle, for the circle effect. Offered only when Effect is "Text in a circle". | A whole number, in pixels | 220 |
| Letters upright | For vertical writing: stacks upright letters instead of turning the line on its side. Offered only when Effect is "Vertical (writing mode)". | On or off | off |
| Animate | Adds the effect's own motion, where it has one. | On or off | off |
| Size (px, phone) | The size on phones, in pixels. The desktop size is the font size on the Style tab. | A whole number, in pixels | 38 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Colour 1 | The first effect colour. Each effect uses the four colours differently; the help beside the field in the builder describes each. | Any colour | none |
| Colour 2 | Sets the colour 2 colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Colour 3 | Sets the colour 3 colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Colour 4 | Sets the colour 4 colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Depth (1-5) | How far 3D sides, shadows, echoes and glows reach, from 1 to 5. | A whole number (1-5) | 3 |
| Gradient angle (degrees) | The direction of the gradient, in degrees. Offered only when Effect is "Multi-colour gradient". | A whole number, in degrees | 90 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Stacking Cards
Blocks panel → Content · add-on key stack_cards
The Stacking Cards add-on tells a short story in steps: each card pins near the top of the window as the page scrolls, and the next card slides up over it, leaving the earlier titles visible above. It turns three to five steps - a method, a set of values, a programme - into a sequence that is read in order.
- Cards with a title, text, icon, picture, link and per-card colours.
- A step-down offset, a top distance, the scroll between cards, a numbered or icon counter, and the picture's position.
- Many cards - beyond five or six the effect becomes tedious to scroll through.
When to use it
- A method in three to five steps.
- Values, principles or programme stages given equal weight.
When to choose another add-on
- A longer sequence → use Timeline.
- Parallel items side by side → use Feature Box.
Procedure
- Add a row per card: title, text, icon, optional picture and link, and optional per-card colours.
- On the Style tab, set Distance from the top to the height of a sticky header, so cards do not settle beneath it.
- Set the step-down per card and the scroll distance between cards.
- Choose the counter beside each title and where the picture sits.
Behaviour on the page
- Each card sticks as it reaches the top distance; the next card rises over it.
- The effect uses the browser's own sticky positioning, so it needs no script and stays smooth.
- On phones, and for visitors who ask their device for reduced motion, the cards do not stack: they are laid out one after another as ordinary cards, with the picture and text in a single column.
- Keep the shadow on; it is what makes the stack read as depth.
- Give alternate cards slightly different backgrounds so each step is distinct.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Cards scroll away instead of stacking. | A parent section has overflow hidden, which disables sticky positioning. Remove it from the section's advanced settings. |
| The first card disappears under the header. | Raise Distance from the top to the header's height. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Cards | The cards. Each row has a title, body text, an icon, an optional picture, link and link words, and optional background and text colours for that card. | Each row, in order:
|
none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Step down per card (px) | How far below the previous card each card settles, so earlier titles stay visible. 0 stacks them exactly. | A whole number, in pixels | 28 |
| Distance from the top (px) | The distance from the top of the window at which cards stick. Leave room for a sticky header. | A whole number, in pixels | 90 |
| Scroll between cards (px) | The scrolling distance between one card settling and the next, in pixels. | A whole number, in pixels | 90 |
| Card background | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Card text | Sets the card text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Accent | Sets the accent colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
| Padding (px) | Sets the padding, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 40 |
| Hairline border | Switches on or off: hairline border. | On or off | on |
| Shadow under each card | Switches on or off: shadow under each card. What makes the stack read as depth rather than as cards that happen to be touching. | On or off | on |
| Beside each title | What appears beside each title: a number, a padded number (01, 02), the card's icon, or nothing. |
|
A padded number - 01, 02 |
| Picture sits | Where each card's picture sits, or whether it is shown at all. |
|
Right of the text |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Support Box
Blocks panel → Content · add-on key support_box
The Support Box add-on is a request for support: a heading, a sentence, buttons to the platforms where visitors can give, and an optional goal bar showing how far a target has been reached.
- Buttons for Ko-fi, Patreon, Buy Me a Coffee, PayPal, GitHub, UPI, merchandise, YouTube, Twitch or your own link, with small print; a goal bar; three layouts.
- Taking payment or reading totals from a platform - the figures are typed in.
When to use it
- A creator, charity or open-source project asking for support.
When to choose another add-on
- A single call to action → use Button.
- A fee or plan → use Pricing / Fee Card.
Procedure
- Write the heading and the request.
- Add a row per platform with button words, link and small print.
- For a goal bar, tick it and fill in what the goal is for, the amount raised, the target and the currency symbol.
- On the Style tab, choose the layout and colours.
Behaviour on the page
- The goal bar fills to the raised amount as a percentage of the target.
- Update the raised amount regularly; a goal bar that never moves discourages giving.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Heading | The heading. | Text | Support the channel |
| The ask | The request itself, in a sentence or two. | Several lines of text | Everything here is free. If it is worth something to you, this is where that goes. |
| Where to send them | The places to send visitors. Each row has the platform, the button words, the link and small print under it. | Each row, in order:
|
none |
| Show a goal bar | Shows a bar of progress towards a target. | On or off | off |
| What the goal is for | The what the goal is for. | Text | New microphone |
| Raised so far | The amount raised so far, typed by you. | A whole number | 0 |
| Target | The target amount, typed by you. | A whole number | 0 |
| Currency symbol | The currency symbol. | Text | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Layout | A panel with stacked buttons, a row of buttons, or a card per platform. |
|
A panel, buttons stacked |
| Accent colour | Sets the accent colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Panel background | Sets the panel background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 20 |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 12 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Table
Blocks panel → Content · add-on key table
The Table add-on presents real tabular data - timetables, fee schedules, product comparisons - with heading rows and columns, highlights, and a choice of behaviour on phones: scroll sideways with the headings frozen, or turn each row into a stacked card. The rows are typed one per line with cells separated by a vertical bar, so a spreadsheet can be pasted in.
- A heading row and a heading column; highlighted rows and columns; a caption.
- Frozen headings and a frozen column while scrolling.
- Thirty design presets - coloured headings, gradients, a dark table, a ledger, a terminal, glass, rows as cards or pills, pricing, a timetable, an invoice, a league table and more.
- Four stylings, three line options, stripes, hover, per-area colours, column widths and pictures in cells.
- Sorting or filtering.
- Data read from a database - the table is typed in.
When to use it
- Timetables, fee structures, opening hours, specifications, plan comparisons.
When to choose another add-on
- A simple list of items and prices → use Price List.
- Plans as cards → use Pricing / Fee Card.
Procedure
- Type or paste the rows, one per line, cells separated by
|. - Tick whether the first line is the heading row and the first column holds headings.
- Enter rows or columns to highlight by number, and a caption.
- Choose the phone behaviour. For scrolling, freeze the heading row and, if useful, a column.
- On the Style tab, choose the styling and lines, then set colours, widths and padding.
Behaviour on the page
- "Turn each row into a card" labels every cell with its column heading, so it requires a heading row.
- The caption is announced as the table's title by screen readers.
- "Your template's own table styling" leaves the table to the template's CSS.
- On a wide table, freeze the heading row and the first column; it is the difference between a table that can be read on a phone and one that cannot.
- Highlight the recommended plan's column rather than colouring its cells individually.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Cells shift into the wrong column. | A row has more or fewer | separators than the others. Leave empty cells as | |. |
| Heading colours do not apply. | The Hairlines and template stylings leave headings unpainted. Tick Use the heading colours below with this styling too. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Rows — one per line, cells separated by | | The table content: one row per line, cells separated by a vertical bar. | Several lines of text | Item | Qty | Price Exercise book | 12 | £4.20 Geometry set | 1 | £6.50 |
| First CSV line is the top heading row | Treats the first line as the heading row. | On or off | on |
| First CSV column uses heading cells | Treats the first cell of each row as a heading. | On or off | off |
| Caption | The caption. | Text | none |
| Rows to highlight (numbers, e.g. 2,5) | Row numbers to highlight, separated by commas. The heading row is not counted. | Text | none |
| Columns to highlight (numbers, e.g. 2,3) | Column numbers to highlight, separated by commas. | Text | none |
| On a phone | What happens on narrow screens. |
|
Keep its shape and scroll sideways |
| Keep the top heading row visible while scrolling | Keeps the heading row in view while the page scrolls. | On or off | off |
| Keep one column visible while scrolling | Keeps one column in view while the table scrolls sideways. | On or off | off |
| Column to keep visible (1 = first column) | Which column to keep in view; 1 is the first. | A whole number (1 = first column) | 1 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Design preset | A finished design to start from: thirty, from clean hairlines to rows as cards, a ledger, a terminal, neon and a league table. Colours set below still win over it; while a preset is in use the styling choice is set aside. |
|
none |
| Styling | The overall styling. |
|
Metro styling |
| Lines | Chooses the lines. Each value is described under Values. |
|
Lines between rows |
| Shade alternate rows | Switches on or off: shade alternate rows. | On or off | on |
| Apply alternating-row colour inside highlighted columns | Applies the alternating-row shading inside highlighted columns as well. | On or off | off |
| Highlight the row under the pointer | Switches on or off: highlight the row under the pointer. | On or off | on |
| Use the heading colours below with this styling too | Applies the heading colours below with the Hairlines and template stylings. Offered only when Styling is "Hairlines only" or "Your template’s own table styling". | On or off | off |
| Top heading row - background | Sets the top heading row - background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Top heading row - text (blank inherits) | Sets the top heading row - text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| First heading column - background | Sets the first heading column - background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| First heading column - text (blank inherits) | Sets the first heading column - text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| All body cells - text (blank inherits) | Sets the all body cells - text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| All body cells - background (blank is transparent) | Sets the all body cells - background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Frozen column - background | Sets the frozen column - background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Frozen column - text (blank uses body text) | Sets the frozen column - text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Alternating body rows - background | Sets the alternating body rows - background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Pointer-hovered body row - background | Sets the pointer-hovered body row - background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Selected body rows - background | Sets the selected body rows - background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Selected columns - background | Sets the selected columns - background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Grid and row lines - colour | Sets the grid and row lines - colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Column widths (e.g. 40%,20%,auto) | Column widths, separated by commas, for example 40%,20%,auto. |
Text | none |
| Least row height (px) | Sets the least row height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Cell padding (px) | Sets the cell padding, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 12 |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 12 |
| Cell alignment | Chooses the cell alignment. Each value is described under Values. |
|
Left |
| Height of pictures in cells (px) | The height of pictures placed in cells with the [img] tag. | A whole number, in pixels | 44 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Tabs
Blocks panel → Content · add-on key tabs
The Tabs add-on places panels of text behind a row of tabs, one tab per line. It is the simple form of Tabs Pro, for content that divides cleanly by category and needs only words.
- Tabs typed one per line as
Title | Content.
- Icons on tabs, tabs down the side, or styled panels - use Tabs Pro.
When to use it
- Short text that divides by category: by year group, by department, by course.
When to choose another add-on
- Tabs with icons, pictures or several styles → use Tabs Pro.
- Optional detail that opens item by item → use Accordion / FAQ.
Procedure
- Write one tab per line: the tab title, a vertical bar, then the panel's text.
Behaviour on the page
- Tabs switch with a click, a tap or the arrow keys; only the open panel is shown.
- Keep tab titles to one or two words.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Tabs — one per line: Title | Content | The tabs, one per line as Title | Content. |
Several lines of text | Curriculum | Our CBSE-aligned curriculum spans Nursery to Class XII. Facilities | Scien… |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Tabs Pro
Blocks panel → Content · add-on key tabs_pro
The Tabs Pro add-on organises content into panels behind tabs, with five tab styles, tabs above, below or down the left, icons on the tabs, and panels that hold pictures, links and lists as well as text. Each panel can therefore act as a small page of its own.
- Tabs with a label, panel content and an optional icon.
- Five styles, three positions, and tabs that share the full width.
- Panels with formatting, pictures floated beside text, links and lists.
- Colours for tabs, the open tab and panels; radius, spacing and padding.
- Other add-ons inside a panel - a panel holds formatted content, not blocks.
When to use it
- The same kind of information for several audiences or products: plans, departments, services.
- Replacing several screens of content with one compact band.
When to choose another add-on
- Questions and answers → use Accordion / FAQ.
- Text-only tabs with no styling → use Tabs.
Procedure
- Add one row per tab with its label, its panel content and an optional icon.
- In the panel, use
[img=path\|alt\|320\|right]for a picture,[a=/page]words[/a]for a link and[ul][li]...[/li][/ul]for a list. Write pipes inside tags as\|. - Choose the tab style, where the tabs sit, and whether they share the full width.
- On the Style tab, set the colours, radius, gaps and panel padding.
Behaviour on the page
- Tabs switch with a click, a tap or the arrow keys, and are announced as tabs to screen readers.
- On phones, tabs placed down the left move above the panel.
- Pictures in panels load lazily and are addressed from the site root.
- "Share the full width" suits three or four short labels, not seven.
- Keep panels of similar length, so the page does not jump when switching tabs.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| A panel is cut off after a picture. | A plain pipe inside the picture tag split the row. Write pipes inside tags as \|. |
| A picture in a panel does not load. | Check the path; it is read from the site root, for example images/metropagebuilder/site/photo.webp. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Tabs | The tabs. Each row has the tab label, the panel content (with formatting, pictures, links and lists) and an optional icon. | Each row, in order:
|
none |
| Tab style | The visual style of the tabs. |
|
Modern - a line under the open tab |
| Where the tabs sit | Whether the tabs sit above, below or to the left of the panel. |
|
Above the panel |
| Share the full width between tabs | Divides the full width equally between the tabs. | On or off | off |
| Where the tabs sit inside the bar | Where the tabs sit within the tab bar when they do not share the full width. |
|
Left |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Accent - the open tab | The colour marking the open tab. | Any colour | none |
| Tab text | Sets the tab text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Tab background | Sets the tab background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Open tab text | Sets the open tab text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Panel background | Sets the panel background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Panel text | Sets the panel text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 8 |
| Gap between tabs (px) | Sets the gap between tabs, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 6 |
| Panel padding (px) | Sets the panel padding, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 22 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Team / Staff
Blocks panel → Content · add-on key team
The Team add-on presents people as cards: a photograph, name, role, a short biography and links to their profiles or email. Columns are set separately for desktop, tablet and phone, and the photograph shape is shared by every card so the grid stays even.
- Any number of people, with photo, name, role, biography and social links; one to six columns per screen size; three photo shapes.
- Profiles read from a staff database - use the Rudra staff profile add-on for Rudra Pro ERP.
When to use it
- Staff pages, leadership teams, faculty, contributors.
When to choose another add-on
- One person described at length → use Image & Content.
- Cards that turn to reveal a biography → use Flip Box Pro.
Procedure
- Add a row per person: photo, name, role, short biography and social links (for example
linkedin:janedoe, email:).This email address is being protected from spambots. You need JavaScript enabled to view it. - Set the columns for desktop, tablet and phone, and the photo shape.
- On the Style tab, set the card background, colours, radius and alignment.
Behaviour on the page
- Photos are cropped to the chosen shape so faces align.
- Social links open the profile or an email to the address given.
- Use photographs taken in similar light and framing.
- Give every person a role that says what they do.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| People | The people. Each row has a photo, name, role, short biography and social links written as network:handle, separated by commas. |
Each row, in order:
|
none |
| Columns — desktop | Chooses the columns — desktop. Each value is described under Values. |
|
3 |
| Columns — tablet | Chooses the columns — tablet. Each value is described under Values. |
|
2 |
| Columns — mobile | Chooses the columns — mobile. Each value is described under Values. |
|
1 |
| Photo shape | The shape every photo is cropped to. |
|
Square |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 24 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Card background | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Name colour | Sets the name colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Role colour | Sets the role colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Text alignment inside each card | Chooses the text alignment inside each card. Each value is described under Values. |
|
Center |
| Card shadow | Switches on or off: card shadow. | On or off | on |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Testimonial
Blocks panel → Content · add-on key testimonial
The Testimonial add-on presents one quotation with its author, their role, a photograph and a star rating.
- One quotation with author, role, photo and rating, aligned left or centre.
- Several quotations, carousels or framed styles - use Testimonial Pro.
When to use it
- A single endorsement beside a call to action.
When to choose another add-on
- Several testimonials in a grid or carousel → use Testimonial Pro.
Procedure
- Paste the quotation and fill in the author and role.
- Add the photograph and the rating (0 to 5 stars).
- Choose the alignment.
Behaviour on the page
- The rating is announced as a number of stars to screen readers.
- Quote a specific outcome rather than general praise, and give the author's real name and role.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Quote | The quote. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | The teachers know every child by name. That changed everything for us. |
| Author | The author. | Text | Parent, Class VI |
| Role / detail | The role / detail. | Text | none |
| Photo | The picture used for the photo. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Stars (0–5) | The number of stars shown, from 0 to 5. 0 shows none. | A whole number (0–5) | 5 |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Center |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Testimonial Pro
Blocks panel → Content · add-on key testimonial_pro
The Testimonial Pro add-on presents several testimonials with a heading of their own, as a grid or a side-scroller with arrows. It offers eleven frames for the quotation (from a card to a comic speech balloon), thirteen portrait shapes in nine positions, five preset looks, and control over quotation marks, stars, hover effects and entrance.
- Any number of testimonials with photo, quotation, name, role and a rating.
- A grid, or a side-scroller with arrows, with one to four across on each screen size.
- Eleven frames, thirteen portrait shapes, portrait positions, borders, overlap, hover and an offset block behind the portrait.
- Five presets as starting points: Editorial, Card wall, Spotlight, Compact, or your own settings.
- Video testimonials - use the Video Playlist or Metro Slideshow.
- Reviews collected from a review site.
When to use it
- A section of customer, parent or student endorsements.
- A carousel of quotations under a hero.
When to choose another add-on
- A single quotation → use Testimonial.
- Video testimonials → use Video Playlist.
Procedure
- Write the section heading and sub-heading, and choose their alignment.
- Add a row per testimonial: photo, quotation, name, role and stars.
- Choose the grid or the side-scroller, and how many show across on each screen size.
- On the Style tab, start from a Preset look, then adjust the frame, portrait, quotation marks and colours. Anything you set yourself overrides the preset.
Behaviour on the page
- The side-scroller moves by swipe, by trackpad, or with the arrow buttons, which appear only when there is more to scroll to.
- Stars are announced as a rating to screen readers.
- Portrait shapes crop the photo; the photo itself is not altered.
- Choose the frame and the quotation marks together: a boxed frame needs no marks, a plain frame reads better with them.
- Speech and thought balloons suit informal brands; for professional services use Card, Rule or Plain.
- Three across on desktop and one on phones is the most readable arrangement.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| A setting seems to have no effect. | A preset may set the same property. Set Preset look to "Custom" to see only your own settings. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Testimonials | The testimonials. Each row has a photo, the quotation, the name, a role or detail, and 0 to 5 stars. | Each row, in order:
|
none |
| Section heading | The section heading. | Text | none |
| Section sub-heading | The section sub-heading. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| Heading alignment | Chooses the heading alignment. Each value is described under Values. |
|
Center |
| Layout | A static grid, or a single row that scrolls sideways with arrows. |
|
Grid |
| Across — desktop | Chooses the across — desktop. Each value is described under Values. |
|
3 |
| Across — tablet | Chooses the across — tablet. Each value is described under Values. |
|
2 |
| Across — mobile | Chooses the across — mobile. Each value is described under Values. |
|
1 |
| Show arrows (side-scroller) | Switches on or off: show arrows. | On or off | on |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Quote frame | The shape drawn around each quotation. |
|
Speech balloon (comic) |
| Frame background | Sets the frame background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Quote text colour | Sets the quote text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Frame border (px) | Sets the frame border, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 2 |
| Frame border colour | Sets the frame border colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Frame corner radius (px) | Sets the frame corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
| Frame inner spacing (px) | Sets the frame inner spacing, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 20 |
| Quote size (px) | Sets the quote size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
| Portrait position | Where the portrait sits relative to the quotation and its frame. |
|
Under the quote, left |
| Portrait shape | The shape the portrait is cropped to. |
|
Circle |
| Portrait size (px) | Sets the portrait size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 72 |
| Portrait border (px) | Sets the portrait border, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 3 |
| Portrait border colour | Sets the portrait border colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Let the portrait overlap the frame | Lets the portrait cross the edge of the frame. | On or off | on |
| Portrait hover effect | Chooses the portrait hover effect. Each value is described under Values. |
|
none |
| Offset block behind the portrait | Draws a coloured block offset behind the portrait. | On or off | off |
| Offset block colour | Sets the offset block colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Preset look | A starting combination of frame, type and spacing. Anything you set yourself still takes precedence. |
|
none |
| Quotation marks | Quotation marks drawn with the text. Independent of the frame. |
|
none |
| Big quote marks over the portrait | Large decorative quotation marks placed over the portrait. | On or off | off |
| Quote mark colour | Sets the quote mark colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Stars colour | Sets the stars colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Name colour | Sets the name colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Gap between testimonials (px) | Sets the gap between testimonials, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 24 |
| Testimonial hover effect | What each testimonial does when the pointer is over it. |
|
Lift up |
| Entrance animation | How the testimonials appear as they scroll into view. |
|
none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Text
Blocks panel → Content · add-on key text
The Text add-on holds paragraphs of running text with the full set of typography controls. Inline formatting in square brackets handles bold, italic, colour, highlights, links, line breaks and lists, so a block of text needs no HTML.
- One or more paragraphs, aligned left, centre, right or justified.
- Inline formatting: [b], [i], [c=#hex], highlights, links, line breaks and lists.
- Typeface, size, weight, line height, letter spacing and case.
- Headings - use the Heading add-on so the page outline is correct.
- Arbitrary HTML - markup is shown as text, for safety.
When to use it
- Introductory paragraphs, descriptions, terms and any running prose.
- A short line of small print under a button or a price.
When to choose another add-on
- A title → use Heading.
- A list where each row has an icon → use Icon List.
- A notice that must stand out → use Alert / Notice.
Procedure
- Type or paste the text under Text. A blank line starts a new paragraph.
- Apply inline formatting from the toolbar or by typing the bracket codes.
- Set the alignment and colour, then the typography settings.
Behaviour on the page
- Pasted text keeps its paragraphs; pasted styling from word processors is removed.
- HTML tags typed into the text are shown as text rather than interpreted.
- Keep lines to 60 to 80 characters for comfortable reading: narrow the column rather than shrinking the text.
- Use justified alignment only in wide columns; in narrow ones it opens uneven gaps between words.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Formatting codes appear literally. | A bracket code is misspelled or not closed. Each opening tag such as [b] needs its closing [/b]. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Text | The text itself. A blank line starts a new paragraph; bracket codes add formatting. | Several lines of text | Write something here. |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Left |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Timeline
Blocks panel → Content · add-on key timeline
The Timeline add-on presents dated or ordered entries along a line: a company history, the stages of a process, the terms of a school year. Each entry has a date or label, a title, a description, a marker (an icon, a number or a picture) and an optional link, and entries can arrive one after another as the visitor scrolls.
- Any number of entries, each with its own marker icon, picture and colours if needed.
- Three layouts: a line on the left, entries alternating either side, or a centred line.
- Eight marker shapes, seven idle animations, six hover effects and five arrival effects.
- Line thickness, style and colour; entry cards with an optional lift on hover.
- A horizontal, scrolling timeline.
- Dates read from a calendar or events component - entries are typed in.
When to use it
- The history of an organisation, milestone by milestone.
- A process the visitor goes through in order: apply, interview, enrol.
- An event programme or a term calendar.
When to choose another add-on
- Three or four steps told with pictures, one screen at a time → use Stacking Cards.
- Short points with icons, in no particular order → use Icon List.
- Upcoming matches or results → use Fixtures & results.
Procedure
- Add one entry per moment: the date or label, the title, the description and, optionally, a marker icon, a picture and a link.
- Choose the layout. For alternating and centred layouts, choose whether the markers sit on one straight line or offset either side of it.
- Choose the marker shape; "Numbered" numbers the entries automatically.
- Choose the marker animation, the hover effect and how entries arrive, and the delay between them.
- On the Style tab, set the line, marker, card and date colours, and sizes.
Behaviour on the page
- On phones every layout becomes a line on the left, so entries are read top to bottom.
- Entries arrive as they scroll into view, each after the delay set. Visitors who ask for reduced motion see them in place, without animation.
- A picture on an entry replaces its marker icon.
- Keep descriptions to one or two sentences; the timeline is read by its dates and titles.
- Use one idle animation at most, and only on the current or next entry's colour - animation on every marker competes with the text.
- Colour a single marker (for example "Today") with the per-entry colours to mark where the visitor is in the sequence.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Entries do not appear until scrolled far down. | The arrival effect waits for each entry to enter the view. Choose "Already there" for a short timeline near the top of the page. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Entries | The entries. Each row has a date or label, a title, a description, a marker icon, an optional link, an optional picture used instead of the icon, and optional colours for that marker alone. | Each row, in order:
|
none |
| Layout | Chooses the layout. Each value is described under Values. |
|
Line on the left |
| Markers in the alternating and centred layouts | In the alternating and centred layouts, whether each marker sits on the centre line or is offset to the side of its entry. Offered only when Layout is "Alternating sides" or "Centred line". |
|
none |
| Marker shape | The shape drawn at each entry on the line. "Numbered" numbers them in order. |
|
Circle |
| Marker animation | A continuous animation on the markers while the page is open. |
|
Nothing |
| Marker on hover | What a marker does when the pointer is over its entry. |
|
Grow |
| Entries arrive by | How each entry appears as it scrolls into view. |
|
Already there |
| Delay between entries arriving (ms) | The pause between one entry arriving and the next, in milliseconds. | A whole number, in milliseconds | 90 |
| Spacing between entries (px) | Sets the spacing between entries, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 28 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Marker size (px) | Sets the marker size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 38 |
| Icon size (px) | Sets the icon size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
| Line thickness (px) | Sets the line thickness, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 2 |
| Line style | Chooses the line style. Each value is described under Values. |
|
Solid |
| Line colour | Sets the line colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Marker colour | Sets the marker colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Icon colour | Sets the icon colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Entry background | Sets the entry background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Entry lifts on hover | Raises an entry slightly when the pointer is over it. | On or off | off |
| Date colour | Sets the date colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 12 |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Timeline Pro
Blocks panel → Content · add-on key timeline_pro
The Timeline Pro add-on draws one list of entries in twenty-one designs, down the page or across it: along a winding road with stops on its crests, a dotted map path with pins, or a glowing wave; as a classic line, entries either side of it, dates split from their entries, large numbered milestones, a stepper with ticks, cards, chevrons, circles with the date inside, or a minimal list of large dates; as a status roadmap or a project plan with progress bars; as a Gantt chart with bars across a scale and a line for today; or in the milestone designs - ring markers on a line with a pin to each entry, thick rings joined in a zigzag, a pyramid of tiers, a pyramid of slanted slices, or a triangle of three. Each entry carries a status word and a percentage, so bringing the page up to date is changing a word and a number.
- Entries with a date, title, line, icon or picture, status, percentage, tag or owner, link and colour.
- Twenty-one designs; down the page or across it (a Gantt chart always across; the pyramid, the slices and the triangle always upright).
- Five milestone designs: pins, rings, pyramid, pyramid slices and triangle. Each is an ordinary list on a phone and takes its shape from a tablet up, so a long list simply continues down the page.
- Colour by a blend from one colour to another, by one colour, by status - with a colour for each status - or a different colour for each entry.
- Seven marker shapes and five fills, the idle and hover motions of Timeline, the site-wide entry hover effects, and Timeline's arrivals.
- Status chips and progress bars on any design; a Gantt scale of any labels, with a "today" line.
- Dates worked out from a calendar - the Gantt chart places bars on the labels you give it.
- Live data from a project tool - entries are typed in.
When to use it
- A company history on a winding road.
- A product roadmap with now, next and later.
- Key results or goals for the year as milestone rings, each drawn to its percentage.
- Objectives and key results as a pyramid, priorities (must, should, could, will not) as pyramid slices, or the scope, time and cost of a project as a triangle.
- A project plan the team updates every week, or a Gantt chart of tasks and owners.
- The steps of a process, a course, an application.
When to choose another add-on
- A simple list of dated entries → use Timeline.
- Three or four steps told with pictures, one screen at a time → use Stacking Cards.
- A plain table of dates and owners → use Table.
Procedure
- Add a row per entry: the date or label, the title, a line of description and an icon.
- Type a status - done, now, next, later or blocked - and a percentage where progress matters.
- Choose the design, and whether it runs down the page or across it.
- For a Gantt chart, type the scale one label per line (Jan, Feb... or Sprint 1, Sprint 2...), give each row the labels it starts and ends on, and optionally the label for today. A row with no end is drawn as a milestone diamond.
- Choose how the entries are coloured, whether statuses and progress bars show, the marker animation (on the entry in progress, or all) and how entries arrive.
- On the Style tab, set the colours, marker shape and fill, the line, the entry box and sizes.
Behaviour on the page
- On a phone every design runs down the page; the Gantt chart keeps its shape and scrolls sideways.
- Pins: a ring marker on the line for each entry, the entry on one side with a pin leading to it and the date on the other, alternating. Down the page, entries and dates alternate either side.
- Rings: each marker is a thick ring, drawn round to the entry's percentage (a full ring without one), on straight links that zigzag between the stops. Markers are never smaller than 72 pixels.
- Pyramid: one tier per entry, the first the point and the last the full width, every tier the same height so the sides run straight, with a dotted leader to its entry. Slices: the same tiers cut as slices of a solid pyramid, entries alternating left and right, a letter in each tier when it has no icon.
- Triangle: the first three entries are its sides, each with its letter in a circle and its colour; they sit to the left, the right and below. Any further entries continue as a list underneath.
- The winding designs lay their curve behind the list, and the stops always sit on its crests, at any width.
- The marker animation plays on the entry marked "now" unless every marker is asked for; it stops for visitors who ask for less motion, and so do the arrivals and the moving road markings.
- Status chips and progress bars are read by screen readers: a chip as its word, a bar as a progress bar with its value.
- Across the page, entries are at least the set width each; when they do not fit, the timeline scrolls sideways.
- Choose "Colour the entries by: the entry's status" for roadmaps, steps and plans - the colours then say what is finished at a glance.
- Choose "a different colour for each entry" for the pins, the rings, the pyramid and the slices - each milestone or tier is told apart at a glance.
- Three to six entries suit the pyramid and the slices; the triangle is made for exactly three.
- Five to seven entries suit the road and the circles; a Gantt chart holds twenty rows comfortably.
- Keep titles to three or four words; the line under them carries the detail.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| A Gantt bar is missing. | Its start is not a label on the scale (spelling counts, case does not) and not a number between 1 and the number of labels. |
| Every entry is the same colour. | Colouring by status needs a status on each entry; blank statuses take the colour. |
| The road runs off the side. | The entries are wider than the screen allows. Lower "Width of each entry across the page". |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Entries | The entries. Each row has a date or label, a title, a description, an icon, a status (done, now, next, later or blocked), a percentage, for a Gantt chart the scale labels it starts and ends on, a tag or owner, a link, a picture instead of the icon and a colour for that entry alone. | Each row, in order:
|
5 sample entries |
| Design | The design. |
|
Classic - a line with markers |
| Runs | Down the page or across it, from a tablet up. Offered only when Design is "Classic - a line with markers" or "Winding road - a 3D ribbon with stops along it" or "Map path - a dotted trail with pins" or "Wave - a glowing curve" or "Zigzag - entries either side of the line" or "Split - dates on one side, entries on the other" or "Milestones - large numbered stops" or "Steps - a progress stepper with ticks" or "Cards - each entry a card on the line" or "Arrows - chevrons pointing onward" or "Circles - the date inside each marker" or "Minimal - large dates and a hairline" or "Neon - dark cards and a glowing line" or "Roadmap - status chips and progress on every entry" or "Project plan - phases with owners and progress" or "Pins - ring markers on a line, entries above and below" or "Rings - thick rings joined in a zigzag". |
|
Down the page |
| Gantt: the scale, one label per line | For a Gantt chart, the scale: one label per line. Offered only when Design is "Gantt chart - bars across a scale". | Several lines of text | Jan Feb Mar Apr May Jun Jul Aug Sep Oct |
| Gantt: mark today at (a scale label) | For a Gantt chart, the scale label to draw a line at. Offered only when Design is "Gantt chart - bars across a scale". | Text | none |
| Gantt: heading of the first column | For a Gantt chart, the heading of the first column. Offered only when Design is "Gantt chart - bars across a scale". | Text | Task |
| Show the status on each entry | Shows each entry's status as a chip. | On or off | on |
| Show a progress bar where a percentage is given | Shows a progress bar on entries with a percentage. | On or off | on |
| Entries arrive by | How entries appear as they scroll into view. |
|
Rise up |
| Delay between entries arriving (ms) | The pause between one entry arriving and the next, in milliseconds. | A whole number, in milliseconds | 90 |
| Marker animation | A continuous motion on the markers. |
|
Pulse |
| Animate | Whether the motion plays on the entry in progress only, or on every marker. |
|
Only the entry in progress |
| Marker on hover | What a marker does when the pointer is over its entry. |
|
Grow |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Colour | The colour of the entries (and of the "now" status). | Any colour | #7c3aed |
| Second colour | The colour the blend runs to, and the second colour of gradient markers. | Any colour | #ec4899 |
| Colour the entries by | How each entry gets its colour: a blend along the timeline, one colour, the entry's status, or a different colour for each entry in turn. |
|
Blend from the colour to the second colour along the timeline |
| Status colour - done | Sets the status colour - done colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #16a34a |
| Status colour - next | Sets the status colour - next colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #f59e0b |
| Status colour - planned | Sets the status colour - planned colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #94a3b8 |
| Status colour - blocked | Sets the status colour - blocked colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #dc2626 |
| Marker shape | The shape of each marker. |
|
Circle |
| Marker fill | How each marker is filled. |
|
Solid colour |
| Marker size (px) | Sets the marker size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 44 |
| Icon size (px) | Sets the icon size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
| Line thickness (px) | Sets the line thickness, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 3 |
| Line style | Chooses the line style. Each value is described under Values. |
|
Solid |
| Line colour (blank follows the entries) | The line's colour. Blank follows each entry's colour. | Any colour | none |
| Road width (px) | For the road, its width in pixels. Offered only when Design is "Winding road - a 3D ribbon with stops along it". | A whole number, in pixels | 30 |
| Road edge colour | For the road, the colour of its edge. Offered only when Design is "Winding road - a 3D ribbon with stops along it". | Any colour | #e2e8f0 |
| The curve | For the curved designs, whether the curve's markings travel or it breathes a glow. Offered only when Design is "Winding road - a 3D ribbon with stops along it" or "Map path - a dotted trail with pins" or "Wave - a glowing curve" or "Rings - thick rings joined in a zigzag". |
|
Still |
| Entry box | The box each entry is written in. |
|
A white card with a shadow |
| Entry background (blank follows the box) | The entry box's background. Blank follows the box style. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Date colour (blank follows the entry) | The date's colour. Blank follows the entry's colour. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Width of each entry across the page (px) | Across the page, the least width of each entry, in pixels. Offered only when Runs is "Across the page". | A whole number, in pixels | 220 |
| Space between entries (px) | The space between entries. | A whole number, in pixels | 28 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Media add-ons
Pictures, video, audio, maps and live data.
Before and After
Blocks panel → Media · add-on key compare
The Before and After add-on sets two pictures of the same subject one over the other with a handle between them; dragging the handle reveals more of one or the other. It demonstrates a change - a renovation, a treatment, a restoration - more convincingly than two pictures side by side.
- Two pictures with labels, a description, a starting position, horizontal or vertical travel, four handle styles and a frame.
- More than two pictures.
When to use it
- Renovation, cleaning, landscaping, retouching, medical or dental results.
When to choose another add-on
- Two pictures side by side → use Image.
Procedure
- Choose the before and after pictures.
- Label each side and describe the pair for screen readers.
- Set where the handle starts.
- On the Style tab, choose the travel direction, shape, handle and label styles, and the frame.
Behaviour on the page
- The handle moves by drag, touch or the arrow keys.
- The description is read once for the pair.
- The pictures must be the same shape and taken from the same spot, or the comparison makes no sense.
- Start away from 50% when one side is the point.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Before | The picture used for the before. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| After | The picture used for the after. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Label on the before picture | The label on the before picture. | Text | Before |
| Label on the after picture | The label on the after picture. | Text | After |
| What the pair shows (for screen readers) | One description of the comparison, for example "The east elevation before and after re-cladding". | Text | none |
| Starting position (%) | Where the split sits before anyone moves it, as a percentage. | A whole number, as a percentage | 50 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Handle travels | Whether the handle moves across or up and down. |
|
Left and right |
| Shape | The shape of the frame. "Whatever the first picture is" follows the before picture. |
|
16 : 9 |
| Handle | How the handle is drawn. |
|
Line with a round grip |
| Handle colour | Sets the handle colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Labels | How the side labels are drawn. |
|
On a pill |
| Label colour | Sets the label colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Label background | Sets the label background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 12 |
| Border (px) | Sets the border, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Border colour | Sets the border colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Drop shadow | Switches on or off: drop shadow. | On or off | off |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Carousel / Banner
Blocks panel → Media · add-on key carousel
The Carousel / Banner add-on is a full-width banner that moves through slides, each with a picture, a caption and a button. It supports automatic advance, arrows and indicators in several styles, and slide effects.
- Slides with picture, caption and button; height; auto-advance; arrows, indicators and effects.
- Several slides visible at once - use Carousel Pro.
- Video slides - use the Metro Slideshow.
When to use it
- A home page banner rotating a few announcements or offers.
When to choose another add-on
- Several cards visible at once → use Carousel Pro.
- Pictures and videos with transition effects and thumbnails → use Metro Slideshow.
- A single, static hero → use Image & Content.
Procedure
- Add a row per slide: picture, caption, button link and button words. Leave the words empty to make the whole slide a link.
- Set the height.
- Choose whether it advances by itself and the seconds between slides.
- On the Style tab, choose the arrows and indicators.
Behaviour on the page
- Slides move by swipe, arrows or indicators.
- Automatic advance pauses while the pointer is over the banner or keyboard focus is inside it, and does not run at all for visitors who ask their device for reduced motion.
- Keep each slide to a headline, one line and a button; a slide that moves on while being read is not read.
- Three to five slides; later slides are rarely seen.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Slides | The slides. Each row has a picture, a caption, a button link and button words; empty words make the whole slide the link. | Each row, in order:
|
none |
| Height (px) | Sets the height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 420 |
| Auto-advance | Moves to the next slide by itself. | On or off | off |
| Seconds between slides | Seconds each slide is shown during automatic advance. | A whole number | 6 |
| Slide animation | How the caption appears on each slide. |
|
none |
| Rounded corners | Switches on or off: rounded corners. | On or off | on |
| Movement | "Slide by slide" settles each slide into place; "Free scroll" stops wherever the visitor lets go. |
|
Slide by slide |
| At the last slide | What happens after the last slide: return to the first, or stop. |
|
Return to the first slide |
| Let the mouse wheel move the slider | Lets a mouse wheel or trackpad move the slider sideways. The page scrolls normally once the slider reaches either end. | On or off | off |
| Slide effect | A visual treatment of the slides near the current one: fading them, bringing the current one forward, a cover-flow or a deck. Effects add no downloads. |
|
Natural scrolling |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Legacy dots | The dots used by earlier versions. Kept for pages built with them; use Slide indicators instead. | On or off | none |
| Show previous and next arrows | Shows previous and next buttons. | On or off | on |
| Arrow icon | The icon drawn on the arrow buttons. |
|
Chevron |
| Arrow position | Where the arrow buttons sit relative to the slider. |
|
Inside, vertically centred |
| Arrow button size (px) | Sets the arrow button size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 42 |
| Arrow colour | Sets the arrow colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Arrow background | Sets the arrow background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Slide indicators | The markers that show which slide is current and let the visitor jump to another. |
|
Dots |
| Indicator position | Where the markers sit. |
|
Inside, along the bottom |
| Indicator alignment | Chooses the indicator alignment. Each value is described under Values. |
|
Center |
| Indicator colour | Sets the indicator colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Current indicator colour | The colour of the marker for the current slide. | Any colour | none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Carousel Pro
Blocks panel → Media · add-on key carousel_pro
The Carousel Pro add-on shows several slides at once - products, courses, projects - with a heading above and a separate count of visible slides for desktop, tablet and phone. It can also run one slide at a time or as a full-screen hero with text over the picture.
- Slides with picture, title, description and button; three layouts; per-screen counts; heading; auto-advance; arrows, indicators and effects.
- Content read from articles or a shop - slides are entered by hand.
When to use it
- A row of featured courses, projects or products that scrolls sideways.
When to choose another add-on
- A single banner → use Carousel / Banner.
- A static grid → use Feature Box.
Procedure
- Write the heading and sub-heading.
- Add a row per slide: picture, title, description, link and optional button words.
- Choose the layout, and the number of visible slides on each screen size.
- On the Style tab, set the picture height, gap, default button words, and the arrows and indicators.
Behaviour on the page
- Slides move by swipe, trackpad, arrows or indicators.
- Automatic advance pauses while the pointer is over the carousel or keyboard focus is inside it, and does not run for visitors who ask for reduced motion.
- Keep titles to one line so the cards align.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Slides | The slides. Each row has a picture, a title, a description, a link and button words; empty words use the default. | Each row, in order:
|
none |
| Layout | Several cards per view, one full-width slide per view, or a full-screen hero with text over the picture. |
|
Cards (several per view) |
| Heading above the carousel | The heading above the carousel. | Text | none |
| Sub-heading | The sub-heading. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| Heading alignment | Chooses the heading alignment. Each value is described under Values. |
|
Center |
| Slides visible — desktop | Slides visible at once on desktop screens. |
|
3 |
| Slides visible — tablet | Slides visible at once on tablets. |
|
2 |
| Slides visible — mobile | Slides visible at once on phones. |
|
1 |
| Auto-advance | Moves to the next slide by itself. | On or off | off |
| Seconds between slides | Seconds between automatic moves. | A whole number | 6 |
| Movement | "Slide by slide" settles each slide into place; "Free scroll" stops wherever the visitor lets go. |
|
Slide by slide |
| At the last slide | What happens after the last slide: return to the first, or stop. |
|
Return to the first slide |
| Let the mouse wheel move the slider | Lets a mouse wheel or trackpad move the slider sideways. The page scrolls normally once the slider reaches either end. | On or off | off |
| Slide effect | A visual treatment of the slides near the current one: fading them, bringing the current one forward, a cover-flow or a deck. Effects add no downloads. |
|
Natural scrolling |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Image height (px) | The height of each slide's picture. | A whole number, in pixels | 200 |
| Gap between slides (px) | Sets the gap between slides, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
| Default button text (blank = no button) | Button words used by slides that do not set their own. Empty shows no button. | Text | Read more |
| Slide animation | How slides appear as they scroll into view. |
|
none |
| Rounded corners | Switches on or off: rounded corners. | On or off | on |
| Card shadow | Switches on or off: card shadow. | On or off | on |
| Legacy dots | The dots used by earlier versions. Kept for pages built with them; use Slide indicators instead. | On or off | none |
| Show previous and next arrows | Shows previous and next buttons. | On or off | on |
| Arrow icon | The icon drawn on the arrow buttons. |
|
Chevron |
| Arrow position | Where the arrow buttons sit relative to the slider. |
|
Inside, vertically centred |
| Arrow button size (px) | Sets the arrow button size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 42 |
| Arrow colour | Sets the arrow colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Arrow background | Sets the arrow background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Slide indicators | The markers that show which slide is current and let the visitor jump to another. |
|
Dots |
| Indicator position | Where the markers sit. |
|
Inside, along the bottom |
| Indicator alignment | Chooses the indicator alignment. Each value is described under Values. |
|
Center |
| Indicator colour | Sets the indicator colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Current indicator colour | The colour of the marker for the current slide. | Any colour | none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Client Logos
Blocks panel → Media · add-on key client_logos
The Client Logos add-on presents the logos of clients, partners or accreditations as evidence of trust. It arranges them as a still row, a wrapping grid, or a marquee that keeps moving in one to three rows; the Automatic layout keeps a few logos still and scrolls a longer list. Logos can be greyed, faded, shown in full colour or turned white for a dark band, and can sit in square, wide or long boxes.
- Logos with company name and link; a heading with alignment and a hairline.
- Row, grid, marquee and automatic layouts; one to three scrolling rows in either direction; faded ends.
- Five treatments, a common height, dividers, boxes and hover effects.
- Logos with descriptions - use Feature Boxes or the Image Slider.
When to use it
- A "trusted by" band under a hero.
- Accreditation or partner logos in a footer area.
- Sponsors on an event page.
When to choose another add-on
- Photos with titles → use Metro Image Slider.
Procedure
- Add a row per logo: the logo, the company name and an optional link.
- Write the heading and choose its alignment and rule.
- Choose the layout and the number across on desktop and on phones.
- For a marquee, set the seconds per loop, the rows, the direction and faded ends.
- On the Style tab, choose the treatment, the logo height, the gap, optional boxes and the hover effect.
Behaviour on the page
- Every logo is shown at the same height, whatever the size of its file.
- Automatic shows a still row when the logos fit and scrolls when there are more.
- Marquees pause while the pointer is over them and are still for visitors who ask for reduced motion.
- The company name is read by screen readers in place of the logo.
- Use SVG logos, or PNG or WebP about twice the logo height; a larger file is only slower.
- 28 to 40 pixels reads as a quiet row of proof. Grey or white stops competing brand colours drawing attention from your page.
- Use the white treatment on dark bands.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Some logos look larger than others. | Their files contain empty space around the mark. Crop the files to the logo. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Logos | The logos. Each row has the logo, the company name for screen readers, and an optional link. | Each row, in order:
|
8 sample entries |
| Heading | The heading. | Text | none |
| Heading sits | Chooses the heading sits. Each value is described under Values. |
|
Centred |
| Hairline under the heading | Draws a hairline under the heading. | On or off | off |
| Layout | How logos are arranged. |
|
Row — evenly spaced |
| Across — desktop | Chooses the across — desktop. Each value is described under Values. |
|
5 |
| Across — mobile | Chooses the across — mobile. Each value is described under Values. |
|
2 |
| Marquee seconds per loop | Seconds for one full loop of the marquee. Longer is slower. | A whole number | 30 |
| Scrolling rows | For a scrolling layout, the number of rows; the logos are shared between them and alternate rows run the other way. |
|
One row |
| Scrolls towards | The direction the marquee moves. |
|
The left |
| Fade the ends of a scrolling row | Fades the logos out at each end of a scrolling row. | On or off | on |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Logo treatment | How logos are coloured, at rest and on hover. |
|
Grey, full colour on hover |
| Logo height (px) | The height every logo is shown at. | A whole number, in pixels | 44 |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 48 |
| Hairline between logos | Draws a hairline between logos. | On or off | off |
| Box each logo | Puts each logo in a box of the chosen proportion. |
|
none |
| Box background | Sets the box background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Box corner radius (px) | Sets the box corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Each logo on hover | What each logo does when the pointer is over it. |
|
none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Gallery
Blocks panel → Media · add-on key gallery
The Gallery add-on shows photographs in an even grid with optional captions. Pictures are listed one per line, so a set can be pasted in quickly. It is the simplest picture add-on; the Image Slider and Mosaic offer shapes, frames, links and larger sets.
- Any number of pictures with captions, two to five columns, gaps and rounded corners.
- Opening pictures large - the grid is static. The Image Slider can open every photo in a pop-up.
- Mixed tile sizes - use the Mosaic.
- Picture shapes, frames, links and "view all" - use the Image Slider.
When to use it
- An event album, a facility tour, a portfolio.
When to choose another add-on
- A designed grid of mixed sizes → use Mosaic.
- Pictures that open large, or a set with a "View all" button → use Metro Image Slider.
- Pictures drifting in columns → use Image Wall.
Procedure
- Enter one picture per line: its path, a vertical bar, then a caption.
- Choose the columns, the gap and rounded corners.
Behaviour on the page
- Every picture is cropped to a 4:3 shape so the grid stays even; the caption is used as its alt text.
- Pictures load as they approach the view.
- Upload pictures at about twice their shown width, not full camera size; the grid never shows them larger.
- Write a caption for every picture; it doubles as the alt text read to screen-reader users.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| A picture is missing. | Check the path on its line. Paths start at the site root, for example images/metropagebuilder/site/photo.webp. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Images — one per line: /images/metropagebuilder/photo.jpg | Caption | The pictures, one per line as path | Caption. |
Several lines of text | none |
| Columns (desktop) | Chooses the columns. Each value is described under Values. |
|
3 |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 12 |
| Rounded corners | Rounds the corners of every picture. | On or off | on |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Image
Blocks panel → Media · add-on key image
The Image add-on places a single picture with control over its width, alignment, shape, frame and link. It can also break out of its section, tilt, carry a second picture behind it for a layered composition, and take a coloured or gradient overlay that changes on hover.
- One picture with alt text, a link, a width and an alignment.
- Cropping to seven shapes, corner radius, border, shadow and a glow or zoom on hover.
- Breaking out above, below or past the edge of its section, and a tilt.
- A second picture behind, positioned, scaled and faded.
- An overlay: solid or gradient, with a blend mode and a hover behaviour.
- Several pictures - use the Gallery, Mosaic, Image Slider or a carousel.
- Text beside the picture - use Image & Content.
When to use it
- A photograph, illustration or diagram within a column.
- A layered hero picture that overlaps the next section.
When to choose another add-on
- A picture beside text → use Image & Content.
- Several pictures that open large → use Gallery.
- Two pictures compared with a handle → use Before and After.
- A picture with labelled points → use Product Callouts.
Procedure
- Choose the picture and write alt text that says what it shows.
- Set the width as a percentage of the column, and the alignment.
- Optionally crop it to a shape, round the corners, and add a border and shadow.
- Optionally add a link and a hover effect.
- For a layered look, choose a second picture behind it and offset it; or set the picture to break out of its section.
- On the Style tab, add an overlay if text or a tint must sit over it.
Behaviour on the page
- Pictures below the first screen load as they approach the view, so long pages stay quick.
- Cropping uses the picture as it is; the file is not altered.
- Hover effects also respond to keyboard focus and touch when the picture is linked.
- Always write alt text; it is read aloud to screen-reader users and shown if the picture fails to load. Leave it empty only for purely decorative pictures.
- Upload pictures close to the size they are shown. A 4000-pixel photograph in a 600-pixel column is a slow page and no sharper.
- Breaking out works best with padding on the neighbouring section, so the overlap has room.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The picture is larger than expected. | Width is a maximum percentage of the column. Lower it, or place the picture in a narrower column. |
| The overlap is cut off. | The section has overflow hidden. Clear it under the section's Advanced settings. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Image | The picture used for the image. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Alt text | What the picture shows, read aloud by screen readers and shown if it fails to load. | Text | none |
| Link (optional) | Where the link leads: a page on this site, a full https:// address, or #name for a section on the same page. |
A link | none |
| Max width (%) | The largest width, as a percentage of the column. | A whole number, as a percentage | 100 |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Center |
| Crop to a shape | Crops the picture to a shape. "The image's own shape" shows it uncropped. |
|
none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Shadow under the picture | Chooses the shadow under the picture. Each value is described under Values. |
|
none |
| ...shadow colour (blank = navy) | Sets the shadow colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Shadow under the picture is "Subtle" or "Medium" or "Strong" or "Soft: hairline edge" or "Soft: card (iOS style)" or "Soft: floating (macOS window)" or "Soft: raised sheet" or "Soft: deep (dialog)" or "Soft: pressed in". | Any colour | none |
| Border (px) | Sets the border, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Border colour | Sets the border colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Hover, focus and touch effect | What the picture does on hover, keyboard focus and touch. |
|
none |
| Glow colour | The colour of the glow effect. | Any colour | none |
| Break out of the section | Lets the picture extend beyond its section. |
|
none |
| Break out by (px) | How far the picture extends beyond its section, in pixels. | A whole number, in pixels | 60 |
| Tilt (degrees, -15 to 15) | Tilts the picture, from -15 to 15 degrees. | A whole number, in degrees | 0 |
| A second picture behind it | A second picture placed behind the first, for a layered composition. | A picture | none |
| Behind — across (px, may be negative) | Moves the second picture across, in pixels; negative values move it left. | A whole number, in pixels | -46 |
| Behind — down (px, may be negative) | Moves the second picture down, in pixels; negative values move it up. | A whole number, in pixels | -46 |
| Behind — size (%) | The second picture's size, as a percentage of the first. | A whole number, as a percentage | 92 |
| Behind — opacity (%) | The second picture's opacity. | A whole number, as a percentage | 100 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Overlay on the picture: strength (0-100%) | How strongly the overlay covers the picture. 0 is none. | A whole number, as a percentage | none |
| ...fill | A single colour or a gradient of two. |
|
none |
| ...colour | Sets the colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| ...second colour (blank fades to clear) | The gradient's second colour. Empty fades to transparent. Offered only when ...fill is "Gradient (two colours)". | Any colour | none |
| ...direction | The direction of the gradient. Offered only when ...fill is "Gradient (two colours)". |
|
none |
| ...blend with the picture | How the overlay combines with the picture. Multiply darkens while keeping detail; Colour gives a duotone. |
|
none |
| ...on hover | What the overlay does when the pointer is over the picture. |
|
none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Image Wall
Blocks panel → Media · add-on key image_wall
The Image Wall add-on packs pictures into columns that drift slowly, each column at a slightly different speed, so the band moves like a pinned wall rather than one sheet. It is a decorative background for a hero or a section break.
- Pictures with descriptions and links; columns per screen; height; speed; tilt; resting opacity; faded edges.
- Browsing pictures one by one - use a Gallery.
When to use it
- A hero or band that suggests a large body of work: a portfolio, a school's activities, a product range.
When to choose another add-on
Procedure
- Add the pictures, with descriptions and optional links.
- Set the pictures per column.
- On the Style tab, set the columns, height, speed, tilt, gap and corner radius.
- Choose the edge fade and set Fade to this colour to the section background.
Behaviour on the page
- Each column repeats its pictures to move continuously.
- The wall is still for visitors who ask their device for reduced motion.
- Four pictures per column is usually enough.
- Set the fade colour to the section background; left empty, the wall fades to transparent, which suits a picture and not a flat colour.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Pictures | The pictures. Each row has a picture, a description for screen readers and an optional link. | Each row, in order:
|
none |
| Pictures per column | How many pictures each column holds before it repeats. | A whole number | 4 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Columns | Chooses the columns. Each value is described under Values. |
|
5 |
| Columns on a phone | Chooses the columns on a phone. Each value is described under Values. |
|
3 |
| Height (% of the window) | The band's height as a percentage of the window height. | A whole number, as a percentage | 70 |
| Seconds for one pass | Seconds for the first column to make one pass; later columns take a little longer. | A whole number | 44 |
| Tilt (degrees) | Rotates the whole wall, in degrees. | A whole number, in degrees | -4 |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Resting opacity (%) | The pictures' opacity at rest. | A whole number, as a percentage | 78 |
| Edges | Whether the wall fades out at its edges. |
|
Fade into the background at the edges |
| Fade to this colour | The colour the edges fade to. Set it to the section background. | Any colour | none |
| Hairline around each picture | Draws a hairline around each picture. | On or off | on |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Intro Curtain
Blocks panel → Media · add-on key curtain
The Intro Curtain add-on covers the page briefly with a name, a line and a logo, then opens - as doors, shutters, an iris, slats and other effects - to reveal it. It is a brand moment for launches and portfolios.
- Name, line and logo; nine openings and seven name entrances; hold and opening times; once per visit; colours, a seam and a texture.
- Waiting for the page to load - use the Loading Screen.
When to use it
- A launch, a portfolio home page, an event microsite.
When to choose another add-on
- A screen shown while a heavy page loads → use Loading Screen.
Procedure
- Write the name and line, and choose the logo and its height.
- Choose how it opens and how the name arrives.
- Set the hold before opening and the opening time.
- Leave Only once per visit on.
- On the Style tab, set the colours, size, weight, seam and texture.
Behaviour on the page
- It covers the whole screen wherever it sits on the page.
- With Only once per visit, moving to another page or returning skips it.
- Visitors who ask for reduced motion do not see the animation.
- If scripting is off, the curtain never leaves a page covered.
- Keep the total under a second and a half.
- Use one curtain per site, on the home page.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Name | The name on the curtain. Empty plays with the logo alone. | Text | none |
| Line underneath | The line underneath. | Text | none |
| Logo or icon | The picture used for the logo or icon. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Logo height (px) | Sets the logo height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 84 |
| How it opens | How the curtain opens. |
|
Doors - two halves part sideways |
| How the name arrives | How the name appears before the curtain opens. |
|
Drops in from above |
| Hold before opening (ms) | How long the name is shown before opening, in milliseconds. Under 600 it is not read; over 2000 visitors are waiting. | A whole number, in milliseconds | 1100 |
| Opening takes (ms) | How long the opening takes, in milliseconds. | A whole number, in milliseconds | 900 |
| Only once per visit | Plays it only on the first page of a visit. | On or off | on |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Curtain colour | Sets the curtain colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Second colour (optional gradient) | A second colour for a gradient curtain. | Any colour | none |
| Name colour | Sets the name colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Accent - the seam and the line | The colour of the seam and the line. | Any colour | none |
| Name size (px) | Sets the name size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 64 |
| Name weight | Chooses the name weight. Each value is described under Values. |
|
Extra bold |
| Letter spacing (px) | Sets the letter spacing, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 2 |
| Show a lit seam down the join | Draws a lit line down the join. | On or off | on |
| Texture over the curtain | A texture over the curtain. |
|
Flat |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Live Stream
Blocks panel → Media · add-on key livestream
The Live Stream add-on shows a live video player while a channel is on air and a fallback picture, message and button when it is not. For YouTube, whether the channel is live can be detected automatically with the site's API key; for other platforms, the state is set by hand.
- YouTube, Twitch, Kick, Vimeo, Trovo and DLive; automatic detection for YouTube; a fallback with text or a countdown to the next stream; a LIVE badge.
- Automatic detection for platforms other than YouTube.
When to use it
- Services, matches, classes or shows streamed on a schedule.
When to choose another add-on
- Recorded videos → use Video Playlist.
Procedure
- Choose the platform and enter the channel. For YouTube, use the channel ID beginning UC, from YouTube Studio → Settings → Channel → Advanced.
- Choose how the live state is decided.
- Set the fallback picture and choose text or a countdown over it.
- Write the off-air line, the next stream time and the button.
- On the Style tab, set the shape, radius, colours and badge.
Behaviour on the page
- "Work it out" works only for YouTube, and only with an API key set in the component's options.
- Other platforms show the fallback until you choose "Always show the player".
- The next stream time is read as UTC unless an offset is given.
- Switch to "Always show the player" shortly before a stream on platforms without detection, and back afterwards.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| YouTube is never detected as live. | The channel is a @handle rather than the UC channel ID, or no API key is set. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Platform | Chooses the platform. Each value is described under Values. |
|
YouTube / YouTube Gaming |
| Channel | The channel on the chosen platform. YouTube needs the channel ID beginning UC. | Text | none |
| When is it live | Whether the player shows automatically (YouTube only), always, or never. |
|
Work it out (YouTube only - needs the site API key) |
| Fallback picture | The picture shown when the channel is not live. | A picture | none |
| Over the fallback | What is shown over the fallback picture. |
|
A line of text |
| Off-air line | The line shown when the channel is not live. | Text | Off air. Back Thursday. |
| Next stream at | The next stream's date and time, for the countdown, for example 2026-09-18 20:00 +0530. |
Text | none |
| Button under it | The button under it. | Text | none |
| Button link | The button link. | Text | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Shape | Chooses the shape. Each value is described under Values. |
|
Widescreen |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
| Accent colour | Sets the accent colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Fallback background | Sets the fallback background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Show the LIVE badge | Shows a LIVE badge while the player is shown. | On or off | on |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Map
Blocks panel → Media · add-on key map
The Map add-on shows a location on an embedded map with a pin, from OpenStreetMap (which sets no cookies) or Google Maps. Neither needs an API key. A link beneath opens the location in a full map application for directions.
- One location by latitude and longitude; place name, zoom, height and caption; a link to Google Maps, OpenStreetMap or both.
- Several pins, routes or custom map styles.
When to use it
- The contact page, an event venue, a branch location.
When to choose another add-on
- A list of addresses with icons → use Icon List.
Procedure
- Find the location in any map site and copy its latitude and longitude (right-click the spot in most map sites).
- Enter them, with the place name.
- Set the zoom (15 to 17 suits a building) and the height.
- Write a caption with the address in words.
- On the Style tab, choose what tapping the map opens and the link wording.
Behaviour on the page
- OpenStreetMap sets no cookies. Google Maps may set Google's cookies once it loads; consider this for your cookie notice.
- The place name labels the pin when the map is opened in the map application.
- Always include the address in words; some visitors cannot use an embedded map.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The pin is in the sea. | Latitude and longitude are swapped, or a minus sign is missing for locations west of Greenwich or south of the equator. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Map to show | Which map service draws the map. |
|
OpenStreetMap (no cookies, no API key) |
| Latitude | The latitude, in decimal degrees, for example 51.5072. |
Text | 28.6139 |
| Longitude | The longitude, in decimal degrees, for example -0.1276. |
Text | 77.2090 |
| Place name (optional — labels the pin when the map is opened) | The name shown on the pin when the map is opened in the map application. | Text | none |
| Zoom (1–19) | From 1 (the whole world) to 19 (a single building). | A whole number (1–19) | 15 |
| Height (px) | Sets the height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 360 |
| Caption below map | A caption under the map. Give the address in words. | Text | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Tapping the map opens | Which map application the link opens. |
|
Google Maps |
| Link text | The words of the link under the map. | Text | Open in {map} |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 10 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Metro 360
Blocks panel → Media · add-on key spin360
The Metro 360 add-on is a turntable: a numbered set of photographs of one object, taken at even steps around it, that visitors turn by dragging, swiping or with the arrow keys. It can also turn by itself, or turn as the page scrolls with cards passing alongside to tell a story.
- Frames listed, or a numbered pattern; several rows for tilting.
- Drag, automatic or scroll-driven turning; direction, speed, sensitivity, momentum and partial sweeps.
- Lazy or click-to-load; a hint; zoom; full screen; play/pause.
- Scroll-story cards on the left and right.
- Spherical 360 photographs of a place - use the Metro Panorama.
When to use it
- Products where shape matters: vehicles, footwear, furniture, equipment.
When to choose another add-on
- A 360 photo of a place → use Metro Panorama.
- A still picture with labels → use Product Callouts.
Procedure
- Add the frames in order, or enter a pattern such as
images/bike/bike-{n}.jpgwith the count, first number and digits. - Describe the object for screen readers.
- Choose how it turns, and set automatic turning, speed and direction.
- Set the drag options, loading, hint, zoom and buttons.
- For scroll mode, add the cards that pass alongside and the number of turns.
- On the Style tab, set the size, shape, backdrop and colours.
Behaviour on the page
- Automatic turning never runs for visitors who ask their device for reduced motion.
- Loading "when it comes into view" keeps the page light until someone reaches it.
- With several rows, dragging up and down tilts the object.
- Shoot 24 to 72 frames at even steps with the camera and lights fixed; every frame the same size.
- Leave the mouse wheel off; a wheel that turns the product instead of scrolling surprises people.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The object jumps between frames. | Frames are missing or out of order. Check the count, first number and digits. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| How it turns | Whether visitors drag it, it turns by itself, or it turns as the page scrolls. |
|
Drag to turn it |
| Pictures, in the order they go round | The photographs, in the order they go round. | Each row, in order:
|
none |
| ...or a numbered set: the address with {n} for the number | A numbered set of files, with {n} where the number goes. Used when the list is empty. |
Text | media/com_metropagebuilder/images/MetroPageBuilder_ind01_{n}.webp |
| How many in the set | The number of files in the set. | A whole number | 12 |
| First number in the set | The number of the first file. | A whole number | 1 |
| Digits in the number (2 = 01, 02 ...) | Digits in the number: 2 gives 01, 02 and so on. | A whole number (2 = 01, 02 ...) | 2 |
| Rows (pictures taken from more than one height) | The number of heights the photographs were taken from. | A whole number (pictures taken from more than one height) | 1 |
| What it shows (read out to screen readers) | The what it shows. | Text | A motorcycle you can turn |
| Turn on its own | When it turns by itself. Offered only when How it turns is "Drag to turn it". |
|
One full turn when it first comes into view |
| Seconds for one full turn | Sets the seconds for one full turn. Leave it empty to use the add-on's default. Offered only when How it turns is "Drag to turn it" or "Keeps turning on its own". | A whole number | 4 |
| Direction | Chooses the direction. Each value is described under Values. |
|
Clockwise |
| Picture to start on (number) | The frame shown first. | A whole number (number) | 1 |
| Reverse the drag direction | Reverses the drag direction. Offered only when How it turns is "Drag to turn it". | On or off | off |
| Drag across the whole width for (turns) | Turns per drag across the full width. 0.5 is twice as sensitive as 1. Offered only when How it turns is "Drag to turn it". | A whole number (turns) | 1 |
| Keep turning a little after a flick | Keeps it turning briefly after a flick. Offered only when How it turns is "Drag to turn it". | On or off | on |
| Turns all the way round (untick for a partial sweep) | Turns all the way round. Untick for a partial sweep. | On or off | on |
| The mouse wheel turns it (while the pointer is over it) | Lets the mouse wheel turn it. Offered only when How it turns is "Drag to turn it". | On or off | off |
| Load the pictures | When the photographs are downloaded. Offered only when How it turns is "Drag to turn it" or "Keeps turning on its own". |
|
When it comes into view |
| Show "Drag to turn" until it has been turned | Shows "Drag to turn" until it is first turned. Offered only when How it turns is "Drag to turn it". | On or off | on |
| Zoom | Whether a click zooms in. Offered only when How it turns is "Drag to turn it". |
|
Click to zoom in, and move the pointer to look around |
| Show a full-screen button | Switches on or off: show a full-screen button. Offered only when How it turns is "Drag to turn it" or "Keeps turning on its own". | On or off | on |
| Show a play / pause button for the automatic turn | Switches on or off: show a play / pause button for the automatic turn. Offered only when How it turns is "Drag to turn it" or "Keeps turning on its own". | On or off | on |
| Heading over the story | The heading over the story. Offered only when How it turns is "Turns as the page scrolls, with cards alongside". | Text | Technology |
| Cards that pass alongside | For scroll mode, the cards that pass alongside. Each has a side, an optional picture, a title and text. Offered only when How it turns is "Turns as the page scrolls, with cards alongside". | Each row, in order:
|
4 sample entries |
| Turns over the whole story | For scroll mode, the turns made while the cards pass. Offered only when How it turns is "Turns as the page scrolls, with cards alongside". | A whole number | 1 |
| Space between cards (px) | For scroll mode, the space between cards. More space is a slower turn. Offered only when How it turns is "Turns as the page scrolls, with cards alongside". | A whole number, in pixels | 260 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Size | Chooses the size. Each value is described under Values. Offered only when How it turns is "Drag to turn it" or "Keeps turning on its own". |
|
none |
| Shape of the frame | Chooses the shape of the frame. Each value is described under Values. Offered only when How it turns is "Drag to turn it" or "Keeps turning on its own". |
|
Widescreen 16:9 |
| Behind it | A disc, glow or floor shadow behind the object. |
|
None |
| ...colour | Sets the colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Behind it is "A round disc behind it" or "A soft glow behind it" or "A shadow on the floor". | Any colour | none |
| Background | The background. Empty lets the section show through. | Any colour | none |
| Border | Chooses the border. Each value is described under Values. Offered only when How it turns is "Drag to turn it" or "Keeps turning on its own". |
|
Borderless |
| Border colour | Sets the border colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Border is "Thin border" or "Thick border". | Any colour | none |
| Corners | Chooses the corners. Each value is described under Values. Offered only when How it turns is "Drag to turn it" or "Keeps turning on its own". |
|
Slightly curved corners |
| Shadow | Chooses the shadow. Each value is described under Values. |
|
none |
| ...shadow colour (blank = navy) | Sets the shadow colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Shadow is "Subtle" or "Medium" or "Strong" or "Soft: hairline edge" or "Soft: card (iOS style)" or "Soft: floating (macOS window)" or "Soft: raised sheet" or "Soft: deep (dialog)" or "Soft: pressed in". | Any colour | none |
| Highlight colour (progress bar, buttons) | Sets the highlight colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Card background | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. Offered only when How it turns is "Turns as the page scrolls, with cards alongside". | Any colour | none |
| Card text colour | Sets the card text colour. Leave it empty to use the colour the section or the site template already gives. Offered only when How it turns is "Turns as the page scrolls, with cards alongside". | Any colour | none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Metro Image Slider
Blocks panel → Media · add-on key image_slider
The Metro Image Slider add-on presents a large set of photographs - a portfolio, a class, a results board - as a grid or a side-scroller, with a heading, titles and subtitles, six frame shapes, and a "View All" button that reveals the rest in place, in a pop-up, or on another page.
- Photos with title, subtitle and link.
- A grid or a side-scroller with arrows, one to six across per screen size.
- Rows shown before "View All", and what the button does.
- Seven picture shapes, fill or fit, six frames, title positions, borders, hover and entrance effects.
- Mixed tile sizes - use the Mosaic.
When to use it
- Toppers and results boards, staff and student photos, product ranges, portfolios.
When to choose another add-on
- A simple album → use Gallery.
- Mixed tile sizes → use Mosaic.
- People with biographies → use Team / Staff.
Procedure
- Write the heading and sub-heading, and choose the alignment and rule.
- Add a row per photo: picture, title, subtitle and optional link.
- Choose the grid or side-scroller and the number across on each screen size.
- Set how many rows show before "View All", and what the button does.
- On the Style tab, choose the picture shape, fit, frame, title position and effects.
Behaviour on the page
- "Open the rest in place" expands the grid; "Open every photo in a pop-up" shows the full set over the page.
- A button link sends the button to another page instead.
- Photos are cropped to the chosen shape so rows align.
- Use "Over the image, on hover only" titles only where the title is not essential; touch screens have no hover.
- Circle frames suit portraits; hearts and hexagons suit informal sets.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Photos | The photos. Each row has a picture, a title, a subtitle (a percentage, a class, a caption) and an optional link. | Each row, in order:
|
none |
| Section heading | The section heading. | Text | Our Toppers |
| Section sub-heading | The section sub-heading. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| Heading alignment | Chooses the heading alignment. Each value is described under Values. |
|
Center |
| Rule under the heading | Draws a short rule under the heading. | On or off | on |
| Layout | A grid, or a single row that scrolls sideways with arrows. |
|
Grid |
| Across — desktop | Chooses the across — desktop. Each value is described under Values. |
|
4 |
| Across — tablet | Chooses the across — tablet. Each value is described under Values. |
|
3 |
| Across — mobile | Chooses the across — mobile. Each value is described under Values. |
|
2 |
| Rows shown before "View All" (0 shows everything) | Rows shown before the "View All" button. 0 shows every photo. | A whole number (0 shows everything) | 2 |
| What "View All" does | What "View All" does. |
|
Open the rest in place |
| Button text | The button text. | Text | View All |
| Button link — set this and the button goes to that page instead | A page for the button to open instead of revealing the rest. | Text | none |
| Movement | "Slide by slide" settles each slide into place; "Free scroll" stops wherever the visitor lets go. |
|
Slide by slide |
| At the last slide | What happens after the last slide: return to the first, or stop. |
|
Stop at the end |
| Let the mouse wheel move the slider | Lets a mouse wheel or trackpad move the slider sideways. The page scrolls normally once the slider reaches either end. | On or off | off |
| Slide effect | A visual treatment of the slides near the current one: fading them, bringing the current one forward, a cover-flow or a deck. Effects add no downloads. |
|
Natural scrolling |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Image shape (aspect ratio) | The shape every photo is cropped to. "Original proportions" does not crop. |
|
1:1 — square |
| How the photo fills that shape | Whether photos fill their shape by cropping, or fit inside it. |
|
Fill and crop |
| Frame | The frame each photo sits in. |
|
Rounded corners |
| Corner radius (px) — for the rounded frame | The corner radius, for the rounded frame. | A whole number, in pixels | 10 |
| Largest photo width (px, 0 = fill the column) | The largest width of each photo. 0 fills the column. | A whole number, in pixels | 0 |
| Gap between photos (px) | Sets the gap between photos, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 20 |
| Title position | Where the title and subtitle sit. |
|
Below the image |
| Title alignment | Chooses the title alignment. Each value is described under Values. |
|
Center |
| Title size (px) | Sets the title size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 17 |
| Title colour | Sets the title colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Subtitle size (px) | Sets the subtitle size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 15 |
| Subtitle colour | Sets the subtitle colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Photo border (px) | Sets the photo border, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Photo border colour | Sets the photo border colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Card shadow | Switches on or off: card shadow. | On or off | off |
| Hover effect | What a photo does when the pointer is over it. |
|
Zoom the photo |
| Entrance animation | How photos appear as they scroll into view. |
|
none |
| Legacy dots | The dots used by earlier versions. Kept for pages built with them; use Slide indicators instead. | On or off | none |
| Show previous and next arrows | Shows previous and next buttons. | On or off | on |
| Arrow icon | The icon drawn on the arrow buttons. |
|
Chevron |
| Arrow position | Where the arrow buttons sit relative to the slider. |
|
Just outside the slider |
| Arrow button size (px) | Sets the arrow button size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 42 |
| Arrow colour | Sets the arrow colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Arrow background | Sets the arrow background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Slide indicators | The markers that show which slide is current and let the visitor jump to another. |
|
None |
| Indicator position | Where the markers sit. |
|
Inside, along the bottom |
| Indicator alignment | Chooses the indicator alignment. Each value is described under Values. |
|
Center |
| Indicator colour | Sets the indicator colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Current indicator colour | The colour of the marker for the current slide. | Any colour | none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Metro Panorama
Blocks panel → Media · add-on key panorama
The Metro Panorama add-on presents 360-degree photographs visitors can look around - including up and down - and wide partial panoramas to pan across, with zoom, a slow automatic turn, full screen, download and a credit line. Several panoramas form a tour, and a folder of pictures can supply them all.
- Scenes with title, credit, type, coverage and starting direction, or every picture in a folder.
- Lazy or click-to-load; automatic turn; starting zoom; wheel zoom; download; full screen; captions.
- Objects turned on a turntable - use the Metro 360.
- Camera-native files such as .insp or dual-fisheye images - export them first.
When to use it
- Hotel rooms, venues, campuses, property and travel.
When to choose another add-on
Procedure
- Add a row per scene: picture, title, credit. Leave the type on "Work it out"; a picture twice as wide as tall is treated as a full 360.
- For a partial panorama, enter the degrees it covers.
- Or give a folder under images/; its pictures are shown in name order.
- Choose when the picture loads, and the automatic turn, speed and starting zoom.
- Choose whether the wheel zooms and whether download, full screen and captions show.
- On the Style tab, set the size, shape, radius and control colour.
Behaviour on the page
- Visitors look around by dragging, swiping or the arrow keys, and zoom with buttons, a slider, pinching, or + and -.
- Automatic turning stops the moment the visitor takes over, and never runs for visitors who ask for reduced motion.
- With several scenes, visitors move between them as a tour.
- Export 360 photos as a flat equirectangular JPG (2:1), around 6000 × 3000 pixels.
- Credit the photographer in the credit field when using others' images.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The picture looks stretched. | It is a partial panorama treated as a full 360. Set its type and the degrees it covers. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Panoramas | The panoramas. Each row has a picture, a title, a credit, the kind of picture, the degrees it covers and the starting direction. | Each row, in order:
|
3 sample entries |
| ...or every picture in a folder | A folder under images/ whose pictures are shown in name order. Used instead of the list. | Text | none |
| Load the picture | When the picture is downloaded. |
|
When it scrolls into view |
| Turn slowly by itself | Turns the view slowly until the visitor takes over. | On or off | on |
| Turning speed (degrees a second) | The automatic turning speed, in degrees a second. | A whole number, in seconds | 4 |
| Starting zoom (field of view, degrees: smaller is closer) | The starting zoom, as a field of view in degrees. Smaller is closer. | A whole number, in degrees | 80 |
| Zoom with the mouse wheel | Lets the mouse wheel zoom. Off keeps the wheel scrolling the page. | On or off | off |
| Offer the picture as a download | Offers the picture as a download. | On or off | on |
| Full-screen button | Switches on or off: full-screen button. | On or off | on |
| Show the title and credit | Shows the title and credit along the bottom. | On or off | on |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Size | Chooses the size. Each value is described under Values. |
|
none |
| Shape | Chooses the shape. Each value is described under Values. |
|
Wide 16:9 |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Control colour | Sets the control colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Metro Slideshow
Blocks panel → Media · add-on key slideshow
The Metro Slideshow add-on presents pictures and videos (YouTube, Vimeo or a file) in one slideshow, with 24 transition effects including 3D cubes and tiles, a slow zoom, and a choice of bullets, numbers or thumbnails to pick a slide. At full size it becomes a screen-tall hero.
- Slides with a picture, a video, or both; title, caption and link.
- 24 effects, effect length, slow zoom, autoplay, pause on hover and loop.
- Bullets, numbers or thumbnails in eight positions, with previews, a progress bar, play/pause, full screen, counter and keyboard control.
- Seven caption placements, videos in a lightbox or inline, six sizes and seven shapes.
- Several slides visible at once - use Carousel Pro.
When to use it
- A hero or feature slideshow mixing photographs and video.
- A product or property showcase with thumbnails.
When to choose another add-on
- A simple banner → use Carousel / Banner.
- Several cards at once → use Carousel Pro.
- A video library → use Video Playlist.
Procedure
- Add a row per slide: a picture, a video link if the slide is a video (leave the picture empty to use the video's thumbnail), a title, a caption and a link.
- Choose the effect and its length, and whether pictures zoom slowly.
- Set autoplay, seconds per slide, pause on hover and loop.
- Choose the selectors and their position, and the controls to show.
- Choose the caption placement and how video slides play.
- On the Style tab, set the size, shape, fit, border, corners, shadow and colours.
Behaviour on the page
- Autoplay and slow zoom never run for visitors who ask their device for reduced motion.
- Video slides open in a lightbox by default, so the slideshow keeps its place.
- Edge-to-edge size fills the full width and screen height; place it in a full-width section.
- An effect length of 0.6 to 1.2 seconds reads as smooth; tile effects look best around 1.2.
- Thumbnails suit property and product sets; bullets suit heroes.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Slides | The slides. Each row has a picture, a video link or file, a title, a caption and a link for the whole slide. | Each row, in order:
|
3 sample entries |
| Effect between slides | The transition between slides. |
|
Fade |
| Effect length (seconds) | How long the transition takes, in seconds. | A whole number, in seconds | 0.9 |
| Slow zoom on pictures (Ken Burns) | Zooms and drifts each picture slowly while it is shown. | On or off | off |
| Play automatically | Switches on or off: play automatically. Never for visitors who have asked their device to reduce motion. | On or off | on |
| Seconds on each slide | Sets the seconds on each slide. Leave it empty to use the add-on's default. Offered only when Play automatically is "1". | A whole number | 5 |
| Pause while the pointer is over it | Pauses autoplay while the pointer is over the slideshow. Offered only when Play automatically is "1". | On or off | on |
| After the last slide, go back to the first | Switches on or off: after the last slide, go back to the first. | On or off | on |
| Pick a slide with | How visitors pick a slide. |
|
Bullets |
| ...shown | Where the selectors sit. Offered only when Pick a slide with is "Bullets" or "Numbers" or "Thumbnail pictures". |
|
Over the slide, at the bottom |
| Preview a slide when hovering its bullet or number | Shows a small preview of a slide when its bullet or number is hovered. Offered only when Pick a slide with is "Bullets" or "Numbers". | On or off | on |
| Previous / next arrows | Chooses the previous / next arrows. Each value is described under Values. |
|
Shown when the pointer is over the slideshow |
| Show a bar counting down to the next slide | Shows a bar counting down to the next slide. Offered only when Play automatically is "1". | On or off | on |
| Show a play / pause button | Switches on or off: show a play / pause button. | On or off | on |
| Show a full-screen button | Switches on or off: show a full-screen button. | On or off | on |
| Show the slide number ("3 / 8") | Shows the slide number, for example 3 / 8. | On or off | off |
| Arrow keys change slide (while the slideshow has focus) | Lets the arrow keys change slide while the slideshow has focus. | On or off | on |
| Captions | Where titles and captions sit. |
|
Over the slide, at the bottom |
| When a video slide is played | Whether video slides play large over the page or inside the slide. |
|
Open it large, over the page |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Size | The slideshow's width, from small and centred to edge to edge. |
|
none |
| Shape | The slideshow's shape. Offered only when Size is "Small (up to 560px, centred)" or "Medium (up to 880px, centred)" or "Large (up to 1200px, centred)" or "Fill its column" or "Wider than the text (up to 1400px)". |
|
Widescreen 16:9 |
| Fixed height (px, empty = use the shape) | A fixed height in pixels, overriding the shape. | A whole number, in pixels | none |
| Pictures | Whether pictures fill the frame by cropping, or show whole with bars. |
|
Fill the frame (may crop) |
| Border | Chooses the border. Each value is described under Values. |
|
Borderless |
| Border colour | Sets the border colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Border is "Thin border" or "Thick border" or "Photo frame (wide, light)". | Any colour | none |
| Corners | The corner style. |
|
Slightly curved corners |
| ...or an exact corner radius (px) | An exact corner radius, overriding the corner style. | A whole number, in pixels | none |
| Shadow | Chooses the shadow. Each value is described under Values. |
|
none |
| ...shadow colour (blank = navy) | Sets the shadow colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Shadow is "Subtle" or "Medium" or "Strong" or "Soft: hairline edge" or "Soft: card (iOS style)" or "Soft: floating (macOS window)" or "Soft: raised sheet" or "Soft: deep (dialog)" or "Soft: pressed in". | Any colour | none |
| Background (behind pictures that do not fill) | The colour behind pictures that do not fill the frame. | Any colour | #0b1220 |
| Highlight colour (current slide, progress bar) | The colour of the current selector and the progress bar. | Any colour | none |
| Bullet / number colour | Sets the bullet / number colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Thumbnail size (px) | Sets the thumbnail size, in pixels. Leave it empty to use the add-on's default. Offered only when Pick a slide with is "Thumbnail pictures". | A whole number, in pixels | 84 |
| Arrow style | Chooses the arrow style. Each value is described under Values. |
|
Round button |
| Caption background | The colour behind captions. Empty lays a soft dark shade. | Any colour | none |
| Caption text colour | Sets the caption text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Title size (px) | Sets the title size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Thumbnail quality | The size of the thumbnail taken from YouTube when no poster is set. The highest quality suits a hero; smaller sizes suit cards and dense grids, where the larger download would be wasted. |
|
Highest available - best for a hero, largest download |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Metro Switch Hero
Blocks panel → Media · add-on key switch_hero
The Metro Switch Hero add-on is a full-screen hero for a product with variants - flavours, colours, finishes. One product stands large in the middle with its name in giant letters behind it, a line and a button beneath, and a row of swatches in a corner. Choosing a swatch changes the whole screen: the background and the colour of every word fade to the variant's own, the product drops in and settles, then floats and sways as if hanging in the air, and a garnish floats beside it. The giant letters answer the pointer: they blur, scatter, lift, turn to outline or brighten where it passes, or the whole word tilts towards it. A slide can instead be split - a picture beside a headline - for an opening screen that shows the whole range.
- Slides with a giant word, a headline, a line, a product picture, a garnish, colours, a swatch and a button.
- Six pointer effects on the letters, four arrivals and three idle motions for the product.
- Swatches in four places with a label, up and down arrows, and an optional automatic change.
- The site-wide typography for the giant word and headline.
- Video - use the Video Hero.
- Several products on one slide - a split slide shows one picture, which can be a group.
When to use it
- The first screen of a brand with a small range: ice cream, drinks, sneakers, paint.
- A product page where the variants are the point.
When to choose another add-on
- A slideshow of pictures and videos → use Metro Slideshow.
- A banner of slides with words → use Carousel / Banner.
- A still hero picture with words → use Image & Content.
Procedure
- Add a slide per variant: the giant word, a line, the product picture (a cut-out on a transparent background works best), a garnish, the background colour, the colour of the words and button, a swatch picture and the button.
- For an opening screen, add a slide with the layout "split", a headline and a picture of the whole range; leave its giant word empty.
- Choose the pointer effect, how the product arrives and how it moves afterwards.
- Write the words above the swatches and choose where the swatches sit.
- On the Style tab, set the word size and strength, the product size and tilt, the button and the swatch size; set the font with the typography settings.
- Place it in a full-width section with no padding; under a transparent header, pull the section up by the header's height.
Behaviour on the page
- The first slide shows without the script; the swatches, arrows and pointer effects need it.
- A long word is made smaller so it always fits across the screen.
- The letters answer a mouse or pen only; on a touch screen, and for visitors who ask for less motion, they stay still, the product appears without dropping and does not float, and the automatic change does not run.
- The automatic change stops for good the moment a visitor picks a swatch, and pauses while the pointer or keyboard focus is inside the hero.
- The giant letters are hidden from screen readers; each slide's name is a real heading, visually hidden. The swatches are buttons named after their slides.
- Use pictures of the same size and framing, so the product stays in place from one variant to the next.
- Keep backgrounds light, or check the site header over the darkest: a transparent header keeps its own colours whatever the hero does.
- Blur suits a calm brand; scatter and lift suit a playful one.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The swatches do nothing. | The page's script is blocked or failed. Check the browser console. |
| The menu disappears over one slide. | That slide's background is dark and the header is transparent. Lighten the slide or give the header a background. |
| The product covers the words. | Lower the product height, or shorten the line under it. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Slides | The slides. Each has the giant word, a headline, a line under the product, the product picture, a garnish, the background colour, the colour of the word and button, a swatch picture (blank draws a dot of the colour), the button words and link, and the layout: center or split. | Each row, in order:
|
3 sample entries |
| Heading level of each slide's name | The heading level of each slide's name. H1 on a page's first screen. |
|
H2 |
| Height | The whole screen, most of it, or as tall as the content needs. |
|
The whole screen |
| The giant word, under the pointer | What the giant letters do near the pointer. |
|
Letters blur near the pointer |
| The product arrives | How the product arrives when its slide is chosen. |
|
Drops in from above and settles |
| Then the product | What the product does after it arrives. |
|
Floats and sways, as if hanging in the air |
| Words above the swatches | Words above the swatches, such as "Choose your flavour". | Text | Choose your flavour |
| Swatches sit | Where the swatches sit. On a phone they sit at the bottom, centred. |
|
Bottom right |
| Show up and down arrows | Shows buttons for the previous and next slide. | On or off | on |
| Change on its own every (seconds, 0 = never) | Changes slide on its own every so many seconds. 0 never does. | A whole number, in seconds | 0 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Giant word size (% of the screen width) | The giant word's size, as a percentage of the screen width. | A whole number, as a percentage | 22 |
| Giant word strength (%) | The giant word's strength, as a percentage. | A whole number, as a percentage | 100 |
| Product height (% of the screen height) | The product's height, as a percentage of the screen height. | A whole number, as a percentage | 58 |
| Product tilt (degrees) | The product's tilt, in degrees. | A whole number, in degrees | -10 |
| Soft shadow under the product | Draws a soft shadow under the product. | On or off | on |
| Button | The button's design. |
|
A pill with a round arrow beside it |
| Swatch size (px) | The swatches' size, in pixels. | A whole number, in pixels | 50 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Mosaic
Blocks panel → Media · add-on key mosaic
The Mosaic add-on arranges pictures in a designed grid of mixed sizes, some wide, some tall, with captions over, under or on hover. Each picture sets how many columns and rows it spans; spans scale down on phones so the composition keeps its proportions.
- Pictures with captions, links and spans; grid columns on desktop and phone; row height; captions; a resting treatment.
- A lightbox viewer - use the Gallery.
When to use it
- A portfolio or project grid that should look composed.
- Category tiles on a home page.
When to choose another add-on
- An even album with a viewer → use Gallery.
- Drifting columns → use Image Wall.
Procedure
- Add a row per picture: picture, caption, second line, link, columns wide and rows tall.
- On the Style tab, choose the grid columns on desktop and phone, the row height, gap and radius.
- Choose the caption position and, for overlaid captions, the darkening behind them.
Behaviour on the page
- Spans are scaled to the phone grid, so a tile that is half the grid on a laptop is still half on a phone.
- Six columns divides into halves and thirds without leftovers.
- Vary spans, but keep each row adding up to the column count.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Gaps appear in the grid. | A row's spans do not add up to the grid columns. Adjust the widths. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Pictures | The pictures. Each row has a picture, a caption, a second line, an optional link, and how many columns wide and rows tall it spans. | Each row, in order:
|
none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Grid columns | The number of columns the grid is divided into. |
|
6 |
| Grid columns on a phone | The number of grid columns on phones; spans are scaled to it. |
|
4 |
| Row height (px) | The height of one grid row, in pixels. | A whole number, in pixels | 160 |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 12 |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 10 |
| Captions | Where captions sit. |
|
Over the picture, at the bottom |
| Caption colour | Sets the caption colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Darken behind an overlaid caption (%) | For overlaid captions, how much the picture is darkened behind them. | A whole number, as a percentage | 55 |
| Resting treatment | The pictures' appearance at rest; hovering restores full colour. |
|
none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Music Player
Blocks panel → Media · add-on key music_player
The Music Player add-on plays a playlist without leaving the page: your own audio files, or tracks from SoundCloud, Suno, Spotify, Apple Music, Bandcamp, Mixcloud, YouTube or Vimeo. Six skins range from a single bar to a spinning vinyl record.
- Tracks with title, artist and artwork; next-track and loop; optional download of your own files; six skins.
- Mixing sources within one player.
- Protecting your files from being saved - streamed files are harder, not impossible, to download.
When to use it
- A musician, podcast, church or school choir site.
When to choose another add-on
- Video → use Video Playlist.
Procedure
- Choose where the music comes from.
- Add a row per track: title, artist, the file or link, and artwork.
- Choose whether the next track plays automatically, the playlist loops, artwork shows, and your own files may be downloaded.
- On the Style tab, choose the skin and colours.
Behaviour on the page
- Your own files are streamed rather than offered as links, unless downloads are allowed.
- Service tracks use that service's own player; the embed height applies to them.
- Upload compressed audio (MP3 or AAC around 192 kbps); uncompressed files are slow to start.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Music from | Where every track in this player comes from. |
|
My own files (streamed, not directly downloadable) |
| Tracks | The tracks. Each row has a title, an artist, the file or link and artwork. | Each row, in order:
|
none |
| Heading | The heading. | Text | none |
| Play the next track automatically | Starts the next track when one ends. | On or off | on |
| Loop the playlist | Returns to the first track after the last. | On or off | off |
| Show artwork | Switches on or off: show artwork. | On or off | on |
| Allow visitors to download my own files | Offers a download link for your own files. | On or off | off |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Skin | The player's appearance. |
|
Card — artwork above the controls |
| Accent colour | Sets the accent colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Background | Sets the background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
| Artwork size (px) | The size of the artwork. | A whole number, in pixels | 150 |
| Embed height (px, services only) | The height of a service's embedded player. | A whole number, in pixels | 166 |
| Largest width (px, 0 = full) | The largest width of the player. 0 fills the column. | A whole number, in pixels | 0 |
| Thumbnail quality | The size of the thumbnail taken from YouTube when no poster is set. The highest quality suits a hero; smaller sizes suit cards and dense grids, where the larger download would be wasted. |
|
Highest available - best for a hero, largest download |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Product Callouts
Blocks panel → Media · add-on key product_callouts
The Product Callouts add-on places numbered dots on a picture; each dot opens a short note about that point. It explains features on equipment, rooms on a floor plan or ingredients on a dish, keeping the explanation next to the thing described.
- One picture; callouts with title, description, side and position; a two-part heading; colours, sizes and a scroll reveal.
- A video behind the dots - use Video Product Callouts.
When to use it
- Product features, anatomy, floor plans, a dish's ingredients.
When to choose another add-on
- The same over a video → use Video Product Callouts.
- A feature list with a picture → use Image & Content.
Procedure
- Choose the picture and write its alt text.
- Write the heading and its second part.
- Add a row per callout: title, description, the side its note opens to, and the dot's position across and down as percentages of the picture.
- On the Style tab, set the colours, picture width, least height and dot size, and whether callouts reveal on scroll.
Behaviour on the page
- Dots are placed as percentages, so they stay on the right spot as the picture resizes.
- On phones the notes are listed under the picture instead of floating over it.
- Find a position by estimating: 50 across and 50 down is the centre.
- Five to eight callouts at most.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| A dot is in the wrong place on phones. | The picture has been cropped by the least height. Lower it, or use a picture with the subject centred. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| The product | The picture used for the the product. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Alt text | The alt text. | Text | none |
| Callouts | The callouts. Each row has a title, a description, the side the note opens to, and the dot's position across and down from 0 to 100. | Each row, in order:
|
none |
| Heading | The heading. | Text | none |
| Heading, second part | A second part of the heading, shown in the accent colour. | Text | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Dot and line colour | The colour of the dots and the lines to the notes. | Any colour | none |
| Feature colour | Sets the feature colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Picture width (%) | The picture's width, as a percentage of the add-on. | A whole number, as a percentage | 38 |
| Least height (px) | The least height of the stage, in pixels. | A whole number, in pixels | 520 |
| Dot size (px) | Sets the dot size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
| Reveal the callouts on scroll | Shows the callouts one after another as they scroll into view. | On or off | on |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Ticker
Blocks panel → Media · add-on key ticker
The Ticker add-on moves a band of short phrases sideways - headlines, opening hours, what is on - separated by a mark of your choice. Large outlined or tilted letters turn it into a decorative ribbon across a section.
- Phrases one per line, a link for the band, direction, speed, pause on hover, letters solid or outlined, separators, case, spacing, tilt and faded ends.
- A separate link per phrase.
When to use it
- Announcements that are useful at a glance.
- A decorative band of keywords between sections.
When to choose another add-on
- A notice that must be read → use Alert / Notice.
- Moving logos → use Client Logos.
Procedure
- Enter one short phrase per line.
- Optionally link the whole band to a page.
- On the Style tab, set the direction, speed, pause, size, weight and letters.
- Choose the separator and its colour, and whether the ends fade.
Behaviour on the page
- The band is still for visitors who ask their device for reduced motion.
- Screen readers read the phrases once, not repeatedly.
- Under about fifteen seconds per pass, the words become decoration rather than something anyone reads.
- A tilt of one or two degrees turns the band into a ribbon.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Phrases — one per line | The phrases, one per line. Keep them short. | Several lines of text | Strategy Delivery Assurance Support |
| Link the whole band to | A page the whole band links to. | Text | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Travels | Chooses the travels. Each value is described under Values. |
|
Right to left |
| Seconds for one pass | Seconds for one pass. Longer is slower. | A whole number | 28 |
| Stop while the pointer is over it | Stops the band while the pointer is over it, so a phrase can be read. | On or off | on |
| Text size (px) | Sets the text size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 54 |
| Weight | Chooses the weight. Each value is described under Values. |
|
800 |
| Letters | Whether letters are solid, outlined, or alternate phrase by phrase. |
|
Solid |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Outline colour | The colour of outlined letters. | Any colour | none |
| Outline width (px) | The width of the outline. | A whole number, in pixels | 1 |
| Between phrases | The mark placed between phrases. |
|
A round dot |
| Separator colour | Sets the separator colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Space around the separator (px) | Sets the space around the separator, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 36 |
| Upper case | Switches on or off: upper case. | On or off | on |
| Letter spacing (px) | Letter spacing, in pixels. | A whole number, in pixels | 0 |
| Tilt (degrees) | Rotates the band, in degrees. | A whole number, in degrees | 0 |
| Fade the ends | Fades the phrases out at each end. | On or off | on |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Video
Blocks panel → Media · add-on key video
The Video add-on embeds a YouTube or Vimeo video at a chosen shape and width. Nothing is loaded from the video service until the visitor presses play, so the page stays quick and no third-party cookies are set before then. The video can play in place or open large over the page.
- YouTube and Vimeo; five shapes; text width, wide or edge to edge; a poster of your own; playing in place or over the page.
- Self-hosted video files - use the Video Hero or Slideshow.
- Silent background loops - use the Video Hero.
When to use it
- A product demonstration, interview, lecture or testimonial video within the page.
When to choose another add-on
- A video behind a heading and buttons → use Video Hero.
- Several videos with a player → use Video Playlist.
- Pictures and videos in one slideshow → use Metro Slideshow.
- A live broadcast → use Live Stream.
Procedure
- Paste the video's address from YouTube or Vimeo.
- Optionally choose a poster picture; otherwise the service's thumbnail is used.
- Choose the shape to match the video (16:9 for most), and the width.
- Choose whether it plays in place or opens large over the page.
Behaviour on the page
- Until play is pressed, only the poster is shown. YouTube videos load from youtube-nocookie.com.
- If the shape does not match the video, "Show the whole picture" adds bars and "Fill the frame" crops.
- Set a poster of your own for important videos; service thumbnails are chosen automatically and are often unflattering.
- Use the vertical shape for phone footage.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The video does not play. | The owner has disabled embedding, or the address is a playlist or channel page. Use the address of a single video. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| YouTube / Vimeo URL | The address of a single YouTube or Vimeo video. | A link | none |
| Thumbnail (optional) | A picture shown before playing. Empty uses the service's thumbnail. | A picture | none |
| Shape | The frame's shape. Match it to the video. |
|
Widescreen 16:9 (most video) |
| How wide | Whether the video is as wide as the text, wider, or edge to edge. |
|
none |
| If the shape does not match the video | What happens when the frame's shape differs from the video's. |
|
Show the whole picture (bars at the sides) |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 8 |
| When it is played | Whether the video plays inside the page or opens large over it. |
|
Play it where it sits |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Thumbnail quality | The size of the thumbnail taken from YouTube when no poster is set. The highest quality suits a hero; smaller sizes suit cards and dense grids, where the larger download would be wasted. |
|
Highest available - best for a hero, largest download |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Video Hero
Blocks panel → Media · add-on key video_hero
The Video Hero add-on places a video across the top of a page with an eyebrow, heading, text and two buttons over it. The video can be a silent background loop or a poster with a play button, from your own file, YouTube or Vimeo. A loop can be cut from the best few seconds of a longer clip.
- Self-hosted files, YouTube (no-cookie) and Vimeo.
- A muted background loop with loop-from and loop-until seconds and a pause button, or a poster with play.
- Heading, text and two buttons; height, alignment, overlay and colours.
- Several videos - use the Video Playlist or Slideshow.
When to use it
- The top of a home page, a campaign or an event page where motion sets the tone.
When to choose another add-on
- A video within the page → use Video.
- A still picture with text → use Image & Content.
- Product callouts over a video → use Video Product Callouts.
Procedure
- Choose where the video comes from and how it plays.
- Paste the video address, and set a poster picture.
- For a loop, set the seconds to loop from and until, and whether a pause button shows.
- Write the eyebrow, heading, text and buttons.
- On the Style tab, set the height, alignment, overlay and colours.
Behaviour on the page
- The poster is shown first, and permanently if the video never loads.
- Background loops are muted and do not play for visitors who ask their device for reduced motion; the poster is shown instead.
- In poster mode nothing loads from the video service until play is pressed.
- Always set a poster.
- Use a self-hosted file of a few megabytes for a background loop: it starts faster than a service player.
- Darken the video enough for the heading to read over its brightest frame.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The background video does not play on some phones. | The device is in low-power or data-saving mode, which blocks autoplay. The poster is shown instead. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Video from | Where the video comes from. |
|
YouTube — loads from youtube-nocookie.com |
| How it plays | A poster with a play button, or a muted loop playing behind the words. |
|
Thumbnail with a play button — nothing loads until it is pressed |
| Once it is playing | Whether the playing video shows its whole picture or fills the banner by cropping. |
|
Show the whole picture (bars above and below) |
| Video URL | The video URL. | Text | none |
| Poster image — shown first, and if the video never loads | The picture shown before the video plays, and if it never loads. | A picture | none |
| Small line above the heading | The small line above the heading. | Text | none |
| Heading | The heading. | Text | none |
| Text | The text. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| Button text | The button text. | Text | none |
| Button link | The button link. | Text | none |
| Second button text | The second button text. | Text | none |
| Second button link | The second button link. | Text | none |
| Loop from (seconds, background only) | For a background loop, the second the loop starts from. | A whole number, in seconds | none |
| Loop until (seconds, background only) | For a background loop, the second the loop returns from. Empty plays to the end. | A whole number, in seconds | none |
| Show a small pause button (autoplaying video) | Shows a small pause button over an autoplaying video. | On or off | on |
| Where the pause button sits | Which corner the pause button sits in. |
|
Bottom right |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Height | Chooses the height. Each value is described under Values. |
|
Three quarters of the screen |
| Content alignment | Chooses the content alignment. Each value is described under Values. |
|
Center |
| Vertical position | Chooses the vertical position. Each value is described under Values. |
|
Middle |
| Darken the video (0–90%) | How much the video is darkened, from 0 to 90 per cent. | A whole number, as a percentage | 45 |
| Overlay colour | Sets the overlay colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Heading size (px) | Sets the heading size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 56 |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Thumbnail quality | The size of the thumbnail taken from YouTube when no poster is set. The highest quality suits a hero; smaller sizes suit cards and dense grids, where the larger download would be wasted. |
|
Highest available - best for a hero, largest download |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Video Playlist
Blocks panel → Media · add-on key video_playlist
The Video Playlist add-on presents several videos as tiles with a player - a channel, a course, a season of matches. It can list chosen videos or show a whole YouTube playlist, with a player beside or above the list, or a grid alone, and tiles in four shapes including a vertical rail for short-form video.
- Chosen YouTube or Vimeo videos with title, length, note and poster, or a whole YouTube playlist; four layouts; four tile shapes; numbering; a "watch all" link; playing in place or over the page.
- Uploading videos to the site.
When to use it
- A course's lessons, a video library, match highlights, reels.
When to choose another add-on
- A single video → use Video.
- Pictures and videos with effects → use Metro Slideshow.
- A live broadcast → use Live Stream.
Procedure
- Choose chosen videos or a whole playlist.
- For chosen videos, add a row each: link, title, length, note and optional poster. For a playlist, paste its address and choose a poster.
- Write the heading and sub-heading.
- Choose the layout, tile shape and columns, whether tiles scroll sideways, numbering, and whether videos open over the page.
- On the Style tab, set the list height, gaps and colours.
Behaviour on the page
- Nothing loads from the video service until a video is played.
- The playing entry is marked in the accent colour.
- Enter lengths; they help visitors choose.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Show | Whether the add-on shows videos you list, or a whole YouTube playlist in one player. |
|
The videos I list below |
| Playlist URL (whole-playlist mode, or the "Watch all" link) | The playlist address: the source in whole-playlist mode, or the target of the "watch all" link. | Text | none |
| Videos | The videos. Each row has a link, a title, a length, a note and an optional poster. | Each row, in order:
|
none |
| Poster for the player (whole-playlist mode) | The player's poster in whole-playlist mode. | A picture | none |
| Layout | The arrangement of the player and the list. |
|
Player, with a vertical list beside it |
| Tile shape | The shape of each tile. |
|
Widescreen, 16:9 |
| Scroll sideways instead of wrapping (grid layouts) | In grid layouts, scrolls tiles sideways in one row instead of wrapping. | On or off | off |
| Heading | The heading. | Text | none |
| Sub-heading | The sub-heading. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| Show a "watch the whole playlist" link | Shows a link to the whole playlist on YouTube. | On or off | on |
| That link's text | The that link's text. | Text | Watch all on YouTube |
| Number the entries | Numbers the entries. | On or off | on |
| Across — grid layouts | Tiles across in grid layouts. | A whole number | 3 |
| When a video is pressed: open it large over the page (leave off to play it where it sits) | Opens a pressed video large over the page, instead of in the player. | On or off | off |
| Movement | Chooses the movement. Each value is described under Values. Slide by slide settles each item into place. Free scroll stops wherever the visitor leaves it. |
|
Slide by slide |
| At the last slide | Chooses the at the last slide. Each value is described under Values. |
|
Stop at the end |
| Let the mouse wheel move the slider | Switches on or off: let the mouse wheel move the slider. Useful for a horizontal gallery. Normal page scrolling continues when the slider reaches either end. | On or off | off |
| Slide effect | Chooses the slide effect. Each value is described under Values. Effects use the same lightweight slider. They add no image requests or third-party code. |
|
Natural scrolling |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Largest height of the list (px, 0 = no limit) | The largest height of the list; it scrolls beyond that. 0 for no limit. | A whole number, in pixels | 420 |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| List background | Sets the list background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Entry background | Sets the entry background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Title colour | Sets the title colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Length and note colour | Sets the length and note colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Accent (the one playing) | The colour marking the video that is playing. | Any colour | none |
| Thumbnail quality | The size of the thumbnail taken from YouTube when no poster is set. The highest quality suits a hero; smaller sizes suit cards and dense grids, where the larger download would be wasted. |
|
Highest available - best for a hero, largest download |
| Legacy dots | Switches on or off: legacy dots. | On or off | none |
| Show previous and next arrows | Switches on or off: show previous and next arrows. | On or off | on |
| Arrow icon | Chooses the arrow icon. Each value is described under Values. |
|
Chevron |
| Arrow position | Chooses the arrow position. Each value is described under Values. |
|
Just outside the slider |
| Arrow button size (px) | Sets the arrow button size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 42 |
| Arrow colour | Sets the arrow colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Arrow background | Sets the arrow background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Slide indicators | Chooses the slide indicators. Each value is described under Values. |
|
None |
| Indicator position | Chooses the indicator position. Each value is described under Values. |
|
Inside, along the bottom |
| Indicator alignment | Chooses the indicator alignment. Each value is described under Values. |
|
Center |
| Indicator colour | Sets the indicator colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Current indicator colour | Sets the current indicator colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Video Product Callouts
Blocks panel → Media · add-on key video_product_callouts
The Video Product Callouts add-on combines a background video, an overlay picture of your own (a different crop for desktop, tablet and phone) and numbered callout dots on top. It suits launches where a product is shown in motion with its features pinned to it.
- YouTube, Vimeo or a file; poster; three overlay pictures; callouts as in Product Callouts; stage width, height, radius, overlay fit and strength, darkening and reveal.
- Dots that follow a moving subject in the video - dots are pinned to the overlay picture.
When to use it
- A product launch hero.
When to choose another add-on
- Callouts on a still picture → use Product Callouts.
- A video hero with text → use Video Hero.
Procedure
- Choose the video source, paste its address and set a poster.
- Choose the overlay picture for each screen size and write its alt text.
- Add a row per callout: title, description, side, and position across and down as percentages.
- Write the heading.
- On the Style tab, set the stage, overlay fit and strength, darkening and dot size.
Behaviour on the page
- An empty tablet or phone overlay falls back to the next size up.
- On phones the notes list beneath the stage.
- Use the same subject at three crops, not three different pictures; the dots are pinned to the overlay.
- Darken the video if light text must read over a busy clip.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Video from | Where the background video comes from. |
|
YouTube - loads from youtube-nocookie.com |
| Video address | The video address. | Text | none |
| Poster (shown until the video plays) | The picture used for the poster. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Overlay picture - desktop | The overlay picture on desktop screens; the dots are placed on it. | A picture | none |
| Overlay picture - tablet | The overlay on tablets. Empty uses the desktop picture. | A picture | none |
| Overlay picture - phone | The overlay on phones. Empty uses the tablet or desktop picture. | A picture | none |
| Overlay alt text | The overlay alt text. | Text | none |
| Callouts | The callouts. Each row has a title, a description, the side the note opens to, and the dot's position across and down from 0 to 100. | Each row, in order:
|
none |
| Heading | The heading. | Text | none |
| Heading, second part | The heading, second part. | Text | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Dot and line colour | Sets the dot and line colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Feature colour | Sets the feature colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Stage width (%) | The stage's width, as a percentage of the add-on. | A whole number, as a percentage | 42 |
| Least height (px) | Sets the least height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 560 |
| Dot size (px) | Sets the dot size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
| Stage corner radius (px) | Sets the stage corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 18 |
| How the overlay sits | Whether the overlay fills the stage by cropping, or fits inside it. |
|
Fit the whole picture inside the stage |
| Overlay strength (%) | The overlay's opacity. | A whole number, as a percentage | 100 |
| Darken the video (0-90%) | How much the video is darkened. | A whole number, as a percentage | 35 |
| Darken with | Sets the darken with colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Reveal the callouts on scroll | Shows the callouts one after another as they scroll into view. | On or off | on |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Weather
Blocks panel → Media · add-on key weather
The Weather add-on shows the current conditions for one or more places - a campus, a venue, a resort - with temperature, condition, high and low, wind, humidity and "feels like". Weather data is fetched live from Open-Meteo, a free service that needs no API key.
- Any number of places; Celsius or Fahrenheit; grid, side-scroller or strip; five sizes; chosen details; animated conditions; solid or glass cards.
- Multi-day forecasts.
When to use it
- A resort, school, event or sports site where conditions affect the visit.
Procedure
- Add a row per place: its name, latitude and longitude.
- Write the heading and choose the unit.
- Choose the layout, size and the number across per screen size.
- Tick the details to show.
- On the Style tab, choose solid or glass cards and the colours.
Behaviour on the page
- Conditions are fetched when the page is viewed, so they are current.
- If the weather service cannot be reached, the card shows "unavailable" rather than figures.
- The tiny strip fits in a header; the feature size suits a single place in a hero.
- Glass cards need a picture behind them.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Places | The places. Each row has the name shown, the latitude and the longitude. | Each row, in order:
|
none |
| Section heading | The section heading. | Text | none |
| Temperature in | Chooses the temperature in. Each value is described under Values. |
|
Celsius (°C) |
| Layout | A grid, a side-scroller with arrows, or a flat strip on one line. |
|
Grid |
| Size | The size of each card, from a header strip to one large card. |
|
Medium |
| Across — desktop | Chooses the across — desktop. Each value is described under Values. |
|
3 |
| Across — tablet | Chooses the across — tablet. Each value is described under Values. |
|
2 |
| Across — mobile | Chooses the across — mobile. Each value is described under Values. |
|
1 |
| Show the condition (Rain, Clear…) | Switches on or off: show the condition. | On or off | on |
| Show today’s high and low | Switches on or off: show today’s high and low. | On or off | on |
| Show wind | Switches on or off: show wind. | On or off | off |
| Show humidity | Switches on or off: show humidity. | On or off | off |
| Show “feels like” | Switches on or off: show “feels like”. | On or off | off |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Animate the condition | Animates the condition icon (rain falling, sun turning). | On or off | on |
| Card style | Solid cards, or glass cards that show the picture behind them blurred. |
|
Solid |
| Card background | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Icon colour | Sets the icon colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Card border (px) | Sets the card border, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Card border colour | Sets the card border colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
| Gap between cards (px) | Sets the gap between cards, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Center |
| Show arrows (side-scroller) | Switches on or off: show arrows. | On or off | on |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Layout and navigation add-ons
Headers, menus, spacing and the pieces that hold a page together.
Divider
Blocks panel → Layout and navigation · add-on key divider
The Divider add-on separates pieces of content with a line - across the page, or upright between two columns. The line can be plain (solid, dashed, dotted, double), designed (faded at the ends, a gradient, a glow, two weights, a short bar, beads, a wave, a zigzag, an arrow, end stops), or broken in the middle by an icon, a few words, a shape or three dots. It can also move: draw itself in when it is scrolled to, carry a light along its length, keep its dashes or waves moving, pulse or turn its ornament, or breathe a glow. "Hidden" keeps the space and draws nothing.
- A line across the page, at a width and alignment, or upright at a length or filling the height of its column.
- Sixteen designs, including a line broken by an icon, words, an ornament, three shapes or three dots.
- A colour, a second colour for gradients, bars and double lines, and a colour for the middle and for the travelling light.
- Seven animations, at a speed you set.
- A hidden style that keeps the spacing without drawing anything.
- A shaped edge between sections - use the section's shape divider (curve, wave, tilt and others).
- Readable content: the words in the middle are a label, not a heading.
When to use it
- Separating groups of content inside a column: opening hours from an address, a heading from its text.
- A short accent bar under a heading.
- An upright line between two columns of text, or between the halves of a footer.
- A chapter mark between long passages: a line with "Part two" or an ornament in the middle.
When to choose another add-on
- Empty space without a line → use Spacer.
- A very large decorative word behind a section → use Ghost Word.
Procedure
- Choose the direction: across the page, or upright.
- Choose the design. For a line with something in the middle, choose the icon, type the words, or pick the shape.
- Set the colour, the thickness and, across the page, the width and alignment - or, upright, the length, or tick "Fill the height of the column".
- Set the second colour for a gradient, a short bar or a double line, and the middle colour for the icon, words, shape or travelling light.
- Optionally choose an animation and its speed.
Behaviour on the page
- A plain horizontal line with no animation is drawn exactly as dividers always have been, so pages built before 2.42.0 are unchanged.
- Every other design is a separator element announced as such to screen readers; the icon, shape and dots are decorative, and the words in the middle are read.
- "Draw itself in" winds the line back the moment it is scrolled to and grows it out from the middle; without the script, or for visitors who ask for less motion, the line is simply there.
- Every other animation stops for visitors who ask their device for less motion.
- "Keep moving" moves dashed, dotted, beaded, wave and zigzag lines; a solid line has nothing to move.
- An upright divider set to fill its column grows with the tallest column in the row.
- A short (10 to 20 per cent), thick bar in the accent colour, aligned with the heading, reads as a deliberate design element; a full-width grey hairline reads as a separator.
- Put an upright divider in its own narrow column (one twelfth) between two wider ones.
- Keep animation to one divider on a screen; several moving lines compete with the content.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The travelling light cannot be seen. | It is drawn in the middle colour, else the second colour, else the section's text colour. Set a middle colour that contrasts with the line. |
| An upright divider is short. | The column is not stretched: "Fill the height of the column" follows the row, so a row set to align its columns to the centre gives the divider only its own content height. Give the length instead. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Line style | How the line is drawn. "Hidden" keeps the space and draws nothing. |
|
Solid |
| Colour | Sets the colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #e2e8f0 |
| Thickness (px) | Sets the thickness, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 1 |
| Width (%, 100 = full) | Across the page: the line's length as a percentage of the column. 100 is the full width. A short bar at full width is drawn 72 px long. Offered only when Direction is "Across (horizontal)". | A whole number, as a percentage | 100 |
| Alignment (when narrower than full) | Chooses the alignment. Each value is described under Values. |
|
Centred |
| Space above and below (px) | The space above and below the line, in pixels. | A whole number, in pixels | none |
| Direction | Whether the line runs across the page or stands upright. |
|
Across (horizontal) |
| Length (px) | Upright: the line's length in pixels - and the least it will be when it fills its column. Offered only when Direction is "Upright (vertical)". | A whole number, in pixels | 120 |
| Fill the height of the column | Upright: runs the full height of the column it sits in. Offered only when Direction is "Upright (vertical)". | On or off | off |
| Design | What the divider looks like. |
|
A plain line |
| Icon in the middle | The icon in the middle, for that design. Offered only when Design is "A line with an icon in the middle". | An icon | bi-star-fill |
| Words in the middle | The words in the middle, for that design. Inline formatting may be used. Offered only when Design is "A line with words in the middle". | Text | Chapter two |
| Shape | The shape used by the ornament and three-shapes designs. Offered only when Design is "A line with a shape in the middle" or "A line with three shapes in the middle". |
|
Diamond |
| Second colour (gradient, bar, double line) | The second colour of a gradient, a short bar and the thinner of two lines. Blank lets a gradient fade out. | Any colour | none |
| Middle and light colour | The colour of the icon, words, shape or dots in the middle, and of the light that travels along the line. Blank uses the line colour. | Any colour | none |
| Size of the middle (px) | The size of the icon, shape or dots in the middle, in pixels; the words are drawn at four fifths of it. Offered only when Design is "A line with an icon in the middle" or "A line with words in the middle" or "A line with a shape in the middle" or "A line with three shapes in the middle" or "Three dots". | A whole number, in pixels | 16 |
| Space either side of the middle (px) | The space between the line and the middle, on each side. Offered only when Design is "A line with an icon in the middle" or "A line with words in the middle" or "A line with a shape in the middle" or "A line with three shapes in the middle" or "Three dots". | A whole number, in pixels | 14 |
| Words in capitals | Sets the words in the middle in spaced capitals. Offered only when Design is "A line with words in the middle". | On or off | on |
| Animation | How the divider moves. |
|
None |
| Animation speed (seconds per cycle) | Seconds for one cycle of the animation; for drawing in, the line takes four tenths of it. Offered only when Animation is "Draw itself in when scrolled to" or "A light travels along it" or "Keep moving (dashes, dots, beads, waves)" or "Pulse the middle (icon, shape, dots)" or "Turn the middle slowly (icon, shape)" or "Breathe a glow". | A whole number, in seconds | 3 |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Footer Menu
Blocks panel → Layout and navigation · add-on key footer_menu
The Footer Menu add-on lays out site links in columns at the foot of the page, built from Joomla menus: either one menu whose top-level items become the column headings, or a separate menu for each column. On phones the columns can collapse into tap-to-open lists.
- Columns of links from one menu or from several.
- Column headings, spacing, colours, and an optional line above the columns.
- Tap-to-open columns on phones.
- The copyright line, contact details or social icons - add Text, Icon List and Social Icons add-ons beside it.
- Typed links that are not in a Joomla menu.
When to use it
- The footer of a site with more than a handful of pages.
- A "sitemap" band of grouped links.
When to choose another add-on
- A single short list or row of links → use Joomla Menu.
Procedure
- Choose how it is built. For one menu, pick it; its top-level items become headings and their children the links. For separate menus, add a line per column with a heading and a menu.
- Set the columns across on desktop and on phones, and whether phone columns collapse.
- On the Style tab, set the alignment, heading style, link colours and spacing.
Behaviour on the page
- Collapsed columns on phones are buttons that expand their list; they are announced as expandable to screen readers.
- Access levels and publishing are respected as in Joomla's menus.
- Four columns is the practical maximum on desktop; two on phones.
- Keep link words short - footers are scanned, not read.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| A column is empty. | Its menu has no published top-level items, or in one-menu mode a top-level item has no children. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Built from | Whether the columns come from one menu (its top level becomes the headings) or from a separate menu per column. |
|
One menu - its top level becomes the column headings |
| Menu (one-menu mode) | Chooses the menu. Each value is described under Values. |
|
none |
| Columns (a separate menu per column) | The columns in "separate menus" mode: one line per column, with a heading and a menu. | Each row, in order:
|
none |
| Columns across | Chooses the columns across. Each value is described under Values. |
|
4 |
| Columns on a phone | Chooses the columns on a phone. Each value is described under Values. |
|
2 |
| Collapse each column to a tap-to-open list on a phone | On phones, turns each column into a heading that opens its list when tapped. | On or off | off |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Left |
| Heading colour | Sets the heading colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Heading size (px) | Sets the heading size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 15 |
| Headings in capitals | Switches on or off: headings in capitals. | On or off | off |
| Link colour | Sets the link colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Link colour on hover | Sets the link colour on hover colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Link size (px) | Sets the link size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 14 |
| Space between links (px) | Sets the space between links, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 12 |
| Space between columns (px) | Sets the space between columns, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 32 |
| Line above the columns | Switches on or off: line above the columns. | On or off | off |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Ghost Word
Blocks panel → Layout and navigation · add-on key ghost_word
The Ghost Word add-on sets one very large word behind a section's content, in the section's own colour and only slightly different from the background. It adds depth and identity to a plain band without a picture, and it never interferes with the content: it takes no space in the layout and ignores the pointer.
- One word (or two short ones) at display size, behind the content of its section.
- Placement, strength, outline or filled letters, tilt and fine positioning.
- A size that scales between a phone size and the desktop size, and an option to hide it on phones.
- Readable text. It is decorative and hidden from screen readers; anything a visitor must read belongs in a heading.
- More than one per section - a second word is noise.
When to use it
- A plain coloured band that needs character: "ABOUT", "MENU", "2026".
- Reinforcing a brand name or a section name at a scale a heading cannot use.
When to choose another add-on
- A heading with a visible effect (outline, gradient, neon) → use Special Heading.
- An ordinary heading → use Heading.
Procedure
- Place the Ghost Word in any column of the section it belongs to; it positions itself relative to the section.
- Type the word and choose Where it sits.
- On the Style tab, set the strength (6 to 14 per cent reads as texture), the fill and, if wanted, a tilt and a nudge.
- Set the desktop size with the font size and the phone size with Size (px, phone); decide whether it shows on phones.
Behaviour on the page
- It sits behind the section's content, takes no space in the layout, and does not respond to the pointer.
- It is hidden from screen readers.
- Its size scales smoothly between the phone size and the desktop size.
- Keep the strength below about 20 per cent; above that it competes with the text in front of it.
- A long word centred in a narrow band is cut at both ends. Place it bottom-left or bottom-right and let it run off one edge deliberately.
- Use it once per page.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The word is not visible. | The strength is too low for the background, or the colour matches the background exactly. Raise the strength or choose a colour a shade away from the background. |
| It crowds the content on phones. | Lower the phone size or switch off Show on phones. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| The word | The the word. One word, or two short ones. A sentence at this size is a wall. | Text | METRO |
| Where it sits | Where the word sits in the section. The "bleeding" placements let it run off one edge. |
|
Centred |
| Size (px, phone) | Sets the size, in pixels. Leave it empty to use the add-on's default. The small end. The desktop size is the font size on the Style tab, and the word scales between the two rather than jumping at a breakpoint. | A whole number, in pixels | 76 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Colour | Sets the colour. Leave it empty to use the colour the section or the site template already gives. Leave empty to use the band's own text colour, faded. A shade off the section background is the look this block is for. | Any colour | none |
| Strength (%) | How much of the colour shows, as a percentage. This is the setting that makes it read as texture rather than as text. | A whole number, as a percentage | 10 |
| Fill | Filled letters, or outlined letters with a transparent inside. |
|
Filled |
| Tilt (degrees) | Tilts the word, in degrees. | A whole number, in degrees | 0 |
| Nudge across (px) | Sets the nudge across, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Nudge down (px) | Sets the nudge down, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Show on phones | Switches on or off: show on phones. On a narrow screen there is often no room for it behind the content. | On or off | on |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Joomla Menu
Blocks panel → Layout and navigation · add-on key joomla_menu
The Joomla Menu add-on places one of the site's Joomla menus inside the page: as a stacked list, a row of links or pills, an indented tree, or an accordion whose sub-levels open on tap. It follows the menu's structure, publishing and access rules, so the links stay in step with the site without being retyped.
- Any Joomla site menu, up to five levels deep.
- Five arrangements, item markers, a heading, and the current page marked.
- An optional drawer on small screens, with its own button, position and logo.
- Typed links that are not in a Joomla menu - use the Site Header with typed links.
- A complete header with a logo and button - use the Site Header.
When to use it
- A sidebar or in-page list of related pages.
- Secondary navigation for a section of the site, such as the pages of a department.
- A compact menu in the footer area when the Footer Menu's columns are not wanted.
When to choose another add-on
- The main navigation bar with the logo → use Site Header.
- Several menus as columns at the foot of the page → use Footer Menu.
Procedure
- Choose the menu under Which menu and the number of levels to show.
- Choose the Arrangement and, optionally, a heading and a marker before each item.
- On the Style tab, set the alignment, colours and spacing, and how the current page is marked.
- For a menu in a row that should collapse on phones, switch on Collapse to a drawer on small screens and set the width below which it collapses.
Behaviour on the page
- Items the visitor is not permitted to see are left out, exactly as in Joomla's own menu module.
- The accordion arrangement keeps sub-levels folded until tapped; the tree arrangement shows them all, indented.
- In the builder's preview the menu is drawn from the site's menu data; menu items added later appear without editing the page.
- Use the accordion arrangement for long menus in narrow columns.
- "Spread" and "Fill" alignment apply only to a menu laid out in a row.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The menu shows nothing. | No menu is chosen, or its items are unpublished or not permitted for the visitor. |
| Sub-levels are missing. | Raise How many levels. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Which menu | Chooses the which menu. Each value is described under Values. |
|
none |
| How many levels | Chooses the how many levels. Each value is described under Values. |
|
Top level only |
| Arrangement | How the items are laid out: stacked, in a row, as pills, as an always-open tree, or as an accordion. |
|
Stacked list, one per line |
| Heading above it (optional) | The heading above it. | Text | none |
| Before each item | A symbol shown before each item, or numbering. |
|
none |
| Collapse to a drawer on small screens | Collapses the menu to a drawer, opened by a button, on screens narrower than Collapse below. | On or off | on |
| Collapse below (px) | Sets the collapse below, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 900 |
| Drawer opens from | Chooses the drawer opens from. Each value is described under Values. |
|
The right |
| Menu button | Chooses the menu button. Each value is described under Values. |
|
Three bars |
| Menu sits | Where the items sit inside the open drawer. At the bottom is easiest to reach with a thumb. |
|
At the top |
| Logo inside the drawer | The picture used for the logo inside the drawer. Choose it in the Media Manager, or type a path under images/. Shown at the top of the open drawer. A drawer covering the whole screen otherwise hides the site name at the moment somebody is deciding where to go. |
A picture | none |
| That logo height (px) | Sets the that logo height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 34 |
| That logo links to | The that logo links to. | Text | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Alignment | Chooses the alignment. Each value is described under Values. Spread and Fill only do anything on a menu laid out in a row. |
|
Left |
| Heading colour | Sets the heading colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Link colour | Sets the link colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Link colour on hover | Sets the link colour on hover colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Current page colour | Sets the current page colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Marker colour | Sets the marker colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Pill background | Sets the pill background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Submenu panel background | Sets the submenu panel background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Submenu text colour | Sets the submenu text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Space between items (px) | Sets the space between items, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 10 |
| Bold the current page | Switches on or off: bold the current page. | On or off | on |
| Menu button colour | Sets the menu button colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Drawer background | Sets the drawer background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Drawer text colour | Sets the drawer text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| A line between items (stacked layouts) | Switches on or off: a line between items. | On or off | off |
| Menu style | Chooses the menu style. Each value is described under Values. |
|
none |
| Menu hover effect | Chooses the menu hover effect. Each value is described under Values. |
|
none |
| Menu style and effect colour (blank = the text colour) | Sets the menu style and effect colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Logo
Blocks panel → Layout and navigation · add-on key logo
The Logo add-on shows the site's mark as an image, as text, or both side by side, with an optional tagline, linked to an address of your choice - normally the home page. Use it where a logo is needed outside the Site Header: a footer, a centred masthead, a coming-soon page.
- Image, text or both, with separate sizing on phones.
- An optional tagline under the text.
- Link, alignment, corner radius, padding and a hover effect.
- Navigation - use the Site Header, which has its own logo.
When to use it
- The footer of a page, above the contact details.
- A centred masthead above an article or a coming-soon message.
When to choose another add-on
- A header bar with navigation → use Site Header.
- Any other picture → use Image.
Procedure
- Choose what to show under Show.
- Choose the logo image and type the logo text and alt text.
- Set Links to, normally
/. - On the Style tab, set the picture height (and a separate phone height), the alignment and the text styling.
Behaviour on the page
- With "Picture if there is one, otherwise the text", the text is shown only while no image is chosen, which lets a template ship with a text logo that is replaced by uploading an image.
- The alt text is what screen readers announce; when the text is shown beside the picture, the picture's alt may be empty to avoid reading the name twice.
- Use an SVG logo where possible: it stays sharp at every size and is usually the smallest file.
- Set the height, not the width; logos of different proportions then align on a common height.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The logo is blurred. | The image is smaller than it is displayed. Supply it at twice the displayed height, or as SVG. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Show | Which form of the logo is shown. |
|
Picture if there is one, otherwise the text |
| Logo image | The picture used for the logo image. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Logo text | The logo text. | Text | Your Site |
| Alt text for the picture | The alt text for the picture. | Text | none |
| Links to | The links to. | Text | / |
| Tagline under the text (optional) | The tagline under the text. | Text | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Picture height (px) | Sets the picture height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 44 |
| Picture width (px, 0 = keep its own ratio) | A fixed picture width, in pixels. 0 keeps the picture's own proportions at the chosen height. | A whole number, in pixels | 0 |
| Picture height on a phone (px) | Sets the picture height on a phone, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 34 |
| If width and height disagree | How the picture is placed when both a width and a height are set and do not match its proportions. |
|
Fit the whole mark inside the box |
| Space around the picture (px) | Space around the picture inside its box, in pixels - useful when a background colour is behind it. | A whole number, in pixels | 0 |
| Corner radius on the picture (px) | Sets the corner radius on the picture, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Space between picture and text (px) | Sets the space between picture and text, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 10 |
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Left |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text in capitals | Switches on or off: text in capitals. | On or off | off |
| Tagline colour | Sets the tagline colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Tagline size (px) | Sets the tagline size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 12 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Metro Mega Menu
Blocks panel → Layout and navigation · add-on key mega_menu
The Mega Menu add-on presents a product range the way a manufacturer's website does: categories in a column on the left, an optional column of groups within the chosen category, and a grid of product cards, each with a picture, a name, a link and an optional badge such as New or Pre-book. Quick links sit at the top of the panel and each category can end with a View all button. The panel can open from its own button, from any link on the page that points at its anchor (typically a link in the Site Header), or stay open as part of the page.
- Up to three levels of choice: category, group, product.
- A product card per line, with a picture, name, link and badge.
- Quick links and a per-category View all link.
- Three ways to open: its own button, a link to its anchor elsewhere on the page, or always open.
- Keyboard operation: categories and groups behave as tabs, and the panel closes with Escape.
- Reading products from a shop or catalogue component - the products are typed into the add-on.
- Prices, stock or an add-to-cart button.
- Being a site's main navigation on its own - pair it with a Site Header.
When to use it
- A manufacturer, dealer or brand site whose visitors choose a product before anything else.
- A range too large for a dropdown but small enough to show as pictures: roughly eight to forty products.
- A "Models" or "Products" item in the header that should open a visual panel rather than a list.
When to choose another add-on
- A plain list of pages with no pictures → use Site Header.
- A browsable catalogue on the page itself, with descriptions → use Carousel Pro.
- A single featured product with its features → use Product Callouts.
Procedure
- Add one line per product under Products: category, group (optional), product name, picture, link and badge. Categories and groups appear in the order they are first used.
- Leave the group empty for every product in a category to show that category's products immediately, without a group column.
- Choose How it opens. For a header link, choose "A link elsewhere on the page", type the anchor under Opened by links to (for example
#products), and give a Site Header link exactly that address. - Optionally add quick links (
Words | link, one per line) and "View all" links per category (Category | link). - On the Style tab, set the products per row, the picture shape, the panel's maximum height and the colours.
- Test it: open the panel from its trigger, move through categories with the keyboard, and close it with Escape.
Behaviour on the page
- In "link" mode the panel is hidden until a link to its anchor is hovered or clicked. On a page with no such link it never appears - this is the most common reason a Mega Menu seems missing.
- In "button" mode the add-on draws its own button; in "always open" mode it draws the panel in place, as page content.
- On small screens the category column becomes a list above the products and the panel scrolls within its maximum height.
- Product pictures load lazily; only the chosen category's cards are shown at a time.
- Use one picture shape for every product. Cut-out product images on a transparent background align best.
- Keep each category to between eight and twelve products; a menu is a tool for choosing, and longer lists belong on a range page linked by View all.
- Use badges sparingly. A badge on every card is no longer a signal.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The Mega Menu does not appear on the page. | It is in "link" mode and nothing on the page links to its anchor. Add a link with that address (for example in the Site Header), or change How it opens to its own button or always open. |
| A category shows no products. | Every product line needs a category. Check that the category name is spelled identically on each line. |
| Pictures are cropped awkwardly. | Choose the Picture shape that matches the source images, or supply images in that shape. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Products | The products. One line per product: category, group (optional), name, picture, link and badge (optional). | Each row, in order:
|
6 sample entries |
| How it opens | What opens the panel: its own button, a link elsewhere on the page that points at its anchor, or nothing - always open. |
|
Its own button opens it |
| Button words | The words on the add-on's own button, in "button" mode. Offered only when How it opens is "Its own button opens it". | Text | Products |
| Opened by links to | The address that opens the panel in "link" mode. Any link on the page with exactly this address opens the panel instead of scrolling. Offered only when How it opens is "A link elsewhere on the page opens it (e.g. in the Site Header)". | Text | #products |
| Opens | Whether the trigger opens the panel on hover (and click or tap), or only on click or tap. Offered only when How it opens is "Its own button opens it" or "A link elsewhere on the page opens it (e.g. in the Site Header)". |
|
On hover, and on click or tap |
| Quick links above the products | Short links shown at the top right of the panel. One per line: Words | link. |
Several lines of text | none |
| "View all" links, per category | A "View all" button at the end of a category. One per line: Category | link; a category without a line shows no button. |
Several lines of text | Motorcycle | #motorcycles Scooter | #scooters Accessories | #accessories |
| "View all" words | The "View all" words. | Text | View all |
| Name for screen readers | The panel's name as announced by screen readers. | Text | Products |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Products per row (large screens) | Sets the products per row (large screens). Leave it empty to use the add-on's default. | A whole number (large screens) | 4 |
| Picture shape | Chooses the picture shape. Each value is described under Values. |
|
Landscape 3:2 |
| Tallest the panel may be (% of the screen) | The tallest the panel may be, as a percentage of the screen height; beyond it the panel scrolls. | A whole number, as a percentage | 78 |
| Accent (chosen category, View all, New) | Sets the accent colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #d7141a |
| Panel background | Sets the panel background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Category column background | Sets the category column background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Badge background | Sets the badge background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #facc15 |
| Button words colour (own-button mode) | Sets the button words colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Site Header
Blocks panel → Layout and navigation · add-on key site_header
The Site Header add-on draws a complete page header in one block: the logo, the navigation, an optional call-to-action button, submenus, and a drawer menu for small screens. The links can come from a Joomla menu, from the named sections of the page itself, or from a list typed into the block, so the same header serves a multi-page site, a one-page site and a landing page.
- Logo as an image, as text, or both, linked to any address.
- Navigation from a Joomla menu (up to five levels), from the page's named sections, or from typed links with dropdown items.
- A call-to-action button at the right-hand end of the bar.
- Hover or click submenus, and a drawer below a breakpoint you set, opening from either side, the top, or full screen.
- Sticky behaviour, a transparent bar over a hero, and highlighting of the section being read.
- Menu styles (underline, pill, box and others) and hover animations.
- Search, a cart or social icons inside the bar - place those add-ons in a column beside the header.
- A product panel with pictures - use the Mega Menu add-on, opened from a header link.
- Different links per language - use one Joomla menu per language and Joomla's language filter.
When to use it
- Every page that needs navigation: it is the header the page templates are built on.
- A one-page site: choose "This page's named sections" and every section with a name becomes a menu link that highlights as the visitor scrolls.
- A landing page with three or four typed links and a single prominent button.
When to choose another add-on
- A list of links inside the page body, a sidebar menu or a menu in the footer area → use Joomla Menu.
- Columns of links at the foot of the page → use Footer Menu.
- A logo on its own, without navigation → use Logo.
Procedure
- Place the Site Header in the first section of the page, alone in a full-width column. Set that section's vertical padding to 0 so the bar sets its own height.
- Under Menu links come from, choose the source. For a Joomla menu, pick it under Which menu and set How many levels. For typed links, write one link per line as
Label | link; start a line with-to place it in a dropdown under the line above. - Choose the Logo mode and supply the image, the text, or both. Set Logo links to (normally
/) and the alt text. - Optionally enter the button words and link under Button on the right.
- Choose the Arrangement, how submenus open, and whether the bar is sticky.
- Set Collapse to a drawer below (992 pixels suits most menus) and choose the drawer's direction and menu button.
- On the Style tab, set the bar height, the colours, the current-page marker and any menu style or animation. Preview at phone width before publishing.
Behaviour on the page
- Below the drawer breakpoint the links move into a drawer opened by the menu button. The drawer traps keyboard focus while open and closes with Escape, a tap outside it, or its close button.
- Submenus open on hover or on click; with hover they also open on keyboard focus and on tap, so they remain usable without a mouse.
- With "This page's named sections", links point at the sections' anchors and the item for the section in view is marked as current while the page scrolls.
- A sticky header only sticks within its own section. To keep it above the whole page, make the header's section sticky (section setting Stay on screen → top) and give it a stacking order above the content.
- "Transparent until scrolled" draws the bar with no background over the section beneath it and switches to the bar background once the page moves. Pull the hero up under the bar (section setting Overlap the thing above) by the bar height.
- Keep the top level to five or six links. More belongs in dropdowns or in a Mega Menu.
- Choose the arrangement from the page beneath it: logo left with the menu right is the neutral default; logo centred suits restaurants and boutiques; stacked suits editorial sites.
- Give the header's section a stacking order above the hero whenever the hero has CSS of its own that sets a z-index - otherwise dropdowns open behind it.
- Use one menu hover animation across the site; mixing styles between pages looks accidental.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The menu is empty. | No menu is chosen, or the chosen menu has no published items the visitor may see. Check Which menu and the menu items' access levels. |
| Dropdowns open behind the hero. | The hero section has a stacking order above the header's section. Give the header's section a higher one (page CSS on its class, or a sticky header section with a stacking order). |
| The logo image does not show. | Check the image path, and set Logo width to 0 or a positive width; 0 keeps the image's own proportions. |
| On a phone the links overflow instead of collapsing. | Collapse to a drawer below is set lower than the width the links need. Raise it until the drawer takes over before the links wrap. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Menu links come from | Where the navigation links come from. A Joomla menu follows the site's menu structure and access rules; named sections builds a one-page menu from this page; typed links are for landing pages and pages outside the main menu. |
|
none |
| Which menu | Chooses the which menu. Each value is described under Values. Offered only when Menu links come from is "A Joomla menu". |
|
none |
| How many levels | Chooses the how many levels. Each value is described under Values. Offered only when Menu links come from is "A Joomla menu". |
|
Two levels (dropdowns) |
| Links, one per line | The links, one per line. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. Label | link. A link is #a-section-name on this page, a path or a full address. Start a line with "-" to put it in a dropdown under the line above. Offered only when Menu links come from is "Links typed here". |
Several lines of text | none |
| Highlight the section being read | Marks the link of the section currently in view as current while the visitor scrolls. Applies to links that point at sections on this page. Offered only when Menu links come from is "This page's named sections (one-page site)" or "Links typed here". |
|
none |
| Arrangement | How the logo, the links and the button are arranged in the bar. |
|
Logo left, menu right |
| Logo | Which form of the logo the bar shows. |
|
The image if one is chosen, otherwise the text |
| Logo image | The picture used for the logo image. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Logo text | The logo text. | Text | Your Site |
| Logo links to | The address the logo links to - normally the home page, /. |
Text | / |
| Logo alt text | The logo alt text. | Text | none |
| Button on the right (optional) | The words on an optional button at the right-hand end of the bar. Leave empty for no button. | Text | none |
| Button link | The button link. | Text | # |
| Open submenus on | Whether a dropdown opens as the pointer arrives or only when its parent is clicked. |
|
Hover (opens as the pointer arrives) |
| Sticky | Whether the bar stays at the top of the screen as the page scrolls. |
|
none |
| Collapse to a drawer below (px) | The screen width, in pixels, below which the links move into a drawer. | A whole number, in pixels | 992 |
| Menu button | The icon of the button that opens the drawer on small screens. |
|
Three lines |
| Drawer opens from | The direction the drawer opens from, or a full-screen overlay. |
|
Slides in from the right |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Bar height (px) | Sets the bar height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 72 |
| Logo height (px) | Sets the logo height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 38 |
| Logo height on a phone (px) | Sets the logo height on a phone, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 30 |
| Logo width (px, 0 = keep its own ratio) | A fixed logo width, in pixels. 0 keeps the image's own proportions at the logo height. | A whole number, in pixels | 0 |
| If width and height disagree | How the logo is placed when both a width and a height are set and do not match its proportions. |
|
Fit the whole mark inside |
| Space around the logo (px) | Sets the space around the logo, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Logo animation | A small animation on the logo: once on arrival, or on hover. |
|
none |
| Menu item animation | How each link reacts to the pointer, or how the links arrive once when the page opens. |
|
none |
| Menu style | How the current page is marked in the menu: underline, overline, dot, pill, box and others. |
|
none |
| Menu style and effect colour (blank = the text colour) | The colour of the menu style and hover effect. Empty uses the link colour. | Any colour | none |
| Logo text colour | Sets the logo text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Logo text size (px) | Sets the logo text size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Logo text weight | Chooses the logo text weight. Each value is described under Values. |
|
none |
| Logo letter spacing (px) | Sets the logo letter spacing, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Logo text in capitals | Switches on or off: logo text in capitals. | On or off | off |
| Bar background | Sets the bar background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Link colour | Sets the link colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Link colour on hover | Sets the link colour on hover colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Current page colour | The colour of the link for the current page or section. | Any colour | none |
| Underline the current page | Draws a line under the current page's link, independent of the menu style. | On or off | on |
| Dropdown background | Sets the dropdown background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Dropdown text | Sets the dropdown text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Space between links (px) | Sets the space between links, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 26 |
| Links in capitals | Switches on or off: links in capitals. | On or off | off |
| Line under the bar | Switches on or off: line under the bar. | On or off | off |
| Shadow under the bar | Switches on or off: shadow under the bar. | On or off | off |
| Transparent until scrolled (over a hero) | Draws the bar without a background over the section beneath it until the page is scrolled. | On or off | off |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Spacer
Blocks panel → Layout and navigation · add-on key spacer
The Spacer add-on inserts empty vertical space of a fixed height. It exists for the occasional case where two blocks in the same column need more separation than their own spacing gives.
- A fixed amount of vertical space, in pixels.
- Responsive spacing that differs by screen size - use section and column padding, which already adapt.
When to use it
- Separating two blocks in one column, such as a heading and a button group, by a precise amount.
When to choose another add-on
- Space between sections or around a whole band → use Divider.
Procedure
- Place the Spacer between the two blocks and set its height in pixels.
Behaviour on the page
- The height is the same on every screen size.
- Prefer section and column padding. A page held together by spacers is difficult to keep consistent on phones.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Height (px) | The empty space, in pixels. | A whole number, in pixels | 40 |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Joomla and integrations add-ons
Add-ons that show what is already on your site or in a connected system, live. An integration whose system is not installed simply shows nothing on the page, so it is safe to leave in place.
Adhrit LMS Carousel
Blocks panel → Joomla and integrations · add-on key adhrit_carousel
The Adhrit LMS Carousel add-on shows a carousel module from Adhrit LMS - courses, featured or recommended courses, events, speakers, teachers, articles or custom slides - inside a Metro page. Each setting can follow the module or be overridden here.
- An Adhrit carousel module; overrides for content, layout, count, autoplay, interval and slides across; module spacing.
- Creating the carousel - it is a site module of Adhrit LMS.
When to use it
- Featured courses or upcoming events on a home page.
When to choose another add-on
- A grid of courses with filters → use Adhrit LMS Courses.
- Events as cards or a list → use Adhrit LMS Events.
Procedure
- Create an Adhrit carousel module in System → Site Modules.
- Place this block and choose the carousel.
- Override what it shows, the layout, count and movement, or leave each on the module's setting.
- Leave the spacing on the section spacing unless the module's own spacing is needed.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
- Empty or "Use the module's setting" values follow the module.
- Ignore the module's negative top spacing inside Metro sections; it is meant for template positions and pulls the carousel over the section above.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The carousel overlaps the section above. | The module pulls itself upward. Set Space above and below to "Use the section spacing". |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Which carousel | The Adhrit carousel module shown. |
|
none |
| What to show | What the carousel shows, overriding the module. |
|
none |
| Layout | The layout, overriding the module. |
|
none |
| Most slides to show, 1-20 (blank = the module setting) | The largest number of slides, from 1 to 20. Empty follows the module. | A whole number (blank = the module setting) | none |
| Move on its own | Whether it moves on its own, overriding the module. |
|
none |
| Seconds per slide (blank = the module setting) | Seconds per slide. Empty follows the module. | A whole number (blank = the module setting) | none |
| Slides side by side on a computer screen, 1-8 (Slim layout; blank = the module setting) | For the Slim layout, slides side by side on a computer screen, from 1 to 8. | A whole number (Slim layout; blank = the module setting) | none |
| Space above and below the carousel | Whether the section's spacing is used or the module's own. |
|
none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Adhrit LMS Course Categories
Blocks panel → Joomla and integrations · add-on key adhrit_categories
The Adhrit LMS Course Categories add-on lists course categories as a side menu, tiles or chips, with course counts and icons. Choosing a category narrows a Courses grid on the same page, or opens a courses page.
- Three layouts; an "All courses" entry; counts; hiding empty categories; a default icon and per-category icons; colours.
When to use it
- Beside the course catalogue, or as a category strip on a home page.
When to choose another add-on
- Categories as a dropdown inside the grid → use Adhrit LMS Courses.
Procedure
- Write the heading and choose the layout.
- Choose what clicking a category opens: this page, or a courses page.
- Choose "All courses", counts and hiding empty categories.
- Choose the icon, and per-category icons one per line as
Category title | bi-icon.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
- On this page, the Courses block must have Follow the category menu ticked.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Choosing a category does nothing. | The Courses block does not follow the category menu. Tick it there. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Heading | The heading. | Text | Categories |
| Layout | A vertical side menu, small cards, or a row of chips. |
|
A side menu, top to bottom |
| Clicking a category opens | Where a category opens: this page, or a page holding a Courses block. |
|
Metro Adhrit Lms Courses (not created yet) |
| Start with "All courses" | Starts the list with "All courses". | On or off | on |
| Show how many courses each has | Shows the number of courses in each category. | On or off | on |
| Hide categories with no courses | Hides categories with no courses. | On or off | on |
| Icon | The icon, chosen in the icon picker from the built-in icon set. | An icon | bi-folder2 |
| A different icon for some categories, one per line: Category title | bi-icon | Icons for particular categories, one per line as Category title | bi-icon. |
Several lines of text | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #1f2a44 |
| Icon and current category colour | Sets the icon and current category colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #c8382a |
| Icon ground and hover colour | The colour behind icons and on hover. | Any colour | #fff1ef |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Adhrit LMS Courses
Blocks panel → Joomla and integrations · add-on key adhrit_courses
The Adhrit LMS Courses add-on shows courses as a grid with optional filters by category, level, track and teacher, and a search box. It can follow a Course Categories menu on the same page, so choosing a category narrows the grid.
- Count, columns, category, track, level, featured-only and order; picture, description and actions; five filters and a side panel; link targets; colours.
- Enrolment and payment - these open Adhrit LMS.
When to use it
- The course catalogue.
- Featured courses on a home page.
When to choose another add-on
- A course carousel → use Adhrit LMS Carousel.
- One course in full → use Adhrit LMS Single Course.
Procedure
- Set how many courses and the columns.
- Choose the category, track, level and order, or leave them on "Every".
- Tick Follow the category menu on this page when a Course Categories block is on the page.
- Tick what each card shows and the filters.
- Point Page that shows one course at your single-course page.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
- Filters need Adhrit LMS 5.12.3 or later.
- Leave the category side panel off when the page already has a Course Categories block.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| How many courses | The largest number of courses shown. | A whole number | 6 |
| Columns | Chooses the columns. Each value is described under Values. |
|
3 |
| Follow the category menu on this page | Shows only the category chosen in a Course Categories block on this page. | On or off | on |
| Category to show when none is picked | The category shown when none is chosen. |
|
none |
| Learning track | Limits the grid to one learning track. |
|
none |
| Level | Chooses the level. Each value is described under Values. |
|
none |
| Featured courses only | Shows only featured courses. | On or off | none |
| Order | Chooses the order. Each value is described under Values. |
|
Adhrit's ordering |
| Picture | Switches on or off: picture. | On or off | on |
| Short description | Switches on or off: short description. | On or off | on |
| Details, enrol and cart buttons | Shows details, enrol and cart buttons. | On or off | on |
| A "view all" button under the grid | Shows a "view all" button under the grid. | On or off | on |
| Button text | The button text. Offered only when A "view all" button under the grid is "1" or "true" or "". | Text | View All Courses |
| Filter: category side panel | A side panel of categories. | On or off | off |
| Filter: search box | Switches on or off: filter: search box. | On or off | off |
| Filter: category dropdown | Switches on or off: filter: category dropdown. | On or off | off |
| Filter: level dropdown | Switches on or off: filter: level dropdown. | On or off | off |
| Filter: learning track dropdown | Switches on or off: filter: learning track dropdown. | On or off | off |
| Filter: teacher dropdown | Switches on or off: filter: teacher dropdown. | On or off | off |
| When a teacher or course is clicked, open | Whether a clicked item opens Adhrit's own page for it, or a Metro page you choose. A Metro page is told which item was clicked, and its Single add-on shows that item. |
|
Adhrit's own teacher or course page |
| Page that shows one teacher | The Metro page holding a Single Teacher add-on. Pages marked "not created yet" are suggested names; create the page first. Offered only when When a teacher or course is clicked, open is "A Metro page I choose". |
|
Metro Adhrit Lms Teacher (not created yet) |
| Page that shows one course | The Metro page holding a Single Course add-on. Offered only when When a teacher or course is clicked, open is "A Metro page I choose". |
|
Metro Adhrit Lms Course (not created yet) |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Colours and style | Whether the colours below are used, or the Adhrit module keeps its own appearance. The colours below take precedence over the site template, including its dark mode. |
|
Use the colours below |
| Title colour | The colour of titles (and of text where no text colour is set). Offered only when Colours and style is "Use the colours below" or "". | Any colour | #1f2a44 |
| Text colour (blank = the title colour) | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | none |
| Small print colour (blank = a lighter text colour) | The colour of small print. Empty uses a lighter shade of the text colour. Offered only when Colours and style is "Use the colours below" or "". | Any colour | none |
| Title font | The typeface of titles. Empty uses the template's font. Offered only when Colours and style is "Use the colours below" or "". |
|
none |
| Accent (badges, prices, links) | The colour of badges, prices, dates and links. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #c8382a |
| Card background colour | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #ffffff |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #1f2a44 |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #ffffff |
| Card corner radius (px) | Sets the card corner radius, in pixels. Leave it empty to use the add-on's default. Offered only when Colours and style is "Use the colours below" or "". | A whole number, in pixels | 22 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Adhrit LMS Event Categories
Blocks panel → Joomla and integrations · add-on key adhrit_event_categories
The Adhrit LMS Event Categories add-on lists event categories as a side menu, tiles or chips, with counts and icons. Choosing a category narrows an Events block on the same page, or opens an events page.
- Three layouts; an "All events" entry; counts; hiding empty categories; icons; colours.
When to use it
- Beside the events list.
Procedure
- Write the heading and choose the layout.
- Choose what clicking a category opens.
- Choose "All events", counts, hiding empty categories and icons.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
- On this page, the Events block must have Follow the category menu ticked.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Heading | The heading. | Text | Categories |
| Layout | A vertical side menu, small cards, or a row of chips. |
|
A side menu, top to bottom |
| Clicking a category opens | Where a category opens: this page, or a page holding an Events block. |
|
Metro Adhrit Lms Events Module (not created yet) |
| Start with "All events" | Starts the list with "All events". | On or off | on |
| Show how many events each has | Shows the number of events in each category. | On or off | on |
| Hide categories with no events | Hides categories with no events. | On or off | on |
| Icon | The icon, chosen in the icon picker from the built-in icon set. | An icon | bi-calendar2-week |
| A different icon for some categories, one per line: Category title | bi-icon | Icons for particular categories, one per line as Category title | bi-icon. |
Several lines of text | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #1f2a44 |
| Icon and current category colour | Sets the icon and current category colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #c8382a |
| Icon ground and hover colour | The colour behind icons and on hover. | Any colour | #fff1ef |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Adhrit LMS Events
Blocks panel → Joomla and integrations · add-on key adhrit_events
The Adhrit LMS Events add-on lists events - upcoming, past or both - as picture cards or a dated list, with category, date and time, venue, a description and a booking button. It can follow an Event Categories menu on the same page.
- Upcoming, past or all; count and columns; category and featured filters; the details to show; an empty message; link targets; colours.
- Ticketing - booking opens Adhrit LMS.
When to use it
- An events page or an upcoming-events band.
When to choose another add-on
- An events carousel → use Adhrit LMS Carousel.
- A countdown to one event → use Countdown.
Procedure
- Choose the layout, which events, how many and the cards per row.
- Choose the category or tick Follow the category menu.
- Tick the details, and write the button words and empty message.
- Choose where a clicked event opens.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
- "Upcoming" includes events running now.
- Write an empty message that points somewhere useful, such as past events or a newsletter.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Layout | Chooses the layout. Each value is described under Values. |
|
Cards with a picture |
| Which events | Which events are listed. |
|
Upcoming and running now |
| How many events | Sets the how many events. Leave it empty to use the add-on's default. | A whole number | 6 |
| Cards per row | Chooses the cards per row. Each value is described under Values. Offered only when Layout is "Cards with a picture" or "". |
|
3 |
| Follow the category menu on this page | Shows only the category chosen in an Event Categories block on this page. | On or off | on |
| Category to show when none is picked | Chooses the category to show when none is picked. Each value is described under Values. |
|
none |
| Featured events only | Switches on or off: featured events only. | On or off | off |
| Show the picture | Switches on or off: show the picture. | On or off | on |
| Show the category | Switches on or off: show the category. | On or off | on |
| Show the date and time | Switches on or off: show the date and time. | On or off | on |
| Show the venue (or Online) | Shows the venue, or "Online". | On or off | on |
| Show a short description | Switches on or off: show a short description. | On or off | on |
| Button text | The button text. | Text | View event |
| Message when there are no events | The message shown when no events match. | Text | No events are scheduled right now. Check back soon. |
| When an event or speaker is clicked, open | Whether a clicked item opens Adhrit's own page for it, or a Metro page you choose. A Metro page is told which item was clicked, and its Single add-on shows that item. |
|
A Metro page I choose |
| Page that shows one event | The Metro page holding a Single Event add-on. Offered only when When an event or speaker is clicked, open is "A Metro page I choose" or "". |
|
Metro Adhrit Lms Event Module (not created yet) |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Title and text colour | The colour of titles (and of text where no text colour is set). | Any colour | #1f2a44 |
| Accent (dates, chips, links) | The colour of badges, prices, dates and links. | Any colour | #c8382a |
| Card background | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #1f2a44 |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Card corner radius (px) | Sets the card corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 22 |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Adhrit LMS Search
Blocks panel → Joomla and integrations · add-on key adhrit_search
The Adhrit LMS Search add-on is a search box for Adhrit LMS courses and articles, as a bar, a hero band or a compact field, with suggestions as the visitor types and suggested searches below.
- Courses, articles or both; three layouts; live suggestions with course pictures; suggested searches; full field and button styling.
- Searching the rest of the site - use the Search add-on.
When to use it
- A course catalogue hero: "What do you want to learn?".
When to choose another add-on
- A site-wide search → use Search.
Procedure
- Choose what to search and the layout; for the hero, write the heading and sub-heading.
- Write the placeholder, button words and accessible label.
- Choose live suggestions and course pictures, and add suggested searches.
- Set the field and button icons, placement and styling.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
- Suggestions appear after a few characters and can be chosen with the keyboard.
- List the three most searched subjects as suggested searches.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Search through | What the search looks through. |
|
Courses only |
| Layout | Chooses the layout. Each value is described under Values. |
|
Search bar |
| Heading (hero layout) | The heading. | Text | none |
| Sub-heading (hero layout) | The sub-heading. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| Placeholder text | The placeholder text. | Text | Search courses |
| Button text | The button text. | Text | Search |
| Accessible label for the input | The field's name for screen readers. | Text | Search courses |
| Suggest as you type | Suggests matching courses and articles as the visitor types. | On or off | on |
| Show course pictures in the suggestions | Shows course pictures beside the suggestions. | On or off | on |
| Suggested searches, one per line | Searches shown under the field as links, one per line. | Several lines of text | none |
| Show an icon in the field | Switches on or off: show an icon in the field. | On or off | on |
| Field icon | The field icon, chosen in the icon picker from the built-in icon set. Offered only when Show an icon in the field is "1" or "true" or "". | An icon | bi-search |
| Field icon sits | Chooses the field icon sits. Each value is described under Values. Offered only when Show an icon in the field is "1" or "true" or "". |
|
At the start |
| Button shows | Whether the button shows words, an icon, both, or is omitted. |
|
Text only |
| Button icon | The button icon, chosen in the icon picker from the built-in icon set. Offered only when Button shows is "Icon only" or "Icon and text". | An icon | bi-search |
| Button icon sits | Chooses the button icon sits. Each value is described under Values. Offered only when Button shows is "Icon and text". |
|
Before the text |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Alignment | Chooses the alignment. Each value is described under Values. |
|
Center |
| Largest width (px, 0 = full) | Sets the largest width, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 640 |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 999 |
| Field background | Sets the field background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Field text colour | Sets the field text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Field border colour | Sets the field border colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button placement | Where the button sits relative to the field. |
|
After the field |
| Button alignment (below the field) | The button's alignment when placed below the field. Offered only when Button placement is "Below the field". |
|
Centre |
| Field height (px, 0 = automatic) | Sets the field height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 0 |
| Text size in the field (px) | Sets the text size in the field, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Space between field and button (px) | Sets the space between field and button, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 8 |
| Button size | Chooses the button size. Each value is described under Values. |
|
Medium |
| Button padding, top and bottom (px, blank = by size) | Sets the button padding, top and bottom, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Button padding, left and right (px, blank = by size) | Sets the button padding, left and right, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Button corner radius (px, blank = same as field) | Sets the button corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Field icon colour | Sets the field icon colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Field icon size (px, blank = automatic) | Sets the field icon size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Adhrit LMS Single Course
Blocks panel → Joomla and integrations · add-on key adhrit_course
The Adhrit LMS Single Course add-on shows one course in full: picture, description, level, duration, lessons, rating, teachers, a curriculum summary and an enrol button. Following the page address, it becomes the single-course page that course cards link to.
- The course from the address or a chosen one; two layouts; the details to show; short or full description; link targets; colours.
- The lessons themselves - those are in Adhrit LMS.
When to use it
- The single-course page of an Adhrit LMS site.
- A landing page for one course.
When to choose another add-on
- Several courses → use Adhrit LMS Courses.
Procedure
- Create a Metro page for courses and place this block.
- Leave Show the course chosen by the link on; choose a course only for a page about that one course.
- Choose the layout, description type and details.
- In the Courses add-on, point Page that shows one course at this page.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
- Opened directly, the page shows the chosen course, or Adhrit's first featured course.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Show the course chosen by the link that opened this page | Shows the item named in the page address, as passed by the card the visitor clicked. The item chosen below is shown when the address names none, so the page is never empty. | On or off | on |
| Course | The course shown when the address names none. |
|
none |
| Layout | A feature layout with the picture beside the details, or a card. |
|
Feature - picture beside the details |
| Picture | Switches on or off: picture. | On or off | on |
| Description | Switches on or off: description. | On or off | on |
| Which description | The short or full description. Offered only when Description is "1" or "true" or "". |
|
Short |
| Level, duration, lessons and rating | Shows level, duration, lessons and rating. | On or off | on |
| Teachers | Switches on or off: teachers. | On or off | on |
| Curriculum summary | Shows a summary of the curriculum. | On or off | on |
| Enrol and cart button | Shows the enrol and cart button. | On or off | on |
| When a teacher or course is clicked, open | Whether a clicked item opens Adhrit's own page for it, or a Metro page you choose. A Metro page is told which item was clicked, and its Single add-on shows that item. |
|
Adhrit's own teacher or course page |
| Page that shows one teacher | The Metro page holding a Single Teacher add-on. Pages marked "not created yet" are suggested names; create the page first. Offered only when When a teacher or course is clicked, open is "A Metro page I choose". |
|
Metro Adhrit Lms Teacher (not created yet) |
| Page that shows one course | The Metro page holding a Single Course add-on. Offered only when When a teacher or course is clicked, open is "A Metro page I choose". |
|
Metro Adhrit Lms Course (not created yet) |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Colours and style | Whether the colours below are used, or the Adhrit module keeps its own appearance. The colours below take precedence over the site template, including its dark mode. |
|
Use the colours below |
| Title colour | The colour of titles (and of text where no text colour is set). Offered only when Colours and style is "Use the colours below" or "". | Any colour | #1f2a44 |
| Text colour (blank = the title colour) | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | none |
| Small print colour (blank = a lighter text colour) | The colour of small print. Empty uses a lighter shade of the text colour. Offered only when Colours and style is "Use the colours below" or "". | Any colour | none |
| Title font | The typeface of titles. Empty uses the template's font. Offered only when Colours and style is "Use the colours below" or "". |
|
none |
| Accent (badges, prices, links) | The colour of badges, prices, dates and links. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #c8382a |
| Card background colour | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #ffffff |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #1f2a44 |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #ffffff |
| Card corner radius (px) | Sets the card corner radius, in pixels. Leave it empty to use the add-on's default. Offered only when Colours and style is "Use the colours below" or "". | A whole number, in pixels | 22 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Adhrit LMS Single Event
Blocks panel → Joomla and integrations · add-on key adhrit_event
The Adhrit LMS Single Event add-on shows one event in full: banner, description, topics, speakers, a map of the venue, and booking and online-meeting buttons. Following the page address, it becomes the event page that event cards link to.
- The event from the address or a fallback; the details to show; booking and join buttons; link targets; colours.
- Ticket sales - booking opens Adhrit LMS.
When to use it
- The single-event page of an Adhrit LMS site.
When to choose another add-on
- A list of events → use Adhrit LMS Events.
Procedure
- Create a Metro page for events and place this block.
- Leave Show the event chosen by the link on, and choose a fallback.
- Tick the details to show and write the button words.
- Choose the speaker page and the all-events page.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
- Opened directly, it shows the chosen event, or the next upcoming one.
- The join button shows only when the event has an online meeting link.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Show the event chosen by the link that opened this page | Shows the item named in the page address, as passed by the card the visitor clicked. The item chosen below is shown when the address names none, so the page is never empty. | On or off | on |
| Event to show when no event is chosen | The event shown when the address names none. |
|
none |
| Show the banner picture | Switches on or off: show the banner picture. | On or off | on |
| Show the description | Switches on or off: show the description. | On or off | on |
| Show the topics | Switches on or off: show the topics. | On or off | on |
| Show the speakers | Switches on or off: show the speakers. | On or off | on |
| Show a map of the venue | Shows a map of the venue. | On or off | on |
| Booking button text | The booking button's words; it opens the event's booking page in Adhrit LMS. | Text | Book your place |
| Online meeting button text | The online meeting button's words; shown only for events with a meeting link. | Text | Join online |
| When an event or speaker is clicked, open | Whether a clicked item opens Adhrit's own page for it, or a Metro page you choose. A Metro page is told which item was clicked, and its Single add-on shows that item. |
|
A Metro page I choose |
| Page that shows one speaker | The Metro page holding a Single Speaker add-on. Offered only when When an event or speaker is clicked, open is "A Metro page I choose" or "". |
|
Metro Adhrit Lms Speaker Module (not created yet) |
| Page that lists all events | The Metro page that lists all events. Offered only when When an event or speaker is clicked, open is "A Metro page I choose" or "". |
|
Metro Adhrit Lms Events Module (not created yet) |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Title and text colour | The colour of titles (and of text where no text colour is set). | Any colour | #1f2a44 |
| Accent (dates, chips, links) | The colour of badges, prices, dates and links. | Any colour | #c8382a |
| Card background | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #1f2a44 |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Card corner radius (px) | Sets the card corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 22 |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Adhrit LMS Single Speaker
Blocks panel → Joomla and integrations · add-on key adhrit_speaker
The Adhrit LMS Single Speaker add-on shows one speaker: photograph, biography, links and the events they speak at. Following the page address, it becomes the speaker page that speaker cards link to.
- The speaker from the address or a fallback; photo, biography, links; their events, optionally including past ones; link targets; colours.
When to use it
- The single-speaker page of a conference site.
When to choose another add-on
- All speakers → use Adhrit LMS Speakers.
Procedure
- Create a Metro page for speakers and place this block.
- Leave Show the speaker chosen by the link on, and choose a fallback.
- Tick what shows, whether past events are included, and the list heading.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
- Opened directly, it shows the chosen speaker, or the first speaker.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Show the speaker chosen by the link that opened this page | Shows the item named in the page address, as passed by the card the visitor clicked. The item chosen below is shown when the address names none, so the page is never empty. | On or off | on |
| Speaker to show when none is chosen | The speaker shown when the address names none. |
|
none |
| Show the photo | Switches on or off: show the photo. | On or off | on |
| Show the biography | Switches on or off: show the biography. | On or off | on |
| Show website and social links | Switches on or off: show website and social links. | On or off | on |
| List the events they speak at | Lists the events the speaker speaks at. | On or off | on |
| Include past events | Includes past events in that list. Offered only when List the events they speak at is "1". | On or off | on |
| Heading above that list | The heading above that list. Offered only when List the events they speak at is "1". | Text | Speaking at |
| When an event or speaker is clicked, open | Whether a clicked item opens Adhrit's own page for it, or a Metro page you choose. A Metro page is told which item was clicked, and its Single add-on shows that item. |
|
A Metro page I choose |
| Page that shows one event | The Metro page holding a Single Event add-on. Offered only when When an event or speaker is clicked, open is "A Metro page I choose" or "". |
|
Metro Adhrit Lms Event Module (not created yet) |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Title and text colour | The colour of titles (and of text where no text colour is set). | Any colour | #1f2a44 |
| Accent (dates, chips, links) | The colour of badges, prices, dates and links. | Any colour | #c8382a |
| Card background | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #1f2a44 |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Card corner radius (px) | Sets the card corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 22 |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Adhrit LMS Single Teacher
Blocks panel → Joomla and integrations · add-on key adhrit_teacher
The Adhrit LMS Single Teacher add-on shows one teacher with their courses beneath. Following the page address, it becomes the detail page that teacher cards across the site link to.
- The teacher from the address or a chosen one; photo, details, biography, social links, courses with columns, a profile link; link targets; colours.
- A designed profile layout without courses - use the Teacher Profile.
When to use it
- The single-teacher page of an Adhrit LMS site.
When to choose another add-on
- A designed profile → use Adhrit: Teacher Profile.
- All teachers → use Adhrit LMS Teachers.
Procedure
- Create a Metro page for teachers and place this block.
- Leave Show the teacher chosen by the link on, and choose a fallback teacher.
- Tick what shows and the course columns.
- Set where a clicked course opens.
- In the Teachers add-on elsewhere, point Page that shows one teacher at this page.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
- Opened directly, the page shows the chosen teacher, or Adhrit's first teacher.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Show the teacher chosen by the link that opened this page | Shows the item named in the page address, as passed by the card the visitor clicked. The item chosen below is shown when the address names none, so the page is never empty. | On or off | on |
| Teacher | The teacher shown when the address names none. |
|
none |
| Photo | Switches on or off: photo. | On or off | on |
| Role, experience and specialism | Shows role, experience and specialism. | On or off | on |
| Biography | Switches on or off: biography. | On or off | on |
| Social links (as the teacher allows) | Switches on or off: social links. | On or off | on |
| Their courses | Lists the teacher's courses. | On or off | on |
| Course columns | Chooses the course columns. Each value is described under Values. Offered only when Their courses is "1" or "true" or "". |
|
3 |
| Link to Adhrit's full profile | Links to Adhrit's full profile. | On or off | on |
| When a teacher or course is clicked, open | Whether a clicked item opens Adhrit's own page for it, or a Metro page you choose. A Metro page is told which item was clicked, and its Single add-on shows that item. |
|
Adhrit's own teacher or course page |
| Page that shows one teacher | The Metro page holding a Single Teacher add-on. Pages marked "not created yet" are suggested names; create the page first. Offered only when When a teacher or course is clicked, open is "A Metro page I choose". |
|
Metro Adhrit Lms Teacher (not created yet) |
| Page that shows one course | The Metro page holding a Single Course add-on. Offered only when When a teacher or course is clicked, open is "A Metro page I choose". |
|
Metro Adhrit Lms Course (not created yet) |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Colours and style | Whether the colours below are used, or the Adhrit module keeps its own appearance. The colours below take precedence over the site template, including its dark mode. |
|
Use the colours below |
| Title colour | The colour of titles (and of text where no text colour is set). Offered only when Colours and style is "Use the colours below" or "". | Any colour | #1f2a44 |
| Text colour (blank = the title colour) | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | none |
| Small print colour (blank = a lighter text colour) | The colour of small print. Empty uses a lighter shade of the text colour. Offered only when Colours and style is "Use the colours below" or "". | Any colour | none |
| Title font | The typeface of titles. Empty uses the template's font. Offered only when Colours and style is "Use the colours below" or "". |
|
none |
| Accent (badges, prices, links) | The colour of badges, prices, dates and links. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #c8382a |
| Card background colour | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #ffffff |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #1f2a44 |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #ffffff |
| Card corner radius (px) | Sets the card corner radius, in pixels. Leave it empty to use the add-on's default. Offered only when Colours and style is "Use the colours below" or "". | A whole number, in pixels | 22 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Adhrit LMS Speakers
Blocks panel → Joomla and integrations · add-on key adhrit_speakers
The Adhrit LMS Speakers add-on shows speakers as cards - for a conference page, or the speakers of one event when placed on a single-event page.
- Count, columns and order; one event's speakers; photo, role, biography line and links; an empty message; link targets; colours.
When to use it
- A conference speakers page.
- Below the details on a single-event page.
When to choose another add-on
- One speaker in full → use Adhrit LMS Single Speaker.
- People typed in by hand → use Team / Staff.
Procedure
- Set how many speakers, cards per row and the order.
- On a single-event page, tick show only that event's speakers; or choose an event.
- Tick what each card shows and write the empty message.
- Choose where a clicked speaker opens.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| How many speakers | Sets the how many speakers. Leave it empty to use the add-on's default. | A whole number | 8 |
| Cards per row | Chooses the cards per row. Each value is described under Values. |
|
4 |
| Order | Chooses the order. Each value is described under Values. |
|
Adhrit's own order |
| On a single event page, show only that event's speakers | On a single-event page, shows only that event's speakers. | On or off | off |
| Show only the speakers of this event | Shows only the speakers of this event. |
|
none |
| Show the photo | Switches on or off: show the photo. | On or off | on |
| Show role and company | Shows role and company. | On or off | on |
| Show a line of the biography | Shows one line of the biography. | On or off | on |
| Show website and social links | Switches on or off: show website and social links. | On or off | on |
| Message when there are no speakers | The message shown when there are no speakers. | Text | Speakers will be announced soon. |
| When an event or speaker is clicked, open | Whether a clicked item opens Adhrit's own page for it, or a Metro page you choose. A Metro page is told which item was clicked, and its Single add-on shows that item. |
|
A Metro page I choose |
| Page that shows one speaker | The Metro page holding a Single Speaker add-on. Offered only when When an event or speaker is clicked, open is "A Metro page I choose" or "". |
|
Metro Adhrit Lms Speaker Module (not created yet) |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Title and text colour | The colour of titles (and of text where no text colour is set). | Any colour | #1f2a44 |
| Accent (dates, chips, links) | The colour of badges, prices, dates and links. | Any colour | #c8382a |
| Card background | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #1f2a44 |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | #ffffff |
| Card corner radius (px) | Sets the card corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 22 |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Adhrit LMS Teachers
Blocks panel → Joomla and integrations · add-on key adhrit_teachers
The Adhrit LMS Teachers add-on shows teachers as a grid with optional filters - a specialism side panel, a search box and a specialism dropdown - and links each teacher and course to a page of your choice.
- Count, columns, order; photo, details, social links and a "view all" button; three filters; link targets; colours.
- Teachers not in Adhrit LMS - use the Team add-on.
When to use it
- A faculty or instructors page.
When to choose another add-on
- One teacher → use Adhrit: Teacher Profile.
- People typed in by hand → use Team / Staff.
Procedure
- Set how many teachers, the columns and the order.
- Tick what each card shows and whether a "view all" button appears.
- Turn on the filters needed.
- Choose what a clicked teacher or course opens and, for Metro pages, which pages.
- On the Style tab, choose the module's look or your own colours.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
- Filters need Adhrit LMS 5.12.3 or later; older versions ignore them.
- Use one filter type; a side panel and a dropdown for the same thing compete.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Filters do not appear. | Adhrit LMS is older than 5.12.3. Update it. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| How many teachers | The largest number of teachers shown. | A whole number | 6 |
| Columns | Chooses the columns. Each value is described under Values. |
|
3 |
| Order | Chooses the order. Each value is described under Values. |
|
Adhrit's ordering |
| Photo | Switches on or off: photo. | On or off | on |
| Role, experience and course count | Shows role, experience and course count. | On or off | on |
| Social links (as each teacher allows) | Shows social links, as each teacher allows. | On or off | on |
| A "view all" button under the grid | Shows a "view all" button under the grid. | On or off | on |
| Button text | The button text. Offered only when A "view all" button under the grid is "1" or "true" or "". | Text | View All Teachers |
| Filter: specialism side panel | A side panel of specialisms. | On or off | off |
| Filter: search box (name, role or specialism) | A search box matching name, role or specialism. | On or off | off |
| Filter: specialism dropdown | A specialism dropdown. | On or off | off |
| When a teacher or course is clicked, open | Whether a clicked item opens Adhrit's own page for it, or a Metro page you choose. A Metro page is told which item was clicked, and its Single add-on shows that item. |
|
Adhrit's own teacher or course page |
| Page that shows one teacher | The Metro page holding a Single Teacher add-on. Pages marked "not created yet" are suggested names; create the page first. Offered only when When a teacher or course is clicked, open is "A Metro page I choose". |
|
Metro Adhrit Lms Teacher (not created yet) |
| Page that shows one course | The Metro page holding a Single Course add-on. Offered only when When a teacher or course is clicked, open is "A Metro page I choose". |
|
Metro Adhrit Lms Course (not created yet) |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Colours and style | Whether the colours below are used, or the Adhrit module keeps its own appearance. The colours below take precedence over the site template, including its dark mode. |
|
Use the colours below |
| Title colour | The colour of titles (and of text where no text colour is set). Offered only when Colours and style is "Use the colours below" or "". | Any colour | #1f2a44 |
| Text colour (blank = the title colour) | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | none |
| Small print colour (blank = a lighter text colour) | The colour of small print. Empty uses a lighter shade of the text colour. Offered only when Colours and style is "Use the colours below" or "". | Any colour | none |
| Title font | The typeface of titles. Empty uses the template's font. Offered only when Colours and style is "Use the colours below" or "". |
|
none |
| Accent (badges, prices, links) | The colour of badges, prices, dates and links. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #c8382a |
| Card background colour | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #ffffff |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #1f2a44 |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Colours and style is "Use the colours below" or "". | Any colour | #ffffff |
| Card corner radius (px) | Sets the card corner radius, in pixels. Leave it empty to use the add-on's default. Offered only when Colours and style is "Use the colours below" or "". | A whole number, in pixels | 22 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Adhrit: Teacher Profile
Blocks panel → Joomla and integrations · add-on key adhrit_teacher_profile
The Adhrit Teacher Profile add-on presents one Adhrit LMS teacher in a designed layout - photograph beside the biography, a large split, or a card - with a heading that can include the teacher's name, and a link to the full profile. Fallback text lets the page be designed before a teacher is chosen.
- A chosen teacher, or the teacher named in the page address.
- Three layouts, photo side, label and heading with
{name}. - Role, experience, specialism, biography length, social links and a profile link.
- Fallback name, role, biography and photo; full styling of heading, text, links, button, photo and box.
- The teacher's courses - use the Single Teacher add-on.
When to use it
- An "about the teacher" section on a course or landing page.
When to choose another add-on
- A teacher with their courses → use Adhrit LMS Single Teacher.
- A grid of teachers → use Adhrit LMS Teachers.
Procedure
- Choose the teacher, or tick Show the teacher chosen by the link for a detail page.
- Choose the layout and photo side, and write the label and heading.
- Tick the details to show and the biography length.
- Choose the profile link, its style and where it opens.
- Fill in the fallback name, role, biography and photo.
- On the Style tab, set the heading, text, link, button, photo and box styling.
Behaviour on the page
- Requires Adhrit LMS to be installed and enabled.
- Without Adhrit LMS, or before a teacher is chosen, the fallback text and photo are shown.
- Write the heading as "Meet {name}" so one page design works for every teacher.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Teacher | The teacher shown. |
|
none |
| Show the teacher chosen by the link that opened this page instead | Shows the item named in the page address, as passed by the card the visitor clicked. The item chosen below is shown when the address names none, so the page is never empty. | On or off | off |
| Layout | How the photo and details are arranged. |
|
Small photo beside the details |
| Photo side | Chooses the photo side. Each value is described under Values. Offered only when Layout is "Large photo beside the details (fills a section)" or "Small photo beside the details". |
|
Left |
| Small label above the heading | The small label above the heading. | Text | none |
| Heading ({name} is the teacher's name) | The heading. {name} is replaced by the teacher's name. |
Text | {name} |
| Photo | Switches on or off: photo. | On or off | on |
| Role | Switches on or off: role. | On or off | on |
| Experience | Switches on or off: experience. | On or off | on |
| Specialism | Switches on or off: specialism. | On or off | on |
| Biography | Switches on or off: biography. | On or off | on |
| Biography length in words (0 = all of it) | The biography's length in words. 0 shows all of it. | A whole number (0 = all of it) | 0 |
| Website and social links | Switches on or off: website and social links. | On or off | off |
| Link to the full profile | Shows a link to the teacher's full profile. | On or off | on |
| Link text | The link text. | Text | View full profile |
| Link looks like | Whether the profile link is text or a button. |
|
A text link |
| The profile link opens | Whether a clicked item opens Adhrit's own page for it, or a Metro page you choose. A Metro page is told which item was clicked, and its Single add-on shows that item. |
|
Adhrit's own teacher page |
| Page that shows one teacher | The Metro page holding a Single Teacher add-on. Pages marked "not created yet" are suggested names; create the page first. Offered only when The profile link opens is "A Metro page (the teacher in its address)". |
|
Metro Adhrit Lms Teacher Module (not created yet) |
| Link | The address, for "A link I type". Offered only when The profile link opens is "A link I type". | A link | none |
| Fallback name (shown until a teacher is picked, or without Adhrit LMS) | Shown until a teacher is chosen, or without Adhrit LMS. | Text | none |
| Fallback role | The fallback role. | Text | none |
| Fallback biography | The fallback biography. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| Fallback photo (also used when the teacher has none) | Shown before a teacher is chosen, and when the teacher has no photo. | A picture | none |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Heading level | Chooses the heading level. Each value is described under Values. |
|
H3 |
| Heading font | Chooses the heading font. Each value is described under Values. |
|
none |
| Heading size (px, blank = inherit) | Sets the heading size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Heading weight | Chooses the heading weight. Each value is described under Values. |
|
none |
| Heading colour | Sets the heading colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Heading colour on hover (when it links) | Sets the heading colour on hover colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Label background | Sets the label background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Label text colour | Sets the label text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Role colour | Sets the role colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Fact label colour (Experience, Specialist in) | The colour of fact labels such as "Experience". | Any colour | none |
| Link colour | Sets the link colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Link colour on hover | Sets the link colour on hover colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button background | Sets the button background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button text colour | Sets the button text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button background on hover | Sets the button background on hover colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button text colour on hover | Sets the button text colour on hover colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Button corner radius (px) | Sets the button corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 999 |
| Photo shape | The shape the photo is cropped to. |
|
Portrait 4:5 |
| Photo width (inline: px; split: % of the width) | The photo's width: pixels in the inline layout, a percentage in the split layout. | A whole number, in pixels | none |
| Photo corner radius (px) | Sets the photo corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 12 |
| Photo shadow | Switches on or off: photo shadow. | On or off | off |
| Photo hover effect | What the photo does on hover. |
|
none |
| Box background | Sets the box background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Box padding (px) | Sets the box padding, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Box corner radius (px) | Sets the box corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Box shadow | Switches on or off: box shadow. | On or off | off |
| Text alignment | Chooses the text alignment. Each value is described under Values. |
|
Left |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Article Scroller
Blocks panel → Joomla and integrations · add-on key article_scroller
The Article Scroller add-on presents Joomla articles as a moving strip or a grid with a heading of its own, chosen from a set of numbered presets (cards, overlays, lists and more). It adds fallbacks for articles without pictures, hover and arrival effects, line cropping and a continuous ticker mode.
- Numbered presets; heading, sub-heading and alignment.
- Category, count, order; strip or grid; per-screen counts.
- A fallback picture or icon, or one picture for every article.
- Nine hover effects, six arrivals, title and intro cropping, a continuous ticker.
- Full articles on the page.
When to use it
- News, notices and blog posts in a band that should look designed.
When to choose another add-on
- A simpler grid or carousel of articles → use Joomla Articles.
- Rudra ERP notices → use Rudra: Notice Board.
Procedure
- Choose a preset.
- Write the heading and sub-heading.
- Choose the category, count and order, the strip or grid, and the number per screen size.
- Choose what each card shows and the fallback picture or icon.
- Choose the hover effect, arrival and line cropping.
- For a ticker, tick Continuous ticker scroll and set the seconds per item.
- On the Style tab, adjust colours, sizes and the slider controls.
Behaviour on the page
- Presets set a starting look; the Style tab adjusts it.
- The ticker scrolls continuously and pauses while the pointer is over it.
- Articles are read live, as for Joomla Articles.
- Crop titles to two lines so cards align.
- Set a fallback picture in the brand colours for articles without images.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Preset | The starting design of the cards. |
|
Cards — 01 · Card |
| Heading above the strip | The heading above the strip. | Text | none |
| Sub-heading | The sub-heading. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| Heading alignment | Chooses the heading alignment. Each value is described under Values. |
|
Center |
| Category | The category the articles come from. |
|
none |
| How many articles | The largest number of articles shown. | A whole number | 8 |
| Order by | Chooses the order by. Each value is described under Values. |
|
Newest first |
| Show as | A scrolling strip or a grid. |
|
Scrolling strip |
| Per view — desktop | Chooses the per view — desktop. Each value is described under Values. |
|
3 |
| Per view — tablet | Chooses the per view — tablet. Each value is described under Values. |
|
2 |
| Per view — mobile | Chooses the per view — mobile. Each value is described under Values. |
|
1 |
| Show the article image | Switches on or off: show the article image. | On or off | on |
| Show a short intro | Switches on or off: show a short intro. | On or off | on |
| Show the date | Switches on or off: show the date. | On or off | on |
| Intro length (characters) | Sets the intro length (characters). Leave it empty to use the add-on's default. | A whole number (characters) | 130 |
| Button text (blank = whole card links) | The button text. | Text | none |
| Auto-advance | Switches on or off: auto-advance. | On or off | off |
| Seconds between slides | Sets the seconds between slides. Leave it empty to use the add-on's default. | A whole number | 6 |
| Picture for articles with no image of their own | A picture used for articles that have none. | A picture | none |
| Icon, if there is no picture either | An icon used when there is no picture at all. | An icon | bi-file-earmark-text |
| Use that picture for every article, not only the ones missing one | Uses the fallback picture for every article. | On or off | off |
| On hover | What a card does when the pointer is over it. |
|
Lift |
| Cards arrive by | How cards appear as they scroll into view. |
|
Already there |
| Delay between cards arriving (ms) | The pause between cards arriving, in milliseconds. | A whole number, in milliseconds | 80 |
| Crop the title after N lines (0 = never) | Crops titles after this many lines. 0 never crops. | A whole number (0 = never) | 2 |
| Crop the intro after N lines (0 = never) | Crops intros after this many lines. 0 never crops. | A whole number (0 = never) | 3 |
| Continuous ticker scroll | Scrolls the strip continuously instead of card by card. | On or off | off |
| Ticker seconds per item | Seconds each card takes to pass in ticker mode. | A whole number | 4 |
| Movement | "Slide by slide" settles each card into place; "Free scroll" stops wherever the visitor lets go. |
|
Slide by slide |
| At the last slide | What happens after the last card: return to the first, or stop. |
|
Return to the first slide |
| Let the mouse wheel move the slider | Lets a mouse wheel or trackpad move the strip sideways. The page scrolls normally once the strip reaches either end. | On or off | off |
| Slide effect | A visual treatment of the cards near the current one. Effects add no downloads. |
|
Natural scrolling |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Image height (px) | Sets the image height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 200 |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 20 |
| Card background | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Title colour | Sets the title colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Date colour | Sets the date colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Accent (rules, numbers, buttons) | The colour of rules, numbers and buttons. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Title size (px) | Sets the title size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Text alignment | Chooses the text alignment. Each value is described under Values. |
|
Left |
| Legacy dots | The dots used by earlier versions. Kept for pages built with them; use Slide indicators instead. | On or off | none |
| Show previous and next arrows | Shows previous and next buttons. | On or off | on |
| Arrow icon | Chooses the arrow icon. Each value is described under Values. |
|
Chevron |
| Arrow position | Where the arrow buttons sit relative to the strip. |
|
Inside, vertically centred |
| Arrow button size (px) | Sets the arrow button size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 42 |
| Arrow colour | Sets the arrow colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Arrow background | Sets the arrow background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Slide indicators | The markers that show the current position and let the visitor jump. |
|
Dots |
| Indicator position | Chooses the indicator position. Each value is described under Values. |
|
Inside, along the bottom |
| Indicator alignment | Chooses the indicator alignment. Each value is described under Values. |
|
Center |
| Indicator colour | Sets the indicator colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Current indicator colour | Sets the current indicator colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Joomla Articles
Blocks panel → Joomla and integrations · add-on key joomla_articles
The Joomla Articles add-on shows articles from a Joomla category as cards in a grid or a carousel, drawn live from the site each time the page is viewed. Each card can show the article's picture, a short intro, the date and a button.
- A category (or all), a count and an order; grid or carousel; per-screen counts; picture, intro, date and button; the shared slider controls.
- Full articles on the page - cards link to each article.
- Filtering by tag or author.
When to use it
- Latest news on a home page.
- Blog posts, case studies or events kept as Joomla articles.
When to choose another add-on
- A moving strip of articles with presets and a heading → use Article Scroller.
- Hand-written cards → use Carousel Pro.
Procedure
- Choose the category, how many articles and the order.
- Choose the grid or the carousel, and the number per screen size.
- Choose what each card shows and the image height; set the intro length.
- Write the button words, or leave them empty to make the whole card a link.
- For a carousel, set auto-advance and the slider controls.
Behaviour on the page
- Only published articles whose access level the visitor holds are shown. Articles are not filtered by language, so on a multilingual site choose a category per language.
- The picture is the article's intro image, or its full image when it has no intro image.
- New articles appear without editing the page.
- Give every article in the category an image, or turn pictures off; otherwise cards are uneven.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| No articles appear. | The category has no published articles visible to the public, or the chosen category is unpublished. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Category | The category the articles come from. |
|
none |
| How many articles | The largest number of articles shown. | A whole number | 6 |
| Order by | The order articles are shown in. |
|
Newest first |
| Show as | A carousel or a grid. |
|
Carousel |
| Per view / columns — desktop | Cards per view, or columns, on desktop screens. |
|
3 |
| Per view / columns — tablet | Cards per view, or columns, on tablets. |
|
2 |
| Per view / columns — mobile | Cards per view, or columns, on phones. |
|
1 |
| Show the article image | Switches on or off: show the article image. | On or off | on |
| Image height (px) | The height of each card's picture. | A whole number, in pixels | 190 |
| Show a short intro | Switches on or off: show a short intro. | On or off | on |
| Intro length (characters) | The intro's length, in characters. | A whole number (characters) | 140 |
| Show the date | Switches on or off: show the date. | On or off | on |
| Button text (blank = whole card links) | The button words. Empty makes the whole card the link. | Text | Read more |
| Gap (px) | Sets the gap, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 16 |
| Auto-advance (carousel only) | Moves the carousel on by itself. | On or off | off |
| Seconds between slides | Sets the seconds between slides. Leave it empty to use the add-on's default. | A whole number | 6 |
| Movement | "Slide by slide" settles each card into place; "Free scroll" stops wherever the visitor lets go. |
|
Slide by slide |
| At the last slide | What happens after the last card: return to the first, or stop. |
|
Return to the first slide |
| Let the mouse wheel move the slider | Lets a mouse wheel or trackpad move the strip sideways. The page scrolls normally once the strip reaches either end. | On or off | off |
| Slide effect | A visual treatment of the cards near the current one. Effects add no downloads. |
|
Natural scrolling |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Legacy dots | The dots used by earlier versions. Kept for pages built with them; use Slide indicators instead. | On or off | none |
| Show previous and next arrows | Shows previous and next buttons. | On or off | on |
| Arrow icon | Chooses the arrow icon. Each value is described under Values. |
|
Chevron |
| Arrow position | Where the arrow buttons sit relative to the strip. |
|
Inside, vertically centred |
| Arrow button size (px) | Sets the arrow button size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 42 |
| Arrow colour | Sets the arrow colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Arrow background | Sets the arrow background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Slide indicators | The markers that show the current position and let the visitor jump. |
|
Dots |
| Indicator position | Chooses the indicator position. Each value is described under Values. |
|
Inside, along the bottom |
| Indicator alignment | Chooses the indicator alignment. Each value is described under Values. |
|
Center |
| Indicator colour | Sets the indicator colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Current indicator colour | Sets the current indicator colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Joomla Module
Blocks panel → Joomla and integrations · add-on key joomla_module
The Joomla Module add-on places any Joomla site module inside a Metro page: a login form, a module from another extension, a menu, a newsletter sign-up - anything already set up in Site Modules. It can also wrap the module in a styled card so that a module designed for a light page reads correctly over a picture or a dark band.
- Any site module, chosen from a list, by title, or by template position.
- Three wrappers (none, HTML5, card).
- A background (the module's own, the page accent, a tint, a chosen colour or a template colour variable), text and link colours, padding, corners, border and shadow.
- Custom CSS for anything else, on the Advanced tab, where
&stands for this block. - A note, visible to editors only, when a module produces nothing.
- Creating or configuring the module - that is done in System → Site Modules.
- Changing how the module itself works; only its surroundings are styled.
When to use it
- Using a form, search or listing from another extension inside a designed page.
- A booking form over a hero picture.
- Showing the same module on several Metro pages without copying its content.
When to choose another add-on
- A contact form → use Contact Form.
- A site search → use Search.
- Articles from a category → use Joomla Articles.
- Markup from an embed code → use Custom HTML (Super User only).
Procedure
- Create and configure the module in System → Site Modules, and publish it.
- Place the Joomla Module block and choose how to find the module: from the list, by title, or by position.
- Choose the module, or type its exact title or the position name.
- Choose the wrapper.
- On the Style tab, set a background, padding and corner radius if the module sits over a picture or a dark band. Tick Clear the module's own background if the module paints one.
- For anything else, write CSS on the Advanced tab using
&for this block, for example& label { color:#fff; }. - View the page while signed in as an editor; if the module does not show, a note explains why.
Behaviour on the page
- A module picked from the list or by title shows on this page whatever its Menu Assignment says. A new Joomla module starts assigned to "No pages", and would otherwise never show.
- A position shows every module assigned there, and does follow each module's Menu Assignment.
- The module's own access level, language and published state are respected.
- When a module produces nothing, signed-in editors see a note naming the likely cause; visitors see nothing.
- A module styled for a light page keeps its own dark text. Over a dark hero, give it a white background, padding and a corner radius, and it becomes a card.
- Pick modules from the list rather than by title; renaming the module then does not break the page.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Nothing appears. | View the page signed in as an editor to read the note. Common causes: the module is unpublished, restricted to another access level or language, or has no content for this page. |
| The module is invisible over a dark section. | Its text is dark. Set a background colour and padding on the Style tab, or set the text and link colours. |
| A position shows nothing. | The modules in that position are not assigned to this menu item. Choose the module from the list instead, or change its Menu Assignment. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Choose by | How the module is found: picked from a list, by its exact title, or by template position. |
|
Module title |
| Module | The module to show, from the site's published modules. Offered only when Choose by is "Pick from the list of site modules". |
|
none |
| Module title (exactly as in Site Modules) | The module's title exactly as in Site Modules. Offered only when Choose by is "Module title" or "". | Text | none |
| Template position | A template position; every module assigned there for this page is shown. Offered only when Choose by is "Template position (follows Menu Assignment)". | Text | none |
| Chrome / layout | The wrapper placed around the module's output. |
|
None (raw output) |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Background | Where the background colour comes from. |
|
none |
| Background colour | Sets the background colour. Leave it empty to use the colour the section or the site template already gives. Offered only when Background is "A colour picked here". | Any colour | none |
| Template colour variable | The name of a CSS custom property defined by the site template, such as --cassiopeia-color-primary. It follows the template when its colours change. Offered only when Background is "A colour variable from the site template". |
Text | --mpb-accent |
| Clear the module's own background so this one shows | Removes the module's own background so the one set here shows. | On or off | none |
| Text colour | Sets the text colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Link colour | The colour of links inside the module. | Any colour | none |
| Padding (px) | Sets the padding, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | none |
| Border colour | Sets the border colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Shadow | A shadow under the wrapper. |
|
none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Repository Showcase
Blocks panel → Joomla and integrations · add-on key repository_showcase
The Repository Showcase add-on presents public code projects as cards - for a developer portfolio or an open-source page - loaded from GitHub, GitLab, Bitbucket or Codeberg, or written by hand. It can also show a commit or pull-request timeline for one repository, with tag filters, metrics and a tech-stack row.
- Repositories from four hosts, or manual cards that also serve as a fallback.
- A repository list, a commit timeline or a pull-request timeline.
- Grid, feature cards or timeline; tag filters; metrics; last update; tech stack.
- Links to the repository, or to your own project page.
- Private repositories.
When to use it
- A developer or agency portfolio.
- An open-source project page showing activity.
When to choose another add-on
- Projects as picture cards → use Metro Image Slider.
Procedure
- Write the heading and introduction.
- Choose what to show, the repository host and the public account; for a timeline, the repository name.
- Add manual project cards; they show when no account is set or the host cannot be reached.
- Choose the presentation, columns and what a card opens.
- Choose the filters, metrics and detail.
Behaviour on the page
- Public data is loaded from the host's public interface; if loading fails, the manual cards are shown.
- A project page you wrote is matched to a repository by name, so your link survives when live data arrives.
- Deep metrics make extra requests and are limited to four projects. Code size is the host's reported bytes, not an estimated line count.
- Fill in the manual cards even when an account is set.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| Only the manual cards show. | The account name is wrong, the host limited the requests, or the account has no public repositories. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Heading | The heading. | Text | Selected repositories |
| Introduction | The introduction. Line breaks are kept; [b], [i] and [c=#hex] formatting is available. |
Several lines of text | none |
| What to show | Repositories, or a commit or pull-request timeline for one repository. |
|
Repositories |
| Repository source | Where repositories are loaded from, or manual cards only. |
|
Manual projects only |
| Public account name | The public account (on Bitbucket, the workspace). | Text | none |
| Repository name | The repository, for the timelines. | Text | none |
| Maximum projects | The largest number of projects shown. | A whole number | 6 |
| Projects and fallback cards | Manual project cards, also used as a fallback. Each has a name, description, language, link, tags, stack and counts. | Each row, in order:
|
none |
| Timeline entries, when no provider is set | Manual timeline entries, used when no host is set. | Each row, in order:
|
none |
| Presentation | The presentation. |
|
Responsive grid |
| Cards across on desktop | Chooses the cards across on desktop. Each value is described under Values. |
|
3 |
| A card opens | Whether a card opens the repository, or your own project page where one is written. |
|
The repository on its host |
| Let visitors filter by tag | Lets visitors filter cards by tag. | On or off | on |
| Show repository metrics | Shows metrics such as stars and forks. | On or off | on |
| Show last update | Switches on or off: show last update. | On or off | on |
| Show the tech stack row | Shows the tech-stack row. | On or off | on |
| Metric detail | Summary metrics in one request, or deep metrics with extra requests. |
|
Summary - one request |
| Projects receiving deep metrics | How many projects receive deep metrics, up to four. | A whole number | 3 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Card background | Sets the card background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Accent colour | Sets the accent colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Corner radius (px) | Sets the corner radius, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 8 |
Its font, size, weight, spacing, shadow and hover-effect settings are the ones described in Settings most add-ons share.
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Rudra: Admission Enquiry Form
Blocks panel → Joomla and integrations · add-on key rudra_admission_enquiry
The Rudra Admission Enquiry Form add-on places Rudra Pro ERP's admission enquiry form on a Metro page. Enquiries are recorded in the ERP's admissions module, where staff follow them up, rather than sent by email.
- The ERP's enquiry form with your title and button words.
- Changing the form's fields - they are defined by the ERP.
When to use it
- An admissions page for a school or college using Rudra Pro ERP.
When to choose another add-on
- An enquiry sent by email → use Contact Form.
Procedure
- Write the form title and the button words.
- Submit a test enquiry and confirm it appears in the ERP.
Behaviour on the page
- Requires Rudra Pro ERP to be installed and enabled.
- Submissions are stored in the ERP, not emailed.
- Place it beside the admissions dates and fees so the enquiry follows the information.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Form title | The form title. | Text | Admission Enquiry |
| Submit button text | The words on the submit button. | Text | Send Enquiry |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Rudra: Notice Board
Blocks panel → Joomla and integrations · add-on key rudra_notice_board
The Rudra Notice Board add-on shows notices published in Rudra Pro ERP, filtered to an audience, with an optional extract and date. Notices posted in the ERP appear on the website without editing the page.
- A title, a count, an audience filter, the notice text with a length, and the date.
- Creating notices - they are written in Rudra Pro ERP.
When to use it
- A school or college home page and notices page.
When to choose another add-on
- Notices kept as Joomla articles → use Article Scroller.
- A single fixed notice → use Alert / Notice.
Procedure
- Write the section title.
- Set how many notices to show and the audience.
- Choose whether the text and date show, and the text length.
Behaviour on the page
- Notices are read from the ERP each time the page is viewed, newest first.
- Requires Rudra Pro ERP to be installed and enabled.
- Show public notices only on public pages; staff notices belong behind a login.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| No notices appear. | None are published for the chosen audience, or Rudra Pro ERP is not installed. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Section title | The section title. | Text | Notices |
| How many to show | The largest number of notices shown. | A whole number | 5 |
| Audience | Which notices are shown: those for all audiences, or every notice regardless of audience. |
|
All |
| Show the notice text | Switches on or off: show the notice text. | On or off | off |
| Notice text length (characters) | The extract's length, in characters. | A whole number (characters) | 160 |
| Show the date | Switches on or off: show the date. | On or off | on |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Rudra: Staff Profile
Blocks panel → Joomla and integrations · add-on key rudra_staff_profile
The Rudra Staff Profile add-on shows one staff member from Rudra Pro ERP: photograph, role, qualification, experience and biography. Changes made in the ERP appear on the website automatically.
- One staff member, with a choice of the details to show.
- Several staff at once - place several blocks, or use the Team add-on.
When to use it
- A principal's message, a head of department, a faculty page.
When to choose another add-on
- Several people typed in by hand → use Team / Staff.
Procedure
- Choose the staff member.
- Tick the details to show.
Behaviour on the page
- Requires Rudra Pro ERP to be installed and enabled.
- Details are read from the ERP each time the page is viewed.
- Keep staff photographs in the ERP consistent in framing.
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Staff member | The staff member shown. |
|
none |
| Show photo | Switches on or off: show photo. | On or off | on |
| Show role | Switches on or off: show role. | On or off | on |
| Show qualification | Switches on or off: show qualification. | On or off | on |
| Show experience | Switches on or off: show experience. | On or off | on |
| Show biography | Switches on or off: show biography. | On or off | on |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Advanced add-ons
For the occasions nothing else covers. Both of these are worth using sparingly.
Custom HTML (Super User only)
Blocks panel → Advanced · add-on key html
The Custom HTML add-on places markup you supply directly into the page. It exists for third-party embeds that no add-on covers - a booking widget, a payment button, a mapping or scheduling service - and is restricted to Super Users, because markup placed this way runs with the full trust of the site.
- Any HTML, including a script tag from a service you use, exactly as pasted.
- Editing restricted to Super Users; other editors see the block but cannot change it.
- Layout. Markup pasted here does not respond to the builder's design settings, does not adapt to phones unless it was written to, and is not included in page templates offered to others.
- Publishing in the Rudra Store: templates containing Custom HTML are refused.
When to use it
- Embedding a widget whose provider gives you an HTML snippet.
- A tracking or verification snippet required on one page only.
When to choose another add-on
- A video from YouTube or Vimeo → use Video.
- A map → use Map.
- A contact form → use Contact Form.
- A module from another Joomla extension → use Joomla Module.
Procedure
- Sign in as a Super User.
- Place the Custom HTML block and paste the code you were given into HTML.
- Save and check the live page; some embeds do not run inside the builder's preview.
Behaviour on the page
- The code is output unchanged. Scripts run with the page's permissions.
- The builder's preview may not execute scripts; check the published page.
- Use it for code you have been given by a trusted provider, not for layout that blocks can build.
- Keep one embed per block, so each can be removed independently.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The embed shows in the page but not in the preview. | Scripts do not run in the preview. Check the published page. |
| An editor cannot change the block. | Only Super Users may edit Custom HTML. This is intentional. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| HTML | The markup placed on the page, exactly as typed. | Several lines of text | none |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Loading Screen
Blocks panel → Advanced · add-on key preloader
The Loading Screen add-on covers the page with a branded screen while it loads - an animation, the logo and a short message - and fades it away when the page is ready. A minimum display time prevents a flash on fast connections, and a maximum ensures the page is never held back if something fails to load.
- Twenty-four animations, or the logo on its own.
- A message, colours, size and speed.
- A minimum and a maximum display time, and a fade-out duration.
- Waiting for anything other than the page itself, such as a third-party widget.
- Showing progress as a percentage.
When to use it
- A heavy page - a video hero, a 360 view, a large gallery - where an unstyled flash before everything settles would look broken.
- A launch or campaign page where the brand moment matters.
When to choose another add-on
- An entrance animation for the page, with no screen covering it → use Intro Curtain.
Procedure
- Place the Loading Screen anywhere on the page; it covers the whole screen regardless of where it sits.
- Choose the animation, add the logo and a short message.
- Set Show for at least (300 to 600 ms) and Give up and show the page after (3000 to 5000 ms).
- On the Style tab, set the background, colours, size, speed and the fade-out time.
Behaviour on the page
- It is removed from the page once it has faded, so it does not block clicks afterwards.
- Visitors who ask their device for reduced motion see it without animation and for no longer than necessary.
- Keep the minimum short. A loading screen shown longer than the page took to load makes a fast site feel slow.
- Use one per site, not per page, so returning visitors are not shown it repeatedly on every click.
Troubleshooting
| Symptom | Cause and remedy |
|---|---|
| The screen never goes away. | A script error on the page stops it from being told the page is ready; it is still removed after Give up and show the page after. Lower that time and check the browser console. |
Settings reference
General tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Animation | The animation shown while the page loads, or "Your own logo" to show only the logo. |
|
Ring |
| Logo (used by “Your own logo”, and shown above any animation) | The picture used for the logo. Choose it in the Media Manager, or type a path under images/. |
A picture | none |
| Logo height (px) | Sets the logo height, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 56 |
| Message | The message. | Text | none |
| Show for at least (ms) | The shortest time the screen stays up, in milliseconds, so it does not flash on a fast connection. | A whole number, in milliseconds | 400 |
| Give up and show the page after (ms) | The longest time the screen stays up, in milliseconds, even if the page has not finished loading. | A whole number, in milliseconds | 4000 |
Style tab
| Setting | What it does | Values | Default |
|---|---|---|---|
| Background | Sets the background colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Animation colour | Sets the animation colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Message colour | Sets the message colour. Leave it empty to use the colour the section or the site template already gives. | Any colour | none |
| Animation size (px) | Sets the animation size, in pixels. Leave it empty to use the add-on's default. | A whole number, in pixels | 54 |
| Speed (ms per cycle) | How long one cycle of the animation takes, in milliseconds. | A whole number, in milliseconds | 1100 |
| Fade out over (ms) | How long the screen takes to fade away, in milliseconds. | A whole number, in milliseconds | 420 |
This add-on also takes the settings every add-on shares: animation, hover and animated background, free position, and custom CSS. They are described once, in their own chapters.
Settings most add-ons share
These settings appear on most add-ons and mean the same thing on each. They are described here once; an add-on's own reference links here when it has them. Animation, scroll effects, animated backgrounds, free position and custom CSS are covered in Motion, Free position and Custom CSS.
| Setting | What it does | Values | Default |
|---|---|---|---|
| Font | The typeface of the add-on's text. A face is downloaded only on pages that use it. Leave it on the first value to use the site template's font. |
|
none |
| Font size (px, blank = inherit) | The text size, in pixels. Headings inside the add-on scale from it where the add-on has them. | A whole number, in pixels | none |
| Weight | How heavy the letters are, from 300 (light) to 900 (black). A face that lacks a weight shows the nearest one it has. |
|
none |
| Line height (e.g. 1.4) | The space between lines, as a multiple of the text size: 1.2 for headings, 1.5 to 1.7 for reading text. | Text | none |
| Letter spacing (px) | Extra space between letters, in pixels. Small positive values suit capitals; negative values tighten large headings. | Text | none |
| Capitalisation | Changes the case of the text as displayed. The text you typed is unchanged, so search engines and screen readers read it as written. |
|
As typed |
| First-line indent (characters) | Indents the first line of each paragraph by this many characters, as in print. | Text | none |
| Hover effect | How the add-on, or each of its items where it has them, reacts when the pointer is over it. A touch screen has no hover, so nothing may depend on it. |
|
none |
© 2026 Metro Page Builder - MixAgile.com