Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1011 Bytes

README.md

File metadata and controls

49 lines (32 loc) · 1011 Bytes
Raw

Navigation

Generates and edits navigation menus.

Installation

Install the gem as usual

gem "katalyst-navigation"

Mount the engine in your routes.rb file:

mount Katalyst::Navigation::Engine, at: "navigation"

Add the Gem's migrations to your application:

rake katalyst_navigation:install:migrations

Add the Gem's javascript and CSS to your build pipeline. This assumes that you're using rails-dartsass and importmaps to manage your assets.

// app/javascript/controllers/application.js
import { application } from "controllers/application";
import navigation from "@katalyst/navigation";
application.load(navigation);
@use "katalyst/navigation";

Usage

See the dummy app for examples.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/katalyst/navigation.

License

The gem is available as open source under the terms of the MIT License.