Skip to content

Commit

Permalink
docs(image): added to the usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lucy authored Dec 14, 2017
1 parent e2213a1 commit 91a5b92
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/components/Image/Image.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
* You can use the `contentful API` to request an image of a certain size.
* `rounded="circle"` requires a square image `(width == height)` in order to generate a perfect circle.
* Non-square images will give a warning and will appear oval shaped.
* When using the image symbol in the Sketch file, replace the image in the overrides with and image with the same aspect ratio.

```jsx
<Image src="image-example.jpg" rounded="corners" width={300} height={300} alt="Image of co-workers collaborating" />
Expand Down

0 comments on commit 91a5b92

Please sign in to comment.