{"id":13403899,"url":"https://github.com/riktar/jkanban","last_synced_at":"2025-05-14T21:07:30.382Z","repository":{"id":22190244,"uuid":"95549573","full_name":"riktar/jkanban","owner":"riktar","description":"Vanilla Javascript plugin for manage kanban boards","archived":false,"fork":false,"pushed_at":"2023-10-02T18:31:22.000Z","size":391,"stargazers_count":1119,"open_issues_count":33,"forks_count":306,"subscribers_count":37,"default_branch":"master","last_synced_at":"2025-04-13T17:46:54.364Z","etag":null,"topics":["component","hacktoberfest","javascript","javascript-plugin","kanban","kanban-board","todolist","vanilla","vanilla-js"],"latest_commit_sha":null,"homepage":"https://www.riccardotartaglia.it/jkanban/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/riktar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":["riktar"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null}},"created_at":"2017-06-27T11:06:24.000Z","updated_at":"2025-04-13T13:28:05.000Z","dependencies_parsed_at":"2023-10-21T01:15:19.410Z","dependency_job_id":null,"html_url":"https://github.com/riktar/jkanban","commit_stats":{"total_commits":131,"total_committers":19,"mean_commits":6.894736842105263,"dds":0.5419847328244275,"last_synced_commit":"963cf2031d0f2cf07e5edbe368978f59bb2e30fd"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/riktar%2Fjkanban","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/riktar%2Fjkanban/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/riktar%2Fjkanban/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/riktar%2Fjkanban/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/riktar","download_url":"https://codeload.github.com/riktar/jkanban/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254227612,"owners_count":22035669,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["component","hacktoberfest","javascript","javascript-plugin","kanban","kanban-board","todolist","vanilla","vanilla-js"],"created_at":"2024-07-30T19:01:36.050Z","updated_at":"2025-05-14T21:07:25.365Z","avatar_url":"https://github.com/riktar.png","language":"JavaScript","funding_links":["https://github.com/sponsors/riktar"],"categories":["JavaScript"],"sub_categories":[],"readme":"# jKanban\n\n\u003e Javascript plugin for Kanban boards\n\njKanban allow you to create and manage Kanban Board in your project!\n\nPlease try out the live [demo][1]!\n\n[1]: http://www.riccardotartaglia.it/jkanban/\n\n## Install\nClone the repo and use the javascript and the css files in the `dist` folder.\n\nYou have to include\n\n`\u003clink rel=\"stylesheet\" href=\"path/to/jkanban.min.css\"\u003e`\n\nand\n\n`\u003cscript src=\"path/to/jkanban.min.js\"\u003e\u003c/script\u003e`\n\nin your page and you are done.\n\n## Usage\nInit jKanban is a piece of cake!\n### `var kanban = new jKanban(options)`\n\nHere's an **overview of the default values**.\n```js\nvar kanban = new jKanban({\n    element          : '',                                           // selector of the kanban container\n    gutter           : '15px',                                       // gutter of the board\n    widthBoard       : '250px',                                      // width of the board\n    responsivePercentage: false,                                    // if it is true I use percentage in the width of the boards and it is not necessary gutter and widthBoard\n    dragItems        : true,                                         // if false, all items are not draggable\n    boards           : [],                                           // json of boards\n    dragBoards       : true,                                         // the boards are draggable, if false only item can be dragged\n    itemAddOptions: {\n        enabled: false,                                              // add a button to board for easy item creation\n        content: '+',                                                // text or html content of the board button   \n        class: 'kanban-title-button btn btn-default btn-xs',         // default class of the button\n        footer: false                                                // position the button on footer\n    },    \n    itemHandleOptions: {\n        enabled             : false,                                 // if board item handle is enabled or not\n        handleClass         : \"item_handle\",                         // css class for your custom item handle\n        customCssHandler    : \"drag_handler\",                        // when customHandler is undefined, jKanban will use this property to set main handler class\n        customCssIconHandler: \"drag_handler_icon\",                   // when customHandler is undefined, jKanban will use this property to set main icon handler class. If you want, you can use font icon libraries here\n        customHandler       : \"\u003cspan class='item_handle'\u003e+\u003c/span\u003e %title% \"  // your entirely customized handler. Use %title% to position item title \n                                                                             // any key's value included in item collection can be replaced with %key%\n    },\n    click            : function (el) {},                             // callback when any board's item are clicked\n    context          : function (el, event) {},                      // callback when any board's item are right clicked\n    dragEl           : function (el, source) {},                     // callback when any board's item are dragged\n    dragendEl        : function (el) {},                             // callback when any board's item stop drag\n    dropEl           : function (el, target, source, sibling) {},    // callback when any board's item drop in a board\n    dragBoard        : function (el, source) {},                     // callback when any board stop drag\n    dragendBoard     : function (el) {},                             // callback when any board stop drag\n    buttonClick      : function(el, boardId) {},                     // callback when the board's button is clicked\n    propagationHandlers: [],                                         // the specified callback does not cancel the browser event. possible values: \"click\", \"context\"\n})\n```\n\nNow take a look to the `boards` object\n```js\n[\n    {\n        \"id\"    : \"board-id-1\",               // id of the board\n        \"title\" : \"Board Title\",              // title of the board\n        \"class\" : \"class1,class2,...\",        // css classes to add at the title\n        \"dragTo\": ['another-board-id',...],   // array of ids of boards where items can be dropped (default: [])\n        \"item\"  : [                           // item of this board\n            {\n                \"id\"    : \"item-id-1\",        // id of the item\n                \"title\" : \"Item 1\"            // title of the item\n                \"class\" : [\"myClass\",...]     // array of additional classes\n            },\n            {\n                \"id\"    : \"item-id-2\",\n                \"title\" : \"Item 2\"\n            }\n        ]\n    },\n    {\n        \"id\"    : \"board-id-2\",\n        \"title\" : \"Board Title 2\"\n    }\n]\n```\n **WARNING: all ids are unique!**\n\n### About custom properties\njKanban also support custom properties on items to improve your applications with html data- properties. You can define them at like:\n```js\n[\n    {\n        \"id\"    : \"board-id-1\",\n        \"title\" : \"Board Title\",\n        \"item\"  : [\n            {\n                \"id\"      : \"item-id-1\",\n                \"title\"   : \"Item 1\",\n                \"username\": \"username1\"\n            },\n            {\n                \"id\"      : \"item-id-2\",\n                \"title\"   : \"Item 2\",\n                \"username\": \"username2\"\n            }\n        ]\n    }\n]\n```\nWhich jKanban will convert to:\n```html\n\u003cmain class=\"kanban-drag\"\u003e\n    \u003cdiv class=\"kanban-item\" data-eid=\"item-id-1\" data-username=\"username1\"\u003eItem 1\u003c/div\u003e\n    \u003cdiv class=\"kanban-item\" data-eid=\"item-id-2\" data-username=\"username2\"\u003eItem 2\u003c/div\u003e\n\u003c/main\u003e\n```\n\n## API\njKanban provides the easiest possible API to make your boards awesome!\n\nMethod Name           | Arguments                        | Description\n----------------------|----------------------------------|------------------------------------------------------------------------------------------------------------------------------\n`addElement`          | `boardID, element, position`     | Add `element` in the board with ID `boardID`, `element` is the standard format. If `position` is set, inserts at position starting from 0\n`addForm`             | `boardID, formItem`              | Add `formItem` as html element into the board with ID `boardID`\n`addBoards`           | `boards`                         | Add one or more boards in the kanban, `boards` are in the standard format\n`findElement`         | `id`                             | Find board's item by `id`\n`replaceElement`      | `id, element`                    | Replace item by `id` with `element` JSON standard format\n`getParentBoardID`    | `id`                             | Get board ID of item `id` passed\n`findBoard`           | `id`                             | Find board by `id`\n`getBoardElements`    | `id`                             | Get all item of a board\n`removeElement`       | `id`                             | Remove a board's element by id\n`removeBoard`         | `id`                             | Remove a board by id\n\n## Example\nClone the repo and look in the `example` folder\n\n## Thanks\njKanban use [dragula](https://github.com/bevacqua/dragula) for drag\u0026drop\n\n## Develop\nClone the repo then use `npm install` for download all the dependencies then launch `npm run build` for build the project\n\n### Pull Requests?\nI'd love them!\n\n### Comments?\nLet's hear them! (The nice ones please!)\n\n### Me?\nIn case you're interested I'm [@riktarweb](http://twitter.com/riktarweb)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friktar%2Fjkanban","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Friktar%2Fjkanban","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friktar%2Fjkanban/lists"}