{"id":13445578,"url":"https://github.com/carstenschaefer/DrawerJs","last_synced_at":"2025-03-20T21:30:55.042Z","repository":{"id":27217632,"uuid":"111986116","full_name":"carstenschaefer/DrawerJs","owner":"carstenschaefer","description":"A customizable WYSIWYG HTML canvas editor.","archived":false,"fork":false,"pushed_at":"2022-09-08T03:05:05.000Z","size":6938,"stargazers_count":548,"open_issues_count":39,"forks_count":137,"subscribers_count":28,"default_branch":"master","last_synced_at":"2024-02-15T15:35:29.066Z","etag":null,"topics":["canvas-api","editor","html5-canvas","javascript","wysiwyg-editor","wysiwyg-js-editor"],"latest_commit_sha":null,"homepage":"https://www.drawerjs.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/carstenschaefer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-25T07:45:12.000Z","updated_at":"2024-01-23T01:58:54.000Z","dependencies_parsed_at":"2023-01-14T08:30:41.080Z","dependency_job_id":null,"html_url":"https://github.com/carstenschaefer/DrawerJs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carstenschaefer%2FDrawerJs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carstenschaefer%2FDrawerJs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carstenschaefer%2FDrawerJs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carstenschaefer%2FDrawerJs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/carstenschaefer","download_url":"https://codeload.github.com/carstenschaefer/DrawerJs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221807738,"owners_count":16883639,"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":["canvas-api","editor","html5-canvas","javascript","wysiwyg-editor","wysiwyg-js-editor"],"created_at":"2024-07-31T05:00:36.142Z","updated_at":"2025-03-20T21:30:55.034Z","avatar_url":"https://github.com/carstenschaefer.png","language":"JavaScript","readme":"# DrawerJS\n\nDrawerJS is a HTML5 widget that allows drawing and writing on HTML5 canvas elements. Mobile devices are fully supported. \n\nIt is a customizable WYSIWYG HTML canvas editor for freehand drawing and creating sketches with simple shapes.\n\n## What is DrawerJs? How can I use it?\n\nHere you will find more informations about features and a short faq: [DrawerJs](https://www.DrawerJs.com)\n\nAnd here you'll find some examples and you can test it live: [DrawerJs on GitHub](https://carstenschaefer.github.io/DrawerJs/)\n\nHere you will find a detailed documentation about the usage and its configuration: [DrawerJs-Docs](https://github.com/carstenschaefer/DrawerJs/wiki)\n\n## Release Notes\n\nHere are the release notes of the deployment since 2015: [DrawerJs-Release Notes](https://www.drawerjs.com/release-notes)\n\n## Contribute?\n\nIf you want to contribute or just help with PR, please contact me!\n\n## Do you know our other JavaScript library?\n\nCheck out our imager uploader [ImagerJs](https://www.imagerjs.com)!\n\n\n# Documentation:\n\n[Distribution versions](#plugin-versions)\n\n[Configuration options](#configuration)\n\n[Development environment setup](#development-how-to)\n\n[Source code files and build system overview](./ARCHITECTURE-DIRECTORIES.md)\n\n[Source code architecture overview](./ARCHITECTURE.md)\n\n## Plugin versions\n\nThis plugin distributes in two versions:\n\n### Redactor editor plugin\n\nCould be embedded to page as follows:\n\n    \u003clink rel=\"stylesheet\" href=\"dist/drawerJs.css\"/\u003e\n\n    \u003cscript src=\"dist/drawerJs.redactor.js\"\u003e\u003c/script\u003e\n\n    \u003c!-- or minified version: --\u003e\n\n    \u003cscript src=\"dist/drawerJs.redactor.min.js\"\u003e\u003c/script\u003e\n\nFor information about how to build everything to the `dist` folder please see [Development how-to](#development-how-to)\n\nThen `drawer` name could be provided to redactor's config into the `plugins` section:\n\n    $('.redactor').redactor({\n        buttons: [\n            'bold',\n            'html',\n            'image'\n        ],\n        plugins: [\n            'video',\n            'drawer', // \u003c\u003c here we specify that redactor should load this plugin\n            'opensave',\n            'contexttoolbar'\n        ],\n        drawer: {\n            // drawer config section here\n            activeColor: '#19A6FD' // default drawing color\n        }\n    });\n\nFor working example please see `demo` folder.\n\nFor more information about drawer config section please see [Configuration](#configuration)\n\n### Standalone version\n\nCould be embedded to page as follows:\n\n    \u003clink rel=\"stylesheet\" href=\"dist/drawerJs.css\"/\u003e\n\n    \u003cscript src=\"dist/drawerJs.standalone.js\"\u003e\u003c/script\u003e\n\n    \u003c!-- or minified version: --\u003e\n\n    \u003cscript src=\"dist/drawerJs.standalone.min.js\"\u003e\u003c/script\u003e\n\nFor information about how to build everything to the `dist` folder please see [Development how-to](#development-how-to)\n\nThen drawer could be appended to any html container like this:\n\n    var canvas = new DrawerJs.Drawer(null, {\n        // drawer config section here\n        activeColor: '#19A6FD' // default drawing color\n    }, 600, 600); // height and width of drawer will be 600x600\n\n    $('#some_id').append(canvas.getHtml());\n    canvas.onInsert();\n\nWhere `#some_id` is any DOM element id.\n\nFor working example please see `examples/standalone` folder.\n\nFor more information about drawer config section please see [Configuration](#configuration)\n\n## Configuration\n\nWhen you finish with [setting up development environment](#development-how-to)\nyou will have dist folder with everything built up.\nLook there for `docs` folder, find `index.html` and open it.\n\nThen the link below will work.\n\nPlease look at [CanvasElement documentation](DrawerJs.CanvasElement.html) for options description.\n\n\n##  Development how-to:\n\nRequirements: node.js, npm, git\n\n`npm install` to install all npm/bower dependencies.\n\n`npm start` to compile everything to `dist` folder.\n\nThis will also watch for changes  in `src` directory and recompile everything.\n\n\n","funding_links":[],"categories":["Libraries","JavaScript","Repository"],"sub_categories":["Canvas draw","Editor"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarstenschaefer%2FDrawerJs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcarstenschaefer%2FDrawerJs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarstenschaefer%2FDrawerJs/lists"}