Skip to content
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

Jump to bottom

docs(cdk:resize): api docs is incorrect #1607

Merged
merged 1 commit into from
Jul 20, 2023
Merged

docs(cdk:resize): api docs is incorrect #1607

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions packages/cdk/resize/docs/Api.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@
| `boundary` | 可调整尺寸的边界范围 | `'parent' \| 'window' \| Window \| MaybeElementRef` | `parent` | - | - |
| `disabled` | 是否禁用 | `boolean` | `false` | - | - |
| `free` | 是否自由调整 | `boolean` | - | - | 自动设置 `style` |
| `handles` | 定义拖拽手柄的位置 | `ResizableHandlePlacement[]` | `allHandlePlacements` | - | - |
| `handlers` | 定义拖拽手柄的位置 | `ResizableHandlePlacement[]` | `allHandlePlacements` | - | - |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

正确的单词应该是 handles 才对，后面版本可能需要改回来。

| `is` | 可以调整尺寸的元素或者组件 | `string \| Component` | `'div'` | - | - |
| `maxHeight` | 可调整的最大高度 | `number` | `Number.MAX_SAFE_INTEGER` | - | - |
| `maxWidth` | 可调整的最大宽度 | `number` | `Number.MAX_SAFE_INTEGER` | - | - |
| `minHeight` | 可调整的最小高度 | `number` | `8` | - | - |
| `minWidth` | 可调整的最小宽度 | `number` | `8` | - | - |
| `onDragStart` | 拖拽开始事件 | - | `ResizableEvent` | - | - |
| `onDrag` | 拖拽过程中事件 | - | `ResizableEvent` | - | - |
| `onDragEnd` | 拖拽结束事件 | - | `ResizableEvent` | - | - |
| `onResizeStart` | 拖拽开始事件 | - | `ResizableEvent` | - | - |
| `onResizing` | 拖拽过程中事件 | - | `ResizableEvent` | - | - |
| `onResizeEnd` | 拖拽结束事件 | - | `ResizableEvent` | - | - |

```ts
const allHandlePlacements = ['top', 'bottom', 'start', 'end', 'topStart', 'topEnd', 'bottomStart', 'bottomEnd'] as const
Expand Down
Loading