Amp Img #1101
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
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,23 @@ | ||
| # Image component | ||
|
|
||
| ## Usage | ||
|
|
||
| Importing the standard Image component, which renders an `<img />` tag. | ||
|
|
||
| ```jsx | ||
| import Image from '../components/Image'; | ||
|
|
||
| const WrappingContainer = ({ alt, height, src, width }) => ( | ||
| <Img alt={alt} height={height} src={src} width={width} /> | ||
| ); | ||
| ``` | ||
|
|
||
| Importing an Amp Image component, which renders an `<amp-img />` tag. | ||
|
|
||
| ```jsx | ||
| import { AmpImg } from '../components/Image'; | ||
|
|
||
| const WrappingContainer = ({ alt, height, src, width }) => ( | ||
| <AmpImg alt={alt} height={height} src={src} width={width} /> | ||
| ); | ||
| ``` | ||
|
There was a problem hiding this comment. Needs the rest of the README structure (guess I could have raised an issue for that!), e.g. https://github.com/BBC-News/psammead/tree/latest/packages/components/psammead-paragraph There was a problem hiding this comment. The CoC and other links will need to change when we move it to Psammead. I've added a note to the description in this Issue: BBC-archive/psammead#203 |
||
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,77 @@ | ||
| // Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
|
||
| exports[`Image - AmpImg should render image with custom dimensions correctly 1`] = ` | ||
| .c0 { | ||
| display: block; | ||
| width: 100%; | ||
| } | ||
|
|
||
| <amp-img | ||
| alt="By Elisa Decker, from her series \\"Sidewalk\\"" | ||
| className="c0" | ||
| height={547} | ||
| src="https://ichef.bbci.co.uk/news/445/cpsprodpb/164BB/production/_104032319_03270dcc-9dda-4bd4-96a0-db89f6b915ae.jpg" | ||
| width={445} | ||
| /> | ||
| `; | ||
|
|
||
| exports[`Image - AmpImg should render image with srcset correctly 1`] = ` | ||
| .c0 { | ||
| display: block; | ||
| width: 100%; | ||
| } | ||
|
|
||
| <amp-img | ||
| alt="Student sitting an exam" | ||
| className="c0" | ||
| height={576} | ||
| src="https://ichef.bbci.co.uk/news/1024/cpsprodpb/7098/production/_104842882_students.jpg" | ||
| srcSet="https://ichef.bbci.co.uk/news/1024/cpsprodpb/7098/production/_104842882_students.jpg 1024w, https://ichef.bbci.co.uk/news/1024/cpsprodpb/7098/production/_104842882_students.jpg 1024w, https://ichef.bbci.co.uk/news/1024/cpsprodpb/7098/production/_104842882_students.jpg 1024w, https://ichef.bbci.co.uk/news/1024/cpsprodpb/7098/production/_104842882_students.jpg 1024w, https://ichef.bbci.co.uk/news/1024/cpsprodpb/7098/production/_104842882_students.jpg 1024w" | ||
| width={1024} | ||
| /> | ||
| `; | ||
|
|
||
| exports[`Image - AmpImg should render landscape image correctly 1`] = ` | ||
| .c0 { | ||
| display: block; | ||
| width: 100%; | ||
| } | ||
|
|
||
| <amp-img | ||
| alt="Student sitting an exam" | ||
| className="c0" | ||
| height={576} | ||
| src="https://ichef.bbci.co.uk/news/1024/cpsprodpb/7098/production/_104842882_students.jpg" | ||
| width={1024} | ||
| /> | ||
| `; | ||
|
|
||
| exports[`Image - AmpImg should render portrait image correctly 1`] = ` | ||
| .c0 { | ||
| display: block; | ||
| width: 100%; | ||
| } | ||
|
|
||
| <amp-img | ||
| alt="Map of the UK displaying Syrian refugees and asylum seekers per 10000 population. Ranges from 0 to 17." | ||
| className="c0" | ||
| height={1138} | ||
| src="https://ichef.bbci.co.uk/news/640/cpsprodpb/439A/production/_100960371_syrians_and_asylum_v2-nc.png" | ||
| width={640} | ||
| /> | ||
| `; | ||
|
|
||
| exports[`Image - AmpImg should render square image correctly 1`] = ` | ||
| .c0 { | ||
| display: block; | ||
| width: 100%; | ||
| } | ||
|
|
||
| <amp-img | ||
| alt="Tracks through the snow" | ||
| className="c0" | ||
| height={1024} | ||
| src="https://ichef.bbci.co.uk/news/1024/cpsprodpb/114FE/production/_104801907_79010.jpg" | ||
| width={1024} | ||
| /> | ||
| `; |
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,12 @@ | ||
| // Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
|
||
| exports[`StyledImg should render correctly 1`] = ` | ||
| .c0 { | ||
| display: block; | ||
| width: 100%; | ||
| } | ||
|
|
||
| <img | ||
| className="c0" | ||
| /> | ||
| `; |
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,34 @@ | ||
| import React from 'react'; | ||
| import { number, string } from 'prop-types'; | ||
| import StyledImg from './styledImg'; | ||
|
|
||
| const AmpImg = ({ alt, height, src, srcset, width }) => { | ||
| const props = { | ||
| as: 'amp-img', | ||
| layout: 'responsive', | ||
| alt, | ||
| src, | ||
| height, | ||
| width, | ||
| }; | ||
|
|
||
| if (srcset) { | ||
| props.srcSet = srcset; | ||
| } | ||
|
|
||
| return <StyledImg {...props} />; | ||
| }; | ||
|
|
||
| AmpImg.propTypes = { | ||
| alt: string.isRequired, | ||
| src: string.isRequired, | ||
| srcset: string, | ||
| height: number.isRequired, | ||
| width: number.isRequired, | ||
| }; | ||
|
|
||
| AmpImg.defaultProps = { | ||
| srcset: null, | ||
| }; | ||
|
|
||
| export default AmpImg; |
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,4 @@ | ||
| import AmpImg from './index.amp'; | ||
| import stories from './testHelpers/stories'; | ||
|
|
||
| stories(AmpImg, 'Image - AmpImg'); |
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,6 @@ | ||
| import AmpImg from './index.amp'; | ||
| import snapshotTests from './testHelpers/snapshotTests'; | ||
|
|
||
| describe('Image - AmpImg', () => { | ||
sareh marked this conversation as resolved.
Show resolved
Hide resolved
sareh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| snapshotTests(AmpImg); | ||
| }); | ||
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,8 +1,29 @@ | ||
| import React from 'react'; | ||
| import { number, string } from 'prop-types'; | ||
| import StyledImg from './styledImg'; | ||
|
|
||
| export { default as AmpImg } from './index.amp'; | ||
|
|
||
| export const Img = ({ alt, height, src, srcset, width }) => { | ||
| const props = { alt, src, height, width }; | ||
|
|
||
| if (srcset) { | ||
| props.srcSet = srcset; | ||
| } | ||
|
|
||
| return <StyledImg {...props} />; | ||
| }; | ||
|
|
||
| Img.propTypes = { | ||
| alt: string.isRequired, | ||
| src: string.isRequired, | ||
ChrisBAshton marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| srcset: string, | ||
| height: number.isRequired, | ||
| width: number.isRequired, | ||
| }; | ||
|
|
||
| Img.defaultProps = { | ||
| srcset: null, | ||
| }; | ||
|
|
||
| export default Img; | ||
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,12 +1,4 @@ | ||
| import { Img } from '.'; | ||
| import stories from './testHelpers/stories'; | ||
|
|
||
| stories(Img, 'Image - Img'); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(makes it consistent with the other below)