Global-nav NPM

Canonical Ltd Global nav

This project contains the JavaScript and styles to display a banner across the top of a page.

This banner displays a list of corporate eco-system websites giving a user the ability to jump around the core sites easily.

Usage

Simply use a node package manager to install this component and then link the JS file into the head of your site, with optional settings. The styles will automatically be injected into the page's <head>.

Install via yarn or npm

yarn add global-nav
npm install global-nav --save

You can then install the library either by directly linking to it or via ES6 imports.

To consume the library directly, add a link to the JS file containing an IIFE and run the canonicalGlobalNav.createNav() function

<script src="/node_modules/global-nav/dist/iife.js"></script>
<script>
  canonicalGlobalNav.createNav();
</script>

To import it, simply call it from your site-wide JS file;

import {createNav} from 'global-nav';
createNav();

Options

The createNav function takes an object of options with the following properties:

maxWidth: The max-width of the global nav element (default: 68rem)
showLogins: Should the "logins" drop-down be shown? (default: false)

For example, to use the global-nav without the "login" section, and set the max-width to 80rem:

<script src="/node_modules/global-nav/dist/index.js"></script>

<script>
  canonicalGlobalNav.createNav({ showLogins: false, maxWidth: '80rem' });
</script>

If you're importing;

import {createNav} from 'global-nav';
createNav({ showLogins: false, maxWidth: '80rem' });

Building the Global nav

To build the JS into the /dist folder, run:

yarn install
yarn build

You can view the build files in action by opening the index.html in the root of this project.

Hacking

When developing this project you can run the following command to listen to changes in the src/js/*.js and src/sass/*.scss and builds them into the /dist folder.