Skip to content
Draft
Changes from all commits
Commits
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
27 changes: 25 additions & 2 deletions src/api/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -588,9 +588,32 @@ export interface ConfigEntry {
pin_mode: PinMode | null;

// === UI / i18n ===
/** When True frontend collapses this entry under an "Advanced" section. */
/**
* When True frontend collapses this entry under an "Advanced" section.
*
* Sourced from upstream esphome's `Visibility.ADVANCED` schema
* kwarg (esphome/esphome#16267) when the field author marked
* it explicitly, or pushed down by the catalog generator's
* cascade pass when an ancestor is `ADVANCED` or stricter.
* The device-builder catalog's name-based heuristic is the
* fallback for fields the schema doesn't yet annotate; as
* upstream adoption grows, the heuristic shrinks toward zero.
*/
advanced: boolean;
/** When True frontend hides the entry entirely. */
/**
* When True frontend hides the entry entirely.
*
* Sourced from upstream esphome's `Visibility.YAML_ONLY`
* schema kwarg (esphome/esphome#16267). Marks fields the user
* shouldn't edit through a visual editor — e.g.
* `setup_priority` on every component, where casual UI-driven
* tweaks can break boot. The YAML escape hatch stays
* available for the rare power-user override. Also pushed down
* by the catalog generator's cascade pass when an ancestor is
* `YAML_ONLY`: a hidden parent takes its descendants with it
* (otherwise the editor would render an unrooted control with
* no surrounding context).
*/
hidden: boolean;
/** Optional URL pointing to documentation specific to this field. */
help_link: string | null;
Expand Down
Loading