Skip to content

Commit 5fd55f1

Browse files
ffff
authored andcommitted
docs: 优化Grid文档
1 parent 102a11f commit 5fd55f1

File tree

2 files changed

+55
-16
lines changed

2 files changed

+55
-16
lines changed

packages/core/src/Empty/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Empty 空状态
33

44
空状态时的展示占位图。
55

6-
![](https://user-images.githubusercontent.com/66067296/137707848-8603fc59-3904-437d-9908-53cd621a1a0e.png)<!--rehype:style=zoom: 33%;float: right; margin-left: 15px;-->
6+
![](https://user-images.githubusercontent.com/66067296/137707848-8603fc59-3904-437d-9908-53cd621a1a0e.png)
77

88
### 基础示例
99

packages/core/src/Grid/README.md

Lines changed: 54 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,38 @@ Grid 宫格
33

44
在水平和垂直方向,将布局切分成若干等大的区块,也可以使用 `List` 组件支持列显示的特性,展示宫格,同时支持下来刷新等特性。
55

6-
![](https://user-images.githubusercontent.com/66067296/137709398-3d7476dd-009d-4852-abed-69b3726c3a25.png)<!--rehype:style=zoom: 33%;float: right; margin-left: 15px;-->
76

87
### 基础示例
98

10-
引入本地图标 `require('./1.png')`
119

12-
```jsx
13-
import { Grid } from '@uiw/react-native';
1410

15-
const uri = 'https://xx.images.com/xxx/icon.png';
11+
```jsx mdx:preview
12+
import { Grid, Icon } from '@uiw/react-native';
13+
import React from "react"
14+
15+
1616
const data = Array.from(new Array(10)).map((_val, i) => {
17-
if(i === 0) {
18-
return { icon: require('./1.png'), text: `Name${i}` };
19-
}
20-
return { icon: uri, text: `Name${i}` }
17+
18+
return { icon: <Icon name="heart-on" color="red" />, text: `${i}`}
2119
});
2220

2321
function Demo() {
2422
return (
2523
<Grid data={data} />
2624
);
2725
}
26+
27+
export default Demo
28+
2829
```
2930

30-
### 自定义单元格
31+
### 自定义icon
3132

32-
引入本地图标 `require('./1.png')`
3333

34-
```jsx
34+
```jsx mdx:preview
3535
import { Text, View } from 'react-native';
3636
import { Grid } from '@uiw/react-native';
37+
import React from "react"
3738

3839
const uri = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADYAAAA2CAMAAAC7m5rvAAAAllBMVEUAAAC/v7+qqqrHx8evr6/ExMS5ubmxsbGsrKysrKytra2pqam8vLy9vb2lpaXExMT////s7Oz8/Pz09PTu7u729vb5+fnp6enMzMzLy8vm5ub4+Pjj4+O3t7fx8fHb29vAwMDHx8ePj4/S0tLf39+rq6ulpaWSkpK7u7vY2NjR0dGnp6eenp6ampqysrLPz8+fn5+ioqKXtObzAAAAEHRSTlMA6wT4/e/f0KyZSy/z8mz4uKbH2gAAA6FJREFUSMellody2zAMhuXEGU6TVBgkbGp529np+79cKREUpbrxdfxnn7g+cYACkKku7m5vricPl4v5Yq5arWLJN14+TK5vbu8udLhCsyuHeY6QD0Q0rEHb765mA/DbJIw4j4XGybdIPV5q13lMC9NHnWvKpxhiAVBYPMX4ezffxSQnHmFoahFgkRpEmHCEMeWTdn8zygOnmAVhkxZZ1AImYdyOnvnJrrohrBiymF/3ZgGsYty1XV1kdy6MATKGnJRgoiAVuRRH/inhTe4uu9U1Q8MMmy0nOcdJ5bMwbEs9g9vsJg8yjq2UXxugdJYBtHKTXUeM64bO2c00bGP/dTbBIAIBERyIaFgTASHQyiS7hyC3KaHcQNSm2r2+vbwvBFRt91OjlfssXizZ+q2WjN3yqvXrcfWxmS/362lYGJfYjQm6zBah4InWbtRyy3UlGPaGvDxU6B8EvqVo9NgX2TwUGDosJzb7vQyPBHafxNSZ2zq9hXOdzYoJWM6Hyo5P0h4PkAcMwI5mAxOx/bvgGEOpfqBihoezoeSKLffWAA4xBLIvS8VywYR5RjFaix8PmDBs77+sa8XYDDA2ilVV9xbAiCF0cFUpZniASa6Yn0y5aICO8tMplkvCMGKbV8x7jqhbYSf8fI4YJgwUq46+FjmillIdK8UgYQUrtlvliaspUflqpxgXHbYiIhD/d77w+kG9oGkg1T5eiYhLImkbV2PsbUO96qcnStq8jbCwyFoX+TJPjhK8kpucv+gi66LfmwXF3peJMkQmcct3xcCeGmCxx55qDdBzuF8kA5yYW9bcUy3Wc7x2p+bOuQgYTJdKxctVBG65g4AVMMCoVgwOECjFlOMDKFbTbz+camcRilwxvS84rX79cPQztYrh51HM+DMtZPmGilkYOQUDiuX1iVPA44F7p2DGLghYZwP+8SJDjKdvADqbg+SCOtmyw9p94anDKwCDw7Pq8JJ7LduTga69rtaf0b3uIJyneAySe32AIPdc+r8D1bM6c23oulzvzB9S6BDnf1+HDifkUugYBCrT1OcCVd1QClQpLALQubDoHAGlsBiDMG3J0pMUthdzKhfw5LtLiUE4hnx0AgDNtnEQVZYQ5XyHf8jWasjXBAPBxgQDziQYFqwmGNmMlIrpDH+ZzihHs5A8+co4eeKUPEFKngKHIXnKvn0H++epmoWppoaP079JDL8//lsa+p9Jb0qx77sUexG0WmmhS7HvRyn2TxZ1zUyK+LY0AAAAAElFTkSuQmCC';
3940

@@ -42,25 +43,63 @@ const data = Array.from(new Array(7)).map((_val, i) => ({
4243
text: `Name${i}`,
4344
}));
4445

46+
function Demo() {
47+
return (
48+
<Grid
49+
data={data}
50+
/>
51+
);
52+
}
53+
54+
export default Demo
55+
56+
```
57+
58+
### 自定义单元格
59+
60+
61+
```jsx mdx:preview
62+
import { Text, View } from 'react-native';
63+
import { Grid, Icon } from '@uiw/react-native';
64+
import React from "react"
65+
66+
const data = Array.from(new Array(7)).map((_val, i) => ({
67+
icon: <Icon name="apple" color="red" />,
68+
text: `Name${i}`,
69+
}));
70+
4571
function Demo() {
4672
return (
4773
<Grid
4874
data={data}
4975
renderItem={(data, index, rowNum) => {
50-
console.log('->', index, rowNum)
76+
console.log('->', data, index, rowNum)
5177
return (
52-
<View>
53-
<Text>{data.item}</Text>
78+
<View style={{width: 100}}>
79+
{data.icon}
80+
<Text>{data.text}</Text>
5481
</View>
5582
)
5683
}}
5784
/>
5885
);
5986
}
87+
88+
export default Demo
89+
6090
```
6191

6292
### Props
6393

94+
95+
```ts
96+
interface ItemData {
97+
icon?: React.ReactNode;
98+
text?: React.ReactNode;
99+
}
100+
101+
```
102+
64103
```ts
65104
export interface GridProps extends ViewProps {
66105
/**

0 commit comments

Comments
 (0)