{"id":13449808,"url":"https://github.com/cudr/slate-collaborative","last_synced_at":"2025-03-22T22:33:58.389Z","repository":{"id":43332726,"uuid":"212967191","full_name":"cudr/slate-collaborative","owner":"cudr","description":"slatejs collaborative plugin \u0026 microservice https://slate-collaborative.herokuapp.com/","archived":false,"fork":false,"pushed_at":"2023-12-14T17:42:11.000Z","size":194,"stargazers_count":384,"open_issues_count":21,"forks_count":45,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-18T01:49:51.050Z","etag":null,"topics":["automerge","collaboration","collaborative-editing","crdt","react","rich-text-editor","slate","slatejs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/cudr.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"License.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-10-05T08:25:29.000Z","updated_at":"2025-02-20T13:32:16.000Z","dependencies_parsed_at":"2024-01-16T07:21:43.682Z","dependency_job_id":"ceb9dec1-be5c-40a5-8151-7d60befa2729","html_url":"https://github.com/cudr/slate-collaborative","commit_stats":{"total_commits":79,"total_committers":8,"mean_commits":9.875,"dds":"0.25316455696202533","last_synced_commit":"f65ab040eecc3f871bc007badddb939a8bee49e2"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cudr%2Fslate-collaborative","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cudr%2Fslate-collaborative/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cudr%2Fslate-collaborative/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cudr%2Fslate-collaborative/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cudr","download_url":"https://codeload.github.com/cudr/slate-collaborative/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244852677,"owners_count":20521155,"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":["automerge","collaboration","collaborative-editing","crdt","react","rich-text-editor","slate","slatejs"],"created_at":"2024-07-31T06:00:57.477Z","updated_at":"2025-03-22T22:33:57.961Z","avatar_url":"https://github.com/cudr.png","language":"TypeScript","funding_links":[],"categories":["Running the update","Editor","📦 Legacy \u0026 Inactive Projects"],"sub_categories":["By Popularity"],"readme":"# slate-collaborative. Check [demo](https://slate-collaborative.herokuapp.com/)\nslatejs collaborative plugin \u0026amp; microservice\n\n![screencast2019-10-2820-06-10](https://user-images.githubusercontent.com/23132107/67700384-ebff7280-f9be-11e9-9005-6ddadcafec47.gif)\n\nA little experiment for co-editing.\n\nBased on idea of https://github.com/humandx/slate-automerge\n\n# API\n\n## Client\n\nUse it as a simple slatejs plugin\n\n```ts\nimport { withIOCollaboration } from '@slate-collaborative/client'\n\nconst collaborationEditor = withIOCollaboration(editor, options)\n```\n\nCheck [detailed example](https://github.com/cudr/slate-collaborative/blob/master/packages/example/src/Client.tsx)\n\n### Options:\n```ts\n{\n  docId?: // document id\n  url?: string // url to open connection\n  connectOpts?: SocketIOClient.ConnectOpts // socket.io-client options\n  cursorData?: any // any data passed to cursor\n  onConnect?: () =\u003e void // connect callback\n  onDisconnect?: () =\u003e void // disconnect callback\n  onError?: (reason: string) =\u003e void // error callback\n  preserveExternalHistory?: boolean // preserve slate-history operations form other clients\n}\n```\n\nYou need to attach the useCursor decorator to provide custom cursor data in renderLeaf function\n\n```ts\nimport { useCursor } from '@slate-collaborative/client'\n\nconst decorator = useCursor(editor)\n```\n\n\n\n## Backend\n```ts\nconst { SocketIOConnection } = require('@slate-collaborative/backend')\n\nconst connection = new SocketIOConnection(options)\n```\n\n### options:\n```ts\n{\n  entry: Server // or specify port to start io server\n  defaultValue: Node[] // default value\n  saveFrequency: number // frequency of onDocumentSave callback execution in ms\n  onAuthRequest: ( // auth callback\n    query: Object,\n    socket?: SocketIO.Socket\n  ) =\u003e Promise\u003cboolean\u003e | boolean\n  onDocumentLoad: ( // request slate document callback\n    pathname: string,\n    query?: Object\n  ) =\u003e Promise\u003cNode[]\u003e | Node[]\n  onDocumentSave: (pathname: string, doc: Node[]) =\u003e Promise\u003cvoid\u003e | void // save document callback\n}\n```\n\n# Contribute\n\nYou welcome to contribute!\n\nstart it ease:\n```\nyarn\nyarn dev\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcudr%2Fslate-collaborative","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcudr%2Fslate-collaborative","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcudr%2Fslate-collaborative/lists"}