@poowf/jekko

Jekko

Jekko is an AdonisJS Helper Package which helps you mark currently active items in your navigation.

It takes inspiration from the Ekko package for Laravel hence Jekko.

Installation

From the command line:

npm install --save poowf/jekko

You will need to include the service provider in start/app.js

const providers = [
  ...,
  '@poowf/jekko/providers/JekkoProvider'
]

And also include it in the globalMiddleware in start/kernel.js

const globalMiddleware = [
  ...,
  'Poowf/Middleware/Jekko'
]

Overview

To mark a menu item active in Bootstrap, you need to add a active CSS class to the <li> tag:

<ul class="nav navbar-nav">
    <li class="active"><a href="/">Home</a></li>
    <li><a href="/about">About</a></li>
</ul>

With Jekko your code will look like this:

<ul class="nav navbar-nav">
    <li class="{{ isActiveURL('/') }}"><a href="/">Home</a></li>
    <li><a href="/about">About</a></li>
</ul>

What if you are not using Bootstrap, but some other framework or a custom design? Instead of returning active CSS class, you can make Ekko return any string you want:

<ul class="nav navbar-nav">
    <li class="{{ isActiveURL('/', 'highlight') }}"><a href="/">Home</a></li>
    <li><a href="/about">About</a></li>
</ul>

You can also use it in templating if you need to display some content depending on which page you are in your layout view:

@if(isActiveRoute('home') != '')
    <p>Something that is only visible on the `home` route.</p>
@endif

API

isActiveRoute

Compares given route name with current route name.

isActiveRoute($routeName, $output = "active")

Examples:

If the current route is home, function isActiveRoute('home') would return string active.

The * wildcard can be used for resource routes

Function isActiveRoute('user.*') would return string active for any current route which begins with user.

isActiveURL

Compares given URL path with current URL path.

isActiveURL($url, $output = "active")

Examples:

If the current URL path is /about, function isActiveURL('/about') would return string active.

isActiveMatch

Detects if the given string is found in the current URL.

isActiveMatch($string, $output = "active")

Examples:

If the current URL path is /about or /insideout, function isActiveMatch('out') would return string active.

areActiveRoutes

Compares given array of route names with current route name.

areActiveRoutes(array $routeNames, $output = "active")

Examples:

If the current route is product.index or product.show, function areActiveRoutes(['product.index', 'product.show']) would return string active.

The * wildcard can be used for resource routes

Function areActiveRoutes(['user.*', 'product.*']) would return string active for any current route which begins with user or product.

areActiveURLs

Compares given array of URL paths with current URL path.

areActiveURLs(array $urls, $output = "active")

Examples:

If the current URL path is /product or /product/create, function areActiveURLs(['/product', '/product/create']) would return string active.

License

The MIT License (MIT)

Copyright (c) 2018 Poowf

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.