Breadcrumbs

Avo has a pretty advanced breadcrumbs system.

It will use the resource avatar or initials to display the breadcrumb and context.

It has minimal configuration options but you will have the oportunity to interact with it in a few places like the avo.rb config file or in the controller actions when you want to add breadcrumbs to a custom tool.

API

add_breadcrumb

This method is used to add a breadcrumb to the stack. It takes the following arguments:

Options

-> title

Sets the title of the breadcrumb.

add_breadcrumb title: "Home"
add_breadcrumb title: "Details"

Option	Value
Required	true
Default value	nil
Possible values	Strings

-> path

This sets the link of the breadcrumb.

add_breadcrumb title: "Posts", path: avo.posts_path
add_breadcrumb title: "Custom tool", path: avo.custom_tool_path

WARNING

You're most probably linking to an internal Avo page, so you need to prefix the path using the avo dot as per Rails' engine rules. See Rails engines and path helpers for a full guide.

Option	Value
Required	false
Default value	nil
Possible values	Strings

-> icon

Sets the icon of the breadcrumb.

add_breadcrumb title: "Home", icon: "heroicons/outline/home"
add_breadcrumb title: "Details", icon: "heroicons/outline/information-circle"

Option	Value
Required	false
Default value	nil
Possible values	Icon strings (e.g. "heroicons/outline/home")

-> initials

Sets the initials displayed in the breadcrumb avatar when no icon is present. Useful for resource records where you want to show abbreviated identifiers (e.g. "JD" for a user named John Doe).

add_breadcrumb title: "John Doe", initials: "JD", path: user_path(@user)
add_breadcrumb title: "Post #123", initials: "P123", path: post_path(@post)

Option	Value
Required	false
Default value	nil
Possible values	Strings

It returns the breadcrumb object.

add_breadcrumb title: "Home", path: root_path

Breadcrumbs for custom pages

You can add breadcrumbs to custom pages in the controller action.

class Avo::ToolsController < Avo::ApplicationController
  def custom_tool
    add_breadcrumb title: "Custom tool", path: avo.custom_tool_path
  end
end