API
SynapEditor.addPlugin(pluginName, pluginGenerator)
릴리즈 2.4.0 이상
사이냅에디터에 플러그인을 추가합니다.
Params:
Name | Type | Description |
---|---|---|
pluginName | string | 플러그인의 이름입니다. |
pluginGenerator | function | 플러그인 객체를 생성해주는 함수입니다. |
Example:
var pluginName = "pluginName"; var pluginGenerator = function (editor) { //플러그인 객체를 반환합니다. return { //... }; }; SynapEditor.addPlugin(pluginName, pluginGenerator);
플러그인 객체의 형태
Properties | Type | Definition |
---|---|---|
buttonDef | Array | Object | buttonDef: { name: '버튼의 이름(없을 경우 플러그인의 이름)', label: '버튼에 보여질 텍스트', iconSVG: '버튼의 아이콘으로 사용될 SVG 태그', onClickFunc: function () { //버튼이 클릭되었을 때 실행될 함수 } } or buttonDef: [{ name: '버튼의 이름(없을 경우 플러그인의 이름)', label: '버튼에 보여질 텍스트', iconSVG: '버튼의 아이콘으로 사용될 SVG 태그', onClickFunc: function () { //버튼이 클릭되었을 때 실행될 함수 } }, ...] |
예제
'Hello World~'를 에디터에 삽입하는 플러그인
PluginGenerator 정의
./plugins/helloWorldInserter.js
var pluginName = "helloWorldInserter"; var pluginGenerator = function(editor) { return { buttonDef: { label: 'Hello World Inserter', iconSVG: `<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="0 0 16 16"> <g xmlns="http://www.w3.org/2000/svg"><title>Layer 1</title> <text stroke="#000000" transform="matrix(0.7835232019424438,0,0,1,0.2672135476022959,0) " xml:space="preserve" text-anchor="start" font-family="Helvetica, Arial, sans-serif" font-size="13" y="12.580528" x="-1.056391" fill="#000000">HW</text> </g> </svg>`, onClickFunc: function () { editor.execCommand('insertText', 'Hello World~'); } } }; }; SynapEditor.addPlugin(pluginName, pluginGenerator);
작성한 플러그인 로드
index.html
<!-- synapeditor plugin --> <script type="text/javascript" src="./plugins/helloWorldInserter.js"></script>
에디터 툴바 영역에 플러그인 버튼 달기
./synapeditor.config.js
"editor.toolbar": ["bold", "italic", "underline", "strike", "helloWorldInserter"] //helloWorldInserter 플러그인을 툴바 영역에 설정합니다.