@cherry-markdown/cherry-markdown-dev 0.8.58-dev

package/types/editor.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Copyright (C) 2021 THL A29 Limited, a Tencent company.
+ *
+ * Licensed 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 CodeMirror from 'codemirror';
+import Cherry from '../src/Cherry.js';
+import { EditorMode } from './cherry.js';
+
+interface EditorEventMap {
+  onBlur: FocusEvent;
+  onFocus: FocusEvent;
+  onKeydown: KeyboardEvent;
+  onPaste: ClipboardEvent;
+}
+
+type EditorDefaultCallback = () => void;
+export type EditorEventCallback<
+  E = unknown,
+  K extends keyof EditorEventMap = keyof EditorEventMap
+> = E extends EditorEventMap[K]
+  ? (event: E, codemirror: CodeMirror.Editor) => void
+  : (codemirror: CodeMirror.Editor) => void;
+
+type EditorPasteEventHandler = (
+  event: ClipboardEvent,
+  clipboardData: ClipboardEvent['clipboardData'],
+  codemirror: CodeMirror.Editor,
+) => void;
+
+export type EditorConfiguration = {
+  id?: string; // textarea 的id属性值
+  name?: string; // textarea 的name属性值
+  autoSave2Textarea?: boolean; // 是否自动将编辑区的内容回写到textarea里
+  editorDom: HTMLElement;
+  wrapperDom: HTMLElement;
+  toolbars: any;
+  value?: string;
+  convertWhenPaste?: boolean;
+  keyMap?: 'sublime' | 'vim'; // 快捷键风格，目前仅支持 sublime 和 vim
+  keepDocumentScrollAfterInit?: boolean;
+  /** 是否高亮全角符号 ·|￥|、|：|“|”|【|】|（|）|《|》 */
+  showFullWidthMark?: boolean;
+  /** 是否显示联想框 */
+  showSuggestList?: boolean;
+  codemirror: CodeMirror.EditorConfiguration;
+  onKeydown: EditorEventCallback<EditorEventMap['onKeydown']>;
+  onFocus: EditorEventCallback<EditorEventMap['onFocus']>;
+  onBlur: EditorEventCallback<EditorEventMap['onBlur']>;
+  onPaste: EditorEventCallback<EditorEventMap['onPaste']>;
+  onChange: (changeList: CodeMirror.EditorChangeLinkedList, codemirror: CodeMirror.Editor) => void;
+  onScroll: EditorEventCallback;
+  handlePaste?: EditorPasteEventHandler;
+  /** 预览区域跟随编辑器光标自动滚动 */
+  autoScrollByCursor: boolean;
+  fileUpload?: (file: File, callback: (fileUrl: string) => void) => void;
+  $cherry?: Cherry;
+  /** 书写风格，normal 普通 | typewriter 打字机 | focus 专注，默认normal */
+  writingStyle?: string;
+  /** 编辑器初始化后的模式 */
+  defaultModel?: EditorMode;
+};

package/types/global.d.ts

@@ -0,0 +1,16 @@
+import Mermaid from 'mermaid';
+
+// for IE
+export {};
+
+declare global {
+  const BUILD_ENV: string;
+  interface Window {
+    // for IE
+    clipboardData: ClipboardEvent['clipboardData'];
+    mermaid?: typeof Mermaid;
+    mermaidAPI?: typeof Mermaid['mermaidAPI'];
+    echarts?: echarts.ECharts;
+    MathJax?: any;
+  }
+}

package/types/menus.d.ts

@@ -0,0 +1,24 @@
+export type MenuIconType = 'svg' | 'iconfont' | 'image' | 'element';
+
+export interface CustomMenuIcon {
+  type: MenuIconType;
+  /**
+   * 如果 type 为 'svg'，则该属性为 svg 文件内容
+   * 如果 type 为 'iconfont'，则该属性为 iconfont 类名（请确保已引入字体）
+   * 如果 type 为 'image'，则该属性为img元素的src属性
+   */
+  content: string;
+  /**
+   * 除了 iconfont 外，其他类型可以设置该属性来改变图标的内联样式
+   */
+  iconStyle?: string;
+  /** 设置class属性 */
+  iconClassName?: string;
+}
+
+export type IconElement<T extends HTMLElement = HTMLElement> = T;
+
+export interface CustomMenuConfig {
+  name: string;
+  icon: string | CustomMenuIcon | IconElement;
+}

package/types/previewer.d.ts

@@ -0,0 +1,53 @@
+import Cherry from '../src/Cherry.js';
+export type AfterUpdateCallbackFunc = () => void;
+
+export interface PreviewerOptions {
+  /** previewer 绑定的 DOM */
+  previewerDom: HTMLDivElement;
+  /** editor或previewer所占宽度比例的最小值 */
+  minBlockPercentage: number;
+  /**  */
+  value: string;
+  /**  */
+  afterUpdateCallBack: AfterUpdateCallbackFunc[];
+  /** */
+  isPreviewOnly: boolean;
+  /**  */
+  previewerCache: {
+    html: string;
+    htmlChanged: boolean;
+    layout: Record<string, any>;
+  };
+  /** */
+  virtualDragLineDom: HTMLDivElement;
+  /** */
+  editorMaskDom: HTMLDivElement;
+  /** */
+  previewerMaskDom: HTMLDivElement;
+  /** 是否开启预览区域菜单 */
+  enablePreviewerBubble?: boolean;
+  // 是否在关闭预览区时，将预览区浮动
+  floatWhenClosePreviewer?: boolean;
+  $cherry?: Cherry;
+  // 配置图片懒加载的逻辑
+  lazyLoadImg?: {
+    // 加载图片时如果需要展示loaing图，则配置loading图的地址
+    loadingImgPath?: string;
+    // 同一时间最多有几个图片请求，最大同时加载6张图片
+    maxNumPerTime?: 1 | 2 | 3 | 4 | 5 | 6,
+    // 不进行懒加载处理的图片数量，如果为0，即所有图片都进行懒加载处理， 如果设置为-1，则所有图片都不进行懒加载处理
+    noLoadImgNum?: number,
+    // 首次自动加载几张图片（不论图片是否滚动到视野内），autoLoadImgNum = -1 表示会自动加载完所有图片
+    autoLoadImgNum?: -1 | number;
+    // 针对加载失败的图片 或 beforeLoadOneImgCallback 返回false 的图片，最多尝试加载几次，为了防止死循环，最多5次。以图片的src为纬度统计重试次数
+    maxTryTimesPerSrc?: 0 | 1 | 2 | 3 | 4 | 5,
+    // 加载一张图片之前的回调函数，函数return false 会终止加载操作
+    beforeLoadOneImgCallback?: (img: HTMLImageElement) => void | boolean;
+    // 加载一张图片失败之后的回调函数
+    failLoadOneImgCallback?: (img: HTMLImageElement) => void;
+    // 加载一张图片之后的回调函数，如果图片加载失败，则不会回调该函数
+    afterLoadOneImgCallback?: (img: HTMLImageElement) => void;
+    // 加载完所有图片后调用的回调函数
+    afterLoadAllImgCallback?: () => void;
+  };
+}

package/types/syntax.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Copyright (C) 2021 THL A29 Limited, a Tencent company.
+ *
+ * Licensed 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 { CherryOptions } from './cherry';
+
+export type HookType = 'sentence' | 'paragraph';
+
+interface HookTypesListMap extends Record<string, HookType> {
+  SEN: 'sentence';
+  PAR: 'paragraph';
+  DEFAULT: 'sentence';
+}
+
+export type HookTypesList<K extends keyof HookTypesListMap = keyof HookTypesListMap> = Record<K, HookTypesListMap[K]>;
+
+export interface EditorConfig {
+  pageHooks: Record<string, any>;
+  /** hook 专用的配置 */
+  config: Record<string, any> | false;
+  /** 引擎的全局配置 */
+  globalConfig: CherryOptions['engine']['global'];
+  /** 外部依赖 */
+  externals: CherryOptions['externals'];
+  [key: string]: any;
+}
+
+export interface BasicHookRegexpRule {
+  reg: RegExp;
+  begin: string;
+  content: string;
+  end: string;
+}
+
+// TODO:
+export type HookRegexpRule = {
+  begin: string;
+  end: string;
+  content: string;
+  reg?: RegExp;
+};