From 59d37406ef2359f6d9e27535bf82e2131e2c647b Mon Sep 17 00:00:00 2001 From: rulishu Date: Thu, 16 Feb 2023 10:54:30 +0800 Subject: [PATCH 1/2] =?UTF-8?q?doc(CardCollapse):=20=E4=BF=AE=E6=94=B9card?= =?UTF-8?q?Collapse=20api=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/core/src/CardCollapse/README.md | 52 +++++------------------- 1 file changed, 11 insertions(+), 41 deletions(-) diff --git a/packages/core/src/CardCollapse/README.md b/packages/core/src/CardCollapse/README.md index 4240af4e6..1e628239d 100644 --- a/packages/core/src/CardCollapse/README.md +++ b/packages/core/src/CardCollapse/README.md @@ -56,44 +56,14 @@ export default Demo ### Props -```ts -type CardCollapseProps = ViewProps & { - /** - * 是否折叠 - */ - isCollapsed: boolean; - /** - * 渲染的内容 - */ - children: JSX.Element | JSX.Element[] - /** - * 外层样式 - */ - containerStyle?: StyleProp; - /** - * 内容样式 - */ - contentContainerStyle?: StyleProp; - /** - * 卡片圆角 - */ - itemBorderRadius?: number; - /** - * 点击卡片回调 - */ - onItemPress?: (index: number) => void; - /** - * 卡片折叠回调(值是未来折叠状态) - */ - onCollapseWillChange?: (changed: boolean) => void; - /** - * 卡片折叠回调(值是目前状态) - */ - onCollapseChanged?: (changed: boolean) => void; - /** - * 卡片是否可以点击 - */ - disablePresses?: boolean; -}; -``` - +| 参数 | 说明 | 类型 | 默认值 | +|------|------|-----|------| +| `isCollapsed` | 是否折叠 | `boolean` | - | +| `children` | 渲染的内容 | `JSX.Element, JSX.Element[]` | - | +| `containerStyle` | 外层样式 | `StyleProp` | - | +| `contentContainerStyle` | 内容样式 | `StyleProp` | - | +| `itemBorderRadius` | 卡片圆角 | `number` | - | +| `onItemPress` | 点击卡片回调 | (`index: number) => void` | - | +| `onCollapseWillChange` | 卡片折叠回调(值是未来折叠状态) | `(changed: boolean) => void` | - | +| `onCollapseChanged` | 卡片折叠回调(值是目前状态) | `(changed: boolean) => void` | - | +| `disablePresses` | 卡片是否可以点击 | `boolean` | - | \ No newline at end of file From 8f47497a7aeb45b9366f33522b972cb8839b7997 Mon Sep 17 00:00:00 2001 From: rulishu Date: Thu, 16 Feb 2023 11:03:48 +0800 Subject: [PATCH 2/2] =?UTF-8?q?doc(ImageViewer):=20=E4=BF=AE=E6=94=B9image?= =?UTF-8?q?Viewer=20api=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/core/src/ImageViewer/README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/packages/core/src/ImageViewer/README.md b/packages/core/src/ImageViewer/README.md index f602ba03c..61e23de5e 100644 --- a/packages/core/src/ImageViewer/README.md +++ b/packages/core/src/ImageViewer/README.md @@ -62,15 +62,11 @@ export default Demo ### props -```ts -export interface ImageViewerProps extends ViewProps { - /** 图片宽度 */ - width?: number, - /** 图片高度 */ - height?: number, - /** 图像源(远程URL或本地文件资源 */ - src?: string | number; - /** 默认展示第几张图片 */ - defaultIndex: number -} -``` +组件继承 [`ViewProps`](https://reactnative.dev/docs/view) + +| 参数 | 说明 | 类型 | 默认值 | +|------|------|-----|------| +| `width` | 图片宽度 | `number` | - | +| `height` | 图片高度 | `number` | - | +| `src` | 图像源(远程URL或本地文件资源) | `'string' \| 'number'` | - | +| `defaultIndex` | 默认展示第几张图片 | `number` | - |