Skip to content

A Q&A platform software for teams at any scales. Whether it's a community forum, help center, or knowledge management platform, you can always count on Apache Answer.

2.1 KB
Raw Blame
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import { Editor, ExtendEditor } from '../../types';

import { createBaseMethods } from './base';
import { createEventMethods } from './events';
import { createCommandMethods } from './commands';

/**
 * Adapts CodeMirror editor to unified editor interface
 *
 * This adapter function extends CodeMirror editor with additional methods,
 * enabling toolbar components to work properly in Markdown mode. The adapter
 * implements the complete `ExtendEditor` interface, including base methods,
 * event handling, and command methods.
 *
 * @param editor - CodeMirror editor instance
 * @returns Extended editor instance that implements the unified Editor interface
 *
 * @example
 * ```typescript
 * const cmEditor = new EditorView({ ... });
 * const adaptedEditor = createCodeMirrorAdapter(cmEditor as Editor);
 * // Now you can use the unified API
 * adaptedEditor.insertBold('text');
 * adaptedEditor.insertHeading(1, 'Title');
 * ```
 */
export function createCodeMirrorAdapter(editor: Editor): Editor {
  const baseMethods = createBaseMethods(editor);
  const eventMethods = createEventMethods(editor);
  const commandMethods = createCommandMethods(editor);

  const editorAdapter: ExtendEditor = {
    ...editor,
    ...baseMethods,
    ...eventMethods,
    ...commandMethods,
  };

  return editorAdapter as unknown as Editor;
}