yhirano55 / active_admin_menu

Manageable menu with YAML for Active Admin

ActiveAdminMenu

Manageable menu with YAML for Active Admin

Installation

Add this line to your application's Gemfile:

gem 'active_admin_menu'

And then execute:

$ bundle

Or install it yourself as:

$ gem install active_admin_menu

Usage

Install and prepare Rails and ActiveAdmin before install active_admin_menu with bundle, and run it:

$ bundle exec rails generate active_admin_menu:install
create  config/initializers/active_admin_menu.rb
create  config/active_admin_menu.yml

And edit config/active_admin_menu.yml:

default: &default
  root:
    - Dashboard
  Admin:
    - AdminUser

development:
  <<: *default

test:
  <<: *default

production:
  <<: *default

And edit config/locales/en.yml:

en:
  active_admin:
    menu:
      admin: Administrator
      dashboard: Admin Dashboard

Configuration

See config/initializers/active_admin_menu.rb:

ActiveAdminMenu.configure do |config|
  config.source                     = Rails.root.join("config", "active_admin_menu.yml")
  config.namespace                  = Rails.env
  config.uncategorize_key_name      = "root"
  config.i18n_scope_prefix[:parent] = "active_admin.menu"
  config.i18n_scope_prefix[:label]  = "active_admin.menu"
end

attribute	type	content
source	/path/to/yaml or Hash	Source of menu
namespace	String	The key of source
uncategorize_key_name	String	Uncategorize key name (default: root)
i18n_scope_prefix[:parent]	String	Looking up i18n scope for parent
i18n_scope_prefix[:label]	String	Looking up i18n scope for register_page

If the resource is not register_page, label will translate from activerecord.models on locale.

Tips

How to sort menu links on top level?

It' impossible to sort by priority option. So you need to add numeric prefix on i18n keys.

You need to change like this:

en:
  active_admin:
    menu:
      user: "01 User"
      admin: "02 Admin"
      dashboard: "Dashboard"

License

MIT License

active_admin_menu's Issues

How to add label to a child item

Thank you for your great work.
It's awsome.

Btw, I have a question.
I'm trying to put a label on a child item.
I tried some ways to do that.
But, they doesn't work.

How should I write in active_admin_menu.yml?

With Ruby 3.1, YAML.load_file is not possible.

Steps to reproduce

With Ruby 3.1, the following code causes an error.

active_admin_menu/lib/active_admin_menu/config.rb

Lines 24 to 26 in 8cd35c0

	def source=(value)
	@source = value.is_a?(Hash) ? value : YAML.load_file(value.to_s)
	end

 Psych::BadAlias: Unknown alias: default

Cause

Ruby 3.1 uses Psych 4 by default, and Psych.load of Psych 4 no longer loads alias by default.

See below for details.
https://secret-garden.hatenablog.com/entry/2021/05/23/200803

System configuration

Ruby version: 3.1 or higher