@bbc/psammead-sitewide-links

psammead-sitewide-links -

Description

The psammead-sitewide-links component is intended to be used at the bottom of an article, serving as a footer, however can be used anywhere on a page. These links are generally intended to be to more general and legal BBC pages, but do not have to be. It also includes information about copyright.

Installation

npm install @bbc/psammead-sitewide-links --save

Props

Argument	Type	Required	Default	Example
links	Array of Link objects	Yes	N/A	[{href:'https://www.bbc.com', text: 'The BBC'}]
copyrightText	Node	Yes	N/A	<span>@ BBC News</span>
externalLink	Link object	Yes	N/A	{href:'https://www.bbc.com', text: 'The BBC'}
service	String	Yes	N/A	'news'
trustProjectLink	Link object	No	null	{href:'https://www.bbc.co.uk/news', text: 'Why you can trust the bbc'}

Usage

import SitewideLinks from '@bbc/psammead-sitewide-links';

const props = {
  links: [
    { href: 'https://www.bbc.co.uk/news', text: 'BBC News' },
    { href: 'https://www.bbc.co.uk/sport', text: 'BBC Sport' },
  ],
  copyrightText: <span>@ BBC News</span>,
  externalLink: { href: 'https://www.bbc.com', text: 'The BBC' },
  service: 'news',
};

const WrappingComponent = () => <SitewideLinks {...props} />;

The typical use-case of this component is at the bottom of BBC pages in a footer element. When this is done it is recommend that the component is wrapped in a contentinfo landmark which denotes content around copyright, privacy and related content.

Example -

<footer role="contentinfo">
  <SitewideLinks service="news" />
</footer>

When to use this component

It is currently used at the bottom of new BBC News and BBC News Persian article pages, however it has no markup requiring this to be its only application. It can be used anywhere on any page.

Contributing

Psammead is completely open source. We are grateful for any contributions, whether they be new components, bug fixes or general improvements. Please see our primary contributing guide which can be found at the root of the Psammead respository.

Code of Conduct

We welcome feedback and help on this work. By participating in this project, you agree to abide by the code of conduct. Please take a moment to read it.

License

Psammead is Apache 2.0 licensed.