feat: 代码编辑器中增加新属性previewStyleClass用于实现自定义高亮代码主题。DevCloudFE#1861

aolinpk · May 29, 2024 · 87eb570 · 87eb570
1 parent 18e63c4
commit 87eb570
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 5 deletions.
diff --git a/packages/devui-vue/devui/editor-md/src/components/md-render.tsx b/packages/devui-vue/devui/editor-md/src/components/md-render.tsx
@@ -8,11 +8,10 @@ export default defineComponent({
   props: mdRenderProps,
   emits: ['mdRenderChange', 'checkedChange'],
   setup(props: MdRenderProps, ctx: SetupContext) {
-    const { previewRef, renderService, onPreviewClick, setContainerContent } = useEditorMdRender(props, ctx);
+    const { previewRef, renderService, previewStyleClass, onPreviewClick, setContainerContent } = useEditorMdRender(props, ctx);
     useMdRenderWatcher(props, renderService, setContainerContent);
-
     return () => (
-      <div ref={previewRef} class="dp-editor-md-preview-container dp-md-view" onClick={onPreviewClick}>
+      <div ref={previewRef} class={`dp-editor-md-preview-container ${previewStyleClass.value}`} onClick={onPreviewClick}>
         {ctx.slots.default?.()}
       </div>
     );

diff --git a/packages/devui-vue/devui/editor-md/src/composables/use-editor-md-render.ts b/packages/devui-vue/devui/editor-md/src/composables/use-editor-md-render.ts
@@ -3,7 +3,7 @@ import { MdPlugin, MdRenderProps } from '../editor-md-types';
 import { MDRenderService } from './md-render-service';
 
 export function useEditorMdRender(props: MdRenderProps, ctx: SetupContext) {
-  const { content, customParse, disableRender } = toRefs(props);
+  const { content, customParse, disableRender, previewStyleClass } = toRefs(props);
   const renderService = new MDRenderService();
   const previewRef = ref();
   let timer: ReturnType<typeof setTimeout> | null = null;
@@ -58,7 +58,7 @@ export function useEditorMdRender(props: MdRenderProps, ctx: SetupContext) {
     }
   };
 
-  return { previewRef, renderService, onPreviewClick, setContainerContent };
+  return { previewRef, renderService, previewStyleClass, onPreviewClick, setContainerContent };
 }
 
 export function useMdRenderWatcher(props: MdRenderProps, renderService: MDRenderService, setContainerContent: () => void) {

diff --git a/packages/devui-vue/devui/editor-md/src/editor-md-types.ts b/packages/devui-vue/devui/editor-md/src/editor-md-types.ts
@@ -61,6 +61,10 @@ const commonProps = {
     type: Array as PropType<Array<MdPlugin>>,
     default: () => [],
   },
+  previewStyleClass: {
+    type: String,
+    default: 'dp-md-view',
+  },
 };
 
 export interface HintConfigItem {

diff --git a/packages/devui-vue/docs/components/editor-md/index.md b/packages/devui-vue/docs/components/editor-md/index.md
@@ -120,6 +120,48 @@ export default defineComponent({
 
 :::
 
+### 自定义代码高亮
+
+`devui`的代码编辑器本身的高亮是由`highlight.js`和一些自定义颜色实现的。传入`preview-style-class`属性则可以覆盖默认类实现自定义高亮样式。
+
+:::demo 使用 highlight.js进行代码高亮或自定义类覆盖高亮样式
+
+```vue
+<template>
+  <d-md-render :preview-style-class="`custom-blank`" :content="content" :md-rules="mdRules" base-url="https://test-base-url"></d-md-render>
+  <d-md-render preview-style-class :content="content" :md-rules="mdRules" base-url="https://test-base-url"></d-md-render>
+  <d-md-render :content="content" :md-rules="mdRules" base-url="https://test-base-url"></d-md-render>
+</template>
+
+<script>
+import { defineComponent, reactive, ref } from 'vue';
+
+export default defineComponent({
+  setup() {
+    const content = ref('# h1 \n [link](#test)');
+    const mdRules = reactive({
+      linkify: {
+        fuzzyLink: false,
+      },
+    });
+
+    return { content, mdRules };
+  },
+});
+</script>
+<style>
+.custom-blank h1{
+  font-size: 48px;
+  font-weight: 700;
+}
+.custom-blank p > a:hover{
+  color: blue;
+}
+</style>
+```
+
+:::
+
 ### 单列渲染模式
 
 :::demo 通过 mode 控制不同的显示模式
@@ -630,6 +672,8 @@ Bob-->>John: Jolly good!
 | fullscreen-z-index     | `number`                                  | 10       | 编辑器全屏状态的 z-index                                                                                           |
 | image-upload-to-server | `boolean`                                 | false    | 是否打开图片自定义上传开关（打开后将将监听图片的复制，toolbar 图片功能上传，传出事件回调）                         |
 |editor-container-height|`number`|--|可选，编辑器内容区高度||
+|preview-style-class|`string`|--|可选，自定义代码渲染的高亮样式  [自定义代码高亮](#自定义代码高亮)||
+
 
 ### EditorMd 事件