0.2.0 • Published 5 years ago

@govuk-frederic/page-navigation v0.2.0

Weekly downloads
3
License
MIT
Repository
-
Last release
5 years ago

PageNavigation

Import

  import PageNavigation from '@govuk-frederic/page-navigation';

Usage

Default example

import React from 'react';
import { BrowserRouter } from 'react-router-dom';
import asNavLink from 'as-nav-link';

import PageNavigation from '.';

const NavLink = asNavLink()(PageNavigation.Anchor);

const PageNavigationExample = () => (
  <BrowserRouter>
    <PageNavigation>
      <NavLink exact to="/">Home</NavLink>
      <NavLink exact to="/section-01">Section 01</NavLink>
      <NavLink exact to="/section-02">Section 02</NavLink>
    </PageNavigation>
  </BrowserRouter>
);

TODO:

  • Add responsive considerations

Properties

PropRequiredDefaultTypeDescription
childrennullnodeNavigation items