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 "datagrid" component

Display small pieces of information in a clear and readable way. Each item has a name and is associated with a value.

Parameters

title (top-level)

Text header at the top of the data grid.

TEXT

title

REQUIRED. Name of the piece of information.

TEXT

active

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

BOOLEAN

color

If set to a color name, the value will be displayed in a pill of that color.

TEXT

description

Value to display below the name.

TEXT

footer

Muted text to display below the value.

TEXT

icon

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

TEXT

link

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

URL

Example 1

Just some sections of information.

SELECT 
    'datagrid' as component;
SELECT 
    'Language' as title,
    'SQL' as description;
SELECT 
    'Creation date' as title,
    '1974' as description;
SELECT 
    'Language family' as title,
    'Query language' as description;

Result

Language
SQL
Creation date
1974
Language family
Query language

Example 2

A beautiful data grid with nice colors and icons.

SELECT 
    'datagrid' as component,
    'User' as title;
SELECT 
    'Pseudo' as title,
    'lovasoa' as description;
SELECT 
    'Status' as title,
    'Active' as description,
    'green' as color;
SELECT 
    'Email Status' as title,
    'Validated' as description,
    'check' as icon,
    '1' as active;
SELECT 
    'Personal page' as title,
    'ophir.dev' as description,
    'https://ophir.dev/' as link;
SELECT 
    'Search engine' as title,
    'https://google.com' as link,
    'Google' as description,
    'red' as color,
    'brand-google' as icon,
    'Owned by Alphabet Inc.' as footer;
SELECT 
    'Encyclopedia' as title,
    'https://wikipedia.org' as link,
    'Wikipedia' as description,
    'blue' as color,
    'world' as icon,
    'Owned by the Wikimedia Foundation' as footer;

Result

User

Pseudo
lovasoa
Status
Active
Email Status
Validated
Personal page
ophir.dev
Search engine
Google Owned by Alphabet Inc.
Encyclopedia
Wikipedia Owned by the Wikimedia Foundation