Class: IronAdmin::Layout::SidebarComponent

Inherits:

ViewComponent::Base

• Object
• ViewComponent::Base
• IronAdmin::Layout::SidebarComponent

Includes:

ThemeHelper

Defined in:

app/components/iron_admin/layout/sidebar_component.rb

Overview

Renders the sidebar navigation menu.

Instance Method Summary

• #grouped_resources ⇒ Hash{String => Array<Class>}

  Returns resources grouped by menu group.

• #grouped_tools ⇒ Hash{String => Array<Class>}

  Returns tools grouped by menu group.

• #logo ⇒ String^? private

  Configured logo URL or path.

• #title ⇒ String private

  Configured admin panel title.

Methods included from ThemeHelper

#cp_badge_count, #cp_body_text, #cp_btn_danger, #cp_btn_filter_apply, #cp_btn_ghost, #cp_btn_primary, #cp_btn_primary_lg, #cp_btn_secondary, #cp_card, #cp_checkbox_class, #cp_file_input_class, #cp_filter_input_class, #cp_focus, #cp_heading, #cp_input_class, #cp_label_text, #cp_link, #cp_link_muted, #cp_muted_text, #cp_navbar_search_class, #cp_scope_active, #cp_scope_inactive, #cp_search_class, #cp_select_class, #cp_sidebar_bg, #cp_sidebar_group_label, #cp_sidebar_link, #cp_sidebar_title, #cp_table_border, #cp_table_header_bg, #cp_table_row_hover, #cp_textarea_class, #t

Instance Method Details

#grouped_resources ⇒ Hash{String => Array<Class>}

Returns resources grouped by menu group.

Returns:

• (Hash{String => Array<Class>})

# File 'app/components/iron_admin/layout/sidebar_component.rb', line 11

def grouped_resources
  IronAdmin::ResourceRegistry.grouped
end

#grouped_tools ⇒ Hash{String => Array<Class>}

Returns tools grouped by menu group.

Returns:

• (Hash{String => Array<Class>})

# File 'app/components/iron_admin/layout/sidebar_component.rb', line 17

def grouped_tools
  IronAdmin::ToolRegistry.grouped
end

#logo ⇒ String^?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Configured logo URL or path.

Returns:

• (String, nil) —

  Configured logo URL or path

# File 'app/components/iron_admin/layout/sidebar_component.rb', line 29

def logo
  IronAdmin.configuration.logo
end

#title ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Configured admin panel title.

Returns:

• (String) —

  Configured admin panel title

# File 'app/components/iron_admin/layout/sidebar_component.rb', line 23

def title
  IronAdmin.configuration.title
end