hexpreview

README.md

# Navigator

[![Build Status](https://github.com/fremantle-industries/navigator/workflows/test/badge.svg?branch=main)](https://github.com/fremantle-industries/navigator/actions?query=workflow%3Atest)
[![hex.pm version](https://img.shields.io/hexpm/v/navigator.svg?style=flat)](https://hex.pm/packages/navigator)

Global navigation between multiple Phoenix endpoints, tailwindcss friendly

![navigation](./docs/navigation.png)

## Installation

Add the `navigator` package to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:navigator, "~> 0.0.3"}
  ]
end
```

## Usage

Configure the navigation links in `config/config.exs`

```elixir
# config/config.exs
use Mix.Config

config :navigator,
  links: %{
    storefront: [
      %{
        label: "Storefront Home",
        link: {StorefrontWeb.Router.Helpers, :home_path, [StorefrontWeb.Endpoint, :index]},
        class: "text-4xl"
      },
      %{
        label: "Orders",
        link: {StorefrontWeb.Router.Helpers, :order_path, [StorefrontWeb.Endpoint, :index]}
      },
      %{
        label: "Admin",
        link: {AdminWeb.Router.Helpers, :home_url, [AdminWeb.Endpoint, :index]}
      }
    ],
    admin: [
      %{
        label: "Admin Home",
        link: {AdminWeb.Router.Helpers, :home_path, [AdminWeb.Endpoint, :index]},
        class: "text-4xl"
      },
      %{
        label: "Order Admin",
        link: {AdminWeb.Router.Helpers, :order_path, [AdminWeb.Endpoint, :index]}
      },
    ]
  }
```

Render the navigation in your phoenix templates

```elixir
<%= render Navigator, "horizontal.html", conn: @conn %>
```

## Authors

- Alex Kwiatkowski - [email protected]

## License

`navigator` is released under the [MIT license](./LICENSE)
OSZAR »