Skip to content

CPP-1103 Change x-teaser's props to match content-pipeline's Content #733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ivomurrell wants to merge 4 commits into
base: main
Choose a base branch
from
Open

CPP-1103 Change x-teaser's props to match content-pipeline's Content #733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
262a323
feat!: rename image prop to mainImage
ivomurrell Jul 20, 2023
66b3fca
feat!: move some teaser-specific parameters into metadata object
ivomurrell Jul 21, 2023
10b3a8d
refactor: add explicit types for teaser's relativeUrl field
ivomurrell Jul 21, 2023
71adb9c
refactor: simplify some teaser code with optional chaining
ivomurrell Jul 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,262 changes: 658 additions & 604 deletions components/x-teaser-list/storybook/content-items.json
View file
Open in desktop

Large diffs are not rendered by default.

1,316 changes: 685 additions & 631 deletions components/x-teaser-timeline/storybook/content-items.json
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 15 additions & 13 deletions components/x-teaser/Props.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,19 +44,21 @@ export interface General {
/** Preferred to url if available */
relativeUrl?: string
type: ContentType
indicators: Indicators
}

export interface Meta {
/** Usually a brand, or a genre, or content type */
metaPrefixText?: string
metaSuffixText?: string
metaLink?: MetaLink
/** Fallback used if the parentId is the same as the display concept */
metaAltLink?: MetaLink
/** Promoted content type */
promotedPrefixText?: string
promotedSuffixText?: string
teaserMetadata: {
/** Usually a brand, or a genre, or content type */
metaPrefixText?: string
metaSuffixText?: string
metaLink?: MetaLink
/** Fallback used if the parentId is the same as the display concept */
metaAltLink?: MetaLink
/** Promoted content type */
promotedPrefixText?: string
promotedSuffixText?: string
indicators: Indicators
}
}

export interface Title {
Expand All @@ -82,7 +84,7 @@ export interface Status {

export interface Image {
/** Images must be accessible to the Origami Image Service */
image?: Media
mainImage?: Media
imageSize?: ImageSize
imageLazyLoad?: Boolean | String
}
Expand Down Expand Up @@ -125,7 +127,7 @@ export interface Variants {
export interface MetaLink {
url: string
/** Preferred if available */
relativeUrl?
relativeUrl?: string
prefLabel: string
}

Expand All @@ -134,7 +136,7 @@ export interface Link {
type: ContentType
url: string
/** Preferred to url if available */
relativeUrl?
relativeUrl?: string
title: string
}

Expand Down
28 changes: 15 additions & 13 deletions components/x-teaser/__fixtures__/article-with-data-image.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,25 @@
"altStandfirst": "Groping and sexual harassment at black-tie dinner charity event",
"publishedDate": "2018-01-23T15:07:00.000Z",
"firstPublishedDate": "2018-01-23T13:53:00.000Z",
"metaPrefixText": "",
"metaSuffixText": "",
"metaLink": {
"url": "#",
"prefLabel": "Sexual misconduct allegations"
"teaserMetadata": {
"metaPrefixText": "",
"metaSuffixText": "",
"metaLink": {
"url": "#",
"prefLabel": "Sexual misconduct allegations"
},
"metaAltLink": {
"url": "#",
"prefLabel": "FT Investigations"
},
"indicators": {
"isEditorsChoice": true
}
},
"metaAltLink": {
"url": "#",
"prefLabel": "FT Investigations"
},
"image": {
"mainImage": {
"url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"width": 2048,
"height": 1152,
"imageLazyLoad": "js-image-lazy-load"
},
"indicators": {
"isEditorsChoice": true
}
}
30 changes: 16 additions & 14 deletions components/x-teaser/__fixtures__/article-with-missing-image-url.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,28 @@
"altStandfirst": "Groping and sexual harassment at black-tie dinner charity event",
"publishedDate": "2018-01-23T15:07:00.000Z",
"firstPublishedDate": "2018-01-23T13:53:00.000Z",
"metaPrefixText": "",
"metaSuffixText": "",
"metaLink": {
"url": "#",
"prefLabel": "Sexual misconduct allegations"
"teaserMetadata": {
"metaPrefixText": "",
"metaSuffixText": "",
"metaLink": {
"url": "#",
"prefLabel": "Sexual misconduct allegations"
},
"metaAltLink": {
"url": "#",
"prefLabel": "FT Investigations"
},
"indicators": {
"accessLevel": "free",
"isEditorsChoice": true
}
},
"metaAltLink": {
"url": "#",
"prefLabel": "FT Investigations"
},
"image": {
"mainImage": {
"width": 2048,
"height": 1152
},
"indicators": {
"isEditorsChoice": true
},
"status": "",
"headshotTint": "",
"accessLevel": "free",
"theme": "",
"parentTheme": "",
"modifiers": ""
Expand Down
30 changes: 16 additions & 14 deletions components/x-teaser/__fixtures__/article.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,29 @@
"altStandfirst": "Groping and sexual harassment at black-tie dinner charity event",
"publishedDate": "2018-01-23T15:07:00.000Z",
"firstPublishedDate": "2018-01-23T13:53:00.000Z",
"metaPrefixText": "",
"metaSuffixText": "",
"metaLink": {
"url": "#",
"prefLabel": "Sexual misconduct allegations"
"teaserMetadata": {
"metaPrefixText": "",
"metaSuffixText": "",
"metaLink": {
"url": "#",
"prefLabel": "Sexual misconduct allegations"
},
"metaAltLink": {
"url": "#",
"prefLabel": "FT Investigations"
},
"indicators": {
"accessLevel": "free",
"isEditorsChoice": true
}
},
"metaAltLink": {
"url": "#",
"prefLabel": "FT Investigations"
},
"image": {
"mainImage": {
"url": "http://prod-upp-image-read.ft.com/a25832ea-0053-11e8-9650-9c0ad2d7c5b5",
"width": 2048,
"height": 1152
},
"indicators": {
"isEditorsChoice": true
},
"status": "",
"headshotTint": "",
"accessLevel": "free",
"theme": "",
"parentTheme": "",
"modifiers": ""
Expand Down
26 changes: 15 additions & 11 deletions components/x-teaser/__fixtures__/content-package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,28 @@
"altStandfirst": "",
"publishedDate": "2018-05-14T16:38:49.000Z",
"firstPublishedDate": "2018-05-14T16:38:49.000Z",
"metaPrefixText": "",
"metaSuffixText": "",
"metaLink": {
"url": "#",
"prefLabel": "FT Magazine"
"teaserMetadata": {
"metaPrefixText": "",
"metaSuffixText": "",
"metaLink": {
"url": "#",
"prefLabel": "FT Magazine"
},
"metaAltLink": {
"url": "#",
"prefLabel": "FT Series"
},
"indicators": {
"accessLevel": "free"
}
},
"metaAltLink": {
"url": "#",
"prefLabel": "FT Series"
},
"image": {
"mainImage": {
"url": "http://prod-upp-image-read.ft.com/7e97f5b6-578d-11e8-b8b2-d6ceb45fa9d0",
"width": 2048,
"height": 1152
},
"status": "",
"headshotTint": "",
"accessLevel": "free",
"theme": "",
"parentTheme": "",
"modifiers": "centre"
Expand Down
32 changes: 17 additions & 15 deletions components/x-teaser/__fixtures__/opinion.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,32 @@
"altStandfirst": "Anti-Semitism and identity politics",
"publishedDate": "2018-04-02T12:22:01.000Z",
"firstPublishedDate": "2018-04-02T12:22:01.000Z",
"metaPrefixText": "",
"metaSuffixText": "",
"metaLink": {
"url": "#",
"prefLabel": "Gideon Rachman"
"teaserMetadata": {
"metaPrefixText": "",
"metaSuffixText": "",
"metaLink": {
"url": "#",
"prefLabel": "Gideon Rachman"
},
"metaAltLink": {
"url": "#",
"prefLabel": "Anti-Semitism"
},
"indicators": {
"accessLevel": "free",
"isOpinion": true,
"isColumn": true
}
},
"metaAltLink": {
"url": "#",
"prefLabel": "Anti-Semitism"
},
"image": {
"mainImage": {
"url": "http://prod-upp-image-read.ft.com/1005ca96-364b-11e8-8b98-2f31af407cc8",
"width": 2048,
"height": 1152
},
"headshot": "fthead-v1:gideon-rachman",
"indicators": {
"isOpinion": true,
"isColumn": true
},
"showHeadshot": true,
"status": "",
"headshotTint": "",
"accessLevel": "free",
"theme": "",
"parentTheme": "",
"modifiers": ""
Expand Down
22 changes: 12 additions & 10 deletions components/x-teaser/__fixtures__/package-item.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,25 @@
"standfirst": "Martin Wolf on the power of vested interests in today’s rent-extracting economy",
"publishedDate": "2018-09-02T15:07:00.000Z",
"firstPublishedDate": "2018-09-02T13:53:00.000Z",
"metaPrefixText": "FT Series",
"metaSuffixText": "",
"metaLink": {
"url": "#",
"prefLabel": "Financial crisis: Are we safer now? "
"teaserMetadata": {
"metaPrefixText": "FT Series",
"metaSuffixText": "",
"metaLink": {
"url": "#",
"prefLabel": "Financial crisis: Are we safer now? "
},
"indicators": {
"accessLevel": "free",
"isOpinion": true
}
},
"image": {
"mainImage": {
"url": "http://prod-upp-image-read.ft.com/a25832ea-0053-11e8-9650-9c0ad2d7c5b5",
"width": 2048,
"height": 1152
},
"indicators": {
"isOpinion": true
},
"status": "",
"headshotTint": "",
"accessLevel": "free",
"theme": "",
"parentTheme": "extra-article",
"modifiers": "centre"
Expand Down
22 changes: 12 additions & 10 deletions components/x-teaser/__fixtures__/podcast.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,25 @@
"altStandfirst": "",
"publishedDate": "2018-10-24T04:00:00.000Z",
"firstPublishedDate": "2018-10-24T04:00:00.000Z",
"metaSuffixText": "12 mins",
"metaLink": {
"url": "#",
"prefLabel": "Tech Tonic podcast"
"teaserMetadata": {
"metaSuffixText": "12 mins",
"metaLink": {
"url": "#",
"prefLabel": "Tech Tonic podcast"
},
"metaAltLink": "",
"indicators": {
"accessLevel": "free",
"isPodcast": true
}
},
"metaAltLink": "",
"image": {
"mainImage": {
"url": "https://www.ft.com/__origami/service/image/v2/images/raw/http%3A%2F%2Fprod-upp-image-read.ft.com%2F5d1a54aa-f49b-11e8-ae55-df4bf40f9d0d?source=next&fit=scale-down&compression=best&width=240",
"width": 2048,
"height": 1152
},
"indicators": {
"isPodcast": true
},
"status": "",
"headshotTint": "",
"accessLevel": "free",
"theme": "",
"parentTheme": "",
"modifiers": ""
Expand Down
12 changes: 8 additions & 4 deletions components/x-teaser/__fixtures__/promoted.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,20 @@
"url": "#",
"title": "Why eSports companies are on a winning streak",
"standfirst": "ESports is big business and about to get bigger: global revenues could hit $1.5bn by 2020",
"promotedPrefixText": "Paid post",
"promotedSuffixText": "UBS",
"image": {
"teaserMetadata": {
"promotedPrefixText": "Paid post",
"promotedSuffixText": "UBS",
"indicators": {
"accessLevel": "free"
}
},
"mainImage": {
"url": "https://tpc.googlesyndication.com/pagead/imgad?id=CICAgKCrm_3yahABGAEyCMx3RoLss603",
"width": 700,
"height": 394
},
"status": "",
"headshotTint": "",
"accessLevel": "free",
"theme": "",
"parentTheme": "",
"modifiers": ""
Expand Down
Loading