@times-components/article-summary

Article Summary

An article summary contains optional information about an article such as headline, summary, publication date, author and label. Some of these components are passed in as render props, and others are passed in as a config object, either containing props to be passed on to the appropriate component, or an Abstract Syntax Tree ("AST") which a component can handle by itself.

Components with a config object of props

These components make up the core of an article summary and so, although not required, are made up of specific components.

• date publication - article summary wraps the DatePublication component and simply passes on the date props it receives
• label - article summary passes label props onto either ArticleLabel or VideoLabel

Components with a render prop

Components that can be specified by the consumer can be passed in as render props.

• headline - ArticleSummaryHeadline lays out an accessible article headline
• content - ArticleSummaryContent handles an AST, but is passed into the summary as a render prop

Components with an AST

• byline - passes the given AST to ArticleByline or ArticleBylineWithLinks

Contributing

Please read CONTRIBUTING.md before contributing to this package

Running the code

Please see our main README.md to get the project running locally

Development

The code can be formatted and linted in accordance with the agreed standards.

yarn fmt
yarn lint

Testing

This package uses yarn (latest) to run unit tests on each platform with jest.

yarn test:web

Visit the official storybook to see our available article summary templates.

Future

We intend to roll out type checking (TypeScript) throughout the Times Components repo. The components that are allowed within article summary props will be controlled with TypeScript.