Skip to content

Add tracking component #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Dec 29, 2023
Merged

Add tracking component #162

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e228e0d
Add tracking component
Dec 29, 2023
13239c1
Add divider component
Dec 29, 2023
a5a3a60
Update examples/official-site/sqlpage/migrations/28_tracking_componen…
olivierauverlot Dec 29, 2023
aeca19e
Many improvements (color and title attributes, width of the component…
Dec 29, 2023
6a33e68
New example with no optional parameters
Dec 29, 2023
a654a73
Empty lines removed
Dec 29, 2023
d0639c5
Refactoring
Dec 29, 2023
69356ff
add newcomponents to changelog
lovasoa Dec 29, 2023
52c95b5
reduce margin in tracking component
lovasoa Dec 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 119 additions & 0 deletions examples/official-site/sqlpage/migrations/28_tracking_component.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
INSERT INTO component (name, description, icon, introduced_in_version)
VALUES (
'tracking',
'Component for visualising activity logs or other monitoring-related data.',
'timeline-event-text',
'0.18.0'
);

INSERT INTO parameter (
component,
name,
description,
type,
top_level,
optional
)
VALUES (
'tracking',
'title',
'Title of the tracking component.',
'TEXT',
TRUE,
FALSE
),
(
'tracking',
'information',
'A short text displayed below the title.',
'TEXT',
TRUE,
TRUE
),
(
'tracking',
'description',
'A short paragraph.',
'TEXT',
TRUE,
TRUE
),
(
'tracking',
'description_md',
'A short paragraph formatted using markdown.',
'TEXT',
TRUE,
TRUE
),
(
'tracking',
'width',
'Width of the component, between 1 and 12.',
'NUMBER',
TRUE,
TRUE
),
(
'tracking',
'placement',
'Position of the tooltip (e.g. top, bottom, right, left)',
'TEXT',
TRUE,
TRUE
),
(
'tracking',
'color',
'Color of the tracked item (e.g. success, warning, danger)',
'TEXT',
FALSE,
TRUE
),
(
'tracking',
'title',
'Description of the state.',
'TEXT',
FALSE,
FALSE
);
-- Insert example(s) for the component
INSERT INTO example(component, description, properties)
VALUES
(
'tracking',
'A basic example of servers tracking component',
JSON(
'[
{"component":"tracking","title":"Servers status"},
{"title":"No data"},
{"title":"No data"},
{"title":"No data"},
{"title":"No data"},
{"title":"No data"},
{"title":"No data"},
{"title":"No data"},
{"title":"No data"}
]'
)
),
(
'tracking',
'An example of servers tracking component',
JSON(
'[
{"component":"tracking","title":"Servers status","information":"60% are running","description_md":"Status of all **currently running servers**","placement":"top","width":4},
{"color":"success","title":"operational"},
{"color":"success","title":"operational"},
{"color":"success","title":"operational"},
{"color":"danger","title":"Downtime"},
{"title":"No data"},
{"color":"success","title":"operational"},
{"color":"warning","title":"Big load"},
{"color":"success","title":"operational"}
]'
)
);


93 changes: 93 additions & 0 deletions examples/official-site/sqlpage/migrations/29_divider_component.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
INSERT INTO component (name, description, icon, introduced_in_version)
VALUES (
'divider',
'Dividers help organize content and make the interface layout clear and uncluttered.',
'separator',
'0.18.0'
);

INSERT INTO parameter (
component,
name,
description,
type,
top_level,
optional
)
VALUES (
'divider',
'contents',
'A text in the divider.',
'TEXT',
TRUE,
TRUE
),
(
'divider',
'position',
'Position of the text (e.g. left, right).',
'TEXT',
TRUE,
TRUE
),
(
'divider',
'color',
'The name of a color for this span of text.',
'COLOR',
TRUE,
TRUE
);
-- Insert example(s) for the component
INSERT INTO example(component, description, properties)
VALUES
(
'divider',
'A divider with centered text',
JSON(
'[
{
"component":"divider",
"contents":"Hello"
}
]'
)
),
(
'divider',
'An empty divider',
JSON(
'[
{
"component":"divider"
}
]'
)
),
(
'divider',
'A divider with text at left',
JSON(
'[
{
"component":"divider",
"contents":"Hello",
"position":"left"
}
]'
)
),
(
'divider',
'A divider with blue text at right',
JSON(
'[
{
"component":"divider",
"contents":"Hello",
"position":"right",
"color":"blue"
}
]'
)
);
5 changes: 5 additions & 0 deletions sqlpage/templates/divider.handlebars
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{{#if contents}}
<div class="hr-text {{#if position}}hr-text-{{position}}{{/if}} {{#if color}}text-{{color}}{{/if}}">{{contents}}</div>
{{else}}
<hr />
{{/if}}
29 changes: 29 additions & 0 deletions sqlpage/templates/tracking.handlebars
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@


<div class="card my-2 col-md-{{default width 12}}">
<div class="card-body">
<div class="d-flex align-items-center">
<div class="subheader">{{title}}</div>
</div>
<div class="d-flex align-items-baseline remove-bottom-margin">
<div class="h1 mb-3 me-2">{{#if information}}{{information}}{{/if}}</div>
</div>
<div class="d-flex align-items-baseline">
<div class="mb-3 me-2 remove-bottom-margin">
{{#if description_md}}
{{{markdown description_md}}}
{{else}}
{{#if description}}{{description}}{{/if}}
{{/if}}
</div>
</div>
<div class="mt-2">
<div class="tracking">
{{#each_row}}
<div class="tracking-block{{#if color}} bg-{{color}}{{/if}}" data-bs-toggle="tooltip" data-bs-placement="{{default ../placement "top"}}" title="{{title}}"></div>
{{/each_row}}
</div>
</div>
</div>
</div>