Status title 릴리즈 3.0.0 이상
여러 사용자가 동시에 문서를 편집할 수 있는 실시간 협업 플러그인입니다.
사용방법
플러그인 파일 불러오기
| Code Block | ||||
|---|---|---|---|---|
| ||||
<!-- SynapEditor 객체가 존재해야 적용할 수 있기 때문에 에디터 스크립트 파일 아래에 include 해야 합니다 -->
<script src="collaboration.min.js의 url"></script> |
플러그인 설정하기
웹소켓 URL 설정
웹소켓 URL을 설정합니다. (필수)
설정을 하지 않으면 플러그인이 초기화되지 않습니다.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
//...
'collaboration.config': {
'wsUrl': 'ws://websocket_url:1234'
}
// ... |
사용자 이름, 커서 색 설정
사용자의 이름과 커서의 색을 설정할 수 있습니다.
설정을 하지 않으면 플러그인에 기본으로 정의된 이름과 색이 설정됩니다.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
//...
'collaboration.config': {
'userName': 'SynapEditor',
'userColor': '#ff0000'
}
// ... |
기본 이름, 기본 색 설정
사용자 이름과 색을 설정을 하지 않았을 때 보여질 기본 이름 목록과 기본 색 목록을 설정할 수 있습니다.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
//...
'collaboration.config': {
'defaultNames': ['강아지', '고양이', '참새'],
'defaultColors': ['#CDB4DB', '#F5CAC3', '#87BBA2']
}
// ... |
커서 표시
- 다른 사용자가 편집 중인 셀렉션 위치를 실시간으로 표시합니다.
- 다른 사용자의 셀렉션은 커서의 형태로 제공되며, 사용자 이름을 설정할 수 있습니다.
...