Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

allow external user name/color management #29

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

allow external user name/color management #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,16 @@ export { YRange, yRemoteSelections, yRemoteSelectionsTheme, ySync, ySyncFacet, Y
* @param {any} awareness
* @param {Object} [opts]
* @param {Y.UndoManager | false} [opts.undoManager] Set undoManager to false to disable the undo-redo plugin
* @param {((u: any) => { name: String, colorLight: String, color: String }) | false} [opts.getUserInfo] Optional fn to take user awareness state info and transform into name + color(s)
* @return {cmState.Extension}
*/
export const yCollab = (ytext, awareness, { undoManager = new Y.UndoManager(ytext) } = {}) => {
const ySyncConfig = new YSyncConfig(ytext, awareness)
export const yCollab = (ytext, awareness, { undoManager = new Y.UndoManager(ytext), getUserInfo = false } = {}) => {
const ySyncConfig = new YSyncConfig(ytext, awareness, getUserInfo)
const plugins = [
ySyncFacet.of(ySyncConfig),
ySync
]

if (awareness) {
plugins.push(
yRemoteSelectionsTheme,
Expand Down
7 changes: 5 additions & 2 deletions src/y-remote-selections.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,8 +191,11 @@ export class YRemoteSelectionsPluginValue {
if (anchor == null || head == null || anchor.type !== ytext || head.type !== ytext) {
return
}
const { color = '#30bced', name = 'Anonymous' } = state.user || {}
const colorLight = (state.user && state.user.colorLight) || color + '33'

const userColorAndName = this.conf.getUserInfo ? this.conf.getUserInfo(state.user) : state.user
const color = userColorAndName?.color || '#30bced'
const name = userColorAndName?.name || 'Anonymous'
const colorLight = userColorAndName.colorLight || color + '33'
const start = math.min(anchor.index, head.index)
const end = math.max(anchor.index, head.index)
const startLine = update.view.state.doc.lineAt(start)
Expand Down
3 changes: 2 additions & 1 deletion src/y-sync.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ import * as cmView from '@codemirror/view' // eslint-disable-line
import { YRange } from './y-range.js'

export class YSyncConfig {
constructor (ytext, awareness) {
constructor (ytext, awareness, getUserInfo) {
this.ytext = ytext
this.awareness = awareness
this.undoManager = new Y.UndoManager(ytext)
this.getUserInfo = getUserInfo
}

/**
Expand Down