Editing Items

A commonly asked question when it comes to handling view items is how to edit them. View items are exposed through the miru.views.View.children property, which contains a list of all added view items. Editing a specific item is as simple as changing the desired properties, then editing the message with the updated view.

Example:

import hikari
import miru

class EditView(miru.View):
    def __init__(self, *args, **kwargs) -> None:
        super().__init__(*args, **kwargs)
        self.counter = 0

    @miru.button(label="Counter: 0", style=hikari.ButtonStyle.PRIMARY)
    async def counter_button(self, button: miru.Button, ctx: miru.ViewContext) -> None:
        self.counter += 1
        button.label = f"Counter: {self.counter}" # Change the property we want to edit
        await ctx.edit_response(components=self) # Re-send the view components

    @miru.button(label="Disable Menu", style=hikari.ButtonStyle.DANGER)
    async def disable_button(self, button: miru.Button, ctx: miru.ViewContext) -> None:
        for item in self.children:
            item.disabled = True # Disable all items attached to the view
        await ctx.edit_response(components=self)
        self.stop()

...

Using the above view code should generate a button, that when clicked, increments it’s counter shown on the label. The second button iterates through all items attached to the view and disables them, then stops the view.