@gold.au/link-list

A simple list of inline links.

Usage no npm install needed!

<script type="module">
  import goldAuLinkList from 'https://cdn.skypack.dev/@gold.au/link-list';
</script>

README

@gold.au/link-list

A simple list of inline links..

Contents

Install

yarn add @gold.au/link-list

npm install @gold.au/link-list

⬆ back to top

Usage

⬆ back to top

React

Usage:

import AUlinkList from './link-list.js';

<AUlinkList items={[
  {
    link: 'link/one/',
    text: 'Link 1',
  },
  {
    link: 'link/two/',
    text: 'Link 2',
    className: 'is-active',
    li: {
      className: 'li-wrapping-class',
    },
  },
  {
    text: 'Link 3',
    onClick: () => console.log('You clicked me!'),
  },
  {
    linkComponent: 'a',
    link: 'link/four/',
    text: 'Link 4',
  },
]} />

All props:

<AUlinkList
  inline={ false }            {/* The inline option to make the list inline, optional */}
  linkComponent="a"           {/* The component used for the link, optional */}
  items={[                    {/* All links in a neat array */}
    {
      link: 'link/to/',       {/* The link for this item, optional */}
      linkComponent: 'a',     {/* The component used for the link, optional */}
      text: 'Link title',     {/* The text for this item */}
      li: {},                 {/* An object that will be spread onto the <li> tag, optional */}
      onClick={ () => {} }    {/* A function to execute when this link is clicked, optional */}
    },
  ]},
/>

(💡 additional props are spread onto the component)

For more details have a look at the usage example.

⬆ back to top

Dependency graph

/link-list
├─ /core
└─ /body
   └─ /core

⬆ back to top

Tests

The visual test: https://auds.service.gov.au/packages/link-list/tests/site/

⬆ back to top

Release History

  • v3.0.9 - Update core package dependency to use the latest version
  • v3.0.8 - Update incorrect proptype for onClick prop
  • v3.0.7 - Remove --save-dev flag from readme instructions
  • v3.0.6 - Added onClick event handler prop
  • v3.0.5 - Removed unused Fragment React import
  • v3.0.4 - Removed uikit references
  • v3.0.3 - Fixing bug in link-list au-body
  • v3.0.2 - Update dependencies
  • v3.0.1 - Removing web pack dev server, updating dependencies
  • v3.0.0 - Move children location in react, build scripts for Windows
  • v2.1.1 - Replace node-sass with sass
  • v2.1.0 - Support react router
  • v2.0.3 - Add support for HTML in link, Update dependencies
  • v2.0.2 - Change homepage links
  • v2.0.1 - Fix dependencies
  • v2.0.0 - Change to focus colour and border/muted color mix
  • v1.0.0 - Moved to AU namespace, added new color themes and spacing
  • v0.3.0 - Added pancake-react plugin, ES5 main file
  • v0.2.0 - Added react component
  • v0.1.0 - 💥 Initial version

⬆ back to top

License

Copyright (c) Commonwealth of Australia. Licensed under MIT.

⬆ back to top

};