Order widgets using order key in dashboard.yml #152
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
✅ 27/27 passed, 2 skipped, 34m56s total Running from acceptance #134 |
JCZuurmond
reviewed
Jun 13, 2024
| sdk_dashboard = make_dashboard(display_name="Order Key") | ||
|
|
||
| with (tmp_path / "dashboard.yml").open("w") as f: | ||
| f.write("display_name: Order Key\n" |
There was a problem hiding this comment.
We were thinking about the following dashboard.yml format:
display_name: <dashboard name>
widgets:
<widget name/id>:
order: 1
<widget name/id>:
order: 0
<widget name/id>:
order: 2Maybe you could add that to the docs first so that we can give feedback about
There was a problem hiding this comment.
Widget id is by default the file stem
| @@ -33,21 +33,37 @@ | |||
| T = TypeVar("T") | |||
| logger = logging.getLogger(__name__) | |||
|
|
|||
| #TODO: check if can be integrated with widget metadata | |||
| @dataclass | |||
| class WidgetSpec: | |||
There was a problem hiding this comment.
WidgetMetdata is added here #147
|
|
||
| @dataclass | ||
| class DashboardMetadata: | ||
| display_name: str | ||
| widgets: list[WidgetSpec] = dataclasses.field(default_factory=list) |
There was a problem hiding this comment.
See other comments
Suggested change
| widgets: list[WidgetSpec] = dataclasses.field(default_factory=list) | |
| widgets: dict[str, WidgetMetadata] = ... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Dashboards can order widgets defined in dashboard.yml
Introduces #131