Skip to content

doc(CardCollapse): 修改cardCollapse&imageViewer api文档 #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 16, 2023
Merged

doc(CardCollapse): 修改cardCollapse&imageViewer api文档 #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59d3740
doc(CardCollapse): 修改cardCollapse api文档
Feb 16, 2023
8f47497
doc(ImageViewer): 修改imageViewer api文档
Feb 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 11 additions & 41 deletions packages/core/src/CardCollapse/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,44 +56,14 @@ export default Demo

### Props

```ts
type CardCollapseProps = ViewProps & {
/**
* 是否折叠
*/
isCollapsed: boolean;
/**
* 渲染的内容
*/
children: JSX.Element | JSX.Element[]
/**
* 外层样式
*/
containerStyle?: StyleProp<ViewStyle>;
/**
* 内容样式
*/
contentContainerStyle?: StyleProp<ViewStyle>;
/**
* 卡片圆角
*/
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<ViewStyle>` | - |
| `contentContainerStyle` | 内容样式 | `StyleProp<ViewStyle>` | - |
| `itemBorderRadius` | 卡片圆角 | `number` | - |
| `onItemPress` | 点击卡片回调 | (`index: number) => void` | - |
| `onCollapseWillChange` | 卡片折叠回调（值是未来折叠状态） | `(changed: boolean) => void` | - |
| `onCollapseChanged` | 卡片折叠回调（值是目前状态） | `(changed: boolean) => void` | - |
| `disablePresses` | 卡片是否可以点击 | `boolean` | - |
20 changes: 8 additions & 12 deletions packages/core/src/ImageViewer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` | - |