# Colaboración

- Human documentation: [https://docs.univer.ai/es-ES/guides/boards/features/collaboration](https://docs.univer.ai/es-ES/guides/boards/features/collaboration)

- Agent Markdown: [https://docs.univer.ai/es-ES/guides/boards/features/collaboration.md](https://docs.univer.ai/es-ES/guides/boards/features/collaboration.md)

- Requested language: `es-ES`

- Content language: `es-ES`

- Documentation version: `1.2.0`

- Source: [boards/features/collaboration.es-ES.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/boards/features/collaboration.es-ES.mdx)

---

#### Package metadata

```json
{
  "preset": [],
  "plugins": [
    {
      "client": "@univerjs-pro/collaboration"
    },
    {
      "client": "@univerjs-pro/collaboration-client",
      "facade": "@univerjs-pro/collaboration-client/facade",
      "locale": "@univerjs-pro/collaboration-client/locale/es-ES"
    },
    {
      "client": "@univerjs-pro/collaboration-client-ui",
      "facade": "@univerjs-pro/collaboration-client-ui/facade",
      "locale": "@univerjs-pro/collaboration-client-ui/locale/es-ES",
      "style": "@univerjs-pro/collaboration-client-ui/lib/index.css"
    }
  ],
  "license": true,
  "server": true
}
```

Permite que varios usuarios editen el mismo tablero y vean los cambios de los demás. Completa la [integración de colaboración](https://docs.univer.ai/es-ES/server/collaboration/browser-integration.md) para conectar el backend, la autenticación, los permisos y el almacenamiento; después configura la [licencia](https://docs.univer.ai/es-ES/server/license.md).

## Configurar y cargar un documento

Añade la configuración del cliente Collaboration a tu editor Boards existente siguiendo el [inicio rápido de Office](https://docs.univer.ai/es-ES/server/collaboration/quick-start.md). Ese ejemplo usa Sheets; tu backend debe crear y guardar un documento Boards y devolver su ID al navegador.

Establece el usuario actual antes de cargar el documento. Consulta [Integración de colaboración](https://docs.univer.ai/es-ES/server/collaboration/browser-integration.md).

```ts
import '@univerjs-pro/boards/facade'
import { UserManagerService } from '@univerjs/core'
import '@univerjs-pro/collaboration-client/facade'

univer.__getInjector().get(UserManagerService).setCurrentUser({ userID, name, avatar })

const document = await univerAPI.getCollaboration().loadBoardAsync('your-document-id')
if (!document) throw new Error('Document could not be loaded')
```

Reutiliza el mismo ID al volver a abrir o compartir el documento. No crees un documento local vacío en lugar de cargar el documento del servidor.

Usa [estado, reenvíos y recuperación de conflictos](https://docs.univer.ai/es-ES/server/collaboration/browser-integration.md#sync-status) para indicar el guardado y proteger cambios sin confirmar antes de recargar.

## Eliminación de la carga integrada por URL de documentos colaborativos

> [!WARNING: Nota]
> A partir de la versión **1.2.0**, Univer ha eliminado la carga integrada por URL de documentos colaborativos. Ya no lee automáticamente los parámetros `unit` y `type` de la URL para cargar un documento colaborativo.

Si tu aplicación depende de este comportamiento, puedes recuperarlo mediante un plugin personalizado.

### Integrar el plugin personalizado

Copia los cuatro archivos siguientes en tu proyecto con esta estructura de directorios:

```text
custom-url-load/
├── plugin.ts
├── controllers/
│   └── data-loader.controller.ts
└── services/
    ├── url.service.ts
    └── web-url.service.ts
```

Después de inicializar el editor y los plugins de colaboración, establece el usuario actual antes de registrar `CustomUrlLoadPlugin`.

```ts
import { UserManagerService } from '@univerjs/core'
import { CustomUrlLoadPlugin } from './custom-url-load/plugin'

univer.__getInjector().get(UserManagerService).setCurrentUser({ userID, name, avatar })

univer.registerPlugin(CustomUrlLoadPlugin)
```

Una vez registrado, el plugin carga el documento, por lo que no necesitas llamar a `loadBoardAsync()` para el mismo documento. Si tu aplicación ya carga documentos mediante la Facade, puedes mantener el enfoque de la sección anterior y gestionar las URL según las necesidades de tu aplicación.

### Código completo del plugin

#### plugin.ts

```ts
import { UniverCollaborationClientPlugin } from '@univerjs-pro/collaboration-client'
import { DependentOn, Inject, Injector, Plugin } from '@univerjs/core'
import { CollaborationDataLoaderController } from './controllers/data-loader.controller'
import { IURLService } from './services/url.service'
import { WebURLService } from './services/web-url.service'

@DependentOn(UniverCollaborationClientPlugin)
export class CustomUrlLoadPlugin extends Plugin {
  static override pluginName = 'CUSTOM_URL_LOAD_PLUGIN'

  constructor(
    _config: undefined,
    @Inject(Injector) protected override readonly _injector: Injector
  ) {
    super()
  }

  override onStarting(): void {
    this._injector.add([IURLService, { useClass: WebURLService }])
    this._injector.add([CollaborationDataLoaderController])

    this.disposeWithMe(this._injector.get(IURLService))
    this.disposeWithMe(this._injector.get(CollaborationDataLoaderController))
  }
}
```

#### controllers/data-loader.controller.ts

```ts
import { DataLoaderService } from '@univerjs-pro/collaboration-client'
import { ILogService, Inject, RxDisposable } from '@univerjs/core'
import { IURLService } from '../services/url.service'

/**
 * Carga un documento colaborativo desde los parámetros de la URL.
 */
export class CollaborationDataLoaderController extends RxDisposable {
  constructor(
    @IURLService private readonly _urlService: IURLService,
    @ILogService private readonly _logService: ILogService,
    @Inject(DataLoaderService) private readonly _dataLoaderService: DataLoaderService
  ) {
    super()

    const unitId = this._urlService.getParam('unit')
    const type = this._urlService.getParam('type')
    if (!unitId || !type) {
      return
    }

    this._dataLoaderService.loadUnit(unitId, Number(type))
      .catch((error: unknown) => {
        this._logService.error('[CollaborationDataLoaderController]', error)
      })
  }
}
```

#### services/url.service.ts

```ts
import type { IDisposable } from '@univerjs/core'
import type { Observable } from 'rxjs'
import { createIdentifier } from '@univerjs/core'

export interface IURLService extends IDisposable {
  getParam: (key: string) => string | undefined
  setParam: (key: string, value: string, useReplace?: boolean) => void
  removeParam: (key: string, useReplace?: boolean) => void
  readonly urlChange$: Observable<void>
}

export const IURLService = createIdentifier<IURLService>('demo.custom-url-load.url-service')
```

#### services/web-url.service.ts

```ts
import type { IURLService } from './url.service'
import { RxDisposable } from '@univerjs/core'
import { fromEvent, map, shareReplay, takeUntil } from 'rxjs'

export class WebURLService extends RxDisposable implements IURLService {
  readonly urlChange$ = fromEvent(window, 'popstate').pipe(
    map(() => undefined),
    takeUntil(this.dispose$),
    shareReplay({ bufferSize: 1, refCount: true })
  )

  getParam(key: string): string | undefined {
    return new URL(window.location.href).searchParams.get(key) ?? undefined
  }

  setParam(key: string, value: string, useReplace = false): void {
    const url = new URL(window.location.href)
    url.searchParams.set(key, value)
    this._updateUrl(url, useReplace)
  }

  removeParam(key: string, useReplace = false): void {
    const url = new URL(window.location.href)
    url.searchParams.delete(key)
    this._updateUrl(url, useReplace)
  }

  private _updateUrl(url: URL, useReplace: boolean): void {
    if (useReplace) {
      window.history.replaceState(window.history.state, '', url.toString())
    } else {
      window.history.pushState(window.history.state, '', url.toString())
    }
  }
}
```

## Verificar la sincronización y los permisos

Abre el mismo ID en dos sesiones independientes del navegador. Edita texto o mueve un elemento en una sesión y comprueba la otra. Verifica que el contenido persista tras recargar la página, reconectar y reiniciar el servicio. Usa cuentas de solo lectura y sin autorización para comprobar que el servidor rechaza las lecturas y escrituras no permitidas.

El [historial de edición](https://docs.univer.ai/es-ES/guides/boards/features/edit-history.md) y la [importación y exportación](https://docs.univer.ai/es-ES/guides/boards/features/import-export.md) requieren una configuración independiente; la colaboración no los activa automáticamente.