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.

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

doc: Simplified description of destroyOnClose #6221

Merged
merged 1 commit into from
Jun 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/components/action-sheet/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Triggered by user operation, it provides a set of two or more options related to
| cancelText | The text of the cancel button , if it is null, the cancel button would not be displayed | `ReactNode` | - |
| closeOnAction | Whether to close after clicking the option | `boolean` | `false` |
| closeOnMaskClick | Whether to close after clicking the mask layer | `boolean` | `true` |
| destroyOnClose | Unmount content when not visible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| forceRender | Render content forcely | `boolean` | `false` |
| extra | The extra area at the top of the the action sheet | `ReactNode` | - |
| getContainer | Get the specified mounted `HTML` node, the default is `body`, if `null` returned, it would be rendered to the current node | `HTMLElement \| () => HTMLElement \| null` | `document.body` |
Expand Down
2 changes: 1 addition & 1 deletion src/components/action-sheet/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
| cancelText | 取消按钮文字,如果设置为空则不显示取消按钮 | `ReactNode` | - |
| closeOnAction | 点击选项后是否关闭 | `boolean` | `false` |
| closeOnMaskClick | 点击背景蒙层后是否关闭 | `boolean` | `true` |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| forceRender | 强制渲染内容 | `boolean` | `false` |
| extra | 顶部的额外区域 | `ReactNode` | - |
| getContainer | 指定挂载的 `HTML` 节点,默认为 `body`,如果为 `null` 的话,会渲染到当前节点 | `HTMLElement \| () => HTMLElement \| null` | `document.body` |
Expand Down
2 changes: 1 addition & 1 deletion src/components/capsule-tabs/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Another style for tabs, used in lists or modules in presentational interfaces.

| Name | Description | Type | Default |
| --- | --- | --- | --- |
| destroyOnClose | Unmount content when not visible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| disabled | Whether to disable the tab | `boolean` | `false` |
| forceRender | Whether to render the `DOM` structure when hidden | `boolean` | `false` |
| key | Corresponding to `activeKey` | `string` | - |
Expand Down
2 changes: 1 addition & 1 deletion src/components/capsule-tabs/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

| 属性 | 说明 | 类型 | 默认值 |
| -------------- | --------------------------- | ----------- | ------- |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| disabled | 是否禁用 | `boolean` | `false` |
| forceRender | 被隐藏时是否渲染 `DOM` 结构 | `boolean` | `false` |
| key | 对应 `activeKey` | `string` | - |
Expand Down
2 changes: 1 addition & 1 deletion src/components/cascader/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ type CascaderValueExtend = {
| children | Render function of the selected options | `(items: CascaderOption[], actions: CascaderActions) => ReactNode` | - |
| confirmText | Text of the ok button | `ReactNode` | `'确定'` |
| defaultValue | Default selected options | `CascaderValue[]` | `[]` |
| destroyOnClose | Unmount content when not visible | `boolean` | `true` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `true` |
| forceRender | Render content forcely | `boolean` | `false` |
| onCancel | Triggered when cancelling | `() => void` | - |
| onClose | Triggered when confirming or cancelling | `() => void` | - |
Expand Down
2 changes: 1 addition & 1 deletion src/components/cascader/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ type CascaderValueExtend = {
| children | 所选项的渲染函数 | `(items: CascaderOption[], actions: CascaderActions) => ReactNode` | - |
| confirmText | 确定按钮的文字 | `ReactNode` | `'确定'` |
| defaultValue | 默认选中项 | `CascaderValue[]` | `[]` |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `true` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `true` |
| forceRender | 强制渲染内容 | `boolean` | `false` |
| onCancel | 取消时触发 | `() => void` | - |
| onClose | 确认和取消时都会触发关闭事件 | `() => void` | - |
Expand Down
2 changes: 1 addition & 1 deletion src/components/collapse/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ A content area that can be collapsed/expanded.
| Name | Description | Type | Default |
| --- | --- | --- | --- |
| arrow | Custom arrow | `React.ReactNode \| ((active: boolean) => React.ReactNode)` | - |
| destroyOnClose | Unmount content when not visible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| disabled | Whether disabled or not | `boolean` | `false` |
| forceRender | Whether to render the `DOM` structure when hidden | `boolean` | `false` |
| key | The unique identifier | `string` | - |
Expand Down
2 changes: 1 addition & 1 deletion src/components/collapse/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
| 属性 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| arrow | 自定义箭头 | `ReactNode \| ((active: boolean) => React.ReactNode)` | - |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| disabled | 是否为禁用状态 | `boolean` | `false` |
| forceRender | 被隐藏时是否渲染 `DOM` 结构 | `boolean` | `false` |
| key | 唯一标识符 | `string` | - |
Expand Down
2 changes: 1 addition & 1 deletion src/components/dialog/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ When users need to process transactions, but do not want to jump to pages to int
| closeOnAction | Whether to close after clicking the operation button | `boolean` | `false` |
| closeOnMaskClick | Whether to support clicking the mask to close the dialog box | `boolean` | `false` |
| content | The content of the Dialog | `React.ReactNode` | - |
| destroyOnClose | Unmount content when not visible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| disableBodyScroll | Whether to disable `body` scrolling | `boolean` | `true` |
| forceRender | Whether to render the `DOM` structure when hidden | `boolean` | `false` |
| getContainer | The parent container of the custom dialog | `HTMLElement \| (() => HTMLElement) \| null` | `null` |
Expand Down
2 changes: 1 addition & 1 deletion src/components/dialog/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
| closeOnAction | 点击操作按钮后后是否关闭 | `boolean` | `false` |
| closeOnMaskClick | 是否支持点击遮罩关闭对话框 | `boolean` | `false` |
| content | 对话框内容 | `React.ReactNode` | - |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| disableBodyScroll | 是否禁用 `body` 滚动 | `boolean` | `true` |
| forceRender | 被隐藏时是否渲染 `DOM` 结构 | `boolean` | `false` |
| getContainer | 自定义对话框的父容器 | `HTMLElement \| (() => HTMLElement) \| null` | `null` |
Expand Down
2 changes: 1 addition & 1 deletion src/components/dropdown/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ It is suitable for filtering, sorting and changing the display range or order of
| Name | Description | Type | Default |
| --- | --- | --- | --- |
| arrow | Custom arrow | `React.ReactNode` | - |
| destroyOnClose | Unmount content when not visible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| forceRender | Whether to render the content even if it is not active | `boolean` | `false` |
| highlight | Highlight | `boolean` | `false` |
| key | The unique value | `string` | - |
Expand Down
2 changes: 1 addition & 1 deletion src/components/dropdown/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
| 属性 | 说明 | 类型 | 默认值 |
| -------------- | --------------------------- | ----------------- | ------- |
| arrow | 自定义 arrow | `React.ReactNode` | - |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| forceRender | 被隐藏时是否渲染 `DOM` 结构 | `boolean` | `false` |
| highlight | 高亮 | `boolean` | `false` |
| key | 唯一值 | `string` | - |
Expand Down
2 changes: 1 addition & 1 deletion src/components/jumbo-tabs/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Used in lists or modules in presentational interfaces when options require furth
| Name | Description | Type | Default |
| --- | --- | --- | --- |
| description | The description text | `ReactNode` | - |
| destroyOnClose | Unmount content when not visible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| disabled | Whether to disable the tab | `boolean` | `false` |
| forceRender | Whether to render the `DOM` structure when hidden | `boolean` | `false` |
| key | Corresponding to `activeKey` | `string` | - |
Expand Down
2 changes: 1 addition & 1 deletion src/components/jumbo-tabs/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
| 属性 | 说明 | 类型 | 默认值 |
| -------------- | --------------------------- | ----------- | ------- |
| description | 选项卡描述 | `ReactNode` | - |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| disabled | 是否禁用 | `boolean` | `false` |
| forceRender | 被隐藏时是否渲染 `DOM` 结构 | `boolean` | `false` |
| key | 对应 `activeKey` | `string` | - |
Expand Down
2 changes: 1 addition & 1 deletion src/components/mask/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Often used in the background layer of a modal window to make the visual focus st
| afterClose | Triggered when completely closed | `() => void` | - |
| afterShow | Triggered after fully displayed | `() => void` | - |
| color | Color of the mask | `'black' \| 'white' \| string` | `'black'` |
| destroyOnClose | Uninstall content when invisible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| disableBodyScroll | Whether to disable `body` scrolling | `boolean` | `true` |
| forceRender | Render content forcely | `boolean` | `false` |
| getContainer | To get the specified mounted `HTML` node, if `null` returned, it would be rendered to the current node | `HTMLElement \| () => HTMLElement \| null` | `null` |
Expand Down
2 changes: 1 addition & 1 deletion src/components/mask/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
| afterClose | 完全关闭后触发 | `() => void` | - |
| afterShow | 完全展示后触发 | `() => void` | - |
| color | 背景蒙层的颜色 | `'black' \| 'white' \| string` | `'black'` |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| disableBodyScroll | 是否禁用 `body` 滚动 | `boolean` | `true` |
| forceRender | 强制渲染内容 | `boolean` | `false` |
| getContainer | 指定挂载的 `HTML` 节点,如果为 `null` 的话,会渲染到当前节点 | `HTMLElement \| () => HTMLElement \| null` | `null` |
Expand Down
2 changes: 1 addition & 1 deletion src/components/modal/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ When users need to process transactions, but do not want to jump to pages to int
| closeOnAction | Whether to close after clicking the operation button | `boolean` | `false` |
| closeOnMaskClick | Whether to support clicking the mask to close the modal box | `boolean` | `false` |
| content | The content of the Modal | `React.ReactNode` | - |
| destroyOnClose | Unmount content when not visible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| disableBodyScroll | Mask Whether to disable `body` scrolling | `boolean` | `true` |
| forceRender | Whether to render the `DOM` structure when hidden | `boolean` | `false` |
| getContainer | The parent container of the custom modal | `HTMLElement \| (() => HTMLElement) \| null` | `null` |
Expand Down
2 changes: 1 addition & 1 deletion src/components/modal/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
| closeOnAction | 点击操作按钮后后是否关闭 | `boolean` | `false` |
| closeOnMaskClick | 是否支持点击遮罩关闭弹窗 | `boolean` | `false` |
| content | 弹窗内容 | `React.ReactNode` | - |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| disableBodyScroll | 背景蒙层是否禁用 `body` 滚动 | `boolean` | `true` |
| forceRender | 被隐藏时是否渲染 `DOM` 结构 | `boolean` | `false` |
| getContainer | 自定义弹窗的父容器 | `HTMLElement \| (() => HTMLElement) \| null` | `null` |
Expand Down
2 changes: 1 addition & 1 deletion src/components/number-keyboard/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ If possible, we recommend using the native keyboard provided by the system or cl
| closeOnConfirm | Whether to automatically close when the ok button is clicked | `boolean` | `true` |
| confirmText | The text of the confirm button, if `null` is set, it would be shown | `string \| null` | `null` |
| customKey | Customized button | `string \| [string, string]` | - |
| destroyOnClose | Unmount content when not visible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| forceRender | Render content forcely | `boolean` | `false` |
| getContainer | To get the specified mounted HTML node, the default is `body`, if `null` returned, it would be rendered to the current node | `HTMLElement \| () => HTMLElement \| null` | `() => document.body` |
| onClose | Triggered when it is clicked | `() => void` | - |
Expand Down
2 changes: 1 addition & 1 deletion src/components/number-keyboard/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
| closeOnConfirm | 是否在点击确定按钮时自动关闭 | `boolean` | `true` |
| confirmText | 完成按钮文案,`null` 不展示 | `string \| null` | `null` |
| customKey | 自定义按钮 | `string \| [string, string]` | - |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| forceRender | 强制渲染内容 | `boolean` | `false` |
| getContainer | 指定挂载的 HTML 节点,默认为 `body`,如果为 `null` 的话,会渲染到当前节点 | `HTMLElement \| () => HTMLElement \| null` | `() => document.body` |
| onClose | 点击关闭时触发 | `() => void` | - |
Expand Down
4 changes: 2 additions & 2 deletions src/components/picker/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ type PickerValueExtend = {
| columns | Options to configure each column | `PickerColumn[] \| ((value: PickerValue[]) => PickerColumn[])` | - |
| confirmText | Text of the ok button | `ReactNode` | `'确定'` |
| defaultValue | Default selected options | `PickerValue[]` | `[]` |
| destroyOnClose | Unmount content when not visible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| forceRender | Render content forcely | `boolean` | `false` |
| mouseWheel | Whether to allow interact with mouse wheel | `boolean` | `false` |
| onCancel | Triggered when cancelling | `() => void` | - |
Expand Down Expand Up @@ -154,7 +154,7 @@ type PickerDate = Date & {
| --- | --- | --- | --- | --- |
| children | The rendering function of the selected items | `(value: PickerDate, actions: PickerActions) => ReactNode` | - |
| defaultValue | Default selected value | `PickerDate` | - |
| destroyOnClose | Unmount content when not visible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| filter | Filter available time | `DatePickerFilter` | - |
| forceRender | Render content forcely | `boolean` | `false` |
| max | Max value | `PickerDate` | ten years later |
Expand Down
4 changes: 2 additions & 2 deletions src/components/picker/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ type PickerValueExtend = {
| columns | 配置每一列的选项 | `PickerColumn[] \| ((value: PickerValue[]) => PickerColumn[])` | - |
| confirmText | 确定按钮的文字 | `ReactNode` | `'确定'` |
| defaultValue | 默认选中项 | `PickerValue[]` | `[]` |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| forceRender | 强制渲染内容 | `boolean` | `false` |
| mouseWheel | 是否允许通过鼠标滚轮进行选择 | `boolean` | `false` |
| onCancel | 取消时触发 | `() => void` | - |
Expand Down Expand Up @@ -156,7 +156,7 @@ type PickerDate = Date & {
| --- | --- | --- | --- | --- |
| children | 所选项的渲染函数 | `(value: PickerDate, actions: PickerActions) => ReactNode` | - |
| defaultValue | 选中值 | `PickerDate` | - |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| filter | 过滤可供选择的时间 | `DatePickerFilter` | - |
| forceRender | 强制渲染内容 | `boolean` | `false` |
| max | 最大值 | `PickerDate` | 十年后 |
Expand Down
2 changes: 1 addition & 1 deletion src/components/popup/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ It is suitable for displaying pop-up windows, information prompts, selection inp
| bodyStyle | Content section style | `React.CSSProperties` | - |
| className | Container class name | `string` | - |
| closeOnMaskClick | Whether to close after clicking the mask layer | `boolean` | `false` |
| destroyOnClose | Unmount content when not visible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| forceRender | Render content forcely | `boolean` | `false` |
| getContainer | To get the specified mounted `HTML` node, the default is `body`, if `null` returned, it would be rendered to the current node | `HTMLElement \| () => HTMLElement \| null` | `() => document.body` |
| mask | Whether to display Mask | `boolean` | `true` |
Expand Down
2 changes: 1 addition & 1 deletion src/components/popup/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| bodyStyle | 内容区域样式 | `React.CSSProperties` | - |
| className | 容器类名 | `string` | - |
| closeOnMaskClick | 点击背景蒙层后是否关闭 | `boolean` | `false` |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| forceRender | 强制渲染内容 | `boolean` | `false` |
| getContainer | 指定挂载的 `HTML` 节点,默认为 `body`,如果为 `null` 的话,会渲染到当前节点 | `HTMLElement \| () => HTMLElement \| null` | `() => document.body` |
| mask | 是否展示蒙层 | `boolean` | `true` |
Expand Down
2 changes: 1 addition & 1 deletion src/components/tabs/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The current content needs to be divided into groups of the same hierarchical str

| Name | Description | Type | Default |
| --- | --- | --- | --- |
| destroyOnClose | Unmount content when not visible | `boolean` | `false` |
| destroyOnClose | Destroy `dom` when not visible | `boolean` | `false` |
| disabled | Whether to disable the tab | `boolean` | `false` |
| forceRender | Whether to render the `DOM` structure when hidden | `boolean` | `false` |
| key | Corresponding to `activeKey` | `string` | - |
Expand Down
2 changes: 1 addition & 1 deletion src/components/tabs/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

| 属性 | 说明 | 类型 | 默认值 |
| -------------- | --------------------------- | ----------- | ------- |
| destroyOnClose | 不可见时卸载内容 | `boolean` | `false` |
| destroyOnClose | 不可见时是否销毁 `DOM` 结构 | `boolean` | `false` |
| disabled | 是否禁用 | `boolean` | `false` |
| forceRender | 被隐藏时是否渲染 `DOM` 结构 | `boolean` | `false` |
| key | 对应 `activeKey` | `string` | - |
Expand Down