github-featured/sqlpage--sqlpage
2
0
Fork 0
Code Issues Pull Requests Deployments Models Agent Notes Packages Projects Releases Wiki Activity

csv component documentation

Browse Source
This commit is contained in:
lovasoa
2024-10-26 00:31:35 +03:00
parent 1e785dde04
commit 0f4656c19d
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/official-site/sqlpage/migrations/01_documentation.sql
+10 -1
View File
@@ -794,7 +794,16 @@ This will generate a table with the stores in the first column, and the items in
INSERT INTO component(name, icon, description) VALUES
('csv', 'download', '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.');
('csv', 'download', '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.
When `csv` is used as a **header component** (without a [shell](?component=shell)), it will trigger a download of the CSV file directly on page load.
If the csv file to download is large, we recommend using this approach.
When used inside a page (after calling the shell component), this will add a button to the page that lets the user download the CSV file.
The button will need to load the entire contents of the CSV file in memory, inside the browser, even if the user does not click on it.
If the csv file to download is large, we recommend using this component without a shell component in order to efficiently stream the data to the browser.
');
INSERT INTO parameter(component, name, description, type, top_level, optional) SELECT 'csv', * FROM (VALUES
-- top level