Origami Frontend Components & Services

Readme: o-link-list

o-link-list has a support status of "dead". This means that there are no plans to fix any issues with this component, and it may stop working at any point. More information on the status of this component is available in the README. If you still rely on this component or have concerns, please contact the Origami team.

Deprecated, please speak to the Origami team if you would like to use a component like o-link-list.

Styles for lists of links typically used in navigation elements and asides.



The suggested markup used for this module depends on the context within the page.

Markup for navigational elements

If the list is a list of links with a navigational purpose then the following markup should be used.
We suggest avoiding <li> in combination with a <nav> as it increases the amount of reading a screen reader will do without adding value to the user.

<nav class="o-link-list" >
  <a class="o-link-list__item" href='#'>item 1</a>
  <a class="o-link-list__item" href='#'>item 2</a>
  <a class="o-link-list__item" href='#'>item 3</a>
  <a class="o-link-list__item" href='#'>item 4</a>
  <a class="o-link-list__item" href='#'>item 5</a>
  <a class="o-link-list__item" href='#'>item 6</a>
  <a class="o-link-list__item" href='#'>item 7</a>

In the event that this list is being used in an <aside>, <li> elements should be used along with an optional title.

<aside class="o-link-list">
  <div class="o-link-list__aside-title">Topics mentioned in this article</div>
  <ul class="o-link-list__item-container" >
    <li><a class="o-link-list__item" href="#">item 1</a></li>
    <li><a class="o-link-list__item" href="#">item 2</a></li>
    <li><a class="o-link-list__item" href="#">item 3</a></li>
    <li><a class="o-link-list__item" href="#">item 4</a></li>
    <li><a class="o-link-list__item" href="#">item 5</a></li>
    <li><a class="o-link-list__item" href="#">item 6</a></li>
    <li><a class="o-link-list__item" href="#">item 7</a></li>


Silent mode

When you're not consuming this module via the build service, by default this module is set to 'silent' - meaning its Sass will not output any CSS classes, only Sass mixins.

When $o-link-list-is-silent: false;, the module outputs a set of classes that are also documented in each section

Migration guide

Updating from v1 to v2

V1 -> V2 introduces the new major of o-colors. Updating to this new version will mean updating any other components that you have which are using o-colors. There are no other breaking changes in this release.


If you have any questions or comments about this component, or need help using it, please either raise an issue, visit #origami-support or email Origami Support.


This software is published by the Financial Times under the MIT licence.

dead Origami v1 (Bower)
Switch component view

GitHub: o-link-list

Install o-link-list

If using the Build Service, add o-link-list@^2.2.0 to your link tag.

If using the npm package manager for a Manual Build, run npm install --save-peer "@financial-times/o-link-list@^2.2.0".

Help & Support

o-link-list is maintained directly by the Origami team. If you have any questions about o-link-list or Origami in general, we are happy to help. 😊

Slack: #origami-support
Email: origami.support@ft.com

Feedback / Issues

To report a bug or request features please create an issue on Github. For support or general feedback please get in touch 😊

Slack: #origami-support
Email: origami.support@ft.com