add various ui component

Author: FoxeiZ

nameless/custom/ui/dropdown/__init__.py

@@ -0,0 +1,3 @@
+from .custom_dropdown import CustomDropdown
+
+__all__ = ["CustomDropdown"]

nameless/custom/ui/dropdown/custom_dropdown.py

@@ -0,0 +1,81 @@
+import os
+from typing import Callable
+
+import discord
+from discord import ui
+from typing_extensions import override
+
+__all__ = ["CustomDropdown"]
+
+
+DropdownCallback = Callable[[discord.Interaction], str | None]
+"""
+A callback for a dropdown.
+
+Parameters:
+-----------
+interaction: discord.Interaction
+    The interaction object.
+
+Returns:
+--------
+``str`` | ``None``
+    Return with a string to mark it as an error message, otherwise None.
+"""
+
+
+class CustomDropdown(ui.Select[ui.View]):
+    def __init__(
+        self,
+        custom_id: str | None = None,
+        placeholder: str | None = "Select an option",
+        min_values: int = 1,
+        max_values: int = 1,
+        disabled: bool = False,
+    ):
+        self._callback: list[DropdownCallback] = []
+        if custom_id is None:
+            custom_id = "nameless-dropdown-" + os.urandom(16).hex()
+
+        super().__init__(
+            custom_id=custom_id,
+            placeholder=placeholder,
+            min_values=min_values,
+            max_values=max_values,
+            disabled=disabled,
+            options=[],
+        )
+
+    def add_callback(self, callback: DropdownCallback):
+        self._callback.append(callback)
+        return self
+
+    @override
+    async def callback(self, interaction: discord.Interaction):
+        await interaction.response.defer()
+        for callback in self._callback:
+            error = callback(interaction)
+            if error:
+                await interaction.response.send_message(error, ephemeral=True)
+                return
+
+        if self.view is not None:
+            self.view.stop()
+
+    def self_add_option(
+        self,
+        *,
+        label: str,
+        value: str = "",
+        description: str | None = None,
+        emoji: str | discord.Emoji | discord.PartialEmoji | None = None,
+        default: bool = False,
+    ):
+        self.add_option(
+            label=label,
+            value=value,
+            description=description,
+            emoji=emoji,
+            default=default,
+        )
+        return self

nameless/custom/ui/modal/__init__.py

@@ -0,0 +1,4 @@
+from .custom_input import CustomInput
+from .custom_modal import BaseCustomModal
+
+__all__ = ["CustomInput", "BaseCustomModal"]

nameless/custom/ui/modal/custom_input.py

@@ -0,0 +1,21 @@
+from typing import Generic, TypeVar, override
+
+import discord
+from discord import ui
+
+V = TypeVar("V", bound=type, covariant=True)
+
+
+class CustomInput(ui.TextInput[ui.Modal], Generic[V]):
+    def __init__(
+        self, label: str, custom_id: str, default: str = "0", convert: V = str
+    ) -> None:
+        super().__init__(
+            label=label, custom_id=custom_id, placeholder=default, default=default
+        )
+        self.convert: V = convert
+        self.input: V = convert(default)
+
+    @override
+    async def callback(self, interaction: discord.Interaction):
+        self.input = self.convert(self.value)

nameless/custom/ui/modal/custom_modal.py

@@ -0,0 +1,24 @@
+from typing import Generic, TypeVar, override
+
+import discord
+
+from .custom_input import CustomInput
+
+V = TypeVar("V", bound=type, covariant=True)
+
+
+class BaseCustomModal(discord.ui.Modal, Generic[V]):
+    def __init__(self, title: str) -> None:
+        super().__init__(timeout=30, title=title)
+
+    @override
+    async def on_submit(self, interaction: discord.Interaction[discord.Client]) -> None:
+        await interaction.response.defer()
+        self.stop()
+
+    def get_input(self) -> CustomInput[V]:
+        return self.children[0]  # pyright: ignore[reportReturnType]
+
+    @property
+    def value(self) -> V:
+        return self.get_input().input

nameless/custom/ui/view/__init__.py

@@ -0,0 +1,4 @@
+from .view_button import ViewButton
+from .view_menu import ViewMenu
+
+__all__ = ["ViewButton", "ViewMenu"]

nameless/custom/ui/view/base.py

@@ -0,0 +1,94 @@
+from abc import ABC, abstractmethod
+from collections.abc import Iterable
+
+import discord
+from discord.ui.button import Button
+from discord.ui.view import View
+
+
+class BaseView(View, ABC):
+    @abstractmethod
+    def add_pages(self, pages: Iterable[discord.Embed]):
+        """
+        Add multiple pages to the view.
+
+        Parameters:
+        -----------
+        pages: Iterable[discord.Embed]
+            An iterable of discord.Embed objects to add to the view.
+        """
+        pass
+
+    @abstractmethod
+    def add_button(self, button: Button["BaseView"]):
+        """
+        Add a button to the view.
+
+        Parameters:
+        -----------
+        button: BaseButton
+            The button to add to the view.
+        """
+        pass
+
+    @abstractmethod
+    async def next_page(self):
+        """
+        Go to the next page.
+        """
+        pass
+
+    @abstractmethod
+    async def previous_page(self):
+        """
+        Go to the previous page.
+        """
+        pass
+
+    @abstractmethod
+    async def go_to_first_page(self):
+        """
+        Go to the first page.
+        """
+        pass
+
+    @abstractmethod
+    async def go_to_last_page(self):
+        """
+        Go to the last page.
+        """
+        pass
+
+    @abstractmethod
+    async def go_to_page(self, page: int):
+        """
+        Go to a specific page.
+
+        Parameters:
+        -----------
+        page: int
+            The page number to go to.
+        """
+        pass
+
+    @abstractmethod
+    async def end(self):
+        """
+        End the view.
+        """
+        pass
+
+    @abstractmethod
+    async def start(self) -> bool:
+        """
+        Start the view. This method should be called
+        after adding all the pages and buttons.
+
+        This method will be blocking and wait for the view to finish interacting.
+
+        Returns:
+        --------
+        bool:
+            Return ``True`` if the view timed out, otherwise ``False``.
+        """
+        pass