Common Properties

These properties are available on all components.

Property	Type	Required	Description
name	string	See note	Friendly display name for the component.
id	string	See note	Unique identifier. If omitted, one is generated from name.
icon	string	No	Icon used in Home Assistant and related UIs.
internal	boolean	No	Override whether the component is internal (see below).

At least one of name or id must be provided; supplying both is also allowed. By default, which one you set decides whether the component is exposed:

• name → the component is visible to connectivity components (Home Assistant via the API, MQTT, the web server).
• only id (no name) → the component is internal.

Set the optional internal attribute to true or false to override this default explicitly.

An internal component still participates in internal wiring such as filters, actions and state routing, but it is not exposed to connectivity components like the API, MQTT or the web server.

Additional attributes such as device_class or entity_category are component-specific and documented on each entities page.

Also check the page for your chosen platform for the full list of required and optional options implemented.