Skip to content

Commit 3edeb93

Browse files
committed
(QuickList&Card):Update README Props
1 parent 418ebb6 commit 3edeb93

File tree

3 files changed

+48
-30
lines changed

3 files changed

+48
-30
lines changed

packages/core/src/Card/README.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,30 @@ class Demo extends Component {
3131
```
3232
<!--End-->
3333

34-
35-
## Props
36-
37-
| 参数 | 说明 | 类型 | 默认值 |
38-
|------|------|-----|------|
39-
| `containerStyle` | 外容器样式(可选) | object (style) | none |
40-
| `wrapperStyle` | 内容器样式(可选) | object (style) | none |
41-
| `title` | 标题(可选) | String | none |
42-
| `titleStyle` | 标题样式(可选) | object (style) | none |
43-
| `showDriver` | 是否展示下划线(可选) | Boolean | false |
44-
| `borderRadius` | 设置卡片圆角度数(可选) | Number | none |
45-
| `selected` | 是否选中(可选) | Boolean | none |
46-
| `onPress` | 按下卡片时的动作(可选) | TouchableOpacityProps['onPress']| none |
47-
| `onLongPress` | 长按下卡片时的动作(可选) | TouchableOpacityProps['onLongPress']| none |
34+
### Props
35+
36+
```ts
37+
export interface CardProps {
38+
/** 外容器样式(可选) */
39+
containerStyle?: StyleProp<ViewStyle>;
40+
/** 内容器样式(可选) */
41+
wrapperStyle?: StyleProp<ViewStyle>;
42+
/** 标题(可选) */
43+
title?: string
44+
/** 标题样式(可选) */
45+
titleStyle?: StyleProp<TextStyle>;
46+
/** 是否展示下划线(可选) */
47+
showDriver?: boolean;
48+
/** 设置卡片圆角度数(可选) */
49+
borderRadius?: number;
50+
/** 是否选中(可选) */
51+
selected?: boolean;
52+
/** 渲染内容 */
53+
children?: React.ReactNode;
54+
/** 按下卡片时的动作(可选) */
55+
onPress?: TouchableOpacityProps['onPress'];
56+
/** 长按下卡片时的动作(可选) */
57+
onLongPress?: TouchableOpacityProps['onLongPress'];
58+
}
59+
```
4860

packages/core/src/QuickList/README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -92,16 +92,22 @@ export default QuickListDemo
9292
```
9393
<!--End-->
9494

95-
## Props
95+
### Props
9696

97-
继承原生 FastList 属性 [`FastListProps`](https://reactnative.dev/docs/flatlist)
97+
```ts
98+
interface QuickListProps<ItemT> extends FlatListProps<ItemT> {
99+
onFetch: (params: any) => void // 请求的接口函数
100+
data: Array<any>, // 数据源
101+
renderItem: ListRenderItem<any>, // 从data列表中获取一个项目并将其渲染到列表中
102+
keyId: string | number,// 唯一健
103+
emptyView?: void | any,// 当列表为空时呈现
104+
pageSize?: number, // 每次加载数据条数
105+
total: number, // 总条数
106+
style?: Object,// 样式
107+
}
98108

99-
| 参数 | 说明 | 类型 | 默认值 |
100-
|------|------|-----|------|
101-
| `onFetch` | 请求的接口 | Promise | - |
102-
| `data` | 数据源 | Array | - |
103-
| `pageSize` | 每次加载数据条数 | number | 10 |
104-
| `total` | 总条数 | number | - |
105-
| `renderItem` | 从data列表中获取一个项目并将其渲染到列表中 | ({item})=>void | - |
106-
| `emptyView` | 当列表为空时呈现 | Boolean | ()=>void |
107-
| `keyId` | 取唯一键 | string | - |
109+
export type QuickListComponent<ItemT = any> = (
110+
props: QuickListProps<ItemT>,
111+
ref?: Ref<FlatList<ItemT>> | any
112+
) => React.ReactElement
113+
```

packages/core/src/QuickList/index.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { emptyDataView, activityIndicatorView, noMoreDataView } from './View'
44

55

66

7-
interface SankFlatListProps<ItemT> extends FlatListProps<ItemT> {
7+
interface QuickListProps<ItemT> extends FlatListProps<ItemT> {
88
onFetch: (params: any) => void // 请求的接口 Promise 类型
99
data: Array<any>, // 数据源 Array 类型
1010
renderItem: ListRenderItem<any>, // 渲染方法 Function 类型
@@ -15,12 +15,12 @@ interface SankFlatListProps<ItemT> extends FlatListProps<ItemT> {
1515
style?: Object,
1616
}
1717

18-
export type SankFlatListComponent<ItemT = any> = (
19-
props: SankFlatListProps<ItemT>,
18+
export type QuickListComponent<ItemT = any> = (
19+
props: QuickListProps<ItemT>,
2020
ref?: Ref<FlatList<ItemT>> | any
2121
) => React.ReactElement
2222

23-
const SankFlatList: SankFlatListComponent = (props, ref) => {
23+
const QuickList: QuickListComponent = (props, ref) => {
2424
const {
2525
onFetch, // 请求的接口 Promise 类型
2626
data, // 数据源 Array 类型
@@ -181,4 +181,4 @@ const SankFlatList: SankFlatListComponent = (props, ref) => {
181181
/>
182182
)
183183
};
184-
export default forwardRef(SankFlatList)
184+
export default forwardRef(QuickList)

0 commit comments

Comments
 (0)