Миграция на новые версии

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 теперь использует новый способ применения локали:

До v1.5.7
    // создать Kanban
    const board = new kanban.Kanban("#root", {...});
    // создать Toolbar
    const toolbar = new kanban.Toolbar("#toolbar", { api: board.api });
    // применить локаль "de" к Toolbar
    toolbar.setLocale(de); // или null для сброса локали на стандартную (en)

С v1.5.7
    // создать 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

Свойства

Свойство columnShape в Kanban было обновлено:

До v1.5
        {
            menu: {
                show: true,
                items: [
                    {
                        label: "Update", ...
                    }
                ]
                // другие параметры
            }
        }

С v1.5
        {
            menu: {
                show: true,
                items: [
                    {
                        text: "Update", ...
                    }
                ]
                // другие параметры
            },
            fixedHeaders: true
        }

1.3 -> 1.4

Api

Свойства

Свойство editorShape для Kanban теперь работает так:

До v1.4
        {
            type: "date",
            key: "start_date",
            label: "Start date"
        },
        // другие параметры

С 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",
        },
        // другие параметры

Обновление свойства cardShape:

До v1.4
        {
            label: true,
            description: true,
            menu: {
                items: [
                    {
                        label: "Delete", ...
                    }
                ]
            }
            // другие параметры
        }

С v1.4
        {
            label: true,
            description: true,
            menu: {
                items: [
                    {
                        text: "Delete", ...
                    }
                ]
            },
            votes: true,
            comments: true,
            css: (card) => card.type == "feature" ? "green" : "red",
            // другие параметры
        }

Обновление свойства columnShape:

До v1.4
        {
            menu: {
                show: true,
                items: [
                    {
                        label: "Delete", ...
                    }
                ]
                // другие параметры
            }
        }

С v1.4
        {
            menu: {
                show: true,
                items: [
                    {
                        text: "Delete", ...
                    }
                ]
                // другие параметры
            },
            css: (column, cards) => column.id == "feature" && cards.length < 5 ? "green" : "red"
        }

Обновление свойства rowShape:

До v1.4
        {
            menu: {
                show: true,
                items: [
                    {
                        label: "Delete", ...
                    }
                ]
                // другие параметры
            }
        }

С v1.4
        {
            menu: {
                show: true,
                items: [
                    {
                        text: "Delete", ...
                    }
                ]
                // другие параметры
            },
            css: (row, cards) => row.id == "task" && cards.length < 5 ? "green" : "red",
        }

Свойство cards теперь выглядит так:

До v1.4
        [
            {
                id: 1,
                label: "Integration with React",
                description: "Some description",
                // другие параметры
            }, ...
        ]

С 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(),
                    },{...}
                ]
                // другие параметры
            }, ...
        ]

Свойство columns теперь содержит новые опции:

До v1.4
        [
            {
                id: "inprogress",
                label: "In progress",
                // другие параметры
            }, ...
        ]

С 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>`)
                // другие параметры
            }, ...
        ]

Свойство rows теперь поддерживает опцию css:

До v1.4
        [
            {
                id: "features",
                label: "Features",
                // другие параметры
            }, ...
        ]

С v1.4
        [
            {
                id: "features",
                label: "Features",
                css: "green"
                // другие параметры
            }, ...
        ]

Обновление свойства cardTemplate:

До v1.4
        const 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
        });

С v1.4
        const 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"
                    }
                ]
            },
        ]

С v1.4
        [
            { // пользовательский контрол сортировки
                type: "sort",
                options: [
                    {
                        text: "Sort by label",
                        by: "label",
                        dir: "asc"
                    },
                    {
                        text: "Sort by description",
                        by: "description",
                        dir: "desc"
                    }
                ]
            },
        ]

Методы

Метод api.getState() в Kanban теперь возвращает меньше свойств:

До v1.4
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,
}*/

С v1.4
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

Свойства

Свойство editorShape теперь поддерживает параметр dateRange:

До v1.3
        {
            type: "date",
            key: "start_date",
            label: "Start date"
        },
        // другие параметры

С v1.3
        {
            type: "dateRange", // либо можно использовать тип "date"
            key: {
                start: "start_date",
                end: "end_date"
            },
            label: "Date Range"
        },
        // другие параметры

Свойство items тулбара теперь включает "undo" и "redo":

До v1.3
items: [
    "search",
    "spacer",
    "sort",
    "addColumn",
    "addRow"
]

С v1.3
items: [
    "search",
    "spacer",
    "undo",
    "redo",
    "sort",
    "addColumn",
    "addRow"
]

Методы

Метод updateCard() теперь принимает дополнительную опцию:

До v1.3
updateCard({
    id: 1,
    card: {
        label: "New Label",
        row: "feature",
        column: "inprogress",
        /*другие параметры*/
    }
});

С v1.3
updateCard({
    id: 1,
    card: {
        label: "New Label",
        row: "feature",
        column: "inprogress",
        /*другие параметры*/
    },
    replace: true
});

Метод updateColumn() также поддерживает новый аргумент:

До v1.3
updateColumn({
    id: "backlog",
    column: {
        label: "Updated column",
        limit: 3,
        strictLimit: 3,
        collapsed: true
    }
});

С v1.3
updateColumn({
    id: "backlog",
    column: {
        label: "Updated column",
        limit: 3,
        strictLimit: 3,
        collapsed: true
    },
    replace: true
});

Метод updateRow() теперь включает опцию replace:

До v1.3
updateRow({
    id: "feature",
    row: {
        label: "Updated row",
        collapsed: true
    },
});

С v1.3
updateColumn({
    id: "feature",
    row: {
        label: "Updated row",
        collapsed: true
    },
    replace: true
});

1.1 -> 1.2

Api

Свойства

Свойство cardShape было улучшено:
- для параметра menu

До v1.2
    menu: true,
    //или
    menu: { show: true }
    // другие параметры

С v1.2
    menu: 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.2
    users: {
        show: true,
        values: [
            {
                id: 1,
                label: "John Smith",
                path: "../assets/user.jpg"
            },
        ]
    },
    // другие параметры

С v1.2
    users: {
        show: true,
        values: [
            {
                id: 1,
                label: "John Smith",
                avatar: "../assets/user.jpg"
            },
        ]
    },
    // другие параметры

для параметров start_date и end_date

До v1.2
    start_date: true,
    end_date: true,
    // другие параметры

С v1.2
    start_date: {
        show: true,
        format: "%d.%m.%Y"
    },
    end_date: {
        show: true,
        format: "%d.%m.%Y"
    },
    // другие параметры

Свойство editorShape теперь использует "avatar" вместо "path":

До v1.2
{
    type: "multiselect",
    key: "users",
    label: "Users",
    values: [
        {
            id: 1, label: "Alan",
            path: "preview_image_path_1.png"
        },
    ]
},
// настройки других полей

С v1.2
{
    type: "multiselect",
    key: "users",
    label: "Users",
    values: [
        {
            id: 1, label: "Alan",
            avatar: "preview_image_path_1.png"
        },
    ]
},
// настройки других полей

Свойство items тулбара получило новые возможности:

До v1.2
items: [
    "search",
    "controls"
]

С v1.2
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 теперь немного отличаются:

До v1.2
setLocale(kanban.en); // сбросить стандартную локаль

С v1.2
setLocale(null); // сбросить стандартную локаль

Метод api.getReactiveState() в Kanban теперь возвращает больше свойств состояния:

До v1.2
api.getReactiveState();
// метод возвращает объект со следующими свойствами
/*{
    dragItemId: {
        subscribe: any,
        update: any,
        set: any
    },
    before: {...},
    overAreaId: {...},
    overAreaMeta: {...},
    dropAreaItemsCoords: {...},
    dropAreasCoords: {...},
    dragItemsCoords: {...},
    selected: {...}
}*/

С v1.2
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 теперь возвращает более детальный объект состояния:

До v1.2
api.getState();
// метод возвращает объект со следующими свойствами
/*{
    dragItemId: string | number,
    before: string | number,
    overAreaId: string | number,
    overAreaMeta: object,
    dropAreaItemsCoords: array,
    dropAreasCoords: array,
    dragItemsCoords: array,
    selected: array
}*/

С v1.2
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 теперь возвращает только стор состояния:

До v1.2
api.getStores();
// метод возвращает объект со следующими stores
/*{
    state: StateStore, // ( object )
    data: DataStore // ( object )
}*/

С v1.2
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"
    }
};

С 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.

До v1.1
const columns = [
    {
        label: "Backlog",
        id: "backlog"
    }, ...
];

С v1.1
const columns = [
    {
        label: "Backlog",
        id: "backlog",
        collapsed: true,
        limit: 3,
        strictLimit: true
    }, ...
];

new kanban.Kanban("#root", {
    columns,
    // другие параметры
});

Параметр color в cardShape был изменён.

До v1.1
const cardShape = {
    color: {
        show: true,
        values: [
            { id: 1, color: "#65D3B3", label: "red" },
            { id: 2, color: "#FFC975", label: "green" }
        ]
    }
};

С v1.1
const cardShape = {
    color: {
        show: true,
        values: ["#65D3B3", "#FFC975", "#58C3FE"]
    }
};

new kanban.Kanban("#root", {
    cardShape
    // другие параметры
});

Методы

Метод addColumn (и событие add-column) теперь инициализируется иначе:

До v1.1
addColumn(column_data_object);

С v1.1
addColumn({
    id: "backlog",
    column: {
        label: "Backlog",
        collapsed: false,
        ...
    }
});

Метод addRow (и событие add-row) также обновился:

До v1.1
addRow(row_data_object);

С v1.1
addRow({
    id: "feature",
    row: {
        label: "Feature",
        collapsed: false,
        ...
    }
});

Метод updateColumn (и событие update-column) изменился следующим образом:

До v1.1
updateColumn(column_data_object);

С v1.1
updateColumn({
    id: "backlog",
    column: {
        label: "Backlog",
        collapsed: true,
        ...
    }
});

Метод updateRow (и событие update-row) также имеет обновлённый формат:

До v1.1
updateRow(row_data_object);

С v1.1
updateRow({
    id: "feature",
    row: {
        label: "Feature",
        collapsed: true,
        ...
    }
});

Метод updateCard (и событие update-card) теперь задаётся так:

До v1.1
updateCard(card_data_object);

С v1.1
updateCard({
    id: 1,
    card: {
        label: "Volvo XC 70",
        progress: 26
        ...
    }
});

Метод parse теперь работает без необходимости сбрасывать начальные данные:

До v1.1
// необходимо сбросить начальные данные перед парсингом новых
const board = new kanban.Kanban("#root", {
    columns: [],
    cards: [],
    rows: []
});

board.parse({
    columns,
    cards,
    rows
});

С v1.1
// сбрасывать начальные данные перед парсингом новых не требуется
const board = new kanban.Kanban("#root", {});

board.parse({
    columns,
    cards,
    rows
});

1.5.13 -> 1.6.0​

1.5.12 -> 1.5.13​

1.5.6 -> 1.5.7​

Api​

Методы​

1.4 -> 1.5​

Api​

Свойства​

1.3 -> 1.4​

Api​

Свойства​

Методы​

1.2 -> 1.3​

Api​

Свойства​

Методы​

1.1 -> 1.2​

Api​

Свойства​

Методы​

Локализация​

1.0 -> 1.1​

Api​

Свойства​

Методы​

1.5.13 -> 1.6.0

1.5.12 -> 1.5.13

1.5.6 -> 1.5.7

Api

Методы

1.4 -> 1.5

Api

Свойства

1.3 -> 1.4

Api

Свойства

Методы

1.2 -> 1.3

Api

Свойства

Методы

1.1 -> 1.2

Api

Свойства

Методы

Локализация

1.0 -> 1.1

Api

Свойства

Методы