Indent text: indent

The indent filter adds a specified number of spaces to the beginning of each line in a string. By default, the first line and blank lines are not indented, but you can change this behavior with the first and blank parameters. This is useful when building multi-line text output that needs proper formatting. For example, you might want to indent a block of YAML data in a notification, format a list of entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] states for readable display, or align text within a larger multi-line message.

Usage

Here’s how to use this template function. Copy any example and adjust it to your setup.

{{ "line 1\nline 2\nline 3" | indent(4) }}

line 1
    line 2
    line 3

Function signature

The signature is a technical summary of this template function. It shows the name of the function, the values (called parameters) it accepts, and what type of data each parameter expects (for example, a piece of text or a number).

Function parameters that have a = with a value after them are optional. If you leave them out, the default value shown is used automatically. Function parameters without a default are required.

indent(
    value: str,
    width: int = 4,
    first: bool = False,
    blank: bool = False,
) -> str

Function parameters

The following parameters can be provided to this function.

Indenting the first line too

Set first to true to also indent the first line.

{{ "line 1\nline 2" | indent(2, first=true) }}

line 1
  line 2

Good to know

• The first line is not indented by default. Pass first=true to indent it along with the rest.
• Blank lines are also skipped by default. Pass blank=true to pad them too.
• The width is in spaces, not tab characters.

Try it yourself

Ready to test this? Open Developer tools > Template, paste the example into the Template editor, and watch the result update on the right. Edit the values to see how the function adapts to your own entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more].

More examples

Real scenarios where this function comes up in automations and templates. Copy any example and adapt it to your setup.

Format a multi-line notification body

Indent a block of status information within a notification message.

Home status:
{{ "Temperature: 22°C\nHumidity: 65%\nPressure: 1013 hPa" | indent(4) }}

Home status:
    Temperature: 22°C
    Humidity: 65%
    Pressure: 1013 hPa

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with your template and expected result, or share on our subreddit /r/homeassistant.

Related template functions

These functions work well alongside this one:

• Center text in a field: center - Centers a string in a field of a given width, padding with spaces.

• Wrap text at a line width: wordwrap - Wraps text at a given line width by inserting line breaks.