Skip to content

navigation

Help system navigation and UI management.

Classes:

  • HelpState –

    Navigation states for the help command.

  • HelpNavigation –

    Manages help system navigation and UI interactions.

Classes

HelpState

Bases: Enum

Navigation states for the help command.

HelpNavigation

Python
HelpNavigation(ctx: Context[Any], data: HelpData, renderer: HelpRenderer)

Manages help system navigation and UI interactions.

Initialize the help navigation manager.

Parameters:

  • ctx (Context[Any]) –

    The Discord context for the help command.

  • data (HelpData) –

    The help data manager instance.

  • renderer (HelpRenderer) –

    The help renderer instance.

Returned by:

Methods:

Attributes:

Attributes

context property
Python
context: Context[Any]

Context property required by HelpCommandProtocol.

Functions

on_category_select async
Python
on_category_select(interaction: Interaction, category: str) -> None

Handle category selection - protocol method.

on_command_select async
Python
on_command_select(interaction: Interaction, command_name: str) -> None

Handle command selection - protocol method.

on_subcommand_select async
Python
on_subcommand_select(interaction: Interaction, subcommand_name: str) -> None

Handle subcommand selection - protocol method.

on_back_button async
Python
on_back_button(interaction: Interaction) -> None

Handle back button - protocol method.

on_next_button async
Python
on_next_button(interaction: Interaction) -> None

Handle next button - protocol method.

on_prev_button async
Python
on_prev_button(interaction: Interaction) -> None

Handle prev button - protocol method.

_paginate_subcommands
Python
_paginate_subcommands(
    commands_list: list[Command[Any, Any, Any]], preserve_page: bool = False
) -> None

Split subcommands into pages for pagination.

_create_paginated_embed async
Python
_create_paginated_embed() -> Embed

Create an embed showing the current page of subcommands.

Returns:

  • Embed –

    The embed for the current subcommand page.

_find_parent_command async
Python
_find_parent_command(subcommand_name: str) -> tuple[str, Command[Any, Any, Any]] | None

Find the parent command for a given subcommand.

Returns:

create_main_view async
Python
create_main_view() -> HelpView

Create main help view.

Returns:

  • HelpView –

    The main help view with category selection.

create_category_view async
Python
create_category_view(category: str) -> HelpView

Create category view.

Returns:

  • HelpView –

    The category view with command selection.

create_command_view async
Python
create_command_view() -> HelpView

Create command view.

Returns:

  • HelpView –

    The command view with command details and navigation.

create_subcommand_view async
Python
create_subcommand_view() -> HelpView

Create subcommand view.

Returns:

  • HelpView –

    The subcommand view with subcommand details.

handle_category_select async
Python
handle_category_select(interaction: Interaction, category: str) -> None

Handle category selection.

handle_command_select async
Python
handle_command_select(interaction: Interaction, command_name: str) -> None

Handle command selection.

handle_subcommand_select async
Python
handle_subcommand_select(interaction: Interaction, subcommand_name: str) -> None

Handle subcommand selection.

handle_back_button async
Python
handle_back_button(interaction: Interaction) -> None

Handle back button navigation.

handle_next_button async
Python
handle_next_button(interaction: Interaction) -> None

Handle next page navigation.

handle_prev_button async
Python
handle_prev_button(interaction: Interaction) -> None

Handle previous page navigation.

Functions