{"id":22048528,"url":"https://github.com/samhammerag/ckeditor5-simple-button-plugin","last_synced_at":"2025-07-23T15:35:01.645Z","repository":{"id":96373537,"uuid":"153228389","full_name":"SamhammerAG/ckeditor5-simple-button-plugin","owner":"SamhammerAG","description":"A generic ckeditor plugin to configure toolbar-buttons from outside.","archived":false,"fork":false,"pushed_at":"2023-04-17T20:16:45.000Z","size":30,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-28T09:41:15.611Z","etag":null,"topics":["ckeditor5"],"latest_commit_sha":null,"homepage":"","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/SamhammerAG.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-16T05:38:08.000Z","updated_at":"2023-02-13T08:08:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"724a63fe-024c-4977-ad96-bc9de5c0b3c8","html_url":"https://github.com/SamhammerAG/ckeditor5-simple-button-plugin","commit_stats":{"total_commits":25,"total_committers":3,"mean_commits":8.333333333333334,"dds":"0.31999999999999995","last_synced_commit":"7b11d7f00b68a064311bd278b3c670dfc03fda1c"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamhammerAG%2Fckeditor5-simple-button-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamhammerAG%2Fckeditor5-simple-button-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamhammerAG%2Fckeditor5-simple-button-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamhammerAG%2Fckeditor5-simple-button-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SamhammerAG","download_url":"https://codeload.github.com/SamhammerAG/ckeditor5-simple-button-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227351655,"owners_count":17768412,"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":["ckeditor5"],"created_at":"2024-11-30T14:12:39.429Z","updated_at":"2024-11-30T14:12:40.148Z","avatar_url":"https://github.com/SamhammerAG.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n# ckeditor5-simple-button-plugin\n\n[![npm version](https://badge.fury.io/js/%40samhammer%2Fckeditor5-simple-button-plugin.svg)](https://www.npmjs.com/package/@samhammer/ckeditor5-simple-button-plugin)\n\nA generic ckeditor plugin to configure toolbar-buttons from outside.\n\n## Features\n\n - Simply configure ui buttons directly via the configuration object.\n - Possibility to enable those buttons even if the editor is in readonly state.\n\n## How to use\nTo be able to use this plugin you need a custom build of ckeditor.\n\nFurther instructions can be found here:\nhttps://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/installing-plugins.html\n\nInstallation:\n\n```bash\nnpm i @samhammer/ckeditor5-simple-button-plugin\n```\n\n## Configuration\n\nEach button is described with a configuration object as shown below. The `onClick` function can return a promise. The button is always disabled before the `onClick` function is called. It is enabled again after the returned promise is resolved or rejected. If no promise is returned the button is enabled again immediately. The `onClick` function receives the `ButtonView` object which makes it possible to change properties of the button (icon, tooltip or something else). The parameter `syncDisabledState` is optional and defaults to `true`. If `true` the enabled-state is always in sync with the readonly-state of the editor. If you need a button in enabled-state when the editor is readonly you have to set this parameter to `false`.\n\nExample:\n\n```js\nInlineEditor\n\t.create( editorElement, {\n\t\tsimpleButton: [\n            {\n                name: \"myFirstButton\",\n                label: \"My First button - Click me\",\n                icon: svgXmlContent,\n                syncDisabledState: false,\n                onClick: (buttonView) =\u003e { /* ... */ }\n            },\n            ...\n        ]\n\t} )\n\t.then( ... )\n\t.catch( ... );\n```\n\n\n## How to publish\n\nFor publishing an npm account that is referenced to the organization is required.\n\nSee the following how to:\n\nhttps://docs.npmjs.com/getting-started/publishing-npm-packages\n\nIf everything is configured correctly just count up the version number in our package.json and execute one of the following commands:\n\n```bash\nnpm publish --access public\n```\n\n## License\n\nckeditor5-simple-button-plugin is released under the MIT License. See LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamhammerag%2Fckeditor5-simple-button-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamhammerag%2Fckeditor5-simple-button-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamhammerag%2Fckeditor5-simple-button-plugin/lists"}