DropdownOption

Inherits: Control

Represents an item in a dropdown.

Properties

• content(Control | None) –

  A Control to display in this option. If not specified, text will be used as

• key(str | None) –

  Option's key.

• leading_icon(IconDataOrControl | None) –

  An optional icon to display before the content or text.

• style(ButtonStyle | None) –

  Customizes this menu item's appearance.

• text(str | None) –

  Option's display text.

• trailing_icon(IconDataOrControl | None) –

  An optional icon to display after the content or text.

Properties

content class-attribute instance-attribute

content: Control | None = None

A Control to display in this option. If not specified, text will be used as fallback, else text will be ignored.

key class-attribute instance-attribute

key: str | None = None

Option's key.

If not specified text will be used as fallback.

Raises:

• ValueError –

  If neither key nor text are provided.

leading_icon class-attribute instance-attribute

leading_icon: IconDataOrControl | None = None

An optional icon to display before the content or text.

style class-attribute instance-attribute

style: ButtonStyle | None = None

Customizes this menu item's appearance.

text class-attribute instance-attribute

text: str | None = None

Option's display text.

If not specified key will be used as fallback.

Raises:

• ValueError –

  If neither key nor text are provided.

trailing_icon class-attribute instance-attribute

trailing_icon: IconDataOrControl | None = None

An optional icon to display after the content or text.