SQLPage documentation
The two most important concepts in SQLPage are components and parameters. This page documents all the components that you can use in SQLPage and their parameters. Use this as a reference when building your SQL application.
components
The "steps" component
Guide users through multi-stage processes, displaying a clear list of previous and future steps.
Top-level parameters
color
Color of the bars displayed between steps.
counter
Display the number of the step on top of its name.
Row-level parameters
active
Whether this item in the grid is considered "active". Active items are displayed more prominently.
description
Tooltip to display when the user passes their mouse over the step's name.
icon
An icon name (from tabler-icons.io) to display on the left side of the step name.
link
A target URL to which the user should be taken when they click on the step.
title
Name of the step.
Example 1
Online store checkout steps.
SELECT
'steps' as component;
SELECT
'Shopping' as title;
SELECT
'Store pickup' as title;
SELECT
'Payment' as title,
1 as active;
SELECT
'Review & Order' as title;
Result
Example 2
A progress indicator with custom color, auto-generated step numbers, icons, and description tooltips.
SELECT
'steps' as component,
1 as counter,
'purple' as color;
SELECT
'Registration form' as title,
'forms' as icon,
'https://github.com/lovasoa/sqlpage' as link,
'Initial account data creation.' as description;
SELECT
'Email confirmation' as title,
'mail' as icon,
'https://sql.ophir.dev' as link,
'Confirm your email by clicking on a link in a validation email.' as description;
SELECT
'ID verification' as title,
'Checking personal information' as description,
'user' as icon,
'#' as link;
SELECT
'Final account approval' as title,
'ophir.dev' as description,
'https://ophir.dev/' as link,
'eye-check' as icon,
1 as active;
SELECT
'Account creation' as title,
'check' as icon;