Skip to content

Order and conditionally show settings in the install form #11

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
514sid merged 1 commit into from
Sep 3, 2026
Merged

Order and conditionally show settings in the install form #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ toggles the configuration options TradingView itself exposes.
| `locale` | all | `en` | |
| `display_errors` | all | `false` | Shows failures on-screen instead of failing silently |

The "Applies to" column is enforced by the manifest, not just documented here:
each setting declares `depends_on` in its `help_text` schema, so the Screenly
console only shows (and only saves) the settings that apply to the selected
`widget_type`. `display_order` controls the sequence the fields render in,
within the basic and advanced sections respectively.

## Development

```bash
Expand Down
86 changes: 71 additions & 15 deletions screenly.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,12 @@ settings:
help_text:
properties:
advanced: true
help_text: Let viewers change the symbol on the Advanced Chart widget. Usually left off for unattended signage.
depends_on:
setting: widget_type
values:
- advanced_chart
display_order: 6
help_text: Let viewers change the symbol on the chart. Usually left off for unattended signage.
type: boolean
schema_version: 1
chart_style:
Expand All @@ -27,7 +32,12 @@ settings:
help_text:
properties:
advanced: true
help_text: Candle/bar/line style for the Advanced Chart widget.
depends_on:
setting: widget_type
values:
- advanced_chart
display_order: 2
help_text: Candle/bar/line style for the chart.
options:
- label: Candles
value: '1'
Expand All @@ -47,17 +57,23 @@ settings:
help_text:
properties:
advanced: true
display_order: 8
help_text: For debugging purposes, display errors on the screen instead of failing silently.
type: boolean
schema_version: 1
heatmap_dataset:
type: string
default_value: SPX500
title: Heatmap Dataset (Stock Heatmap)
title: Heatmap Dataset
optional: true
help_text:
properties:
help_text: Which market the Stock Heatmap widget visualizes.
depends_on:
setting: widget_type
values:
- stock_heatmap
display_order: 3
help_text: Which market the Stock Heatmap visualizes.
options:
- label: S&P 500 (US)
value: SPX500
Expand Down Expand Up @@ -88,12 +104,17 @@ settings:
heatmap_grouping:
type: string
default_value: sector
title: Heatmap Grouping (Stock Heatmap)
title: Heatmap Grouping
optional: true
help_text:
properties:
advanced: true
help_text: Group the Stock Heatmap widget's blocks by sector, or show a flat grid.
depends_on:
setting: widget_type
values:
- stock_heatmap
display_order: 7
help_text: Group the Stock Heatmap's blocks by sector, or show a flat grid.
options:
- label: By Sector
value: sector
Expand All @@ -109,7 +130,12 @@ settings:
help_text:
properties:
advanced: true
help_text: Hide the Advanced Chart widget's symbol legend overlay.
depends_on:
setting: widget_type
values:
- advanced_chart
display_order: 5
help_text: Hide the chart's symbol legend overlay.
type: boolean
schema_version: 1
hide_side_toolbar:
Expand All @@ -120,7 +146,12 @@ settings:
help_text:
properties:
advanced: true
help_text: Hide the Advanced Chart widget's left-hand drawing toolbar.
depends_on:
setting: widget_type
values:
- advanced_chart
display_order: 4
help_text: Hide the chart's left-hand drawing toolbar.
type: boolean
schema_version: 1
hide_top_toolbar:
Expand All @@ -131,7 +162,12 @@ settings:
help_text:
properties:
advanced: true
help_text: Hide the Advanced Chart widget's top toolbar (interval/style controls).
depends_on:
setting: widget_type
values:
- advanced_chart
display_order: 3
help_text: Hide the chart's top toolbar (interval/style controls).
type: boolean
schema_version: 1
interval:
Expand All @@ -142,7 +178,12 @@ settings:
help_text:
properties:
advanced: true
help_text: Default time interval for the Advanced Chart widget.
depends_on:
setting: widget_type
values:
- advanced_chart
display_order: 1
help_text: Default time interval for the chart.
options:
- label: 1 minute
value: '1'
Expand All @@ -169,22 +210,36 @@ settings:
default_value: en
title: Locale
optional: true
help_text: |
Language code for the widget UI (e.g. en, fr, de, ja).
help_text:
properties:
display_order: 5
help_text: Language code for the widget UI (e.g. en, fr, de, ja).
type: string
schema_version: 1
symbol:
type: string
default_value: NASDAQ:AAPL
title: Symbol
optional: true
help_text: |
The ticker to display, in EXCHANGE:SYMBOL format (e.g. NASDAQ:AAPL, BINANCE:BTCUSDT). Used by the Advanced Chart and Symbol Overview widgets (not the heatmaps, which show a whole market). Symbol Overview intentionally shows a single symbol only, since its multi-symbol tab switcher requires mouse input unattended signage can't provide.
help_text:
properties:
depends_on:
setting: widget_type
values:
- advanced_chart
- symbol_overview
display_order: 2
help_text: The ticker to display, in EXCHANGE:SYMBOL format (e.g. NASDAQ:AAPL, BINANCE:BTCUSDT). Symbol Overview intentionally shows a single symbol only, since its multi-symbol tab switcher requires mouse input unattended signage can't provide.
type: string
schema_version: 1
theme:
type: string
default_value: dark
title: Color Theme
optional: true
help_text:
properties:
display_order: 4
help_text: Dark or light mode for the widget.
options:
- label: Dark
Expand All @@ -200,7 +255,8 @@ settings:
optional: true
help_text:
properties:
help_text: Which TradingView widget to display full-screen.
display_order: 1
help_text: Which TradingView widget to display full-screen. The settings below change to match.
options:
- label: Advanced Real-Time Chart
value: advanced_chart
Expand Down
86 changes: 71 additions & 15 deletions screenly_qc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,12 @@ settings:
help_text:
properties:
advanced: true
help_text: Let viewers change the symbol on the Advanced Chart widget. Usually left off for unattended signage.
depends_on:
setting: widget_type
values:
- advanced_chart
display_order: 6
help_text: Let viewers change the symbol on the chart. Usually left off for unattended signage.
type: boolean
schema_version: 1
chart_style:
Expand All @@ -27,7 +32,12 @@ settings:
help_text:
properties:
advanced: true
help_text: Candle/bar/line style for the Advanced Chart widget.
depends_on:
setting: widget_type
values:
- advanced_chart
display_order: 2
help_text: Candle/bar/line style for the chart.
options:
- label: Candles
value: '1'
Expand All @@ -47,17 +57,23 @@ settings:
help_text:
properties:
advanced: true
display_order: 8
help_text: For debugging purposes, display errors on the screen instead of failing silently.
type: boolean
schema_version: 1
heatmap_dataset:
type: string
default_value: SPX500
title: Heatmap Dataset (Stock Heatmap)
title: Heatmap Dataset
optional: true
help_text:
properties:
help_text: Which market the Stock Heatmap widget visualizes.
depends_on:
setting: widget_type
values:
- stock_heatmap
display_order: 3
help_text: Which market the Stock Heatmap visualizes.
options:
- label: S&P 500 (US)
value: SPX500
Expand Down Expand Up @@ -88,12 +104,17 @@ settings:
heatmap_grouping:
type: string
default_value: sector
title: Heatmap Grouping (Stock Heatmap)
title: Heatmap Grouping
optional: true
help_text:
properties:
advanced: true
help_text: Group the Stock Heatmap widget's blocks by sector, or show a flat grid.
depends_on:
setting: widget_type
values:
- stock_heatmap
display_order: 7
help_text: Group the Stock Heatmap's blocks by sector, or show a flat grid.
options:
- label: By Sector
value: sector
Expand All @@ -109,7 +130,12 @@ settings:
help_text:
properties:
advanced: true
help_text: Hide the Advanced Chart widget's symbol legend overlay.
depends_on:
setting: widget_type
values:
- advanced_chart
display_order: 5
help_text: Hide the chart's symbol legend overlay.
type: boolean
schema_version: 1
hide_side_toolbar:
Expand All @@ -120,7 +146,12 @@ settings:
help_text:
properties:
advanced: true
help_text: Hide the Advanced Chart widget's left-hand drawing toolbar.
depends_on:
setting: widget_type
values:
- advanced_chart
display_order: 4
help_text: Hide the chart's left-hand drawing toolbar.
type: boolean
schema_version: 1
hide_top_toolbar:
Expand All @@ -131,7 +162,12 @@ settings:
help_text:
properties:
advanced: true
help_text: Hide the Advanced Chart widget's top toolbar (interval/style controls).
depends_on:
setting: widget_type
values:
- advanced_chart
display_order: 3
help_text: Hide the chart's top toolbar (interval/style controls).
type: boolean
schema_version: 1
interval:
Expand All @@ -142,7 +178,12 @@ settings:
help_text:
properties:
advanced: true
help_text: Default time interval for the Advanced Chart widget.
depends_on:
setting: widget_type
values:
- advanced_chart
display_order: 1
help_text: Default time interval for the chart.
options:
- label: 1 minute
value: '1'
Expand All @@ -169,22 +210,36 @@ settings:
default_value: en
title: Locale
optional: true
help_text: |
Language code for the widget UI (e.g. en, fr, de, ja).
help_text:
properties:
display_order: 5
help_text: Language code for the widget UI (e.g. en, fr, de, ja).
type: string
schema_version: 1
symbol:
type: string
default_value: NASDAQ:AAPL
title: Symbol
optional: true
help_text: |
The ticker to display, in EXCHANGE:SYMBOL format (e.g. NASDAQ:AAPL, BINANCE:BTCUSDT). Used by the Advanced Chart and Symbol Overview widgets (not the heatmaps, which show a whole market). Symbol Overview intentionally shows a single symbol only, since its multi-symbol tab switcher requires mouse input unattended signage can't provide.
help_text:
properties:
depends_on:
setting: widget_type
values:
- advanced_chart
- symbol_overview
display_order: 2
help_text: The ticker to display, in EXCHANGE:SYMBOL format (e.g. NASDAQ:AAPL, BINANCE:BTCUSDT). Symbol Overview intentionally shows a single symbol only, since its multi-symbol tab switcher requires mouse input unattended signage can't provide.
type: string
schema_version: 1
theme:
type: string
default_value: dark
title: Color Theme
optional: true
help_text:
properties:
display_order: 4
help_text: Dark or light mode for the widget.
options:
- label: Dark
Expand All @@ -200,7 +255,8 @@ settings:
optional: true
help_text:
properties:
help_text: Which TradingView widget to display full-screen.
display_order: 1
help_text: Which TradingView widget to display full-screen. The settings below change to match.
options:
- label: Advanced Real-Time Chart
value: advanced_chart
Expand Down