본문 바로가기

플러그인

에디터 플러그인 베타

플러그인은 에디터에 패널을 더합니다. .sshowplugin 파일을 가져와 설치하고, 목록에서 클릭해 실행합니다.

플러그인은 자체 패널을 가진 작은 도구입니다. 문서를 읽고, 오브젝트를 만들고 고치는 일을 에디터와 같은 방식으로 — 항상 실행취소 가능한 편집으로 — 수행합니다.

카탈로그에서 설치하기

게시된 플러그인은 스튜디오 대시보드에 있습니다. 설치하면 계정에 저장되어, 웹과 데스크톱 어디서든 로그인한 에디터에 자동으로 로드됩니다.

  1. 1 스튜디오 대시보드를 열고 사이드바에서 플러그인을 선택하세요.
  2. 2 카탈로그를 검색·둘러보고 카드에서 설치를 누르세요 — 카드를 클릭하면 상세 정보가 열립니다.
  3. 3 아무 프로젝트나 열면 설치한 플러그인이 에디터의 플러그인 패널에 바로 나타납니다.

설치는 계정에 저장됩니다. 카드나 에디터 패널에서 제거하면 모든 곳에서 함께 제거됩니다.

사용하기

  1. 1 우상단 툴바의 플러그인 버튼(검색 옆)으로 플러그인 패널을 엽니다.
  2. 2 패널 제목줄의 + 버튼으로 .sshowplugin 파일을 가져옵니다.
  3. 3 목록에서 플러그인을 클릭하면 전용 패널에서 실행됩니다. 패널을 닫으면 플러그인도 종료됩니다.
  4. 4 목록 행 오른쪽의 − 버튼으로 제거합니다.
아이콘·이름·버전·제작자가 표시된 플러그인 패널 목록
플러그인 패널 — 상단 검색, 타이틀바의 임포트(+), 그리고 플러그인마다 아이콘·버전·제작자가 담긴 행.

목록 상단의 검색으로 이름·제작자·설명을 걸러낼 수 있고, 실행 중인 플러그인의 행은 강조 표시됩니다.

플러그인이 문서에 가한 변경은 한 번의 실행취소(Ctrl+Z)로 전부 되돌아갑니다.

.sshowplugin 파일

플러그인 패키지는 plugin.json과 화면 문서(ui.html) 하나를 담은 zip 파일입니다. plugin.json의 필드는 다음과 같습니다.

필드 설명
id 고유 id — 소문자 역도메인 형식 (필수)
name 목록과 패널 제목에 보이는 이름 (필수)
version x.y.z 버전 (필수)
api 플러그인 API 버전 — 현재 1 (필수)
main 화면 문서 파일명, 예: ui.html (필수)
description 목록에 보이는 한 줄 설명 (선택)
author 목록에 보이는 제작자 이름 (선택)
icon 패키지 안의 아이콘 파일명 — png/svg/jpg/webp (선택)

직접 만들기

플러그인의 화면 문서는 평범한 웹 페이지 하나입니다. 빌드 도구 없이 HTML 파일 하나로 시작할 수 있고, 안에서 SSHOWPlugin.connect()로 에디터와 연결합니다.

  • document.getState() — 문서 전체의 스냅샷을 읽습니다.
  • document.getSelection() — 선택된 오브젝트들을 읽습니다.
  • document.applyActions(actions) — 문서를 편집하는 유일한 방법입니다. 호출 한 번이 실행취소 한 단위가 됩니다.
  • events.on/off — 문서 변경과 선택 변경을 구독합니다.
  • ui.resize(size) — 패널 안 화면 크기를 요청합니다: 높이 숫자 또는 { width, height }.

모든 호출은 비동기(Promise)입니다. 문서는 액션으로만 바뀌므로, 잘못된 요청이 문서를 깨뜨리지 않습니다.

안전

  • 플러그인은 격리된 샌드박스 안에서 실행되며 네트워크에 접근할 수 없습니다.
  • 문서 접근은 위의 API로만 가능합니다 — 에디터 화면이나 계정에는 닿을 수 없습니다.
  • 문서 파일에는 플러그인의 흔적이 남지 않습니다. 플러그인으로 만든 문서는 플러그인이 없어도 똑같이 열립니다.