{"id":20915982,"url":"https://github.com/indico/ckeditor5-full-screen","last_synced_at":"2025-05-13T10:33:51.088Z","repository":{"id":59506680,"uuid":"536155679","full_name":"indico/ckeditor5-full-screen","owner":"indico","description":null,"archived":true,"fork":false,"pushed_at":"2023-07-31T15:08:00.000Z","size":929,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-22T01:04:05.292Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/indico.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":"2022-09-13T14:05:53.000Z","updated_at":"2025-01-16T23:37:51.000Z","dependencies_parsed_at":"2024-11-19T05:03:17.096Z","dependency_job_id":null,"html_url":"https://github.com/indico/ckeditor5-full-screen","commit_stats":{"total_commits":9,"total_committers":2,"mean_commits":4.5,"dds":0.4444444444444444,"last_synced_commit":"47e7c97ecc05d71fb605dc355cd968e6d05d4600"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indico%2Fckeditor5-full-screen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indico%2Fckeditor5-full-screen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indico%2Fckeditor5-full-screen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indico%2Fckeditor5-full-screen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/indico","download_url":"https://codeload.github.com/indico/ckeditor5-full-screen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253923192,"owners_count":21984853,"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":[],"created_at":"2024-11-18T16:19:13.656Z","updated_at":"2025-05-13T10:33:50.798Z","avatar_url":"https://github.com/indico.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CKEditor 5 full screen plugin\n\n![](assets/fullscreen.png)\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"assets/fullscreen-icon.png\" /\u003e\n\u003c/p\u003e\n\nIcon thanks to [css.gg](https://github.com/astrit/css.gg).\n\n## Description\n\nThis plugin provides a full screen mode for ckeditor 5. The plugin adds a button to the editor toolbar which can be used to toggle between the normal ckeditor and the full screen mode. To exit the full screen mode, it is also possible to press escape or click anywhere in the background (See [configuration](#configuration)).\n\n## Installation\n\nVia npm:\n\n```bash\nnpm i ckeditor5-full-screen\n```\n\n### Add the plugin to ckeditor:\n\nIf using a predefined build:\n\n```js\nimport FullScreen from \"ckeditor5-full-screen/src/fullscreen\";\n\nEditor.builtinPlugins = [\n  // ...\n  FullScreen,\n];\n\nEditor.defaultConfig = {\n  toolbar: {\n    items: [\n      // ...\n      \"fullscreen\", // Add the toolbar button\n    ],\n  },\n};\n```\n\nIf building from source:\n\n```js\nimport FullScreen from \"ckeditor5-full-screen/src/fullscreen\";\n\nEditor.create(element, {\n  plugins: [FullScreen],\n  toolbar: [\"fullscreen\"],\n})\n  .then((editor) =\u003e {\n    // ...\n  })\n  .catch((error) =\u003e {\n    // ...\n  });\n```\n\nMore information about installing plugins can be found in the official [documentation](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/installing-plugins.html\n).\n\n## Configuration\n\n| Name                       | Default value | Description                                                                            |\n| -------------------------- | ------------- | -------------------------------------------------------------------------------------- |\n| `fullscreen.closeOnEscape` | `true`        | If set to `true`, exits the full screen mode when escape is pressed.                   |\n| `fullscreen.closeOnClick`  | `true`        | If set to `true`, exits the full screen mode when clicking anywhere in the background. |\n\n### Example\n\n```js\nEditor.defaultConfig = {\n  // ...\n  fullscreen: {\n    closeOnEscape: true,\n    closeOnClick: false,\n  },\n};\n```\n\n```js\nEditor.create(element, {\n  // ...\n  fullscreen: {\n    closeOnEscape: true,\n    closeOnClick: false,\n  },\n});\n```\n\n## Development\n\nIgnore this if you just want to use this package.\n\nIf you want to run ckeditor locally using e.g. https://github.com/indico/ckeditor,\nyou can install this package directly:\n\n`npm install $(npm pack /path/to/the/package | tail -1)`\n\nJust using `npm install /path/to/the/package` doesn't work because npm symlinks the package instead of copying it. This will cause duplicated packages when bundling the editor with webpack (this [error](https://ckeditor.com/docs/ckeditor5/latest/support/error-codes.html#error-ckeditor-duplicated-modules)). The fix is to create a zipped package with `npm pack` first and installing that one instead.\n\nUseful SO links:\n\n- https://stackoverflow.com/a/53215430\n- https://stackoverflow.com/a/45016447\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findico%2Fckeditor5-full-screen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Findico%2Fckeditor5-full-screen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findico%2Fckeditor5-full-screen/lists"}