@govuk-react/list-navigation

0.9.1 • Public • Published

ListNavigation

Import

  import ListNavigation from '@govuk-react/list-navigation';

Usage

Simple

import { ListNavigation, Link } from 'govuk-react';

<ListNavigation>
  <Link href="/section-a">Section A</Link>
  <Link href="/section-b">Section B</Link>
</ListNavigation>

Using React Router with Link component for GDS styled links

import { Link as RouterLink } from 'react-router-dom';
import { ListNavigation, Link } from 'govuk-react';

<ListNavigation listStyleType="circle">
  <Link as={RouterLink} to="/link-a">Link A</Link>
  <Link as={RouterLink} to="/link-b">Link B</Link>
</ListNavigation>

References:

TODO:

Properties

Prop Required Default Type Description
children true `````` node List navigation content
listStyleType undefined string CSS value for list-style-type

Readme

Keywords

none

Package Sidebar

Install

npm i @govuk-react/list-navigation

Weekly Downloads

270

Version

0.9.1

License

MIT

Unpacked Size

27.9 kB

Total Files

18

Last publish

Collaborators

  • loque-
  • steve_sims
  • petelockey
  • penx
  • marksy