Skip to content

Commit

Permalink
Merge pull request #3850 from calctree/dpnova/doc/fix-collab-docs
Browse files Browse the repository at this point in the history
doc: fix registry component location and issue in plugin config docs
  • Loading branch information
zbeyens authored Dec 12, 2024
2 parents 77842e0 + 63e8a2a commit b48eb17
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 57 deletions.
6 changes: 3 additions & 3 deletions apps/www/content/docs/collaboration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ const editor = createPlateEditor({
plugins: [
// ...otherPlugins,
YjsPlugin.configure({
render: {
afterEditable: RemoteCursorOverlay,
},
options: {
render: {
afterEditable: RemoteCursorOverlay,
},
cursorOptions: {
autoSend: true,
data: { name: 'A plate user', color: '#5AC990' },
Expand Down
46 changes: 23 additions & 23 deletions apps/www/public/r/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -1476,29 +1476,6 @@
"registryDependencies": [],
"type": "registry:ui"
},
{
"dependencies": [
"@slate-yjs/react"
],
"doc": {
"description": "A cursor overlay to display multiplayer cursors in the yjs plugin.",
"docs": [
{
"route": "/docs/collaboration"
}
],
"examples": []
},
"files": [
{
"path": "plate-ui/remote-cursor-overlay.tsx",
"type": "registry:ui"
}
],
"name": "remote-cursor-overlay",
"registryDependencies": [],
"type": "registry:ui"
},
{
"dependencies": [
"@udecode/plate-ai",
Expand Down Expand Up @@ -3032,5 +3009,28 @@
"transforms"
],
"type": "registry:ui"
},
{
"dependencies": [
"@slate-yjs/react"
],
"doc": {
"description": "A cursor overlay to display multiplayer cursors in the yjs plugin.",
"docs": [
{
"route": "/docs/collaboration"
}
],
"examples": []
},
"files": [
{
"path": "plate-ui/remote-cursor-overlay.tsx",
"type": "registry:ui"
}
],
"name": "remote-cursor-overlay",
"registryDependencies": [],
"type": "registry:ui"
}
]
32 changes: 16 additions & 16 deletions apps/www/src/__registry__/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -877,22 +877,6 @@ export const Index: Record<string, any> = {
subcategory: "",
chunks: []
},
"remote-cursor-overlay": {
name: "remote-cursor-overlay",
description: "",
type: "registry:ui",
registryDependencies: [],
files: [{
path: "src/registry/default/plate-ui/remote-cursor-overlay.tsx",
type: "registry:ui",
target: ""
}],
component: React.lazy(() => import("@/registry/default/plate-ui/remote-cursor-overlay.tsx")),
source: "",
category: "",
subcategory: "",
chunks: []
},
"ai-menu": {
name: "ai-menu",
description: "",
Expand Down Expand Up @@ -1737,6 +1721,22 @@ export const Index: Record<string, any> = {
subcategory: "",
chunks: []
},
"remote-cursor-overlay": {
name: "remote-cursor-overlay",
description: "",
type: "registry:ui",
registryDependencies: [],
files: [{
path: "src/registry/default/plate-ui/remote-cursor-overlay.tsx",
type: "registry:ui",
target: ""
}],
component: React.lazy(() => import("@/registry/default/plate-ui/remote-cursor-overlay.tsx")),
source: "",
category: "",
subcategory: "",
chunks: []
},
"editor-plugins": {
name: "editor-plugins",
description: "",
Expand Down
30 changes: 15 additions & 15 deletions apps/www/src/registry/registry-ui.ts
Original file line number Diff line number Diff line change
Expand Up @@ -874,6 +874,21 @@ import { withDraggables } from './withDraggables';`,
registryDependencies: ['dropdown-menu', 'toolbar', 'transforms'],
type: 'registry:ui',
},
{
dependencies: ['@slate-yjs/react'],
doc: {
description:
'A cursor overlay to display multiplayer cursors in the yjs plugin.',
docs: [{ route: '/docs/collaboration' }],
examples: [],
},
files: [
{ path: 'plate-ui/remote-cursor-overlay.tsx', type: 'registry:ui' },
],
name: 'remote-cursor-overlay',
registryDependencies: [],
type: 'registry:ui',
},
];

export const uiNodes: Registry = [
Expand Down Expand Up @@ -1723,21 +1738,6 @@ export const uiPrimitives: Registry = [
registryDependencies: [],
type: 'registry:ui',
},
{
dependencies: ['@slate-yjs/react'],
doc: {
description:
'A cursor overlay to display multiplayer cursors in the yjs plugin.',
docs: [{ route: '/docs/collaboration' }],
examples: [],
},
files: [
{ path: 'plate-ui/remote-cursor-overlay.tsx', type: 'registry:ui' },
],
name: 'remote-cursor-overlay',
registryDependencies: [],
type: 'registry:ui',
},
];

export const ui: Registry = [...uiNodes, ...uiPrimitives, ...uiComponents];

0 comments on commit b48eb17

Please sign in to comment.