Nickname

Customize how nicknames are displayed within a buffer.

Nickname
- Configuration
  - alignment
  - away
  - brackets
  - color
  - offline
  - show_access_levels
  - shown_status
  - click
  - truncate
  - hide_consecutive

Configuration

alignment

Horizontal alignment of nicknames.


# Type: string
# Values: "left", "right", "top"
# Default: "left"

[buffer.nickname]
alignment = "right"

away

Controls the appearance of away nicknames.


# Type: string or object
# Values: "dimmed", "none" or { dimmed = float }
# Default: "dimmed"
[buffer.nickname]
away = "dimmed"

# with custom dimming alpha value (0.0-1.0)
[buffer.nickname]
away = { dimmed = 0.5 }

# no away indication
[buffer.nickname]
away = "none"

brackets

Brackets around nicknames.


# Type: string
# Values: { left = "<any string>", right = "<any string>" }
# Default: { left = "", right = "" }

[buffer.nickname]
brackets = { left = "<", right = ">" }

color

Nickname colors in a channel buffer. "unique" generates colors by randomizing the hue, while keeping the saturation and lightness from the theme’s nickname color.


# Type: string
# Values: "solid", "unique"
# Default: "unique"

[buffer.nickname]
color = "unique"

offline

Controls the appearance of offline nicknames.


# Type: string or object
# Values: "solid" or "none"
# Default: "solid"
[buffer.nickname]
offline = "solid"

# no offline indication
[buffer.nickname]
offline = "none"

show_access_levels

Show access levels in front of nicknames (@, +, ~, etc.).


# Type: boolean
# Values: true, false
# Default: true

[buffer.nickname]
show_access_levels = true

shown_status

What status should be indicated (by either away or offline settings), the user’s current status ("current") or their status at the time of sending the message ("historical").


# Type: string or object
# Values: "current" or "historical"
# Default: "current"
[buffer.nickname]
shown_status = "current"

click

Click action for when interaction with nicknames.

"open-query": Open a query with the User
"insert-nickname": Inserts the nickname into text input


# Type: string
# Values: "open-query", "insert-nickname"
# Default: "open-query"

[buffer.nickname]
click = "open-query"

truncate

Truncate nicknames in buffer to a maximum length


# Type: integer
# Values: any non-negative integer
# Default: not set

[buffer.nickname]
truncate = 10

Hide nickname if consecutive messages are from the same user. If specified as { smart = integer } then the nickname will be hidden for consecutive messages are from the same user and each is within smart seconds of each other.

⚠️ hide_consecutive does not work in conjunction with alignment = "top" .


# Type: boolean
# Values: true, false, or { smart = integer }
# Default: false

[buffer.nickname]
hide_consecutive = true

# hide if the previous message was from the same user and sent within 2m of the current message
[buffer.nickname]
hide_consecutive = { smart = 120 }

Keyboard shortcuts