CodeMirror는 웹 브라우저에서 사용할 수 있는 강력한 코드 에디터 라이브러리입니다. 이를 React 환경에서 더 쉽고 가볍게 사용할 수 있도록 도와주는 @uiw/react-codemirror 컴포넌트의 주요 특징과 사용법을 소개합니다.
주요 특징
- 설정된
mode에 따라 필요한 언어 파일을 자동으로 로드합니다. - 직관적이고 간결한 API 구성을 제공하여 빠른 도입이 가능합니다.
패키지 설치
프로젝트에 라이브러리를 추가하려면 아래 명령어를 사용합니다.
npm install @uiw/react-codemirror --save
기본적인 사용법
가장 단순한 형태의 에디터 구현 예시입니다. 필요한 테마와 키맵 설정을 불러와 적용할 수 있습니다.
import React from 'react';
import CodeMirror from '@uiw/react-codemirror';
import 'codemirror/keymap/sublime';
import 'codemirror/theme/eclipse.css';
const MyEditor = () => {
const initialValue = 'console.log("Hello, CodeMirror!");';
return (
<CodeMirror
value={initialValue}
options={{
keyMap: 'sublime',
mode: 'javascript',
theme: 'eclipse',
}}
/>
);
};
export default MyEditor;
애드온 및 확장 기능 적용
자동 새로고침, 괄호 매칭, 주석 처리 등 CodeMirror에서 제공하는 다양한 애드온을 함께 사용할 수 있습니다. 언어 모드를 설정하면 관련 리소스가 지연 로딩(Lazy Loading) 방식으로 처리됩니다.
import CodeMirror from '@uiw/react-codemirror';
import 'codemirror/addon/display/autorefresh';
import 'codemirror/addon/comment/comment';
import 'codemirror/addon/edit/matchbrackets';
import 'codemirror/theme/monokai.css';
const codeSnippet = 'function add(a, b) {\n return a + b;\n}';
<CodeMirror
value={codeSnippet}
options={{
theme: 'monokai',
tabSize: 4,
mode: 'javascript',
matchBrackets: true,
autoRefresh: true,
}}
/>
에디터 옵션 상세
에디터의 동작을 제어하기 위해 options 속성을 통해 다양한 설정을 전달할 수 있습니다. 주요 설정 항목은 다음과 같습니다.
- value: 에디터에 표시될 초기 텍스트 내용입니다.
- mode: 구문 강조를 적용할 언어 설정입니다. (문자열 또는 객체 형태)
- theme: 에디터의 시각적 스타일을 정의하는 테마 이름입니다.
- lineNumbers: 좌측에 줄 번호를 표시할지 여부를 결정합니다.
- readOnly: 에디터를 읽기 전용 상태로 설정합니다.
- tabSize: 탭 문자의 너비를 지정합니다.
인스턴스 메서드 및 이벤트 처리
CodeMirror 인스턴스를 통해 직접 에디터를 제어하거나 이벤트를 감지할 수 있습니다.
- getValue(separator?): 현재 에디터에 입력된 전체 텍스트를 가져옵니다.
- setValue(content): 에디터의 내용을 새로운 텍스트로 교체합니다.
- focus(): 에디터에 포커스를 줍니다.
- refresh(): 에디터의 레이아웃을 다시 계산하여 갱신합니다.
이벤트 등록은 on 메서드를 사용하여 수행합니다.
<CodeMirror
onBeforeChange={(instance, change) => {
// 변경 사항이 적용되기 전에 실행되는 로직
}}
onChange={(instance, change) => {
console.log('내용이 변경되었습니다:', instance.getValue());
}}
onFocus={(instance) => {
console.log('에디터에 포커스됨');
}}
/>
라이선스
이 프로젝트는 MIT 라이선스 하에 배포됩니다.