사용방법

플러그인 파일 불러오기

<!-- SynapEditor 객체가 존재해야 적용할 수 있기 때문에 에디터 스크립트 파일 아래에 include 해야 합니다 -->
<script src="collaboration.min.js의 url"></script>

웹소켓 URL을 설정합니다. (필수)

설정을 하지 않으면 플러그인이 초기화되지 않습니다.

synapeditor.config.js

//...
'collaboration.config': { 
    'wsUrl': 'ws://websocket_url:1234'
}
// ...

사용자의 이름과 커서의 색을 설정할 수 있습니다.

설정을 하지 않으면 플러그인에 기본으로 정의된 이름과 색이 설정됩니다.

synapeditor.config.js

//...
'collaboration.config': { 
    'userName': 'SynapEditor',
    'userColor': '#ff0000'
}
// ...

사용자 이름과 색을 설정을 하지 않았을 때 보여질 기본 이름 목록과 기본 색 목록을 설정할 수 있습니다.

synapeditor.config.js

//...
'collaboration.config': { 
    'defaultNames': ['강아지', '고양이', '참새'],
    'defaultColors': ['#CDB4DB', '#F5CAC3', '#87BBA2']
}
// ...

실시간 협업에 참여 중인 사용자 정보를 표시하는 UI가 기본으로 제공됩니다.
- 툴바에 버튼 형태로 추가 할 수 있습니다.
- 사용자 이름이 설정되지 않은 경우 10개의 형용사와, 10개의 동물 이름을 랜덤하게 조합해 표기합니다.
- 사용자 이름과 색상은 설정으로 변경이 가능합니다.
필요한 정보는 API형태로 제공됩니다.
- API정보로 직접 사용자 정보를 표현 할 수 있습니다.
- 사용자 정보가 있다면 설정이 가능합니다.