SQLPage v0.20.5 documentation

If you are completely new to SQLPage, you should start by reading the get started tutorial, which will guide you through the process of creating your first SQLPage application.

Building an application with SQLPage is quite simple. To create a new web page, just create a new SQL file. For each SELECT statement that you write, the data it returns will be analyzed and rendered to the user. The two most important concepts in SQLPage are components and parameters.

To select a component and set its top-level properties, you write the following SQL statement:

SELECT 'component_name' AS component, 'my value' AS top_level_parameter_1;

Then, you can set its row-level parameters by writing a second SELECT statement:

SELECT my_column_1 AS row_level_parameter_1, my_column_2 AS row_level_parameter_2 FROM my_table;

This page documents all the components provided by default in SQLPage and their parameters. Use this as a reference when building your SQL application. If at any point you need help, you can ask for it on the SQLPage forum.

If you know some HTML, you can also easily create your own components for your 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.

description

Description of the section.

id

id attribute injected as an anchor in HTML. It can be used for scrolling to this item through links (use "#id" in link url). Added in v0.18.0.

title

Title of the section.

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,
    TRUE      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,
    TRUE     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,
    TRUE                     as active;
select 
    'Account creation' as title,
    'check'            as icon;

Result

Official SQLPage documentation