vue-editify 0.1.9 → 0.1.12

package/src/editify/props.ts

@@ -0,0 +1,141 @@
+import { common as DapCommon } from 'dap-util'
+import { ExtractPublicPropTypes, PropType } from 'vue'
+import { MenuConfigType, ObjectType, ToolbarConfigType } from '../core/tool'
+import { AlexElement } from 'alex-editor'
+import { LocaleType } from '../locale'
+
+export type EditifyTableColumnResizeParamsType = {
+	element: AlexElement | null
+	start: number
+}
+
+export type EditifyToolbarOptionsType = {
+	show: boolean
+	node: string | null
+	type: 'text' | 'link' | 'image' | 'video' | 'table' | 'codeBlock'
+}
+
+export const EditifyProps = {
+	//国际化语言类型
+	locale: {
+		type: String as PropType<LocaleType>,
+		default: 'zh_CN'
+	},
+	//编辑器内容
+	modelValue: {
+		type: String,
+		default: '<p><br></p>'
+	},
+	//占位符
+	placeholder: {
+		type: String,
+		default: ''
+	},
+	//是否自动获取焦点
+	autofocus: {
+		type: Boolean,
+		default: false
+	},
+	//是否禁用编辑器
+	disabled: {
+		type: Boolean,
+		default: false
+	},
+	//是否允许复制
+	allowCopy: {
+		type: Boolean,
+		default: true
+	},
+	//是否允许粘贴
+	allowPaste: {
+		type: Boolean,
+		default: true
+	},
+	//是否允许剪切
+	allowCut: {
+		type: Boolean,
+		default: true
+	},
+	//是否允许粘贴html
+	allowPasteHtml: {
+		type: Boolean,
+		default: false
+	},
+	//是否显示边框
+	border: {
+		type: Boolean,
+		default: false
+	},
+	//主题色
+	color: {
+		type: String,
+		default: '#03a8f3',
+		validator(value: any) {
+			return DapCommon.matchingText(value, 'hex')
+		}
+	},
+	//视频宽高比
+	videoRatio: {
+		type: Number,
+		default: 16 / 9
+	},
+	//工具条按钮设置
+	toolbar: {
+		type: Object as PropType<ToolbarConfigType>,
+		default: null
+	},
+	//是否显示字数统计
+	showWordLength: {
+		type: Boolean,
+		default: false
+	},
+	//自定义粘贴图片
+	customImagePaste: {
+		type: Function as PropType<(url: string) => string | Promise<string>>,
+		default: null
+	},
+	//自定义粘贴视频
+	customVideoPaste: {
+		type: Function as PropType<(url: string) => string | Promise<string>>,
+		default: null
+	},
+	//菜单栏配置
+	menu: {
+		type: Object as PropType<MenuConfigType>,
+		default: null
+	},
+	//粘贴html时额外保留的标记（全部元素生效）
+	pasteKeepMarks: {
+		type: Object as PropType<ObjectType>,
+		default: null
+	},
+	//粘贴html时额外保留的样式（仅在非文本元素生效）
+	pasteKeepStyles: {
+		type: Object as PropType<ObjectType>,
+		default: null
+	},
+	//自定义node转元素时的处理
+	customParseNode: {
+		type: Function as PropType<(el: AlexElement) => AlexElement>,
+		default: null
+	},
+	//自定义额外的渲染规范
+	renderRules: {
+		type: Array as PropType<((el: AlexElement) => void)[]>,
+		default: function () {
+			return []
+		}
+	},
+	//自适应高度
+	autoheight: {
+		type: Boolean,
+		default: false
+	},
+	//是否使用tab快捷键
+	tab: {
+		type: Boolean,
+		default: true
+	}
+}
+
+export type EditifyPropsType = ExtractPublicPropTypes<typeof EditifyProps>

package/src/hljs/{index.js → index.ts}

@@ -69,8 +69,13 @@ hljs.configure({
 	ignoreUnescapedHTML: true
 })
 
+export type LanguagesItemType = {
+	label?: string
+	value?: string
+}
+
 //获取经过hljs处理的html元素
-const getHljsHtml = function (code, language) {
+export const getHljsHtml = function (code: string, language: string) {
 	if (language) {
 		return hljs.highlight(code, {
 			language: language,
@@ -80,7 +85,7 @@ const getHljsHtml = function (code, language) {
 	return hljs.highlightAuto(code).value
 }
 //可选择语言列表
-const languages = [
+export const languages: LanguagesItemType[] = [
 	{
 		label: 'Plain Text',
 		value: 'plaintext'
@@ -190,5 +195,3 @@ const languages = [
 		value: 'rust'
 	}
 ]
-
-export { getHljsHtml, languages }

package/src/index.ts

@@ -0,0 +1,32 @@
+//引入AlexElement
+import { AlexElement } from 'alex-editor'
+//引入组件
+import Editify from './editify/editify.vue'
+//引入图标样式
+import './icon/iconfont.css'
+
+import { App } from 'vue'
+import { ButtonTypeType, ButtonOptionsItemType, ButtonSelectConfigType, ButtonDisplayConfigType } from './components/button/props'
+import { MenuButtonType, MenuSelectButtonType, MenuDisplayButtonType, MenuImageButtonType, MenuVideoButtonType, MenuTableButtonType, MenuCustomButtonType, CodeBlockToolbarType, TextToolbarType, ToolbarConfigType, MenuSequenceType, MenuModeType, MenuConfigType } from './core/tool'
+import { InsertImageUploadErrorType } from './components/insertImage/props'
+import { InsertVideoUploadErrorType } from './components/insertVideo/props'
+
+//版本号
+const version = '0.1.12'
+//安装函数
+const install = (app: App) => {
+	app.component(Editify.name!, Editify)
+}
+//全局导出的对象
+const stdin_default = {
+	install,
+	version
+}
+
+//导出一些编辑器操作方法
+export * from './core/function'
+
+//导出类型
+export type { ButtonTypeType, ButtonOptionsItemType, ButtonSelectConfigType, ButtonDisplayConfigType, MenuButtonType, MenuSelectButtonType, MenuDisplayButtonType, MenuImageButtonType, MenuVideoButtonType, MenuTableButtonType, MenuCustomButtonType, CodeBlockToolbarType, TextToolbarType, ToolbarConfigType, MenuSequenceType, MenuModeType, MenuConfigType, InsertImageUploadErrorType, InsertVideoUploadErrorType }
+
+export { stdin_default as default, install, version, Editify, AlexElement }

package/src/locale/{en_US.js → en_US.ts}

@@ -1,4 +1,6 @@
-export default {
+import { ObjectType } from '../core/tool'
+
+export const en_US: ObjectType = {
 	textWrapUp: 'Up feed',
 	textWrapDown: 'Down feed',
 	insertRowTop: 'Insert row forward',

package/src/locale/index.ts

@@ -0,0 +1,12 @@
+import { en_US } from './en_US'
+import { zh_CN } from './zh_CN'
+
+//语言类型
+export type LocaleType = 'zh_CN' | 'en_US'
+
+//翻译方法
+export const trans = (locale: LocaleType) => {
+	return (key: string) => {
+		return { zh_CN, en_US }[locale][key]
+	}
+}

package/src/locale/{zh_CN.js → zh_CN.ts}

@@ -1,4 +1,6 @@
-export default {
+import { ObjectType } from '../core/tool'
+
+export const zh_CN: ObjectType = {
 	textWrapUp: '向上换行',
 	textWrapDown: '向下换行',
 	insertRowTop: '向前插入行',

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+	"compilerOptions": {
+		"target": "ES2020",
+		"useDefineForClassFields": true,
+		"module": "ESNext",
+		"lib": ["ES2020", "DOM", "DOM.Iterable"],
+		"skipLibCheck": true,
+		"allowSyntheticDefaultImports": true,
+		"types": ["node"],
+
+		/* Bundler mode */
+		"moduleResolution": "bundler",
+		"allowImportingTsExtensions": true,
+		"resolveJsonModule": true,
+		"isolatedModules": true,
+		"noEmit": true,
+		"jsx": "preserve",
+
+		/* Linting */
+		"strict": true,
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"noFallthroughCasesInSwitch": true
+	},
+	"include": ["src/**/*.ts", "src/**/*.vue", "vite-env.d.ts"],
+	"references": [{ "path": "./tsconfig.node.json" }]
+}

package/tsconfig.node.json

@@ -0,0 +1,11 @@
+{
+	"compilerOptions": {
+		"composite": true,
+		"skipLibCheck": true,
+		"module": "ESNext",
+		"moduleResolution": "bundler",
+		"allowSyntheticDefaultImports": true,
+		"strict": true
+	},
+	"include": ["vite.config.ts"]
+}

package/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/vite.config.ts

@@ -0,0 +1,39 @@
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import dts from 'vite-plugin-dts'
+import path from 'path'
+
+export default defineConfig({
+	plugins: [vue(), dts()],
+	build: {
+		//打包后的目录名称
+		outDir: 'lib',
+		minify: 'terser',
+		lib: {
+			entry: path.resolve(__dirname, 'src/index.ts'),
+			name: 'editify',
+			fileName: format => `editify.${format}.js`
+		},
+		rollupOptions: {
+			// 确保外部化处理那些你不想打包进库的依赖
+			external: ['vue'],
+			output: {
+				// 在 UMD 构建模式下为这些外部化的依赖提供一个全局变量
+				globals: {
+					vue: 'Vue'
+				},
+				exports: 'named'
+			}
+		},
+		sourcemap: false //是否构建source map 文件
+	},
+	css: {
+		preprocessorOptions: {
+			less: {
+				// 使用 less 编写样式的 UI 库（如 antd）时建议加入这个设置
+				javascriptEnabled: true,
+				additionalData: `@import "src/css/base.less";`
+			}
+		}
+	}
+})

package/examples/main.js

@@ -1,4 +0,0 @@
-import { createApp } from 'vue'
-import App from './App.vue'
-import Editify from '../src'
-createApp(App).use(Editify, { locale: 'zh_CN' }).mount('#app')