Enum Component

pub enum Component {
    ActionRow(ActionRow),
    Button(Button),
    SelectMenu(SelectMenu),
    TextInput(TextInput),
    Unknown(u8),
}

Interactive message element.

Must be either a top level ActionRow or nested inside one.

Examples

Button

use twilight_model::channel::message::component::{ActionRow, Button, ButtonStyle, Component};

Component::ActionRow(ActionRow {
    components: Vec::from([Component::Button(Button {
        custom_id: Some("click_one".to_owned()),
        disabled: false,
        emoji: None,
        label: Some("Click me!".to_owned()),
        style: ButtonStyle::Primary,
        url: None,
        sku_id: None,
    })]),
});

Select menu

use twilight_model::{
    channel::message::{
        component::{ActionRow, Component, SelectMenu, SelectMenuOption, SelectMenuType},
        EmojiReactionType,
    },
    id::Id,
};

Component::ActionRow(ActionRow {
    components: vec![Component::SelectMenu(SelectMenu {
        channel_types: None,
        custom_id: "class_select_1".to_owned(),
        default_values: None,
        disabled: false,
        kind: SelectMenuType::Text,
        max_values: Some(3),
        min_values: Some(1),
        options: Some(Vec::from([
            SelectMenuOption {
                default: false,
                emoji: Some(EmojiReactionType::Custom {
                    animated: false,
                    id: Id::new(625891304148303894),
                    name: Some("rogue".to_owned()),
                }),
                description: Some("Sneak n stab".to_owned()),
                label: "Rogue".to_owned(),
                value: "rogue".to_owned(),
            },
            SelectMenuOption {
                default: false,
                emoji: Some(EmojiReactionType::Custom {
                    animated: false,
                    id: Id::new(625891304081063986),
                    name: Some("mage".to_owned()),
                }),
                description: Some("Turn 'em into a sheep".to_owned()),
                label: "Mage".to_owned(),
                value: "mage".to_owned(),
            },
            SelectMenuOption {
                default: false,
                emoji: Some(EmojiReactionType::Custom {
                    animated: false,
                    id: Id::new(625891303795982337),
                    name: Some("priest".to_owned()),
                }),
                description: Some("You get heals when I'm done doing damage".to_owned()),
                label: "Priest".to_owned(),
                value: "priest".to_owned(),
            },
        ])),
        placeholder: Some("Choose a class".to_owned()),
    })],
});

Variants

ActionRow(ActionRow)

Top level, non-interactive container of other (non action row) components.

Button(Button)

Clickable item that renders below messages.

SelectMenu(SelectMenu)

Dropdown-style item that renders below messages.

TextInput(TextInput)

Pop-up item that renders on modals.

Unknown(u8)

Variant value is unknown to the library.

Implementations

impl Component

pub const fn kind(&self) -> ComponentType

Type of component that this is.

use twilight_model::channel::message::component::{
    Button, ButtonStyle, Component, ComponentType,
};

let component = Component::Button(Button {
    custom_id: None,
    disabled: false,
    emoji: None,
    label: Some("ping".to_owned()),
    style: ButtonStyle::Primary,
    url: None,
    sku_id: None,
});

assert_eq!(ComponentType::Button, component.kind());

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Component

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Component

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<ActionRow> for Component

fn from(action_row: ActionRow) -> Self

Converts to this type from the input type.

impl From<Button> for Component

fn from(button: Button) -> Self

Converts to this type from the input type.

impl From<SelectMenu> for Component

fn from(select_menu: SelectMenu) -> Self

Converts to this type from the input type.

impl From<TextInput> for Component

fn from(text_input: TextInput) -> Self

Converts to this type from the input type.

impl Hash for Component

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Component

fn eq(&self, other: &Component) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Component

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for Component

impl StructuralPartialEq for Component