Button API Reference#

class flare.components.button.Button(*args, **kwargs)[source]#

Bases: CallbackComponent

build(action_row: MessageActionRowBuilder) → None[source]#: Build the button into the passed action row.

property width: int#: The width of the component.

class flare.components.button.LinkButton(url: str, *, label: str)[source]#

class flare.components.button.LinkButton(url: str, *, emoji: Emoji)

class flare.components.button.LinkButton(url: str, *, label: str, emoji: Emoji)

Bases: Component[MessageActionRowBuilder]

A button with a link.

Parameters:

url – The link for this button.
label – The label on the button.
emoji – The emoji on the button.

build(action_row: MessageActionRowBuilder) → None[source]#: Build and append a flare component to a hikari action row.

property custom_id: str#: A custom_id for a component.

property width: int#: The width of the component.

class flare.components.button.button(*, cookie: str | None = None, label: str | None = None, emoji: str | ~hikari.emojis.Emoji | None = None, style: ~hikari.components.ButtonStyle = <ButtonStyle.PRIMARY: 1>, disabled: bool = False)[source]#

Bases: FunctionalComponent[Button]

A decorator to create a flare.Button. This is a shorthand for when type safety is not needed.

property component_type: type[Button]#: The component type.

property kwargs: dict[str, Any]#: The kwargs for __init_subclass__