Миграция на новые версии
1.6.5 -> 1.7.0
Api
Свойства
- Свойство
editorShapeбыло обновлено. ПараметрclearButtonзаменён наclear:
new kanban.Kanban("#root", {
editorShape: [
{
type: "combo",
label: "Priority",
key: "priority",
config: {
clearButton: true // устаревшее
}
}, { /* ... */ }
]
// другие параметры
});
new kanban.Kanban("#root", {
editorShape: [
{
type: "combo",
label: "Priority",
key: "priority",
config: {
clear: true // новое
}
}, { /* ... */ }
]
// другие параметры
});
- Функция
cardShape.menu.itemsбыла обновлена. Параметр store заменён на readonly:
menu: {
show: true,
items: ({ card, store }) => {
const defaultMenuItems = getDefaultCardMenuItems({ card, store }); // параметр "store" устарел
...
}
}
menu: {
show: true,
items: ({ card, readonly }) => {
const defaultMenuItems = getDefaultCardMenuItems({ card, readonly }); // параметр "readonly" новый
...
}
}
- Функция
columnShape.menu.itemsбыла обновлена. Параметр store заменён на readonly:
menu: {
show: true,
items: ({ column, columnIndex, columns, store }) => {
const defaultMenuItems = getDefaultColumnMenuItems({ column, columnIndex, columns, store }); // параметр "store" устарел
...
}
}
menu: {
show: true,
items: ({ column, columnIndex, columns, readonly }) => {
const defaultMenuItems = getDefaultColumnMenuItems({ column, columnIndex, columns, readonly }); // параметр "readonly" новый
...
}
}
- Функция
rowShape.menu.itemsбыла обновлена. Параметр store заменён на readonly:
menu: {
show: true,
items: ({ row, rowIndex, rows, store }) => {
const defaultMenuItems = getDefaultRowMenuItems({ row, rowIndex, rows, store }); // параметр "store" устарел
...
}
}
menu: {
show: true,
items: ({ row, rowIndex, rows, readonly }) => {
const defaultMenuItems = getDefaultRowMenuItems({ row, rowIndex, rows, readonly }); // параметр "readonly" новый
...
}
}
-
Параметры menu.items[0].label и menu.items[0].items были удалены в v1.7 для свойств
cardShape.menu.items,columnShape.menu.itemsиrowShape.menu.items -
Свойство
editorAutoSaveбыло удалено в v1.7. Используйте свойствоeditor.autoSave:
new kanban.Kanban("#root", {
editorAutoSave: true, // устаревшее
// другие параметры
});
new kanban.Kanban("#root", {
editor: {
autoSave: true // новое
}
// другие параметры
});
- Свойство
linksбыло обновлено следующим образом:- Параметр masterId заменён на source
- Параметр slaveId заменён на target
const links = [
{
id: 1,
// устаревшее
masterId: 2,
slaveId: 5
}, {...} // другие данные связи
];
new kanban.Kanban("#root", {
links,
// другие параметры
});
const links = [
{
id: 1,
// новое
source: 2,
target: 5
}, {...} // другие данные связи
];
new kanban.Kanban("#root", {
links,
// другие параметры
});
Методы
- Методы
undoиredoбыли удалены из store-методов:
kanban.api.getStores().data.undo() // устаревшее
kanban.undo();
// или
kanban.api.exec("undo");
-
Методы
api.getState()иapi.getReactiveState()были обновлены следующим образом:- Следующие параметры удалены в v1.7.0:
fromAreaMeta,
dropAreaItemsCoords,
dropAreasCoords,
overAreaMeta,
before,
dragItemId,
dragItemsCoords,
overAreaId- Следующие параметры стали приватными в v1.7.0:
edit -> _edit: object,
layout -> _layout: string,
cardsMap -> _cardsMap: object,
cardsMeta -> _cardsMeta: object,
areasMeta -> _areasMeta: object,
scroll -> _scroll: object
События
- Параметры
dragItemsCoordsиdropAreasCoordsбыли удалены из событияstart-drag-card
1.5.13 -> 1.6.0
CSS-классы, связанные с меню, были изменены следующим образом:
.menu -> .wx-menu
.item -> .wx-item
.icon -> .wx-icon
.value -> .wx-value
1.5.12 -> 1.5.13
CSS-классы, связанные с редактором, были изменены следующим образом:
.modal -> .wx-modal
.window -> .wx-window
.modal .window .buttons -> .wx-modal .wx-window .wx-buttons
.combo -> .wx-combo
.combo -> .wx-multicombo
.item -> .wx-item
.color-picker -> .wx-colorselect
.colors -> .wx-colors
.slider -> .wx-slider
.datepicker -> .wx-datepicker
.calendar -> .wx-calendar
.calendar .days .day.out -> .wx-calendar .wx-days .wx-day.wx-out
.combo .tag -> .multicombo .wx-tag
.dropdown -> .wx-dropdown
.dropdown .item -> .wx-dropdown .wx-item
.clear -> .wx-clear
1.5.6 -> 1.5.7
Api
Методы
- Метод
setLocaleтулбара Kanban был обновлён следующим образом:
// создать Kanban
const board = new kanban.Kanban("#root", {...});
// создать Toolbar
const toolbar = new kanban.Toolbar("#toolbar", { api: board.api });
// применить локаль "de" к Toolbar
toolbar.setLocale(de); // или null для сброса на локаль по умолчанию (en)
// создать Kanban
const board = new kanban.Kanban("#root", {...});
// создать Toolbar
const toolbar = new kanban.Toolbar("#toolbar", { api: board.api });
// применить локаль "de" к Toolbar
toolbar.setLocale(de, board.api);
1.4 -> 1.5
Api
Свойства
-
Свойство
columnShapeKanban было обновлено следующим образом:До v1.5{
menu: {
show: true,
items: [
{
label: "Update", ...
}
]
// другие параметры
}
}C v1.5{
menu: {
show: true,
items: [
{
text: "Update", ...
}
]
// другие параметры
},
fixedHeaders: true
}
1.3 -> 1.4
Api
Свойства
-
Свойство
editorShapeKanban было обновлено следующим образом:До v1.4{
type: "date",
key: "start_date",
label: "Start date"
},
// другие параметрыC v1.4{
type: "date", // или можно использовать тип "dateRange"
key: "start_date",
label: "Date Range"
format: "%d/%m/%y"
},
{
type: "comments",
key: "comments",
label: "Comments",
config: {
format: "%M %d",
placement: "page", // или "editor"
html: true,
},
},
{
type: "links",
key: "links",
label: "Links",
},
// другие параметры -
Свойство
cardShapeKanban было обновлено следующим образом:До v1.4{
label: true,
description: true,
menu: {
items: [
{
label: "Delete", ...
}
]
}
// другие параметры
}C v1.4{
label: true,
description: true,
menu: {
items: [
{
text: "Delete", ...
}
]
},
votes: true,
comments: true,
css: (card) => card.type == "feature" ? "green" : "red",
// другие параметры
} -
Свойство
columnShapeKanban было обновлено следующим образом:До v1.4{
menu: {
show: true,
items: [
{
label: "Delete", ...
}
]
// другие параметры
}
}C v1.4{
menu: {
show: true,
items: [
{
text: "Delete", ...
}
]
// другие параметры
},
css: (column, cards) => column.id == "feature" && cards.length < 5 ? "green" : "red"
} -
Свойство
rowShapeKanban было обновлено следующим образом:До v1.4{
menu: {
show: true,
items: [
{
label: "Delete", ...
}
]
// другие параметры
}
}C v1.4{
menu: {
show: true,
items: [
{
text: "Delete", ...
}
]
// другие параметры
},
css: (row, cards) => row.id == "task" && cards.length < 5 ? "green" : "red",
} -
Свойство
cardsKanban было обновлено следующим образом:До v1.4[
{
id: 1,
label: "Integration with React",
description: "Some description",
// другие параметры
}, ...
]C v1.4[
{
id: 1,
label: "Integration with React",
description: "Some description",
css: "red",
votes: [4,6,9],
comments: [
{
id: 1,
userId: 9,
cardId: 6,
text: "Greetings, fellow colleagues. I would like to share my insights on this task. I reckon we should deal with at least half of the points in the plan without further delays.",
date: new Date(),
},{...}
]
// другие параметры
}, ...
] -
Свойство
columnsKanban было обновлено следующим образом:До v1.4[
{
id: "inprogress",
label: "In progress",
// другие параметры
}, ...
]C v1.4[
{
id: "inprogress",
label: "In progress",
css: "red",
overlay: template(`
<div className="blockOverlay disable-drop">
<span className="disable-drop-header">Drop is not allowed</span>
<span className="disable-drop-description">Only testers can move cards to this
column</span>
</div>`)
// другие параметры
}, ...
] -
Свойство
rowsKanban было обновлено следующим образом:До v1.4[
{
id: "features",
label: "Features",
// другие параметры
}, ...
]C v1.4[
{
id: "features",
label: "Features",
css: "green"
// другие параметры
}, ...
] -
Свойство
cardTemplateKanban было обновлено следующим образом:До v1.4const cardTemplate = ({ cardFields, selected, dragging, cardShape }) => {
if (selected) {
return `
<div className="custom-card" style={{padding: '20px'}}>
<div className="status-color" style={{background: '${cardFields.color}'}}></div>
Selected:${cardFields.label}
</div>
`;
}
}
new kanban.Kanban("#root", {
cards,
columns,
cardTemplate
});C v1.4const cardTemplate = ({ cardFields, selected, dragging, cardShape }) => {
if (selected) {
return `
<div className="custom-card" style={{padding: '20px'}}>
<div className="status-color" style={{background: '${cardFields.color}'}}></div>
<div data-menu-id=${cardFields.id} >
<i className="wxi-dots-v"></i>
</div>
Selected:${cardFields.label}
</div>
`;
}
}
new kanban.Kanban("#root", {
cards,
columns,
cardTemplate: kanban.template(card => cardTemplate(card)),
// другие параметры
}); -
Контрол сортировки sort в свойстве
itemsтулбара Kanban был обновлён следующим образом:До v1.4[
{ // кастомный контрол сортировки
type: "sort",
options: [
{
label: "Sort by label",
by: "label",
dir: "asc"
},
{
label: "Sort by description",
by: "description",
dir: "desc"
}
]
},
]C v1.4[
{ // кастомный контрол сортировки
type: "sort",
options: [
{
text: "Sort by label",
by: "label",
dir: "asc"
},
{
text: "Sort by description",
by: "description",
dir: "desc"
}
]
},
]
Методы
- Метод
api.getState()Kanban был обновлён:
api.getState();
// метод возвращает объект со следующими свойствами
/*{
areasMeta: object,
before: string | number,
cardShape: object,
cards: array,
cardsMap: object,
cardsMeta: object,
columnKey: string,
columns: array,
dragItemId: string | number,
dragItemsCoords: array,
edit: object,
editorShape: array,
fromAreaMeta: object,
overAreaId: string | number,
readonly: object,
rowKey: string,
rows: array,
scroll: object,
search: object,
selected: array,
sort: object,
dropAreaItemsCoords: array,
dropAreasCoords: array,
overAreaMeta: object,
}*/
api.getState();
// метод возвращает объект со следующими свойствами
/*{
areasMeta: object,
before: string | number,
cardShape: object,
cards: array,
cardsMap: object,
cardsMeta: object,
columnKey: string,
columns: array,
dragItemId: string | number,
dragItemsCoords: array,
edit: object,
editorShape: array,
fromAreaMeta: object,
overAreaId: string | number,
readonly: object,
rowKey: string,
rows: array,
scroll: object,
search: object,
selected: array,
sort: object,
}*/
1.2 -> 1.3
Api
Свойства
-
Свойство
editorShapeKanban было обновлено следующим образом:- параметр dateRange
До v1.3{
type: "date",
key: "start_date",
label: "Start date"
},
// другие параметрыC v1.3{
type: "dateRange", // или можно использовать тип "date"
key: {
start: "start_date",
end: "end_date"
},
label: "Date Range"
},
// другие параметры -
Свойство
itemsтулбара было обновлено следующим образом:
items: [
"search",
"spacer",
"sort",
"addColumn",
"addRow"
]
items: [
"search",
"spacer",
"undo",
"redo",
"sort",
"addColumn",
"addRow"
]
Методы
- Метод
updateCard()Kanban был обновлён:
updateCard({
id: 1,
card: {
label: "New Label",
row: "feature",
column: "inprogress",
/*другие параметры*/
}
});
updateCard({
id: 1,
card: {
label: "New Label",
row: "feature",
column: "inprogress",
/*другие параметры*/
},
replace: true
});
- Метод
updateColumn()Kanban был обновлён:
updateColumn({
id: "backlog",
column: {
label: "Updated column",
limit: 3,
strictLimit: 3,
collapsed: true
}
});
updateColumn({
id: "backlog",
column: {
label: "Updated column",
limit: 3,
strictLimit: 3,
collapsed: true
},
replace: true
});
- Метод
updateRow()Kanban был обновлён:
updateRow({
id: "feature",
row: {
label: "Updated row",
collapsed: true
},
});
updateColumn({
id: "feature",
row: {
label: "Updated row",
collapsed: true
},
replace: true
});
1.1 -> 1.2
Api
Свойства
-
Свойство
cardShapeKanban было обновлено следующим образом:- параметр menu
До v1.2menu: true,
//или
menu: { show: true }
// другие параметрыC v1.2menu: true,
// или
menu: {
show: true,
items: ({ card, store }) => {
if(card.id === 1){
return false;
} else {
return [
{ id: "set-edit", icon: "wxi-edit", label: "Edit" },
{ id: "delete-card", icon: "wxi-delete", label: "Delete" }
];
}
}
},
// другие параметры- параметр users
До v1.2users: {
show: true,
values: [
{
id: 1,
label: "John Smith",
path: "../assets/user.jpg"
},
]
},
// другие параметрыC v1.2users: {
show: true,
values: [
{
id: 1,
label: "John Smith",
avatar: "../assets/user.jpg"
},
]
},
// другие параметры- параметры start_date и end_date
До v1.2start_date: true,
end_date: true,
// другие параметрыC v1.2start_date: {
show: true,
format: "%d.%m.%Y"
},
end_date: {
show: true,
format: "%d.%m.%Y"
},
// другие параметры -
Свойство
editorShapeKanban было обновлено следующим образом:
{
type: "multiselect",
key: "users",
label: "Users",
values: [
{
id: 1, label: "Alan",
path: "preview_image_path_1.png"
},
]
},
// настройки других полей
{
type: "multiselect",
key: "users",
label: "Users",
values: [
{
id: 1, label: "Alan",
avatar: "preview_image_path_1.png"
},
]
},
// настройки других полей
- Свойство
itemsтулбара было обновлено следующим образом:
items: [
"search",
"controls"
]
items: [
{ // или "search",
type: "search",
options: [
{
id: "label",
label: "By label"
},
{
id: "start_date",
label: "By date",
searchRule: (card, value, by) => {
const date = card[by];
return date?.toString().includes(value);
}
}
]
},
"spacer",
{ // или "sort",
type: "sort",
options: [
{
label: "Sort by label",
by: "label",
dir: "asc"
},
{
label: "Sort by description",
by: "description",
dir: "desc"
}
]
},
"addColumn",
"addRow"
]
Методы
- Метод
setLocale()Kanban и методsetLocale()Toolbar были обновлены:
setLocale(kanban.en); // сброс на локаль по умолчанию
setLocale(null); // сброс на локаль по умолчанию
- Метод
api.getReactiveState()Kanban был обновлён:
api.getReactiveState();
// метод возвращает объект со следующими свойствами
/*{
dragItemId: {
subscribe: any,
update: any,
set: any
},
before: {...},
overAreaId: {...},
overAreaMeta: {...},
dropAreaItemsCoords: {...},
dropAreasCoords: {...},
dragItemsCoords: {...},
selected: {...}
}*/
api.getReactiveState();
// метод возвращает объект со следующими свойствами
/*{
areasMeta: {
subscribe: any,
update: any,
set: any
},
before: {...},
cardShape: {...},
cards: {...},
cardsMap: {...},
cardsMeta: {...},
columnKey: {...},
columns: {...},
dragItemId: {...},
dragItemsCoords: {...},
dropAreaItemsCoords: {...},
dropAreasCoords: {...},
edit: {...},
editorShape: {...},
fromAreaMeta: {...},
overAreaId: {...},
overAreaMeta: {...},
readonly: {...},
rowKey: {...},
rows: {...},
scroll: {...},
search: {...},
selected: {...},
sort: {...}
}*/
- Метод
api.getState()Kanban был обновлён:
api.getState();
// метод возвращает объект со следующими свойствами
/*{
dragItemId: string | number,
before: string | number,
overAreaId: string | number,
overAreaMeta: object,
dropAreaItemsCoords: array,
dropAreasCoords: array,
dragItemsCoords: array,
selected: array
}*/
api.getState();
// метод возвращает объект со следующими свойствами
/*{
areasMeta: object,
before: string | number,
cardShape: object,
cards: array,
cardsMap: object,
cardsMeta: object,
columnKey: string,
columns: array,
dragItemId: string | number,
dragItemsCoords: array,
dropAreaItemsCoords: array,
dropAreasCoords: array,
edit: object,
editorShape: array,
fromAreaMeta: object,
overAreaId: string | number,
overAreaMeta: object,
readonly: object,
rowKey: string,
rows: array,
scroll: object,
search: object,
selected: array,
sort: object
}*/
- Метод
api.getStores()Kanban был обновлён:
api.getStores();
// метод возвращает объект со следующими stores
/*{
state: StateStore, // ( object )
data: DataStore // ( object )
}*/
api.getStores();
// метод возвращает объект со следующими свойствами
/*{
state: StateStore, // ( object )
}*/
Локализация
До v1.2
const days = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"];
const months = [
"January",
"February",
"March",
"April",
"May",
"June",
"July",
"August",
"September",
"October",
"November",
"December"
];
const monthsShort = [
"Jan",
"Feb",
"Mar",
"Apr",
"May",
"Jun",
"Jul",
"Aug",
"Sep",
"Oct",
"Nov",
"Dec"
];
const wx = {
Today: "Today",
Clear: "Clear",
Close: "Close"
};
const en = {
lang: "en",
__dates: {
months,
monthsShort,
days
},
wx,
kanban: {
Save: "Save",
Close: "Close",
Delete: "Delete",
Name: "Name",
Description: "Description",
Type: "Type",
"Start date": "Start date",
"End date": "End date",
Result: "Result",
"No results": "No results",
Search: "Search",
"Search in": "Search in",
"Add new row": "Add new row",
"Add new column": "Add new column",
"Add new card": "Add new card",
"Edit card": "Edit card",
Edit: "Edit",
Everywhere: "Everywhere",
Label: "Label",
Status: "Status",
Color: "Color",
Date: "Date",
Untitled: "Untitled",
Rename: "Rename"
}
};
C v1.2
const en = {
kanban: { // переводы подписей Kanban
"Save": "Save",
"Close": "Close",
"Delete": "Delete",
"Name": "Name",
"Description": "Description",
"Type": "Type",
"Start date": "Start date",
"End date": "End date",
"Result": "Result",
"No results": "No results",
"Search": "Search",
"Search in": "Search in",
"Add new row": "Add new row",
"Add new column": "Add new column",
"Add new card": "Add new card",
"Edit card": "Edit card",
"Edit": "Edit",
"Everywhere": "Everywhere",
"Label": "Label",
"Status": "Status",
"Color": "Color",
"Date": "Date",
"Untitled": "Untitled",
"Rename": "Rename",
"Move up": "Move up",
"Move down": "Move down",
"Move left": "Move left",
"Move right": "Move right",
"Sort": "Sort",
"Label (a-z)": "Label (a-z)",
"Label (z-a)": "Label (z-a)",
"Description (a-z)": "Description (a-z)",
"Description (z-a)": "Description (z-a)"
},
calendar: { // переводы и настройки календаря
monthFull: [
"January", "February", "March", "April",
"May", "June", "July", "August",
"September", "October", "November", "December"
],
monthShort: [
"Jan", "Feb", "Mar", "Apr",
"May", "Jun", "Jul", "Aug",
"Sep", "Oct", "Nov", "Dec"
],
dayFull: [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
dayShort: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"],
hours: "Hours",
minutes: "Minutes",
done: "Done",
clear: "Clear",
today: "Today",
am: ["am", "AM"],
pm: ["pm", "PM"],
weekStart: 7,
timeFormat: 24
},
core: { // переводы базовых элементов
ok: "OK",
cancel: "Cancel"
}
};
1.0 -> 1.1
Api
Свойства
- Свойство
columnsбыло расширено новыми параметрами. Начиная с v1.1, вы можете использовать конфигурации collapsed, limit и strictLimit.
const columns = [
{
label: "Backlog",
id: "backlog"
}, ...
];
const columns = [
{
label: "Backlog",
id: "backlog",
collapsed: true,
limit: 3,
strictLimit: true
}, ...
];
new kanban.Kanban("#root", {
columns,
// другие параметры
});
- Параметр color свойства
cardShapeбыл обновлён.
const cardShape = {
color: {
show: true,
values: [
{ id: 1, color: "#65D3B3", label: "red" },
{ id: 2, color: "#FFC975", label: "green" }
]
}
};
const cardShape = {
color: {
show: true,
values: ["#65D3B3", "#FFC975", "#58C3FE"]
}
};
new kanban.Kanban("#root", {
cardShape
// другие параметры
});
Методы
- Метод
addColumn(и событиеadd-column) был обновлён:
addColumn(column_data_object);
addColumn({
id: "backlog",
column: {
label: "Backlog",
collapsed: false,
...
}
});
addRow(row_data_object);
addRow({
id: "feature",
row: {
label: "Feature",
collapsed: false,
...
}
});
- Метод
updateColumn(и событиеupdate-column) был обновлён:
updateColumn(column_data_object);
updateColumn({
id: "backlog",
column: {
label: "Backlog",
collapsed: true,
...
}
});
- Метод
updateRow(и событиеupdate-row) был обновлён:
updateRow(row_data_object);
updateRow({
id: "feature",
row: {
label: "Feature",
collapsed: true,
...
}
});
- Метод
updateCard(и событиеupdate-card) был обновлён:
updateCard(card_data_object);
updateCard({
id: 1,
card: {
label: "Volvo XC 70",
progress: 26
...
}
});
- Метод
parseбыл обновлён:
// необходимо сбрасывать начальные данные перед парсингом новых
const board = new kanban.Kanban("#root", {
columns: [],
cards: [],
rows: []
});
board.parse({
columns,
cards,
rows
});
// не требуется сбрасывать начальные данные перед парсингом новых
const board = new kanban.Kanban("#root", {});
board.parse({
columns,
cards,
rows
});