Skip to content

Commit cfd867f

Browse files
committed
format readme
1 parent 50b5850 commit cfd867f

1 file changed

Lines changed: 21 additions & 30 deletions

File tree

README.md

Lines changed: 21 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# react-codepen-embed
2+
23
React component for embedding pens from [`Codepen.io`](https://codepen.io)
34

45
## Installation
@@ -14,36 +15,31 @@ yarn add react-codepen-embed
1415
## Usage
1516

1617
```javascript
17-
import React from 'react';
18-
import Codepen from 'react-codepen-embed';
18+
import React from "react";
19+
import Codepen from "react-codepen-embed";
1920

2021
const CodepenEmbedded = () => {
21-
return (
22-
<Codepen
23-
hash="JyxeVP"
24-
user="shettypuneeth"
25-
/>
26-
);
27-
}
22+
return <Codepen hash="JyxeVP" user="shettypuneeth" />;
23+
};
2824
```
2925

3026
## Component Props
3127

32-
Property | Type | Required | Default | Description |
33-
-----------|----------|----------|-------------|---------------------------------------------------------------|
34-
hash | `string` | `true` | | Id of the pen to embed |
35-
user | `string` | `true` | | Codepen username |
36-
height | `number` | `false` | `300` | Height of the pen |
37-
loader | `element`| `false` | | Loader to render while the pen is being embedded or errors out|
38-
defaultTab | `string` | `false` | `css,result`| Default tab to display |
39-
themeId | `string` | `false` | `dark` | Theme for the pen |
40-
preview | `boolean`| `false` | `true` | Make the preview "Click-to-Load" |
41-
title | `string` | `false` | | Title of the pen |
42-
28+
| Property | Type | Required | Default | Description |
29+
| ---------- | --------- | -------- | ------------ | -------------------------------------------------------------- |
30+
| hash | `string` | `true` | | Id of the pen to embed |
31+
| user | `string` | `true` | | Codepen username |
32+
| height | `number` | `false` | `300` | Height of the pen |
33+
| loader | `element` | `false` | | Loader to render while the pen is being embedded or errors out |
34+
| defaultTab | `string` | `false` | `css,result` | Default tab to display |
35+
| themeId | `string` | `false` | `dark` | Theme for the pen |
36+
| preview | `boolean` | `false` | `true` | Make the preview "Click-to-Load" |
37+
| title | `string` | `false` | | Title of the pen |
4338

4439
## API
4540

4641
#### `Props.loader`
42+
4743
Compenent to render when the pen is being embedded or when it errors.
4844

4945
```js
@@ -57,15 +53,10 @@ Compenent to render when the pen is being embedded or when it errors.
5753
If the embed fails then the loader component will receive an error prop
5854

5955
```js
60-
const Loading = (props) => {
56+
const Loading = props => {
6157
if (props.error) {
62-
return (
63-
<div>Error</div>
64-
);
65-
} else {
66-
return (
67-
<div>Loading...</div>
68-
);
58+
return <div>Error</div>;
6959
}
70-
}
71-
```
60+
return <div>Loading...</div>;
61+
};
62+
```

0 commit comments

Comments
 (0)