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

list
A vertical list of items. Each item can be clickable and link to another page.
card
A grid where each element is a small card that displays a piece of data.
datagrid
Display small pieces of information in a clear and readable way. Each item has a name and is associated with a value.
steps
Guide users through multi-stage processes, displaying a clear list of previous and future steps.
text
A paragraph of text. The entire component will render as a single paragraph, with each item being rendered as a span of text inside it, the styling of which can be customized using parameters.
form
A series of input fields that can be filled in by the user. The form contents can be posted and handled by another SQLPage. The value entered by the user in a field named x will be accessible to the target SQL page as $x.
chart
A component that plots data. Line, area, bar, and pie charts are all supported. Each item in the component is a data point in the graph.
table
A table with optional filtering and sorting. Unlike most others, this component does not have a fixed set of item properties, any property that is used will be rendered directly as a column in the table.
csv
A button that lets the user download data as a CSV file. Each column from the items in the component will map to a column in the resulting CSV.
dynamic
A special component that can be used to render other components, the number and properties of which are not known in advance.
shell
Personalize the "shell" surrounding your page contents. Used to set properties for the entire page.

The "steps" component

Guide users through multi-stage processes, displaying a clear list of previous and future steps.

Parameters

color (top-level)

Color of the bars displayed between steps.

TEXT

counter (top-level)

Display the number of the step on top of its name.

TEXT

active

Whether this item in the grid is considered "active". Active items are displayed more prominently.

BOOLEAN

description

Tooltip to display when the user passes their mouse over the step's name.

TEXT

icon

An icon name (from tabler-icons.io) to display on the left side of the step name.

TEXT

link

A target URL to which the user should be taken when they click on the step.

URL

title

Name of the step.

TEXT

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

Shopping Store pickup Payment Review & Order

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;

Result

Registration form Email confirmation ID verification Final account approval Account creation