Enum Component 

pub enum Component {
    ActionRow(ActionRow),
    Button(Button),
    Checkbox(Checkbox),
    CheckboxGroup(CheckboxGroup),
    Container(Container),
    File(FileDisplay),
    FileUpload(FileUpload),
    Label(Label),
    MediaGallery(MediaGallery),
    Section(Section),
    SelectMenu(SelectMenu),
    Separator(Separator),
    TextDisplay(TextDisplay),
    TextInput(TextInput),
    Thumbnail(Thumbnail),
    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 {
    id: None,
    components: Vec::from([Component::Button(Button {
        id: None,
        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::{
        EmojiReactionType,
        component::{ActionRow, Component, SelectMenu, SelectMenuOption, SelectMenuType},
    },
    id::Id,
};

Component::ActionRow(ActionRow {
    id: None,
    components: vec![Component::SelectMenu(SelectMenu {
        id: None,
        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()),
        required: None,
    })],
});

Variants

ActionRow(ActionRow)

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

Button(Button)

Clickable item that renders below messages.

Checkbox(Checkbox)

A selectable checkbox in a modal

CheckboxGroup(CheckboxGroup)

A group of selectable checkboxes in a modal

Container(Container)

Container that visually groups a set of components.

File(FileDisplay)

Displays an attached file.

FileUpload(FileUpload)

Allows uploading files in a modal.

Label(Label)

Wrapper for modal components providing a label and an optional description.

MediaGallery(MediaGallery)

Display images and other media.

Section(Section)

Container to display text alongside an accessory component.

SelectMenu(SelectMenu)

Dropdown-style item that renders below messages.

Separator(Separator)

Component to add vertical padding between other components.

TextDisplay(TextDisplay)

Markdown text.

TextInput(TextInput)

Pop-up item that renders on modals.

Thumbnail(Thumbnail)

Small image that can be used as an accessory.

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 {
    id: None,
    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());

pub const fn component_count(&self) -> usize

Get the amount of components a component should count as.

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a duplicate 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<Checkbox> for Component

fn from(checkbox: Checkbox) -> Self

Converts to this type from the input type.

impl From<CheckboxGroup> for Component

fn from(checkbox_group: CheckboxGroup) -> Self

Converts to this type from the input type.

impl From<Container> for Component

fn from(container: Container) -> Self

Converts to this type from the input type.

impl From<FileDisplay> for Component

fn from(file_display: FileDisplay) -> Self

Converts to this type from the input type.

impl From<FileUpload> for Component

fn from(file_upload: FileUpload) -> Self

Converts to this type from the input type.

impl From<Label> for Component

fn from(label: Label) -> Self

Converts to this type from the input type.

impl From<MediaGallery> for Component

fn from(media_gallery: MediaGallery) -> Self

Converts to this type from the input type.

impl From<Section> for Component

fn from(section: Section) -> 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<Separator> for Component

fn from(separator: Separator) -> Self

Converts to this type from the input type.

impl From<TextDisplay> for Component

fn from(text_display: TextDisplay) -> 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 From<Thumbnail> for Component

fn from(thumbnail: Thumbnail) -> 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 TryFrom<Component> for ActionRow

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for Button

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for Checkbox

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for CheckboxGroup

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for Container

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for FileDisplay

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for FileUpload

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for Label

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for MediaGallery

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for Section

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for SelectMenu

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for Separator

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for TextDisplay

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for TextInput

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for Thumbnail

type Error = Component

The type returned in the event of a conversion error.

fn try_from(value: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Component

impl StructuralPartialEq for Component