@10up/component-navigation

Accessible navigation component.

Usage no npm install needed!

<script type="module">
  import 10upComponentNavigation from 'https://cdn.skypack.dev/@10up/component-navigation';
</script>

README

10up Navigation component

An accessible and responsive navigation component.

Support Level Build Status

Installation

NPM

npm install --save @10up/component-navigation

Standalone

Clone this repo and import navigation.js and navigation.css from the dist/ directory.

API

This component accepts two arguments, the selector for the navigation container and an object containing configuration settings and optional callbacks.

Settings

  • action: The action to use to open menu items (default) hover
  • breakpoint: Viewport breakpoint to switch to small screen menu (default) (min-width: 48em)

Callbacks

  • onCreate: Called after the component is initialized on page load
  • onOpen: Called when a menu item is opened
  • onClose: Called when a menu item is closed
  • onSubmenuOpen: Called when a submenu item is opened
  • onSubmenuClose: Called when a submenu item is closed

Usage

Markup

This is the markup template expected by the component.

<nav class="site-navigation" role="navigation" itemscope="itemscope" itemtype="http://schema.org/SiteNavigationElement">

   <a href="#primary-nav" aria-controls="primary-nav">
       <span class="screen-reader-text">Primary Menu</span>
       <span aria-hidden="true">☰</span>
   </a>

   <?php
       wp_nav_menu( array(
           'theme_location' => 'primary',
           'menu_class'     => 'primary-menu',
           'menu_id'        => 'primary-nav',
           ) );
   ?>

</nav>

CSS

The styles can be imported into your existing codebase by using PostCSS imports, or by including the standalone CSS file in your project.

PostCSS Imports

@import '@10up/component-navigation';

Standalone

Include the navigation.css file from the dist/ directory.

JavaScript

Create a new instance by supplying the selector to use for the navigation and an object containing any necessary configuration settings and callback functions.

NPM

import Navigation from '@10up/component-navigation';

new Navigation( '.navigation', {
    action: 'click',
    onCreate: function() {
        console.log( 'onCreate callback' );
    },
    onOpen: function() {
        console.log( 'onOpen callback' );
    },
    onClose: function() {
        console.log( 'onClose callback' );
    },
    onSubmenuOpen: function() {
        console.log( 'onSubmenuOpen callback' );
    },
    onSubmenuClose: function() {
        console.log( 'onSubmenuClose callback' );
    }
} );

Standalone

Include the navigation.js file from the dist/ directory and access the component from the gobal TenUp object.

let myNavigation = new TenUp.navigation( '.navigation', {
    action: 'click',
    onCreate: function() {
        console.log( 'onCreate callback' );
    },
    onOpen: function() {
        console.log( 'onOpen callback' );
    },
    onClose: function() {
        console.log( 'onClose callback' );
    },
    onSubmenuOpen: function() {
        console.log( 'onSubmenuOpen callback' );
    },
    onSubmenuClose: function() {
        console.log( 'onSubmenuClose callback' );
    }
} );

Demo

Example implementations can be found in the demo directory.

Support Level

Active: 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.