Simplified interface with ButtonMenu class

Author: DenverCoder1

README.md

@@ -176,17 +176,17 @@ await pages.start(ctx)
 
 ## Button Component Menus
 
-Button implementation of a basic menu that has a stop button and two reply reactions:
+Here is a button implementation of a basic menu that has a stop button and two reply reactions. Note that the `ButtonMenu` class is used instead of `Menu` in order to make it a `View`.
+
+`ButtonMenu` is a subclass of `Menu` and it therefore has all the same attributes and methods.
+
+Also note that `ButtonMenu.stop()` is a coroutine and needs to be awaited.
 
 ```py
 import nextcord
 from nextcord.ext import menus
 
-class MyButtonMenu(menus.Menu, nextcord.ui.View):
-    def __init__(self):
-        menus.Menu.__init__(self)
-        nextcord.ui.View.__init__(self)
-
+class MyButtonMenu(menus.ButtonMenu):
     async def send_initial_message(self, ctx, channel):
         return await channel.send(f'Hello {ctx.author}', view=self)
 
@@ -200,7 +200,7 @@ class MyButtonMenu(menus.Menu, nextcord.ui.View):
 
     @nextcord.ui.button(emoji="\N{BLACK SQUARE FOR STOP}\ufe0f")
     async def on_stop(self, button, interaction):
-        nextcord.ui.View.stop(self)
+        await self.stop()
 ```
 
 Instantiation is the same as above.
@@ -215,7 +215,7 @@ A `ButtonMenuPages` class is provided for pagination with button components.
 
 `ButtonMenuPages` works the same way as the `MenuPages` class found above, but with button components instead of reactions.
 
-`MySource` is the same as defined above, but instantiated with:
+`MySource` is the same as defined above, but the menu is instantiated with:
 
 ```py
 pages = menus.ButtonMenuPages(source=MySource(range(1, 100)), clear_reactions_after=True)

nextcord/ext/menus/__init__.py

@@ -14,6 +14,7 @@
 # consistency with the `nextcord` namespaced logging
 log = logging.getLogger(__name__)
 
+DEFAULT_TIMEOUT = 180.0
 
 class MenuError(Exception):
     pass
@@ -312,7 +313,7 @@ class Menu(metaclass=_MenuMeta):
         calling :meth:`send_initial_message`\, if for example you have a pre-existing
         message you want to attach a menu to.
     """
-    def __init__(self, *, timeout=180.0, delete_message_after=False,
+    def __init__(self, *, timeout=DEFAULT_TIMEOUT, delete_message_after=False,
                           clear_reactions_after=False, check_embeds=False, message=None):
 
         self.timeout = timeout
@@ -763,6 +764,30 @@ def stop(self):
         self.__tasks.clear()
 
 
+class ButtonMenu(Menu, nextcord.ui.View):
+    r"""An interface that allows handling menus by using button interaction components.
+
+    Buttons should be marked with the :func:`nextcord.ui.button` decorator. Please note that
+    this expects the methods to have two parameters, the ``button`` and the ``interaction``.
+    The ``button`` is of type :class:`nextcord.ui.Button`.
+    The ``interaction`` is of type :class:`nextcord.Interaction`.
+    """
+    def __init__(self, timeout=DEFAULT_TIMEOUT, *args, **kwargs):
+        Menu.__init__(self, timeout=timeout, *args, **kwargs)
+        nextcord.ui.View.__init__(self, timeout=timeout)
+
+    async def stop(self):
+        """Stops the internal loop and view interactions."""
+        # disable the buttons
+        for child in self.children:
+            child.disabled = True
+        await self.message.edit(view=self)
+        # stop the menu loop
+        Menu.stop(self)
+        # stop view interactions
+        nextcord.ui.View.stop(self)
+
+
 class PageSource:
     """An interface representing a menu page's data source for the actual menu page.
 
@@ -1082,7 +1107,7 @@ class ButtonMenuPages(MenuPagesBase, nextcord.ui.View):
         The current page that we are in. Zero-indexed
         between [0, :attr:`PageSource.max_pages`).
     """
-    def __init__(self, source, timeout = 180.0, **kwargs):
+    def __init__(self, source, timeout=DEFAULT_TIMEOUT, **kwargs):
         MenuPagesBase.__init__(self, source, **kwargs)
         nextcord.ui.View.__init__(self, timeout=timeout)
         skip_double_triangle_buttons = self._skip_double_triangle_buttons()