릴리즈 2.4.0이상
기본 설정
Key
Window 환경에서 사용할 단축키와 Mac 환경에서 사용할 단축키를 각각 설정합니다.
windows
: Windows 환경에서 사용할 단축키를 string 형태로 설정mac
: Mac 환경에서 사용할 단축키를 string 형태로 설정
여러 키를 조합해야 할 경우 +
기호로 연결해 표기합니다.
Ctrl 키와 Shift 키와 ; 키를 조합시 :
Ctrl+Shift+;
- Ctrl 키와 Alt 키와 N 키를 조합시 :
Ctrl+Alt+N
// Ctrl+Shift+; shortcutDef: { key: { windows: 'Ctrl+Shift+;', mac: 'Cmd+Shift+;' }, option: {...} } // Ctrl+Alt+N shortcutDef: { key: { windows: 'Ctrl+Alt+N', mac: 'Cmd+Alt+N' }, option: {...} }
단축키에 사용할 수 있는 Key 목록
Key | 설명 | Key | 설명 |
---|---|---|---|
Ctrl | 0~9 | 0 부터 9까지 숫자 | |
Shift | A~Z | A 부터 Z까지 알파벳 | |
Alt | Windows OS에서는 Alt, Mac OS는 Option 키로 동작 | F1~F12 | F1부터 F12까지 |
Cmd | Command 키 (Mac OS 전용) | ; | |
Backspace | + | ||
Tab | , | ||
Enter | - | ||
Esc | . | ||
Space | / | ||
PageUp | ` | ||
PageDown | [ | ||
End | \ | ||
Home | ] | ||
Insert | ' | ||
Delete | |||
Left | 왼쪽 방향키 | ||
Up | 위쪽 방향키 | ||
Right | 오른쪽 방향키 | ||
Down | 아래쪽 방향키 |
Option
단축키가 실행되었을 때 수행할 동작이나 포커스 등의 기타 옵션을 설정합니다.
action
또는 onExecute
를 설정하면 단축키가 실행되었을 때 설정한 동작이 수행되고, 두 개의 옵션을 모두 설정 시 onExecute
만 수행됩니다.
설정가능한 옵션:
action
: 단축키를 실행시 수행할 에디터에 정의된 Action의 이름 (사용 가능한 액션 목록: Actions)params
:action
사용시 Action에 넘겨줄 인자 목록onExecute
: 릴리즈 2.15.2211이상 단축키를 실행시 수행할 함수focusIme
: 단축키를 동작 한 후 에디터에 포커스를 설정할지 여부 (기본값 true)
// 에디터에 정의된 Action 을 수행하도록 설정 shortcutDef: { key: {...}, option: { action: 'increaseFontSize' } } // 에디터에 정의된 Action 을 수행하도록 설정 (인자를 전달해야 하는 경우) shortcutDef: { key: {...}, option: { action: 'align', params: ['center'] } } // 함수를 수행하도록 설정 shortcutDef: { key: {...}, option: { /** * 함수의 인자로 editor 객체와 키 이벤트가 전달됩니다. * @param {SynapEditor} editor * @param {KeyboardEvent} keyEvent */ onExecute: function (editor, keyEvent) { window.alert('Shortcut test!'); } } }
하나의 단축키 설정하기
shortcutDef
에 객체 형태로 단축키와 단축키 실행시 수행될 동작을 설정합니다.
shortcutDef: { key: { ... }, option: { ... } }
여러 개의 단축키 설정하기
shortcutDef
에 배열 형태로 단축키와 단축키 실행시 수행될 동작을 설정합니다.
shortcutDef: [{ key: { ... }, option: { ... } }, ...]