psammead-byline -       

Description

The Byline component is designed to display an author's full name, title, and optional avatar.

Installation

``
npm install @bbc/psammead-byline --save
`

Props

| Argument | Type | Required | Default | Example |
| ----------------- | --------- | -------- | --------- | ------------------------------ |
| service | string | Yes | N/A | 'news' |
| avatar | object | No | null | _See below._ |
| name | string | Yes | N/A | 'John Smith' |
| title | string | Yes | N/A | 'Art editor' |

$3

| Argument | Type | Required | Default | Example |
| ----------------- | --------- | -------- | --------- | -------------------------------- |
| src | string | Yes | N/A | 'http://www.bbc.co.uk/img.jpg' |
| alt | string | No | null | 'A person wearing glasses.' |

Usage

`jsx
import Byline from "@bbc/psammead-byline"

service='news'
avatar={{ src: 'http://www.bbc.co.uk/john-smith.jpg' }}
name="John Smith"
title="Art editor"
/>
`

$3

This component should be used when crediting the author of a piece of content, such as an article.

$3

N/A.

$3

By default the avatar img is rendered with an empty alt` attribute as it is expected to be of the person, which the adjacent name describes.

$3

There are no known future changes to this component.

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.

$3

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.

$3

Psammead is Apache 2.0 licensed.