allow customization of empty lists

Author: lovasoa

CHANGELOG.md

@@ -35,6 +35,7 @@
  - Better error messages. SQLPage displays a more precise and useful message when an error occurs, and displays the position in the SQL statement where the error occured. Incorrect error messages on invalid migrations are also fixed.
  - We now distribute docker images from ARM too. Say hello to SQLPage on your Raspberry Pi and your Mac M1 !
  - Create the default SQLite database file in the "sqlpage" config directory instead of at the root of the web server by default. This makes it inaccessible from the web, which is a more secure default. If you want to keep the old behavior, set the `database_url` configuration parameter to `sqlite://sqlpage.db` in your [configuration](./configuration.md).
+ - New `empty_title`, `empty_description`, and `empty_link` top-level attributes on the [`list`](https://sql.ophir.dev/documentation.sql?component=list#component) component to customize the text displayed when the list is empty.
 
 ## 0.11.0 (2023-09-17)
  - Support for **environment variables** ! You can now read environment variables from sql code using `sqlpage.environment_variable('VAR_NAME')`.

examples/official-site/sqlpage/migrations/01_documentation.sql

@@ -27,6 +27,10 @@ INSERT INTO component(name, icon, description) VALUES
 INSERT INTO parameter(component, name, description, type, top_level, optional) SELECT 'list', * FROM (VALUES
     -- top level
     ('title', 'Text header at the top of the list.', 'TEXT', TRUE, TRUE),
+    ('empty_title', 'Title text to display if the list is empty.', 'TEXT', TRUE, TRUE),
+    ('empty_description', 'Description to display if the list is empty.', 'TEXT', TRUE, TRUE),
+    ('empty_description_md', 'Description to display if the list is empty, in Markdown format.', 'TEXT', TRUE, TRUE),
+    ('empty_link', 'URL to which the user should be taken if they click on the empty list.', 'URL', TRUE, TRUE),
     -- item level
     ('title', 'Name of the list item, displayed prominently.', 'TEXT', FALSE, FALSE),
     ('description', 'A description of the list item, displayed as greyed-out text.', 'TEXT', FALSE, TRUE),
@@ -39,6 +43,7 @@ INSERT INTO parameter(component, name, description, type, top_level, optional) S
 
 INSERT INTO example(component, description, properties) VALUES
     ('list', 'The most basic list', json('[{"component":"list"},{"title":"A"},{"title":"B"},{"title":"C"}]')),
+    ('list', 'An empty list with a link to add an item', json('[{"component":"list", "empty_title": "No items yet", "empty_description": "This list is empty. Click here to create a new item !", "empty_link": "documentation.sql"}]')),
     ('list', 'A list with rich text descriptions', json('[{"component":"list"},
         {"title":"SQLPage", "description_md":"A **SQL**-based **page** generator for **PostgreSQL**, **MySQL**, and **SQLite**. [Free on Github](https://github.com/lovasoa/sqlpage)"},
         {"title":"Tabler", "description_md":"A **free** and **open-source** **HTML** template pack based on **Bootstrap**."},

sqlpage/templates/list.handlebars

@@ -29,5 +29,20 @@
                 </div>
             </{{#if link}}a {{else}}div{{/if}}>
         {{/each_row}}
+        {{#if (eq @row_index 0)}}
+            <a href="{{default empty_link '#'}}" class="list-group-item list-group-item-action">
+                <div class="row align-items-center">
+                    <div class="col text-truncate">
+                        {{default empty_title 'No item'}}
+                        <div class="d-block text-muted text-truncate mt-n1">
+                            {{~empty_description~}}
+                            {{~#if empty_description_md~}}
+                                <div style="margin-bottom: -1rem">{{{markdown empty_description_md}}}</div>
+                            {{~/if~}}
+                        </div>
+                    </div>
+                </div>
+            </a>
+        {{/if}}
     </div>
 </div>

src/render.rs

@@ -597,11 +597,15 @@ impl SplitTemplateRenderer {
             "Closing a template {}",
             self.split_template
                 .name()
-                .map(|n| format!("('{n}')"))
+                .map(|name| format!("('{name}')"))
                 .unwrap_or_default(),
         );
-        if let Some(local_vars) = self.local_vars.take() {
+        if let Some(mut local_vars) = self.local_vars.take() {
             let mut render_context = handlebars::RenderContext::new(None);
+            local_vars.put("row_index", self.row_index.into());
+            log::info!(
+                "Rendering the after_list template with the following local variables: {local_vars:?}"
+            );
             *render_context
                 .block_mut()
                 .expect("ctx created without block")