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

alert
A visually distinctive message or notification.
card
A grid where each element is a small card that displays a piece of data.
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.
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.
datagrid
Display small pieces of information in a clear and readable way. Each item has a name and is associated with a value.
dynamic
A special component that can be used to render other components, the number and properties of which are not known in advance.
form
A series of input fields that can be filled in by the user. The form contents can be posted and handled by another sql file in your site. The value entered by the user in a field named x will be accessible to the target SQL page as a variable named $x. For instance, you can create a SQL page named "create_user.sql" that would contain "INSERT INTO users(name) VALUES($name)" and a form with its action property set to "create_user.sql" that would contain a field named "name"."
hero
Display a large title and description for your page, with an optional large illustrative image. Useful in your home page, for instance.
http_header
An advanced component that can be used to create redirections, set a custom caching policy to your pages, or set any HTTP header. If you are a beginner, you probably don't need this component. When used, this component has to be the first component in the page, because once the page is sent to the browser, it is too late to change the headers. Any valid HTTP header can be used as a top-level parameter for this component. HTTP headers are additional pieces of information sent with responses to web requests that provide instructions or metadata about the data being sent — for example, setting cache control directives to control caching behavior or specifying the content type of a response.
list
A vertical list of items. Each item can be clickable and link to another page.
shell
Personalize the "shell" surrounding your page contents. Used to set properties for the entire page.
steps
Guide users through multi-stage processes, displaying a clear list of previous and future steps.
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.
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.

The "alert" component

A visually distinctive message or notification.

Top-level parameters

Row-level parameters

title

REQUIRED. Title of the alert message.

TEXT

color

The color theme for the alert message.

TEXT

description

Detailed description or content of the alert message.

TEXT

dismissible

Whether the user can close the alert message.

TEXT

icon

Icon name (from tabler-icons.io) to display next to the alert message.

TEXT

important

Set this to TRUE to make the alert message more prominent.

BOOLEAN

link

A URL to link to from the alert message.

URL

link_text

Customize the text of the link in the alert message. The default is "Ok".

TEXT

Example 1

A basic alert message

SELECT 
    'alert' as component;
SELECT 
    'Attention' as title,
    'This is an important message.' as description;

Result

Example 2

A list of notifications

SELECT 
    'alert' as component;
SELECT 
    'Success' as title,
    'Item successfully added to your cart.' as description,
    'check' as icon,
    'green' as color;
SELECT 
    'Warning' as title,
    'Your cart is almost full.' as description,
    'alert-triangle' as icon,
    'yellow' as color;
SELECT 
    'Error' as title,
    'Your cart is full.' as description,
    'alert-circle' as icon,
    'red' as color;

Result

Example 3

A full-featured notification message with a link

SELECT 
    'alert' as component;
SELECT 
    'Your dashboard is ready!' as title,
    'analyze' as icon,
    'teal' as color,
    1 as dismissible,
    'Your public web dashboard was successfully created.' as description,
    '/index.sql' as link;

Result

Example 4

An important danger alert message with an icon and color

SELECT 
    'alert' as component;
SELECT 
    'Alert' as title,
    'alert-circle' as icon,
    'red' as color,
    1 as important,
    1 as dismissible,
    'SQLPage is entirely free and open source.' as description,
    'https://github.com/lovasoa/SQLPage' as link,
    'See source code' as link_text;

Result