""" The MIT License (MIT) Copyright (c) 2021-present Disnake Development Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ from __future__ import annotations from typing import TYPE_CHECKING, List, Optional, Sequence, TypeVar, Union from ..components import ActionRow as ActionRowComponent, NestedComponent, SelectOption from ..enums import ButtonStyle, ComponentType, TextInputStyle from ..utils import MISSING from .button import Button from .item import WrappedComponent from .select import Select from .text_input import TextInput __all__ = ("ActionRow",) if TYPE_CHECKING: from ..emoji import Emoji from ..partial_emoji import PartialEmoji from ..types.components import ActionRow as ActionRowPayload ActionRowT = TypeVar("ActionRowT", bound="ActionRow") Components = Union[ ActionRowT, WrappedComponent, Sequence[Union[ActionRowT, WrappedComponent, Sequence[WrappedComponent]]], ] class ActionRow: """Represents a UI action row. Useful for lower level component manipulation. .. versionadded:: 2.4 Parameters ---------- *components: :class:`WrappedComponent` The components of this action row. """ def __init__(self, *components: WrappedComponent): self.width: int = 0 raw_components: List[NestedComponent] = [] # Validate the components for component in components: if not isinstance(component, WrappedComponent): raise ValueError("ActionRow must contain only WrappedComponent instances") self.width += component.width if self.width > 5: raise ValueError("Too many components in one row.") raw_components.append(component._underlying) self._underlying = ActionRowComponent._raw_construct( type=ComponentType.action_row, children=raw_components, ) def __repr__(self) -> str: return f"" @property def children(self) -> List[NestedComponent]: """List[Union[:class:`~disnake.Button`, :class:`~disnake.SelectMenu`, :class:`~disnake.TextInput`]]: The components of this row.""" return self._underlying.children @children.setter def children(self, value: List[NestedComponent]): self._underlying.children = value @property def type(self) -> ComponentType: return self._underlying.type def append_item(self, item: WrappedComponent) -> None: """Appends a component to the action row. Parameters ---------- item: :class:`WrappedComponent` The component to append to the action row. Raises ------ ValueError The width of the action row exceeds 5. """ if self.width + item.width > 5: raise ValueError("Too many components in this row, can not append a new one.") self.width += item.width self._underlying.children.append(item._underlying) def add_button( self, *, style: ButtonStyle = ButtonStyle.secondary, label: Optional[str] = None, disabled: bool = False, custom_id: Optional[str] = None, url: Optional[str] = None, emoji: Optional[Union[str, Emoji, PartialEmoji]] = None, ): """Adds a button to the action row. To append a pre-existing :class:`~disnake.ui.Button` use the :meth:`append_item` method instead. Parameters ---------- style: :class:`.ButtonStyle` The style of the button. custom_id: Optional[:class:`str`] The ID of the button that gets received during an interaction. If this button is for a URL, it does not have a custom ID. url: Optional[:class:`str`] The URL this button sends you to. disabled: :class:`bool` Whether the button is disabled or not. label: Optional[:class:`str`] The label of the button, if any. emoji: Optional[Union[:class:`.PartialEmoji`, :class:`.Emoji`, :class:`str`]] The emoji of the button, if available. Raises ------ ValueError The width of the action row exceeds 5. """ self.append_item( Button( style=style, label=label, disabled=disabled, custom_id=custom_id, url=url, emoji=emoji, ) ) def add_select( self, *, custom_id: str = MISSING, placeholder: Optional[str] = None, min_values: int = 1, max_values: int = 1, options: List[SelectOption] = MISSING, disabled: bool = False, ): """Adds a select menu to the action row. To append a pre-existing :class:`~disnake.ui.Select` use the :meth:`append_item` method instead. Parameters ---------- custom_id: :class:`str` The ID of the select menu that gets received during an interaction. If not given then one is generated for you. placeholder: Optional[:class:`str`] The placeholder text that is shown if nothing is selected, if any. min_values: :class:`int` The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25. max_values: :class:`int` The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25. options: List[:class:`~disnake.SelectOption`] A list of options that can be selected in this menu. disabled: :class:`bool` Whether the select is disabled or not. Raises ------ ValueError The width of the action row exceeds 5. """ self.append_item( Select( custom_id=custom_id, placeholder=placeholder, min_values=min_values, max_values=max_values, options=options, disabled=disabled, ) ) def add_text_input( self, *, label: str, custom_id: str, style: TextInputStyle = TextInputStyle.short, placeholder: Optional[str] = None, value: Optional[str] = None, required: bool = True, min_length: Optional[int] = None, max_length: Optional[int] = None, ): """Adds a text input to the action row. To append a pre-existing :class:`~disnake.ui.TextInput` use the :meth:`append_item` method instead. .. versionadded:: 2.4 Parameters ---------- style: :class:`.TextInputStyle` The style of the text input. label: :class:`str` The label of the text input. custom_id: :class:`str` The ID of the text input that gets received during an interaction. placeholder: Optional[:class:`str`] The placeholder text that is shown if nothing is entered. value: Optional[:class:`str`] The pre-filled value of the text input. required: :class:`bool` Whether the text input is required. Defaults to ``True``. min_length: Optional[:class:`int`] The minimum length of the text input. max_length: Optional[:class:`int`] The maximum length of the text input. Raises ------ ValueError The width of the action row exceeds 5. """ self.append_item( TextInput( label=label, custom_id=custom_id, style=style, placeholder=placeholder, value=value, required=required, min_length=min_length, max_length=max_length, ) ) def to_component_dict(self) -> ActionRowPayload: return self._underlying.to_dict() def components_to_rows(components: Components) -> List[ActionRow]: if not isinstance(components, Sequence): components = [components] action_rows: List[ActionRow] = [] auto_row = ActionRow() for component in components: if isinstance(component, WrappedComponent): try: auto_row.append_item(component) except ValueError: action_rows.append(auto_row) auto_row = ActionRow(component) else: if auto_row.width > 0: action_rows.append(auto_row) auto_row = ActionRow() if isinstance(component, ActionRow): action_rows.append(component) elif isinstance(component, Sequence): action_rows.append(ActionRow(*component)) else: raise ValueError( "`components` must be a `WrappedComponent` or `ActionRow`, " "a sequence/list of `WrappedComponent`s or `ActionRow`s, " "or a nested sequence/list of `WrappedComponent`s" ) if auto_row.width > 0: action_rows.append(auto_row) return action_rows def components_to_dict(components: Components) -> List[ActionRowPayload]: return [row.to_component_dict() for row in components_to_rows(components)]