npm - vue3-element-dict - Versions diffs - 2.0.0 - Mend

vue3-element-dict 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md +387 -0
package/lib/vite.svg +1 -0
package/lib/vue3-element-dict.js +2837 -0
package/lib/vue3-element-dict.umd.cjs +1 -0
package/package.json +38 -0
package/vue3-element-dict-types/index.d.ts +350 -0

package/lib/vue3-element-dict.umd.cjs ADDED Viewed

@@ -0,0 +1 @@

package/package.json ADDED Viewed

@@ -0,0 +1,38 @@
+{
+  "name": "vue3-element-dict",
+  "private": false,
+  "version": "2.0.0",
+  "author": {
+    "name": "shenxiaobu",
+    "url": "https://shenxiaobu.github.io"
+  },
+  "keywords": [
+    "vue3字典包",
+    "elementPlus字典包",
+    "dict",
+    "elementPlus",
+    "vue3",
+    "爆米花小布"
+  ],
+  "main": "lib/vue3-element-dict.js",
+  "type": "module",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "dev": "vite",
+    "build:tsc": "vue-tsc && vite build",
+    "build": "vite build",
+    "preview": "vite preview",
+    "tsc": "vue-tsc"
+  },
+  "devDependencies": {
+    "@element-plus/icons-vue": "^2.1.0",
+    "@types/node": "^18.15.12",
+    "@vitejs/plugin-vue": "^4.1.0",
+    "element-plus": "^2.3.3",
+    "typescript": "^4.9.3",
+    "vite": "^4.2.0",
+    "vue": "^3.2.47",
+    "vue-router": "^4.1.6",
+    "vue-tsc": "^1.2.0"
+  }
+}

package/vue3-element-dict-types/index.d.ts ADDED Viewed

@@ -0,0 +1,350 @@
+/**
+ * 字典配置相关开始
+ */
+export type TreeSetting = {
+  idField: string, //唯一标识字段名
+  parentIdField: string, //父节点唯一标识字段名
+  childrenField: string, //子节点标识字段名
+  firstId: string|number, // 根节点值
+  labelField: string, //label字段名
+  labelArrField: string, //给对象新增的中文数组字段名
+  idArrField: string, //给对象新增的id数组字段名
+  levelField: string, //给对象新增的层级字段名
+  level: number, // 给根目录配置的层级
+  leafField: string //叶子节点标识字段名
+}
+export interface IFilterDataFun {
+  (list: {[key: string]: any}[]): {key: string}[]
+}
+export interface IDisabledDataFun extends IFilterDataFun {}
+export type DictConfig = {
+  getDictCodeApi: any; // 获取字典的接口
+  version: string; // 当前字典最新版本号
+  localDictCodes: { [key: string]: object[] }; // 本地字典数据
+  versionKey: string; // 版本号缓存键名
+  dictDataKey: string; // 字典数据缓存键名
+  query: string; // 请求字典的参数名
+  format: {
+    // 格式化字典数据的 值和名 字段
+    value: string;
+    label: string;
+    disabled: string;
+    type: string;
+    color: string;
+  };
+  formatterDictList: (
+    data: { dictData: object; version: string },
+    query?: string
+  ) => object; //格式化字典数据
+  formatterDictVersion: (data: {
+    dictData: object;
+    version: string;
+  }) => string; // 格式化返回的最新字典版本号
+  filterDataFun: IFilterDataFun; // 字典数据过滤方法
+  disabledDataFun: IDisabledDataFun; // 字典数据禁用方法
+  formatterRequest: (query: string, dictType: string) => object; // 格式化请求体
+  storage: any; // localstorage   sessionstorage
+  isGetAll?: boolean; // 是否请求全部
+  usuallyGetDictTypes?: string; // 经常获取的字典数据
+  usuallyGetDictTypesByApi?: boolean; // 是否每次都通过接口获取数据
+  treeSetting: TreeSetting;
+}
+// 可选的字典配置
+export type OptionalDictConfig = {
+  getDictCodeApi: any; // 获取字典的接口
+  version: string; // 当前字典最新版本号
+  localDictCodes?: { [key: string]: object[] }; // 本地字典数据
+  versionKey?: string; // 版本号缓存键名
+  dictDataKey?: string; // 字典数据缓存键名
+  query?: string; // 请求字典的参数名
+  format?: {
+    // 格式化字典数据的 值和名 字段
+    value: string;
+    label: string;
+    disabled: string;
+    type: string;
+    color: string;
+  };
+  formatterDictList?: (
+    data: { dictCodeList: object; version: string },
+    query?: string
+  ) => object; //格式化字典数据
+  formatterDictVersion?: (data: {
+    dictCodeList: object;
+    version: string;
+  }) => string; // 格式化返回的最新字典版本号
+  filterDataFun?: (list: object[]) => object[]; // 字典数据过滤方法
+  disabledDataFun?: (list: object[]) => object[]; // 字典数据禁用方法
+  formatterRequest?: (query: string, dictType: string) => object; // 格式化请求体
+  storage?: any; // localstorage   sessionstorage
+  isGetAll?: boolean; // 是否请求全部
+  usuallyGetDictTypes?: string; // 经常获取的字典数据
+  usuallyGetDictTypesByApi?: boolean; // 是否每次都通过接口获取数据
+  treeSetting?: FewTreeSetting;
+}
+// 可选的树形配置
+export type OptionalTreeSetting = {
+  idField?: "id", //唯一标识字段名
+  parentIdField?: "parentId", //父节点唯一标识字段名
+  childrenField?: "children", //子节点标识字段名
+  firstId?: "0", // 根节点值
+  labelField?: "label", //label字段名
+  labelArrField?: "labelArr", //给对象新增的中文数组字段名
+  idArrField?: "idArr", //给对象新增的id数组字段名
+  levelField?: "level", //给对象新增的层级字段名
+  level?: 0, // 给根目录配置的层级
+  leafField?: "leaf" //叶子节点标识字段名
+}
+// 通过code获取树形数据配置
+export type GetTreeItemByCodeOptions = {
+  idField: string,
+  parentIdField: string
+}
+export type GetTreeItemByLabelOptions = {
+  idField: string,
+  labelField: string, //唯一标识字段名
+  parentIdField: string //父节点唯一标识字段名
+}
+/**
+ * 字典配置相关结束
+ */
+/**
+ * 脱敏相关开始
+ */
+export type OptionalMaskOptions = {
+  start?: number; // 从前往后保留的位数，默认为 1
+  end?: number; // 从后往前保留的位数，默认为 0
+  middle?: number; // 中间展示几个symbol
+  symbol?: string; // 替换的字符，默认为 *
+}
+export type MaskOptions = {
+  start: number; // 从前往后保留的位数，默认为 1
+  end: number; // 从后往前保留的位数，默认为 0
+  symbol: string; // 替换的字符，默认为 *
+  middle?: number; // 中间展示几个symbol
+}
+export type MaskType = "name" | "mobile" |"address" | "idCard" | "none" | ""
+// 必填的脱敏配置
+export type DesensitizationOptions = MaskOptions & {
+  defaultVal: string,
+  maskType: MaskType,
+  middle?: number;
+}
+// 可选的脱敏方法配置
+export type OptionalDesensitizationOptions = OptionalMaskOptions & {
+  middle?: number,
+  defaultVal?: string,
+  maskType?: MaskType
+}
+/**
+ * 脱敏相关结束
+ */
+/**
+ * 日期格式化 开始
+ */
+export type DefaultForamt = {
+  date: string,
+  month: string,
+  datetime: string,
+  time: string,
+  year: string
+}
+export type FormatType = "date" | "month" | "datetime" | "time" | "year"
+/**
+ * 日期格式化 结束
+ */
+// 获取字典配置接口
+export interface IGetDictConfig {
+  (): DictConfig
+}
+// 通过key获取对应字典配置接口
+export interface IGetDictConfigByKey {
+  (string): any
+}
+// 判断是否是日期接口
+export interface IIsDate {
+  (string): boolean
+}
+// 格式化日期接口
+export interface IFormatDate {
+  (date: Date|string|number, format: string, defaultVal?:string): string
+}
+// 通过code获取字典数据接口
+export interface IGetLabelByCode {
+  (val: string | number, type: string, defaultVal?: string | number): Promise<string | number>
+}
+export interface IGetLabelByCodeFilter {
+  (val: string | number, type: string, defaultVal?: string | number): string | number | undefined
+}
+export type Format = { label: string | number; value: string | number }
+export type GetLabelByCodesOptions = {
+  defaultVal?: string | number,
+  formatFun?: (arr: object[], format: Format) => string|number,
+  spacer?: string
+}
+// 通过多个code获取多个label
+export interface IGetLabelByCodes {
+  (vals: string | (string | number)[], type: string, options?: GetLabelByCodesOptions): Promise<string|number>
+}
+export interface IGetLabelByCodesFilter {
+  (vals: string | (string | number)[], type: string, options?: GetLabelByCodesOptions): string | number | undefined
+}
+export interface IGetCodeByLabel {
+  (val: string | number, type: string, defaultVal?: string | number): Promise<string | number>
+}
+export interface IGetCodeByLabelFilter {
+  (val: string | number, type: string, defaultVal?: string | number): string | number | undefined
+}
+export type GetCodeByLabelsOptions = GetLabelByCodesOptions
+export interface IGetCodeByLabels {
+  (vals: string | (string | number)[], type: string, options?: GetCodeByLabelsOptions): Promise<string|number>
+}
+export interface IGetCodeByLabelsFilter {
+  (vals: string | (string | number)[], type: string, options?: GetCodeByLabelsOptions): string|number|undefined
+}
+export interface IGetDictObjByDictTypes {
+  (dictTypes: string | string[]): Promise<object>
+}
+export interface IListToTree {
+  (data: object[], config?: OptionalTreeSetting, parentObj?:{ [key: string]: any }): object[]
+}
+export interface IGetTreeItemByCode {
+  (id: string | number, arr: {[key: string]: any}[], options: GetTreeItemByCodeOptions): object[]
+}
+export interface IGetTreeItemByLabel {
+  (label: string | number, arr: {[key: string]: any}[], options: GetTreeItemByLabelOptions): object[]
+}
+export interface IMask {
+  (str: string, paramsOptions: OptionalMaskOptions): string
+}
+export interface IMaskName {
+  (name: string, symbol:string): string
+}
+export interface IMaskIdCard {
+  (idcard: string, symbol: string): string
+}
+export interface IMaskPhone {
+  (phone: string | number, symbol: string): string
+}
+export interface IMaskAddress {
+  (address: string, symbol: string): string
+}
+export type MaskTypeObj = {
+  mobile: IMaskPhone
+  name: IMaskName
+  address: IMaskAddress
+  idCard: IMaskIdCard
+}
+export interface IDesensitization {
+  (str: string, options: OptionalDesensitizationOptions): string
+}
+export interface IFormatFun {
+  (arr: any, treeSetting: TreeSetting): string|number
+}
+export type GetTreeLabelByCodeOptions = {
+  defaultVal?: string | number,
+  formatFun?: IFormatFun,
+  treeSetting?: OptionalTreeSetting
+}
+export interface IGetTreeLabelByCode {
+  (val: string, type: string, options?:GetTreeLabelByCodeOptions): Promise<string|number>
+}
+export interface IGetTreeLabelByCodeFilter {
+  (val: string, type: string, options?:GetTreeLabelByCodeOptions): string | number | undefined
+}
+export interface IFormatFunIn {
+  (arr: any, treeSetting: TreeSetting): string
+}
+export interface IFormatFunOut {
+  (arr: any, treeSetting: TreeSetting): string
+}
+export type GetTreeLabelByCodesOptions = {
+  defaultVal?: string | number,
+  formatFunIn?: IFormatFunIn,
+  treeSetting?: OptionalTreeSetting,
+  formatFunOut?: IFormatFunOut,
+  spacer?: string
+}
+export interface IGetTreeLabelByCodes {
+  (vals: string[] | string, type: string, options?: GetTreeLabelByCodesOptions): Promise<string|number>
+}
+export interface IGetTreeLabelByCodesFilter {
+  (vals: string[] | string, type: string, options?: GetTreeLabelByCodesOptions): string | number | undefined
+}
+export type GetTreeCodeByLabelOptions = GetTreeLabelByCodeOptions
+export interface IGetTreeCodeByLabel {
+  ( val: string, type: string, options?: GetTreeCodeByLabelOptions): Promise<string | number>
+}
+export interface IGetTreeCodeByLabelFilter {
+  ( val: string, type: string, options?: GetTreeCodeByLabelOptions): string | number | undefined
+}
+export type GetTreeCodeByLabelsOptions = GetTreeLabelByCodesOptions
+export interface IGetTreeCodeByLabels {
+  ( vals: string[] | string, type: string, options?: GetTreeCodeByLabelsOptions): Promise<string|number>
+}
+export interface IGetTreeCodeByLabelsFilter {
+  ( vals: string[] | string, type: string, options?: GetTreeCodeByLabelsOptions): string | number | undefined
+}
+export interface IGetItemByCode {
+  (val: string | number, type: string, defaultVal?: string | number): Promise<object | string | number>
+}