{"_id":"@convergencelabs/ace-collab-ext","_rev":"2-67c52db24e75b8f16ca049cba5dcd161","name":"@convergencelabs/ace-collab-ext","dist-tags":{"latest":"0.6.0"},"versions":{"0.5.0":{"name":"@convergencelabs/ace-collab-ext","version":"0.5.0","title":"Ace Editor Collaborative Extensions","description":"Collaborative Extensions for the Ace Editor","keywords":["collaboration","ace","editor"],"homepage":"http://convergencelabs.com","author":{"name":"Convergence Labs","email":"info@convergencelabs.com","url":"http://convergencelabs.com"},"contributors":[],"repository":{"type":"git","url":"git+https://github.com/convergencelabs/ace-collab-ext.git"},"bugs":{"url":"https://github.com/convergencelabs/ace-collab-ext/issues"},"license":"MIT","main":"lib/index.js","typings":"typings/index.d.ts","publishConfig":{"registry":"https://registry.npmjs.org/","access":"public"},"dependencies":{"ace-builds":"^1.4.8"},"devDependencies":{"@babel/cli":"7.8.4","@babel/core":"7.8.7","@babel/node":"7.8.7","@babel/preset-env":"7.8.7","@babel/preset-stage-3":"7.8.3","@babel/preset-typescript":"7.8.3","@babel/register":"7.8.6","babel-plugin-module-resolver":"4.0.0","del":"5.1.0","gulp":"4.0.2","gulp-bump":"3.1.3","gulp-clean-css":"4.2.0","gulp-header":"2.0.9","gulp-insert":"0.5.0","gulp-rename":"2.0.0","gulp-sourcemaps":"2.6.5","gulp-typescript":"6.0.0-alpha.1","gulp-uglify-es":"2.0.0","ts-loader":"6.2.1","tslint":"6.1.0","typescript":"3.8.3","webpack":"4.42.0","webpack-stream":"5.2.1"},"scripts":{"dist":"gulp dist","clean":"gulp clean"},"_id":"@convergencelabs/ace-collab-ext@0.5.0","_nodeVersion":"12.14.0","_npmVersion":"6.14.2","dist":{"integrity":"sha512-qrekoqRNfK6tqwy4vQqdas/T06QwcNdZ/kFYTfTHDZvRTyiFfXT0i94yC94dnO848hT2u3QbJxISv5JaY34XJw==","shasum":"3f3b5501eb81d1031498d311020e916095c2bcf5","tarball":"https://registry.npmjs.org/@convergencelabs/ace-collab-ext/-/ace-collab-ext-0.5.0.tgz","fileCount":31,"unpackedSize":137892,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJebQFyCRA9TVsSAnZWagAA/koP/3DsF/tgkedRZq/eEjZ2\n+5NYWfRszipH/fq4nq/m46bTnjT9zF8p4cMBSFkgdl10PjiZeCosB1yDf/UW\nGefW12bCvmIXNBOAFTNyXvY/WEW/NivMXRVruj9KQR+XHQAIWyFgurObZeeZ\nO7AMJXLwZP9eZhVDp/nSGefpDOpjXKYDi7hs6XZgTlDF0qOoua3XeAMacKl7\n+rKsxLU7We6UZVXpuvUjBG1kdkfqAptFAb7dYcHrjJRoDGvrbYFjO9EiXVrq\nY8TFMMC2hOkbhMGC6Ym+Q8llaf9sXeZ1xVLDjgCHC8Ymw4AVBXlOvmUye94N\nsxZp2nkK8K2vyywGH8C4Yh3Ws5mcoD2SzYgUqZmAfETXqZT6Ha1UAeW6NuDr\nlw2o+m4S6VCmM6RQ4MerslgLe5wJbNyrSKI3k+CpQiBC2xinZfgn606Cmhbt\nL8X4qC32sIG3VMnpS9QXb2Az0gg0qkH5t99o87c4u9eO+bqlgrShu0CcA/xj\nuMGqJ8jVM5MRj/7Se0jb3BPU57DIaGn/8gGbq3DI8KF0LYh7pZWNL7St7SKm\nbh/CiXbAiYMKNwqOfuBJNvMZwm2eBIg8VPoociDGeBvxiLH1N+2LTC2SQovn\nWAcJPMVlpU85dBkkkd0ScRHc6sYfFvUeIML8p0u4XTVgKdMS/lOTY/eqE37D\nAAxb\r\n=u3wT\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCRaYToYkbcKTbBihk6EOKRY6lQezEDObh/0ZLWTKCDCAIhAM0SMcIKUw6Y/SDsnnU/cyu9S5IBGMk8EtSPRq8YS/Gn"}]},"maintainers":[{"name":"alalonde","email":"alec@boxelderweb.com"},{"name":"convergence","email":"sysadmin@convergencelabs.com"},{"name":"mmacfadden","email":"michael@macfadden.org"},{"name":"convergencelabs-admin","email":"sysadmin@convergencelabs.com"}],"_npmUser":{"name":"convergence","email":"sysadmin@convergencelabs.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ace-collab-ext_0.5.0_1584202098299_0.976965183230466"},"_hasShrinkwrap":false},"0.6.0":{"name":"@convergencelabs/ace-collab-ext","version":"0.6.0","title":"Ace Editor Collaborative Extensions","description":"Collaborative Extensions for the Ace Editor","keywords":["collaboration","ace","editor"],"homepage":"http://convergencelabs.com","author":{"name":"Convergence Labs","email":"info@convergencelabs.com","url":"http://convergencelabs.com"},"contributors":[],"repository":{"type":"git","url":"git+https://github.com/convergencelabs/ace-collab-ext.git"},"bugs":{"url":"https://github.com/convergencelabs/ace-collab-ext/issues"},"license":"MIT","scripts":{"build:esm":"tsc --module ES2020 --target ES2020 --outDir dist/module","build:commonjs":"tsc --module commonjs --target es5 --outDir dist/lib","build:types":"tsc --declaration true --emitDeclarationOnly true --outDir dist/types && node ./scripts/enhance-types.js","build:umd":"rollup -c rollup.config.js","build:css":"node scripts/build-css.js","dist":"npm run build:esm && npm run build:commonjs && npm run build:umd && npm run build:types && npm run build:css","clean":"rimraf dist","prepack":"npm run dist"},"publishConfig":{"registry":"https://registry.npmjs.org/","access":"public"},"main":"dist/lib/index.js","module":"dist/module/index.js","types":"dist/types/index.d.ts","browser":"dist/umd/ace-collab-ext.js","dependencies":{"ace-builds":"^1.4.12"},"devDependencies":{"@rollup/plugin-commonjs":"19.0.0","@rollup/plugin-node-resolve":"13.0.0","@rollup/plugin-typescript":"8.2.1","@types/backbone":"1.4.1","clean-css":"^5.1.3","fs-extra":"^10.0.0","rimraf":"^3.0.2","rollup":"2.47.0","rollup-plugin-license":"2.3.0","rollup-plugin-terser":"7.0.2","tslib":"^2.3.0","typescript":"4.2.4"},"gitHead":"ee98f972a4a27656b821ac75c7734831bf1929d0","_id":"@convergencelabs/ace-collab-ext@0.6.0","_nodeVersion":"14.17.1","_npmVersion":"7.19.0","dist":{"integrity":"sha512-QizJXn66bHu688jrMD6X18YmePu0YXmL8a/4EOxMOPFepDioS34oz1TTmL7oq1AHRBhCRAxKHJao53LbqyJ8vQ==","shasum":"dc914080f84312916940ed1e0d476fed7582a691","tarball":"https://registry.npmjs.org/@convergencelabs/ace-collab-ext/-/ace-collab-ext-0.6.0.tgz","fileCount":69,"unpackedSize":312376,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg6h1jCRA9TVsSAnZWagAA18sP/RvCrXyrSxAipAUzAkeg\n6Gejcg6WHGfwAIQ5JQqs4S4Yf508ETLTOB5koqesD4eZTM1xi/fcKQynd1SI\nZwTfg+oXNHfnFLBswBzfLpVoCtz3twbm9RvrVSvwIR26Ljbf9hVMBKtwkvpw\nHJU/cjQvdNJfEr1jTCTPzTB6IHHmuQqlqRs0MTN3SIV21szOW6d2xodPYwIT\nwh7kdJdnsCi5txQoRo7t5IsEgetGwKyMjFe2/bCub5zZhu9w5iVjpXO5MTcE\n+LpPIO8nMtsFb5jfwJf3NQ1C9AF488524exwPWn4Otn+vGVr3jp1IO3nPC8q\npY3iy2cqEqaWg4ZwpfqRskcjaP9pHgjqsO28e3TX5PhXQmvXfYSFHVb9kluH\nWM424qGMcPyHi08cxp1koYCM2FhHAKCaRWnXjutGoaT8VZufK+Qw9hqAC1TV\n/Gm1jWwaJGnvXRu97xhSLQ6idN2/aEQEaPykB6xNB6Xeyhu70yF1LpCJEER2\n2E/mg661jF/jK8mpYR+mLmv5TlGNeAVsok+T6jm1KYFx3U3OGbxdUwA27eHX\nsIJgNfWt9ozx3N/h9ErX60a4vqcrxg5Eqfu6Gc4EU/GP2uooMFmyVot7NPmA\n5Uf53zVFT2VKH2zFbgtR4j1+9layODj8aaMgZ0+kX1zRYyUlweGqdUMBQeYT\ngGQI\r\n=6eGH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD3w7ElH6N7tl9YQFhzPGgmhzRovQTiYz5GeXCDbvRk0AIhAJmFuFMPSVx58Z8Y0rUWHHws0st23jBrJeiWlUDXfMVZ"}]},"_npmUser":{"name":"convergence","email":"sysadmin@convergencelabs.com"},"directories":{},"maintainers":[{"name":"convergencelabs-admin","email":"sysadmin@convergencelabs.com"},{"name":"mmacfadden","email":"michael@macfadden.org"},{"name":"convergence","email":"sysadmin@convergencelabs.com"},{"name":"alalonde","email":"alec@boxelderweb.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ace-collab-ext_0.6.0_1625955682762_0.9374163605707684"},"_hasShrinkwrap":false}},"time":{"created":"2020-03-14T16:08:18.111Z","0.5.0":"2020-03-14T16:08:18.477Z","modified":"2022-04-05T01:08:57.430Z","0.6.0":"2021-07-10T22:21:22.937Z"},"maintainers":[{"name":"convergencelabs-admin","email":"sysadmin@convergencelabs.com"},{"name":"mmacfadden","email":"michael@macfadden.org"},{"name":"convergence","email":"sysadmin@convergencelabs.com"},{"name":"alalonde","email":"alec@boxelderweb.com"}],"description":"Collaborative Extensions for the Ace Editor","homepage":"http://convergencelabs.com","keywords":["collaboration","ace","editor"],"repository":{"type":"git","url":"git+https://github.com/convergencelabs/ace-collab-ext.git"},"contributors":[],"author":{"name":"Convergence Labs","email":"info@convergencelabs.com","url":"http://convergencelabs.com"},"bugs":{"url":"https://github.com/convergencelabs/ace-collab-ext/issues"},"license":"MIT","readme":"## Ace Collaborative Extensions\n[![example workflow](https://github.com/convergencelabs/ace-collab-ext/actions/workflows/build.yml/badge.svg)](https://github.com/convergencelabs/ace-collab-ext/actions/workflows/build.yml)\n\nEnhances the [Ace Editor](https://github.com/ajaxorg/ace) by adding the ability to render cues about what remote users are doing in the system.\n\n## Installation\n\nInstall package with NPM and add it to your development dependencies:\n\nFor versions >= 0.5.0 (current):\n```npm install --save-dev @convergencelabs/ace-collab-ext```\n\nFor versions <= 0.4.0 (previous):\n```npm install --save-dev @convergence/ace-collab-ext```\n\n## Demo\nGo [here](https://examples.convergence.io/examples/ace/) to see a live demo of multiple cursors, multiple selections, and remote scrollbars (Visit on multiple browsers, or even better, point a friend to it too).  This uses [Convergence](https://convergence.io) to handle the synchronization of data and user actions. \n\n## Usage\n\n### CSS\nBe sure to include one of CSS files located in the css directory of the node modules: \n\n* `css/ace-collab-ext.css`\n* `css/ace-collab-ext.min.css`\n\nHow to do this will depend on how you are packaging and distributing your application. For example if you are bundling your css / sass / less you might be able to use an `@import` statement or you might `require` it. If you are hotlinking, you might need to at a `<link>` tag to your document.\n\nIf you forget to include the styles, its likely that the remote cursors / selections will either not show up, or they will not properly move.\n\n### Multi Cursor Manager\nThe multi cursor manager allows you to easily render the cursors of other users\nworking in the same document.  The cursor position can be represented as either\na single linear index or as a 2-dimensional position in the form of\n```{row: 0, column: 10}```.\n\n```javascript\nconst editor = ace.edit(\"editor\");\nconst curMgr = new AceCollabExt.AceMultiCursorManager(editor.getSession());\n\n// Add a new remote cursor with an id of \"uid1\", and a color of orange.\ncurMgr.addCursor(\"uid1\", \"User 1\", \"orange\", {row: 0, column: 10});\n\n// Set cursor for \"uid1\" to index 10.\ncurMgr.setCursor(\"uid1\", 10);\n\n// Clear the remote cursor for \"uid1\" without removing it.\ncurMgr.clearCursor(\"uid1\");\n\n// Remove the remote cursor for \"uid1\".\ncurMgr.removeCursor(\"uid1\");\n```\n\n### Multi Selection Manager\nThe multi selection manager allows you to easily render the selection of other\nusers working in the same document. Selection is represented by an array of \nAceRanges.  A single range is common for normal selection, but multiple ranges \nare needed to support block selection.\n\n```javascript\nconst AceRange = ace.require(\"ace/range\");\n\nconst editor = ace.edit(\"editor\");\nconst selMgr = new AceCollabExt.AceMultiSelectionManager(editor.getSession());\n\n// A two-line block selection\nconst initialRanges = [\n  new AceRange(0, 0, 0, 10),\n  new AceRange(1, 0, 1, 10),\n];\n\n// Add a new remote view indicator with an id of \"uid1\", and a color of orange.\nselMgr.addSelection(\"uid1\", \"User 1\", \"orange\", initialRanges);\n\n// Set the selection to a new range.\nselMgr.setSelection(\"uid1\", new AceRange(10, 0, 11, 10));\n\n// Nullify the selection without removing the marker.\nselMgr.clearSelection(\"uid1\");\n\n// Remove the remote view indicator for \"uid1\".\nselMgr.removeSelection(\"uid1\");\n```\n\n### Radar View\nA radar view indicates where in a document another user is looking and allows\nyou to easily go to the location in the document.\n\n```javascript\nconst editor = ace.edit(\"editor\");\nconst radarView = new AceCollabExt.RadarView(\"radarView\", editor);\n\n// Add a new remote view indicator with an id of \"uid1\", and a color of orange.\nradarView.addView(\"uid1\", \"user1\", \"orange\", 0, 20, 0);\n\n// Set the viewport range of the indicator to span rows 10 through 40.\nradarView.setViewRows(\"uid1\", 10, 40);\n\n// Set the row location of the cursor to line 10.\nradarView.setCursorRow(\"uid1\", 10);\n\n// Remove the remote view indicator for \"uid1\".\nradarView.removeView(\"uid1\");\n```\n","readmeFilename":"README.md"}