API Reference

This section contains an index of all the API reference pages for miru.

If you think anything is missing, feel free to open an issue or pull request.

---

Index:

• Bootstrap API Reference
  • install()
  • uninstall()
• Item API Reference
  • DecoratedItem
    • DecoratedItem.build()
    • DecoratedItem.name
  • Item
    • Item.custom_id
    • Item.position
    • Item.row
    • Item.type
    • Item.width
  • ModalItem
    • ModalItem.modal
    • ModalItem.required
  • ViewItem
    • ViewItem.callback()
    • ViewItem.disabled
    • ViewItem.view
• Item Handler API Reference
  • ItemArranger
    • ItemArranger.add_item()
    • ItemArranger.clear()
    • ItemArranger.remove_item()
  • ItemHandler
    • ItemHandler.add_item()
    • ItemHandler.build()
    • ItemHandler.clear_items()
    • ItemHandler.get_item_by()
    • ItemHandler.get_item_by_id()
    • ItemHandler.on_timeout()
    • ItemHandler.remove_item()
    • ItemHandler.stop()
    • ItemHandler.wait()
    • ItemHandler.app
    • ItemHandler.bot
    • ItemHandler.children
    • ItemHandler.last_context
    • ItemHandler.timeout
• View API Reference
  • View
    • View.add_item()
    • View.from_message()
    • View.get_context()
    • View.on_error()
    • View.start()
    • View.stop()
    • View.view_check()
    • View.wait_for_input()
    • View.autodefer
    • View.is_bound
    • View.is_persistent
    • View.message
    • View.message_id
  • get_view()
• Modal API Reference
  • Modal
    • Modal.add_item()
    • Modal.callback()
    • Modal.get_context()
    • Modal.modal_check()
    • Modal.on_error()
    • Modal.send()
    • Modal.start()
    • Modal.custom_id
    • Modal.title
    • Modal.values
• Button API Reference
  • Button
    • Button.emoji
    • Button.label
    • Button.style
    • Button.type
    • Button.url
  • button()
• Select API Reference
  • ChannelSelect
    • ChannelSelect.channel_types
    • ChannelSelect.type
    • ChannelSelect.values
  • MentionableSelect
    • MentionableSelect.type
    • MentionableSelect.values
  • RoleSelect
    • RoleSelect.type
    • RoleSelect.values
  • SelectBase
    • SelectBase.max_values
    • SelectBase.min_values
    • SelectBase.placeholder
  • SelectOption
  • TextSelect
    • TextSelect.options
    • TextSelect.placeholder
    • TextSelect.type
  • UserSelect
    • UserSelect.type
    • UserSelect.values
  • channel_select()
  • mentionable_select()
  • role_select()
  • text_select()
  • user_select()
• TextInput API Reference
  • TextInput
    • TextInput.label
    • TextInput.max_length
    • TextInput.min_length
    • TextInput.placeholder
    • TextInput.style
    • TextInput.type
    • TextInput.value
• Context API Reference
  • Context
    • Context.defer()
    • Context.edit_response()
    • Context.get_channel()
    • Context.get_guild()
    • Context.get_last_response()
    • Context.respond()
    • Context.app
    • Context.app_permissions
    • Context.author
    • Context.bot
    • Context.channel_id
    • Context.custom_id
    • Context.guild_id
    • Context.guild_locale
    • Context.interaction
    • Context.is_valid
    • Context.locale
    • Context.member
    • Context.responses
    • Context.user
  • InteractionResponse
    • InteractionResponse.delete()
    • InteractionResponse.delete_after()
    • InteractionResponse.edit()
    • InteractionResponse.retrieve_message()
  • ModalContext
    • ModalContext.get_value_by()
    • ModalContext.get_value_by_id()
    • ModalContext.get_value_by_predicate()
    • ModalContext.modal
    • ModalContext.values
  • RawComponentContext
    • RawComponentContext.respond_with_modal()
    • RawComponentContext.message
  • RawModalContext
  • ViewContext
    • ViewContext.view
• Exceptions API Reference
  • BootstrapFailureError
  • HandlerFullError
  • ItemAlreadyAttachedError
  • MiruException
  • RowFullError
• Traits API Reference
  • MiruAware
• ext.nav
  • NavigatorView API Reference
    • NavigatorView
      • NavigatorView.add_item()
      • NavigatorView.get_default_buttons()
      • NavigatorView.on_timeout()
      • NavigatorView.send()
      • NavigatorView.send_page()
      • NavigatorView.start()
      • NavigatorView.swap_pages()
      • NavigatorView.children
      • NavigatorView.current_page
      • NavigatorView.ephemeral
      • NavigatorView.is_persistent
      • NavigatorView.pages
    • Page
      • Page.attachment
      • Page.attachments
      • Page.content
      • Page.embed
      • Page.embeds
      • Page.mentions_everyone
      • Page.role_mentions
      • Page.user_mentions
  • Navigation Items API Reference
    • FirstButton
      • FirstButton.before_page_change()
      • FirstButton.callback()
    • IndicatorButton
      • IndicatorButton.before_page_change()
      • IndicatorButton.callback()
    • LastButton
      • LastButton.before_page_change()
      • LastButton.callback()
    • NavButton
    • NavChannelSelect
    • NavItem
      • NavItem.before_page_change()
      • NavItem.view
    • NavMentionableSelect
    • NavRoleSelect
    • NavTextSelect
    • NavUserSelect
    • NextButton
      • NextButton.before_page_change()
      • NextButton.callback()
    • PrevButton
      • PrevButton.before_page_change()
      • PrevButton.callback()
    • StopButton
      • StopButton.callback()
• ext.menu
  • Menu API Reference
    • Menu
      • Menu.on_timeout()
      • Menu.pop()
      • Menu.pop_until_root()
      • Menu.push()
      • Menu.send()
      • Menu.update_message()
      • Menu.current_screen
      • Menu.ephemeral
      • Menu.is_persistent
  • Screen API Reference
    • Screen
      • Screen.add_item()
      • Screen.build_content()
      • Screen.clear_items()
      • Screen.get_item_by()
      • Screen.get_item_by_id()
      • Screen.on_dispose()
      • Screen.on_error()
      • Screen.remove_item()
      • Screen.children
      • Screen.menu
    • ScreenContent
      • ScreenContent.attachment
      • ScreenContent.attachments
      • ScreenContent.content
      • ScreenContent.embed
      • ScreenContent.embeds
      • ScreenContent.mentions_everyone
      • ScreenContent.role_mentions
      • ScreenContent.user_mentions
  • Screen Items API Reference
    • ScreenButton
    • ScreenChannelSelect
    • ScreenItem
      • ScreenItem.menu
      • ScreenItem.screen
      • ScreenItem.view
    • ScreenMentionableSelect
    • ScreenRoleSelect
    • ScreenTextSelect
    • ScreenUserSelect
    • button()
    • channel_select()
    • mentionable_select()
    • role_select()
    • text_select()
    • user_select()