-
Notifications
You must be signed in to change notification settings - Fork 229
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10898 from bbc/WSTEAMA-376-adding-component-healt…
…hcheck-to-most-read WSTEAMA-376 - Adding component healthcheck to Most Read component
- Loading branch information
Showing
3 changed files
with
48 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,25 @@ | ||
# MostRead | ||
|
||
## Description | ||
|
||
This component renders a collection of most read articles to a news page so that relevant and trusted onward journeys are provided for the audience. It is featured on Homepages, Topic, Article, and Story pages and comprises a number rank, a title, and a link to the article. These elements sit within a region landmark. The component limits the number of Most Read items to be displayed based on the [`mostRead -> numberOfItems`](https://github.com/bbc/simorgh/blob/561414ae7c1e6636372381a8e0deddf48f926c1c/src/app/lib/config/services/mundo.ts#L256-L257) value for each service. | ||
|
||
The component uses a [MostReadData](https://github.com/bbc/simorgh/blob/c4d38ae16587f29306d1109ea19bd55205c5709b/src/app/components/MostRead/types.ts#L79-L90) type, which contains an items array with the following fields: id, rank, title, href, and timestamp. | ||
|
||
It also uses a [ColumnLayout](https://github.com/bbc/simorgh/blob/c4d38ae16587f29306d1109ea19bd55205c5709b/src/app/components/MostRead/types.ts#L7) type that determines how many columns the component is spread across: `oneColumn`, `twoColumn` or `multiColumn`. `multiColumn` will spread the data across 5 columns. | ||
|
||
A [Size](https://github.com/bbc/simorgh/blob/c4d38ae16587f29306d1109ea19bd55205c5709b/src/app/components/MostRead/types.ts#L5) type is also used, which determines the sizing of the fonts used. This has values of `default` and `small`. | ||
|
||
## Props | ||
|
||
| Name | type | Description | | ||
| ---- | ---- | ----------- | | ||
| | | | | ||
| Name | type | Description | | ||
| ------------ | ------------ | -------------------------------------------------------------------------------------- | | ||
| data | MostReadData | Contains the data rendered to the browser. i.e rank, title, and appropriate href link | | ||
| columnLayout | ColumnLayout | Determines how many columns the component is spread across. Defaults to `multiColumn`. | | ||
| size | Size | Determines the font size used by the component. Defaults to `default`. | | ||
|
||
## How to use | ||
|
||
```tsx | ||
{ | ||
<MostRead />; | ||
<MostRead data={mostRead} columnLayout="twoColumn" size="small" />; | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
{ | ||
"lastUpdated": { | ||
"day": 15, | ||
"month": "June", | ||
"year": 2023 | ||
}, | ||
"uxAccessibilityDoc": { | ||
"done": false, | ||
"reference": { | ||
"url": "", | ||
"label": "Screen Reader UX" | ||
} | ||
}, | ||
"acceptanceCriteria": { | ||
"done": true, | ||
"reference": { | ||
"url": "https://paper.dropbox.com/doc/Most-Read-Accessibility-Acceptance-Criteria--B6T7sKDpGdzV~Pblb_UYYf6dAg-31z8j3gmy1rIdbCByQHfY", | ||
"label": "Accessibility Acceptance Criteria" | ||
} | ||
}, | ||
"swarm": { | ||
"done": false, | ||
"reference": { | ||
"url": "", | ||
"label": "A11y swarm notes" | ||
} | ||
} | ||
} |