Skip to content

Commit f3f20dc

Browse files
serhiipylypchuk1991serhiipylypchuk1991
committed
[update] Retranslate ZH locale
- sync to commit 943f1d7 - translate 4 new RestDataProvider methods (getHandlers, getIDResolver, getQueue, setHeaders) - update configs: cardheight, columnshape, editorshape, rendertype, scrolltype, toolbar_items - update overviews: internal_rest, properties - update guides: configuration, working_with_server - update whats_new release notes
1 parent ae4fdcf commit f3f20dc

16 files changed

Lines changed: 301 additions & 41 deletions

‎i18n/zh/docusaurus-plugin-content-docs/current/.sync‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
f55b2fb6832c9d6955cfb66b8e5734aa93ffa3d3
1+
943f1d77abd087cfa70fc9f4a148239ebcae9d9a

‎i18n/zh/docusaurus-plugin-content-docs/current/api/config/js_kanban_cardheight_config.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ cardHeight?: number; // px
1919
:::important
2020
如果您同时使用 [`renderType: "lazy"`](api/config/js_kanban_rendertype_config.md) 和 [`scrollType: "default"`](api/config/js_kanban_scrolltype_config.md) 设置，请务必通过 `cardHeight` 属性指定卡片的固定高度。如果未指定，卡片将不会显示。
2121
当您将 [`renderType: "lazy"`](api/config/js_kanban_rendertype_config.md) 与 [`scrollType: "column"`](api/config/js_kanban_scrolltype_config.md) 配合使用时，也应通过 `cardHeight` 属性固定卡片高度。尽管该布局类型支持卡片高度可变，但在自定义卡片内容时，可能无法稳定工作。
22+
23+
如果未指定 `cardHeight`，组件将根据 [`cardShape`](api/config/js_kanban_cardshape_config.md) 中声明的可见字段，对卡片高度进行实验性估算作为回退方案。若使用了自定义 [`cardTemplate`](api/config/js_kanban_cardtemplate_config.md)，此估算将不适用——在这种情况下，请显式设置 `cardHeight`，或提供自定义的 [`getCardHeight`](api/config/js_kanban_getcardheight_config.md) 函数。
2224
:::
2325

2426
### 示例

‎i18n/zh/docusaurus-plugin-content-docs/current/api/config/js_kanban_columnshape_config.md‎

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ columnShape?: {
3030
},
3131
fixedHeaders?: boolean,
3232
css?: (column, cards) => string,
33-
headerTemplate?: template(column => {
33+
headerTemplate?: template(props => {
3434
return "展开状态下列头的 HTML 模板";
3535
}),
36-
collapsedTemplate?: template(column => {
36+
collapsedTemplate?: template(props => {
3737
return "折叠状态下列头的 HTML 模板";
3838
}),
3939
confirmDeletion?: boolean
@@ -94,8 +94,28 @@ columnShape?: {
9494

9595
- `fixedHeaders` - （可选）在垂直滚动时固定列头（默认 *true*）。必须在看板本身启用滚动（限制高度）
9696
- `css` - （可选）一个函数，根据条件返回应用于列的 CSS 类名
97-
- `headerTemplate` - （可选）展开状态下列头的 HTML 模板
98-
- `collapsedTemplate` - （可选）折叠状态下列头的 HTML 模板
97+
- `headerTemplate` - （可选）展开状态下列头的 HTML 模板。该函数接收一个 `props` 对象，包含以下属性：
98+
- `column` - （对象）列数据（结构参见 [`columns`](api/config/js_kanban_columns_config.md)）
99+
- `columnState` - （对象）列的当前状态，始终包含以下属性：
100+
- ***columnId*** - （string | number）列的 ID
101+
- ***column*** - （对象）列数据（与 `props.column` 相同）
102+
- ***cardsCount*** - （number）列中卡片数量
103+
- ***noFreeSpace*** - （boolean）当列无法接受更多卡片时为 ***true***
104+
105+
当启用 [`columns[i].limit`](api/config/js_kanban_columns_config.md) 参数时，还包含：
106+
- ***totalLimit*** - （number）配置的卡片数量限制
107+
- ***isOverLimit*** - （boolean）当卡片数量超过限制时为 ***true***
108+
109+
当列属于泳道（行）时，还包含：
110+
- ***rowId*** - （string | number）行的 ID
111+
- ***row*** - （对象）行数据（结构参见 [`rows`](api/config/js_kanban_rows_config.md)）
112+
- ***height*** - （number）区域高度
113+
- `isMenuVisible` - （boolean）当该列头应显示菜单时为 ***true***
114+
- `renaming` - （boolean）当列名编辑输入框处于激活状态时为 ***true***
115+
- `readonly` - （boolean）当列编辑被禁用时为 ***true***（等同于 `!readonly.edit`，参见 [`readonly`](api/config/js_kanban_readonly_config.md) 属性）
116+
- `collapsedTemplate` - （可选）折叠状态下列头的 HTML 模板。该函数接收一个 `props` 对象，包含以下属性：
117+
- `column` - （对象）列数据（参见 [`columns`](api/config/js_kanban_columns_config.md)）
118+
- `columnState` - （对象）列的当前状态，结构与上方 [`headerTemplate`](#parameters) 参数中的 `columnState` 相同
99119
- `confirmDeletion` - （可选）显示/隐藏 **确认对话框**，允许用户确认或取消列的删除操作
100120

101121
### 默认配置
@@ -160,30 +180,30 @@ const columnShape = {
160180
},
161181
fixedHeaders: false,
162182
css: (column, cards) => column.id == "inprogress" && cards.length < 5 ? "green" : "red",
163-
headerTemplate: template(column => {
183+
headerTemplate: template(props => {
164184
return `<div class="wx-collapse-icon" data-action=${"collapse"}>
165-
<i class=${column.column.collapsed ? "wxi-angle-right" : "wxi-angle-left"}></i>
185+
<i class=${props.column.collapsed ? "wxi-angle-right" : "wxi-angle-left"}></i>
166186
</div>
167187
${
168-
!column.column.collapsed
188+
!props.column.collapsed
169189
? `<div class="wx-label" data-action="rename">
170-
${escapeHTML(column.column.label)}
171-
(${column.columnState.cardsCount})
190+
${escapeHTML(props.column.label)}
191+
(${props.columnState.cardsCount})
172192
</div>`
173193
: ""
174194
}
175195
${
176-
!column.column.collapsed
177-
? `<div class="wx-menu" data-menu-id=${column.id}>
196+
!props.column.collapsed
197+
? `<div class="wx-menu" data-menu-id=${props.column.id}>
178198
<i class="wxi-dots-h"></i>
179199
</div>`
180200
: ""
181201
}`;
182202
}),
183-
collapsedTemplate: template(column => {
203+
collapsedTemplate: template(props => {
184204
return `<div class="wx-collapsed-label">
185-
<div class="wx-label-text">${escapeHTML(column.column.label)} (${
186-
column.columnState?.cardsCount
205+
<div class="wx-label-text">${escapeHTML(props.column.label)} (${
206+
props.columnState?.cardsCount
187207
})</div>
188208
</div>`;
189209
}),
@@ -213,4 +233,4 @@ new kanban.Kanban("#root", {
213233
**相关示例：**
214234
- [Kanban. 通过自定义菜单更改列颜色](https://snippet.dhtmlx.com/fnlvd2g5?tag=kanban)
215235
- [Kanban. 固定表头、懒加载和列滚动](https://snippet.dhtmlx.com/xez9ghqq?tag=kanban)
216-
- [Kanban. 列头模板](https://snippet.dhtmlx.com/gq2saz9c?tag=kanban)
236+
- [Kanban. 列头模板](https://snippet.dhtmlx.com/gq2saz9c?tag=kanban)

‎i18n/zh/docusaurus-plugin-content-docs/current/api/config/js_kanban_editorshape_config.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ editorShape?: [
1919
type: string,
2020
key: string,
2121
label?: string,
22+
modalSection?: "left" | "right",
2223

2324
// 仅针对 "dateRange" 类型
2425
key: {
@@ -182,6 +183,9 @@ editorShape?: [
182183
~~~
183184

184185
- `label` - （可选）编辑器字段标签
186+
- `modalSection` - （可选）定义字段在模态编辑器中的列位置。仅当编辑器通过 [`editor.placement: "modal"`](api/config/js_kanban_editor_config.md) 属性以模态窗口形式显示时生效。可设置为：
187+
- `"left"` - 字段放置在左列
188+
- `"right"` - 字段放置在右列（默认值）
185189

186190
#### - "dateRange" 类型的参数
187191

@@ -466,6 +470,7 @@ new kanban.Kanban("#root", {
466470

467471
- v1.3 版本新增了 ***dateRange*** 类型
468472
- v1.4 版本新增了 ***comments*** 和 ***links*** 编辑器类型，以及 ***format*** 参数
473+
- v1.6 版本新增了 ***modalSection*** 参数
469474
- ***clearButton*** 参数被替换为 ***clear*** 参数
470475

471476
**相关文档：** [配置](guides/configuration.md/#editor)

‎i18n/zh/docusaurus-plugin-content-docs/current/api/config/js_kanban_rendertype_config.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ renderType?: "default" | "lazy";
2323
:::important
2424
如果您将 `renderType: "lazy"` 与 [`scrollType: "default"`](api/config/js_kanban_scrolltype_config.md) 设置结合使用，请务必通过 [`cardHeight`](api/config/js_kanban_cardheight_config.md) 属性指定卡片的固定高度。否则卡片将无法正确显示。
2525
当您将 `renderType: "lazy"` 与 [`scrollType: "column"`](api/config/js_kanban_scrolltype_config.md) 搭配使用时，也应通过 [`cardHeight`](api/config/js_kanban_cardheight_config.md) 属性固定卡片的高度。虽然此布局类型支持卡片高度可变，但如果使用自定义卡片内容，可能无法稳定工作。
26+
27+
如果未设置 `cardHeight`，组件将根据 [`cardShape`](api/config/js_kanban_cardshape_config.md) 对卡片高度进行实验性近似估算。对于使用自定义 [`cardTemplate`](api/config/js_kanban_cardtemplate_config.md) 的看板，请改为提供自定义的 [`getCardHeight`](api/config/js_kanban_getcardheight_config.md) 函数。
2628
:::
2729

2830
### 默认配置

‎i18n/zh/docusaurus-plugin-content-docs/current/api/config/js_kanban_scrolltype_config.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ scrollType: "default"
2929
:::important
3030
如果您将 [`renderType: "lazy"`](api/config/js_kanban_rendertype_config.md) 和 `scrollType: "default"` 设置结合使用，请务必通过 [`cardHeight`](api/config/js_kanban_cardheight_config.md) 属性指定卡片的固定高度。否则卡片将无法显示。
3131
当您将 [`renderType: "lazy"`](api/config/js_kanban_rendertype_config.md) 与 `scrollType: "column"` 一起使用时，也应该通过 [`cardHeight`](api/config/js_kanban_cardheight_config.md) 属性固定卡片的高度。尽管该布局类型支持可变高度的卡片，但如果卡片内容为自定义内容，显示效果可能不稳定。
32+
33+
如果未设置 `cardHeight`，组件将根据 [`cardShape`](api/config/js_kanban_cardshape_config.md) 对卡片高度进行实验性估算作为回退。对于使用自定义 [`cardTemplate`](api/config/js_kanban_cardtemplate_config.md) 的看板，请改为提供自定义的 [`getCardHeight`](api/config/js_kanban_getcardheight_config.md) 函数。
3234
:::
3335

3436
### 示例

‎i18n/zh/docusaurus-plugin-content-docs/current/api/config/toolbar_items_config.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ items?: [
2626
}
2727
}, {...}
2828
],
29-
resultTemplate?: template(searchResult => {
30-
return "搜索结果的 HTML 模板";
29+
resultTemplate?: template(({ result }) => {
30+
return `HTML template using ${result.label}`;
3131
})
3232
},
3333
"sort" | {
@@ -66,7 +66,7 @@ items?: [
6666
- ***card*** - 卡片数据对象
6767
- ***value*** - 搜索栏中指定的搜索值
6868
- ***by*** - 用于搜索卡片的字段键
69-
- `searchResult` - （可选）用于显示自定义搜索结果的模板
69+
- `resultTemplate` - （可选）用于显示自定义搜索结果的模板
7070

7171
~~~jsx
7272
items: [
@@ -93,10 +93,10 @@ items: [
9393
}
9494
}
9595
],
96-
resultTemplate: kanban.template(searchResult => {
96+
resultTemplate: kanban.template(({ result }) => {
9797
return `<div class="list-item">
98-
<div class="list-item-text">${searchResult.result.label}</div>
99-
${searchResult.result.description ? `<div class="list-item-text item-description">${searchResult.result.description}</div>` : ""}
98+
<div class="list-item-text">${result.label}</div>
99+
${result.description ? `<div class="list-item-text item-description">${result.description}</div>` : ""}
100100
</div>`
101101
})
102102
},
@@ -161,10 +161,10 @@ new kanban.Toolbar("#toolbar", {
161161
items: [
162162
{
163163
type: "search",
164-
resultTemplate: kanban.template(searchResult => {
164+
resultTemplate: kanban.template(({ result }) => {
165165
return `<div class="list-item">
166-
<div class="list-item-text">${searchResult.result.label}</div>
167-
${searchResult.result.description ? `<div class="list-item-text item-description">${searchResult.result.description}</div>` : ""}
166+
<div class="list-item-text">${result.label}</div>
167+
${result.description ? `<div class="list-item-text item-description">${result.description}</div>` : ""}
168168
</div>`
169169
})
170170
},
@@ -182,10 +182,10 @@ new kanban.Toolbar("#toolbar", {
182182

183183
- 在 v1.3 版本中新增了 *"Undo"* 和 *"Redo"* 控件
184184
- 在 v1.4 版本中，**sort** 控件的 ***items.options[0].label*** 参数被替换为 ***items.options[0].text***
185-
- 在 v1.6 版本中，**"search"** 控件新增了 ***items.searchResult*** 参数
185+
- 在 v1.6 版本中，**"search"** 控件新增了 ***items.resultTemplate*** 参数
186186

187187
**相关文档：** [配置](guides/configuration.md#toolbar) 和 [自定义](guides/customization.md#custom-toolbar)
188188

189189
**相关示例：**
190190
- [看板. 自定义工具栏](https://snippet.dhtmlx.com/s5r5h4ju?tag=kanban)
191-
- [看板. 搜索结果中建议项的自定义](https://snippet.dhtmlx.com/2uo2f5mf?tag=kanban)
191+
- [看板. 搜索结果中建议项的自定义](https://snippet.dhtmlx.com/2uo2f5mf?tag=kanban)

‎i18n/zh/docusaurus-plugin-content-docs/current/api/overview/internal_rest_overview.md‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,15 @@ description: 您可以在 DHTMLX JavaScript 看板库的文档中查看 JavaScri
66

77
# RestDataProvider 方法
88

9-
| 名称 | 描述 |
10-
| ------------------------------------------------------------ | ----------------------------------------------------------------- |
11-
| [](api/provider/rest_methods/js_kanban_getcards_method.md) | @getshort(api/provider/rest_methods/js_kanban_getcards_method.md) |
12-
| [](api/provider/rest_methods/js_kanban_getcolumns_method.md) | @getshort(api/provider/rest_methods/js_kanban_getcolumns_method.md) |
13-
| [](api/provider/rest_methods/js_kanban_getlinks_method.md) | @getshort(api/provider/rest_methods/js_kanban_getlinks_method.md) |
14-
| [](api/provider/rest_methods/js_kanban_getrows_method.md) | @getshort(api/provider/rest_methods/js_kanban_getrows_method.md) |
15-
| [](api/provider/rest_methods/js_kanban_getusers_method.md) | @getshort(api/provider/rest_methods/js_kanban_getusers_method.md) |
16-
| [](api/provider/rest_methods/js_kanban_send_method.md) | @getshort(api/provider/rest_methods/js_kanban_send_method.md) |
9+
| 名称 | 描述 |
10+
| --------------------------------------------------------------- | --------------------------------------------------------------------- |
11+
| [](api/provider/rest_methods/js_kanban_getcards_method.md) | @getshort(api/provider/rest_methods/js_kanban_getcards_method.md) |
12+
| [](api/provider/rest_methods/js_kanban_getcolumns_method.md) | @getshort(api/provider/rest_methods/js_kanban_getcolumns_method.md) |
13+
| [](api/provider/rest_methods/js_kanban_gethandlers_method.md) | @getshort(api/provider/rest_methods/js_kanban_gethandlers_method.md) |
14+
| [](api/provider/rest_methods/js_kanban_getidresolver_method.md) | @getshort(api/provider/rest_methods/js_kanban_getidresolver_method.md)|
15+
| [](api/provider/rest_methods/js_kanban_getlinks_method.md) | @getshort(api/provider/rest_methods/js_kanban_getlinks_method.md) |
16+
| [](api/provider/rest_methods/js_kanban_getqueue_method.md) | @getshort(api/provider/rest_methods/js_kanban_getqueue_method.md) |
17+
| [](api/provider/rest_methods/js_kanban_getrows_method.md) | @getshort(api/provider/rest_methods/js_kanban_getrows_method.md) |
18+
| [](api/provider/rest_methods/js_kanban_getusers_method.md) | @getshort(api/provider/rest_methods/js_kanban_getusers_method.md) |
19+
| [](api/provider/rest_methods/js_kanban_send_method.md) | @getshort(api/provider/rest_methods/js_kanban_send_method.md) |
20+
| [](api/provider/rest_methods/js_kanban_setheaders_method.md) | @getshort(api/provider/rest_methods/js_kanban_setheaders_method.md) |

‎i18n/zh/docusaurus-plugin-content-docs/current/api/overview/properties_overview.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ description: 您可以在 DHTMLX JavaScript Kanban 库的文档中查看 JavaScr
2020
| [](api/config/js_kanban_currentuser_config.md) | @getshort(api/config/js_kanban_currentuser_config.md) |
2121
| [](api/config/js_kanban_editor_config.md) | @getshort(api/config/js_kanban_editor_config.md) |
2222
| [](api/config/js_kanban_editorshape_config.md) | @getshort(api/config/js_kanban_editorshape_config.md) |
23+
| [](api/config/js_kanban_getcardheight_config.md) | @getshort(api/config/js_kanban_getcardheight_config.md) |
2324
| [](api/config/js_kanban_history_config.md) | @getshort(api/config/js_kanban_history_config.md) |
2425
| [](api/config/js_kanban_links_config.md) | @getshort(api/config/js_kanban_links_config.md) |
2526
| [](api/config/js_kanban_locale_config.md) | @getshort(api/config/js_kanban_locale_config.md) |

‎i18n/zh/docusaurus-plugin-content-docs/current/api/provider/rest_methods/js_kanban_gethandlers_method.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
sidebar_label: getHandlers()
3+
title: getHandlers REST 方法
4+
description: 您可以在 DHTMLX JavaScript Kanban 库的文档中了解 getHandlers REST 方法。浏览开发者指南和 API 参考，试用代码示例和在线演示，并下载免费 30 天评估版本的 DHTMLX Kanban。
5+
---
6+
7+
# getHandlers()
8+
9+
### 描述
10+
11+
@short: 返回 RestDataProvider 用于向服务器发送数据操作的默认操作处理程序
12+
13+
:::info
14+
**getHandlers()** 方法是用于与服务器交互的 **RestDataProvider** 服务的一部分。
15+
:::
16+
17+
### 用法
18+
19+
~~~jsx {}
20+
getHandlers(): object;
21+
~~~
22+
23+
### 返回值
24+
25+
`getHandlers()` 方法返回一个对象，该对象将 [`RestDataProvider` 支持的数据操作](guides/working_with_server.md/#restdataprovider)映射到提供程序发送到服务器的请求。
26+
27+
返回的对象是 `RestDataProvider` 内部使用的默认操作映射。可以通过覆盖此方法来添加自定义处理程序，或使用自定义逻辑替换默认处理程序。
28+
29+
### 示例
30+
31+
要使用自定义处理程序扩展默认处理程序，请创建一个继承 `RestDataProvider` 的类并覆盖 `getHandlers()`。始终在覆盖中调用 `super.getHandlers()` 以保留默认处理程序：
32+
33+
~~~jsx {3-11}
34+
const url = "https://some_backend_url";
35+
36+
class MyDataProvider extends kanban.RestDataProvider {
37+
getHandlers() {
38+
const handlers = super.getHandlers();
39+
return {
40+
...handlers,
41+
// custom or overridden handlers go here
42+
};
43+
}
44+
}
45+
46+
const restProvider = new MyDataProvider(url);
47+
board.api.setNext(restProvider);
48+
~~~
49+
50+
:::warning
51+
请勿手动将默认处理程序复制到覆盖中。默认操作映射的内容可能在版本之间发生变化；调用 `super.getHandlers()` 可确保您的自定义处理程序始终合并在当前默认值之上。
52+
:::
53+
54+
**相关文章：** [与服务器配合使用](guides/working_with_server.md)

0 commit comments

Comments
 (0)