Skip to content
This repository was archived by the owner on Jun 2, 2024. It is now read-only.

Commit e42f7bf

Browse files
committed
docs: add example for Resolve component
1 parent f79e386 commit e42f7bf

File tree

6 files changed

+61
-8
lines changed

6 files changed

+61
-8
lines changed

package-lock.json

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
"coveralls": "^3.0.2",
4545
"enzyme-adapter-react-16": "^1.1.1",
4646
"enzyme": "^3.3.0",
47+
"faker": "^4.1.0",
4748
"husky": "^1.0.0-rc.13",
4849
"jest": "^23.4.1",
4950
"lint-staged": "^7.2.0",

src/components/List/List.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
```jsx
2-
<List
3-
items={[1, 2, 3]}
4-
render={n => (
5-
<div key={n}>{`Render me! ${n}`}</div>
6-
)}
7-
/>
8-
```
2+
const data = [1,2,3,4,5,6,7,8,9].map(() => faker.name.findName());
3+
4+
<ul>
5+
<List
6+
items={data}
7+
render={n => (
8+
<li key={n}>
9+
<div>{n}</div>
10+
</li>
11+
)}
12+
/>
13+
</ul>
14+
```

src/components/Resolve/Resolve.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
```jsx
2+
const data = [1,2,3].map(() => faker.fake("{{lorem.sentence}}"));
3+
4+
class Example extends React.Component {
5+
render() {
6+
return (
7+
<>
8+
<List
9+
items={data}
10+
render={(v,i) => (
11+
<Resolve
12+
promise={this._getData(v)}
13+
pending={<div key={i}>Fetching data...</div>}
14+
resolved={value => (
15+
<div key={i}>{v}</div>
16+
)}
17+
/>
18+
)}
19+
/>
20+
<button style={{marginTop: '16px'}} onClick={() => this.forceUpdate()}>Reload</button>
21+
</>
22+
)
23+
}
24+
25+
_getData(data) {
26+
return new Promise(resolve => {
27+
setTimeout(() => {
28+
resolve(data);
29+
}, Math.floor(Math.random() * Math.floor(3000)))
30+
})
31+
}
32+
}
33+
34+
<Example />
35+
```

src/components/Show/Show.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11

22
```jsx
3+
const data = faker.fake("{{lorem.words}}");
4+
35
<Show when={true}>
4-
<div>Render me!</div>
6+
<div>{data}</div>
57
</Show>
68
```

styleguide.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ module.exports = {
2424
skipComponentsWithoutExample: true,
2525
components: getComponents('src/components/**/*.tsx'),
2626
styleguideDir: 'docs',
27+
context: {
28+
faker: "faker"
29+
},
2730
template: {
2831
head: {
2932
links: [

0 commit comments

Comments
 (0)