⛔️ This is an alpha component ⛔️
This component is currently tagged as alpha and is not suitable for production use. Following the passing of an accessibility review this component will be marked as ready for production and the alpha tag removed.
psammead-leading-story-promo - 
Description
The LeadingStoryPromo component is designed to be used on 'index' pages, which are pages that contain a list or collection of stories. Examples of index pages include front pages, feature index pages, topic pages. The LeadingStoryPromo component displays both an image and info, where info can be a collection of any nodes.
Installation
npm install @bbc/psammead-leading-story-promo
Props
| Argument | Type | Required | Default | Example |
|---|---|---|---|---|
| image | node | Yes | N/A | <img /> |
| info | node | Yes | N/A | <h2>Title</h2> |
Usage
The typical usage of this component is as described below. For LTR services an image sits on the right side of the promo with info elements on the left, while for RTL services an image sits on the left side of the promo with info elements on the right.
import LeadingStoryPromo from '@bbc/psammead-leading-story-promo';
const WrappingComponent = () => (
<div>
<LeadingStoryPromo image={image} info={info} />
</div>
);When to use this component
The LeadingStoryPromo component is designed to be used within a link element to allow the user to navigate to the featured story on another page.
When not to use this component
Accessibility notes
This component is still in its initial alpha stages, and requires a full and extensive accessibility review.
Roadmap
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 repository.
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.