Enums

---

components

ComponentType

Bases: DiscordTypes

              flowchart TD
              scurrypy.enums.components.ComponentType[ComponentType]
              scurrypy.enums.enum_types.DiscordTypes[DiscordTypes]

                              scurrypy.enums.enum_types.DiscordTypes --> scurrypy.enums.components.ComponentType
                


              click scurrypy.enums.components.ComponentType href "" "scurrypy.enums.components.ComponentType"
              click scurrypy.enums.enum_types.DiscordTypes href "" "scurrypy.enums.enum_types.DiscordTypes"
            

Represents component type constants

ACTION_ROW = 1 class-attribute instance-attribute

Container to display a row of interactive components.

BUTTON = 2 class-attribute instance-attribute

Button object.

STRING_SELECT = 3 class-attribute instance-attribute

Select menu for picking from defined text options.

TEXT_INPUT = 4 class-attribute instance-attribute

Text input object.

USER_SELECT = 5 class-attribute instance-attribute

Select menu for users.

ROLE_SELECT = 6 class-attribute instance-attribute

Select menu for roles.

MENTIONABLE_SELECT = 7 class-attribute instance-attribute

Select menu for mentionables (users and roles).

CHANNEL_SELECT = 8 class-attribute instance-attribute

Select menu for channels.

SECTION = 9 class-attribute instance-attribute

Container to display text alongside an accessory component.

TEXT_DISPLAY = 10 class-attribute instance-attribute

Markdown text.

THUMBNAIL = 11 class-attribute instance-attribute

Small image that can be used as an accessory.

MEDIA_GALLERY = 12 class-attribute instance-attribute

Display images and other media.

FILE = 13 class-attribute instance-attribute

Displays an attached file.

SEPARATOR = 14 class-attribute instance-attribute

Component to add vertical padding between other components.

CONTAINER = 17 class-attribute instance-attribute

Container that visually groups a set of components.

LABEL = 18 class-attribute instance-attribute

Container associating a label and description with a component.

FILE_UPLOAD = 19 class-attribute instance-attribute

Component for uploading files.

RADIO_GROUP = 21 class-attribute instance-attribute

Single-choice set of options.

CHECKBOX_GROUP = 22 class-attribute instance-attribute

Multi-selectable group of checkboxes.

CHECKBOX = 23 class-attribute instance-attribute

Single checkbox for yes/no choice.

SeparatorType

Bases: DiscordTypes

              flowchart TD
              scurrypy.enums.components.SeparatorType[SeparatorType]
              scurrypy.enums.enum_types.DiscordTypes[DiscordTypes]

                              scurrypy.enums.enum_types.DiscordTypes --> scurrypy.enums.components.SeparatorType
                


              click scurrypy.enums.components.SeparatorType href "" "scurrypy.enums.components.SeparatorType"
              click scurrypy.enums.enum_types.DiscordTypes href "" "scurrypy.enums.enum_types.DiscordTypes"
            

Represents separator type constants.

SMALL_PADDING = 1 class-attribute instance-attribute

Small separator padding.

LARGE_PADDING = 2 class-attribute instance-attribute

Large separator padding.

ButtonStyle

Bases: DiscordTypes

              flowchart TD
              scurrypy.enums.components.ButtonStyle[ButtonStyle]
              scurrypy.enums.enum_types.DiscordTypes[DiscordTypes]

                              scurrypy.enums.enum_types.DiscordTypes --> scurrypy.enums.components.ButtonStyle
                


              click scurrypy.enums.components.ButtonStyle href "" "scurrypy.enums.components.ButtonStyle"
              click scurrypy.enums.enum_types.DiscordTypes href "" "scurrypy.enums.enum_types.DiscordTypes"
            

Represents button styles for a Button component.

PRIMARY = 1 class-attribute instance-attribute

The most important or recommended action in a group of options. (Blurple)

SECONDARY = 2 class-attribute instance-attribute

Alternative or supporting actions. (Gray)

SUCCESS = 3 class-attribute instance-attribute

Positive confirmation or completion actions. (Green)

DANGER = 4 class-attribute instance-attribute

An action with irreversible consequences. (Red)

LINK = 5 class-attribute instance-attribute

Navigates to a URL. (Gray + window)

TextInputStyle

Bases: DiscordTypes

              flowchart TD
              scurrypy.enums.components.TextInputStyle[TextInputStyle]
              scurrypy.enums.enum_types.DiscordTypes[DiscordTypes]

                              scurrypy.enums.enum_types.DiscordTypes --> scurrypy.enums.components.TextInputStyle
                


              click scurrypy.enums.components.TextInputStyle href "" "scurrypy.enums.components.TextInputStyle"
              click scurrypy.enums.enum_types.DiscordTypes href "" "scurrypy.enums.enum_types.DiscordTypes"
            

Represents the types of Text Inputs.

SHORT = 1 class-attribute instance-attribute

One line text input.

PARAGRAPH = 2 class-attribute instance-attribute

Multi-line text input.

DefaultValueType

Bases: DiscordString

              flowchart TD
              scurrypy.enums.components.DefaultValueType[DefaultValueType]
              scurrypy.enums.enum_types.DiscordString[DiscordString]

                              scurrypy.enums.enum_types.DiscordString --> scurrypy.enums.components.DefaultValueType
                


              click scurrypy.enums.components.DefaultValueType href "" "scurrypy.enums.components.DefaultValueType"
              click scurrypy.enums.enum_types.DiscordString href "" "scurrypy.enums.enum_types.DiscordString"
            

Represents types of default values for select menus.

ROLE = 'role' class-attribute instance-attribute

Default value is a role.

CHANNEL = 'channel' class-attribute instance-attribute

Default value is a channel.

USER = 'user' class-attribute instance-attribute

Default value is a user.