You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/config/js_kanban_cardheight_config.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ cardHeight?: number; // px
17
17
~~~
18
18
19
19
:::important
20
-
When using [`renderType: "lazy"`](/api/config/js_kanban_rendertype_config.md) together with [`scrollType: "default"`](/api/config/js_kanban_scrolltype_config.md), it's important to set a fixed height for cards using the `cardHeight` property. Without this, the cards won't be visible.
20
+
When using [`renderType: "lazy"`](/api/config/js_kanban_rendertype_config) together with [`scrollType: "default"`](/api/config/js_kanban_scrolltype_config), it's important to set a fixed height for cards using the `cardHeight` property. Without this, the cards won't be visible.
21
21
:::
22
22
23
23
### Example
@@ -33,6 +33,6 @@ new kanban.Kanban("#root", {
33
33
34
34
**Change log:** This property was introduced in version 1.2
Copy file name to clipboardExpand all lines: docs/api/config/js_kanban_cards_config.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,15 +70,15 @@ Each card can include the following parameters:
70
70
- `name` - (optional) file name
71
71
- `isCover` - (optional) when **true**, the cover image is loaded from the "coverURL"
72
72
-`color` - (optional) HEX color code representing the card's top line color
73
-
-`users` - (optional) either an **array** of user IDs for multiple users or a **string | number** for a single user. To assign users, define an array with user data in the [cardShape.users](../js_kanban_cardshape_config) property. Users appear in the **Users** field
73
+
-`users` - (optional) either an **array** of user IDs for multiple users or a **string | number** for a single user. To assign users, define an array with user data in the [`cardShape.users`](/api/config/js_kanban_cardshape_config) property. Users appear in the **Users** field
74
74
75
75
:::info
76
-
`users?: array` - use an **array** of user **IDs** when using the [**multiselect**](../js_kanban_editorshape_config/#--parameters-for-combo-select-and-multiselect-types) editor type for multiple user assignments
76
+
`users?: array` - use an **array** of user **IDs** when using the [**multiselect**](/api/config/js_kanban_editorshape_config/#--parameters-for-combo-select-and-multiselect-types) editor type for multiple user assignments
77
77
78
-
`users?: string | number` - specify a single user **ID** when using the [**combo** or **select**](../js_kanban_editorshape_config/#--parameters-for-combo-select-and-multiselect-types) editor types for single user assignment
78
+
`users?: string | number` - specify a single user **ID** when using the [**combo** or **select**](/api/config/js_kanban_editorshape_config/#--parameters-for-combo-select-and-multiselect-types) editor types for single user assignment
79
79
:::
80
80
81
-
-`priority` - (optional) priority **ID** of the card. Define an array of priorities in the [cardShape.priority](../js_kanban_cardshape_config) property. Displayed in the **Priority** field
81
+
-`priority` - (optional) priority **ID** of the card. Define an array of priorities in the [`cardShape.priority`](/api/config/js_kanban_cardshape_config) property. Displayed in the **Priority** field
82
82
-`css` - (optional) custom CSS styles for the card
83
83
-`votes` - (optional) array of user IDs who voted
84
84
-`comments` - (optional) array of comment objects with:
@@ -87,10 +87,10 @@ Each card can include the following parameters:
87
87
-`cardId` - (required) card **ID** the comment belongs to
88
88
-`text` - (optional) comment text, which can include HTML markup
89
89
-`date` - (optional) Date object representing when the comment was posted (not updated after edits)
90
-
-`custom_key` - (optional) any custom key for the card. This can be used to position the card within columns or rows, see the [columnKey](../js_kanban_columnkey_config) and [rowKey](../js_kanban_rowkey_config) properties
90
+
-`custom_key` - (optional) any custom key for the card. This can be used to position the card within columns or rows, see the [`columnKey`](/api/config/js_kanban_columnkey_config) and [`rowKey`](/api/config/js_kanban_rowkey_config) properties
91
91
92
92
:::info
93
-
To load new card data dynamically, the [**parse()**](../../methods/js_kanban_parse_method) method can be used.
93
+
To load new card data dynamically, the [`parse()`](/api/methods/js_kanban_parse_method) method can be used.
Copy file name to clipboardExpand all lines: docs/api/config/js_kanban_cardshape_config.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -160,7 +160,7 @@ items: ({ card, store }) => {
160
160
Setting `maxCount` controls how many assigned users appear on the card. Setting it to `false` displays all assigned users.
161
161
162
162
:::info
163
-
The **_users_** field is off by default. To enable it, set `show` to `true` and provide user data in `values`. To assign users via the editor, configure the appropriate control in [`editorShape`](/api/config/js_kanban_editorshape_config.md#--parameters-for-combo-select-and-multiselect-types). Use **_select_** for single user or **_multiselect_** for multiple users.
163
+
The **_users_** field is off by default. To enable it, set `show` to `true` and provide user data in `values`. To assign users via the editor, configure the appropriate control in [`editorShape`](/api/config/js_kanban_editorshape_config/#--parameters-for-combo-select-and-multiselect-types). Use **_select_** for single user or **_multiselect_** for multiple users.
164
164
165
165
```jsx {}
166
166
cardShape: {
@@ -188,7 +188,7 @@ The **_users_** field is off by default. To enable it, set `show` to `true` and
188
188
- `clickable` - (optional) if `true`, users can vote by clicking the icon on the card; otherwise, voting is only possible via the editor
189
189
- `css` - function returning a CSS class to conditionally style cards
190
190
- `headerFields` - (optional) array of objects defining **custom fields**
191
-
- `key` - (required) custom field key, used when configuring the editor via [editorShape](../js_kanban_editorshape_config)
191
+
- `key` - (required) custom field key, used when configuring the editor via [editorShape](/api/config/js_kanban_editorshape_config)
192
192
- `label` - (optional) custom field label
193
193
- `css` - (optional) CSS class for the custom field
194
194
@@ -317,7 +317,7 @@ new kanban.Kanban("#root", {
317
317
- The **_menu.items[0].label_** option was renamed to **_menu.items[0].text_** in v1.4
318
318
- The **_users.maxCount_** and **_votes.clickable_** options were added in v1.6
Copy file name to clipboardExpand all lines: docs/api/config/js_kanban_currentuser_config.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ description: You can learn about the currentUser config in the documentation of
11
11
@short: Optional. Represents the ID of the current user
12
12
13
13
:::note
14
-
The current user ID should match one of the IDs listed in the [`cardShape.users`](/api/config/js_kanban_cardshape_config.md) property. If this ID isn't provided, comments will be accessible only in read-only mode.
14
+
The current user ID should match one of the IDs listed in the [`cardShape.users`](/api/config/js_kanban_cardshape_config) property. If this ID isn't provided, comments will be accessible only in read-only mode.
Starting with version 1.3, the `editorAutoSave` property is **deprecated**. To control the "autosave" mode, please use the [`editor`](/api/config/js_kanban_editor_config.md) property instead.
12
+
Starting with version 1.3, the `editorAutoSave` property is **deprecated**. To control the "autosave" mode, please use the [`editor`](/api/config/js_kanban_editor_config) property instead.
Copy file name to clipboardExpand all lines: docs/api/config/js_kanban_editorshape_config.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -157,7 +157,7 @@ The editor appearance and features can be customized by setting the following pa
157
157
Supported field types in the Kanban editor are: **dateRange**, **date**, **combo**, **select**, **multiselect**, **color**, **text**, **textarea**, **progress**, **files**, **comments**, and **links**.
158
158
:::
159
159
160
-
- `key` - (required) the key for the editor field. This should match the value set in the [`cardShape`](../js_kanban_cardshape_config) property. Example:
160
+
- `key` - (required) the key for the editor field. This should match the value set in the [`cardShape`](/api/config/js_kanban_cardshape_config) property. Example:
161
161
162
162
~~~js {8,17}
163
163
// card appearance settings
@@ -190,7 +190,7 @@ Supported field types in the Kanban editor are: **dateRange**, **date**, **combo
190
190
-`end`- (required) key for the end date
191
191
192
192
:::important
193
-
These keys correspond to those used in the [`cardShape`](../js_kanban_cardshape_config) property.
193
+
These keys correspond to those used in the [`cardShape`](/api/config/js_kanban_cardshape_config) property.
194
194
:::
195
195
196
196
-`config`- (optional) configuration object for the **"dateRange"** field with the following options:
@@ -468,4 +468,4 @@ new kanban.Kanban("#root", {
468
468
- Added the ***dateRange*** type in v1.3
469
469
- Added the ***comments*** and ***links*** editor types, along with***format*** parameters in v1.4
Copy file name to clipboardExpand all lines: docs/api/config/js_kanban_history_config.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ The `history` property lets you turn history management on or off for Kanban. Se
15
15
:::
16
16
17
17
:::tip
18
-
It's also possible to exclude certain operations from the Kanban history by using the [`$meta`](/api/common/js_kanban_meta_parameter.md) parameter with methods and events!
18
+
It's also possible to exclude certain operations from the Kanban history by using the [`$meta`](/api/common/js_kanban_meta_parameter) parameter with methods and events!
19
19
:::
20
20
21
21
### Usage
@@ -43,4 +43,4 @@ new kanban.Kanban("#root", {
43
43
44
44
**Change log:** This property was introduced in version 1.3
45
45
46
-
**Related articles:**[`undo()`](/api/methods/js_kanban_undo_method.md) and [`redo()`](/api/methods/js_kanban_redo_method.md)
46
+
**Related articles:**[`undo()`](/api/methods/js_kanban_undo_method) and [`redo()`](/api/methods/js_kanban_redo_method)
0 commit comments