Skip to content

Commit ac7bc97

Browse files
committed
improve shell comoonent description
1 parent f1446c6 commit ac7bc97

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

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

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1290,7 +1290,20 @@ GROUP BY name;
12901290
', NULL);
12911291

12921292
INSERT INTO component(name, icon, description) VALUES
1293-
('shell', 'layout-navbar', 'Personalize the "shell" surrounding your page contents. Used to set properties for the entire page.');
1293+
('shell', 'layout-navbar', '
1294+
Customize the overall layout, header and footer of the page.
1295+
1296+
This is a special component that provides the page structure wrapping all other components on your page.
1297+
1298+
It generates the complete HTML document including the `<head>` section with metadata, title, and stylesheets,
1299+
as well as the navigation bar, main content area, and footer.
1300+
1301+
If you don''t explicitly call the shell component at the top of your SQL file, SQLPage will automatically
1302+
add a default shell component before your first try to display data on the page.
1303+
1304+
Use the shell component to customize page-wide settings like the page title, navigation menu, theme, fonts,
1305+
and to include custom visual styles (with CSS) or interactive behavior (with JavaScript) that should be loaded on the page.
1306+
');
12941307

12951308
INSERT INTO parameter(component, name, description_md, type, top_level, optional) SELECT 'shell', * FROM (VALUES
12961309
('favicon', 'The URL of the icon the web browser should display in bookmarks and tabs. This property is particularly useful if multiple sites are hosted on the same domain with different [``site_prefix``](https://github.com/sqlpage/SQLPage/blob/main/configuration.md#configuring-sqlpage).', 'URL', TRUE, TRUE),
@@ -1523,7 +1536,7 @@ SELECT
15231536
('shell', '
15241537
### A page without a shell
15251538
SQLPage provides the `shell-empty` component to create a page without a shell.
1526-
In this case, the `html` and `body` tags are not generated, and the components are rendered directly in the page
1539+
In this case, the `<html>` and `<body>` tags are not generated, and the components are rendered directly in the page
15271540
without any styling, navigation bar, footer, or dynamic content.
15281541
Any component whose name starts with `shell` will be considered as a shell component,
15291542
so you can also [create your own shell component](custom_components.sql#custom-shell).

0 commit comments

Comments
 (0)