Skip to content
Draft
Changes from 1 commit
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
22 changes: 20 additions & 2 deletions src/api/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -588,9 +588,27 @@ 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.
*
* Source of truth: upstream esphome's ``cv.Optional(...,
* advanced=True)`` schema kwarg (esphome/esphome#16267) when the
* field author marked it explicitly. The catalog generator's
* ``_classify_advanced`` heuristic in ``script/sync_components.py``
* is the fallback for fields the schema doesn't yet annotate; as
Comment thread
bdraco marked this conversation as resolved.
Outdated
* upstream adoption grows, the heuristic shrinks toward zero.
Comment thread
bdraco marked this conversation as resolved.
Outdated
*/
advanced: boolean;
/** When True frontend hides the entry entirely. */
/**
* When True frontend hides the entry entirely.
*
* Source of truth: upstream esphome's ``cv.Optional(...,
* yaml_only=True)`` 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.
Comment thread
bdraco marked this conversation as resolved.
Outdated
*/
hidden: boolean;
/** Optional URL pointing to documentation specific to this field. */
help_link: string | null;
Expand Down
Loading