@mlightcad/cad-viewer 1.0.0 → 1.0.2

package/README.md

@@ -14,6 +14,17 @@ CAD Viewer is a **high-performance** Vue 3 component for viewing and editing CAD
 - Dialogs, toolbars, and command line interface
 - Vue 3 component for embedding high-performance CAD viewers in your own apps
 
+## When Should You Choose cad-viewer?
+
+Use `cad-viewer` if you want a **ready-to-use Vue 3 component** for viewing and editing CAD files with a modern UI, dialogs, toolbars, and state management. This package is ideal if:
+
+- You want to quickly embed a high-performance CAD viewer/editor into your Vue application with minimal setup.
+- You need a solution that handles file loading, rendering, layer/entity management, and user interactions out of the box.
+- You want seamless integration with optimized SVG and THREE.js renderers, internationalization, and theming.
+- You do **not** want to build your own UI from scratch.
+
+**Recommended for:** Most web applications, dashboards, or platforms that need to display CAD files with a polished user interface.
+
 ## Browser-Only Architecture
 
 This Vue 3 component operates entirely in the browser with **no backend dependencies**. DWG/DXF files are parsed and processed locally using WebAssembly and JavaScript, providing:
@@ -45,6 +56,21 @@ Please refer to sub-package `cad-viewer-example` as one example.
 
 ### Basic Usage
 
+Firstly, add the following dependencies into your package.json.
+
+- @element-plus/icons-vue
+- @mlightcad/cad-simple-viewer
+- @mlightcad/cad-viewer
+- @mlightcad/data-model
+- @mlightcad/libredwg-converter
+- @mlightcad/libredwg-web
+- @vueuse/core
+- element-plus
+- vue
+- vue-i18n
+
+Then create one vue component as follows.
+
 ```vue
 <template>
   <div>
@@ -81,75 +107,88 @@ initApp()
 </script>
 ```
 
-### Advanced Usage
+## MlCadViewer Component
 
-By default, cad viewer registers DXF converter only and can view DXF file only. If you want to view DWG file, you need to register DWG converter. The following example code shows how to register DWG converter.
+The `MlCadViewer` is the main Vue 3 component that provides a complete CAD viewing and editing interface. It includes toolbars, layer management, command line, status bar, and various dialogs for a full-featured CAD experience.
 
-```typescript
-import {
-  AcDbDatabaseConverterManager,
-  AcDbFileType
-} from '@mlightcad/data-model'
-import { AcDbLibreDwgConverter } from '@mlightcad/libredwg-converter'
-
-
-const registerConverters = async () => {
-  try {
-    const isDev = import.meta.env.DEV
-    if (!isDev) {
-      // Production mode - use dynamic import with explicit chunk name
-      const instance = await import(
-        /* webpackChunkName: "libredwg-web" */ '@mlightcad/libredwg-web'
-      )
-      const converter = new AcDbLibreDwgConverter(await instance.createModule())
-      AcDbDatabaseConverterManager.instance.register(
-        AcDbFileType.DWG,
-        converter
-      )
-    }
-  } catch (error) {
-    console.error('Failed to load libredwg-web: ', error)
-  }
-}
+### Component Properties
+
+The `MlCadViewer` component accepts the following props:
+
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `locale` | `'en' \| 'zh' \| 'default'` | `'default'` | Sets the language for the component interface. Use `'en'` for English, `'zh'` for Chinese, or `'default'` to use the browser's default language. |
+| `url` | `string` | `undefined` | Optional URL to automatically load a CAD file when the component mounts. The file will be fetched and opened automatically. |
+| `wait` | `number` | `10` | When set to a positive number, the component will wait for DWG converter ready for use for the specified number of seconds before initializing. This is useful when you need to ensure DWG file support is available before the component becomes interactive. Set to `0` or negative value to disable waiting. |
+
+### Usage Examples
+
+#### Basic Usage with Default Settings
+```vue
+<template>
+  <MlCadViewer />
+</template>
 ```
 
-In order to make it work in Vite dev mode, you need to add the following code.
+#### With Custom Locale
+```vue
+<template>
+  <MlCadViewer locale="en" />
+</template>
+```
 
-```typescript
-// This is for development mode only. In production mode, the library is bundled
-window.addEventListener('libredwg-ready', event => {
-  // @ts-expect-error this is one custom event and you can get details in index.html
-  const instance = event.detail as LibreDwgEx
-  const converter = new AcDbLibreDwgConverter(instance)
-  AcDbDatabaseConverterManager.instance.register(AcDbFileType.DWG, converter)
-})
+#### Auto-load File from URL
+```vue
+<template>
+  <MlCadViewer 
+    locale="zh" 
+    url="https://example.com/path/to/drawing.dwg" 
+  />
+</template>
 ```
 
-Copy `libredwg-web.js` to folder `public/assets` and update `index.html` by adding the following code.
-
-```html
-<script type="module" defer>
-  if (import.meta.env.DEV) {
-    (async () => {
-      // Create a script element to load the module
-      const script = document.createElement("script");
-      script.type = "module";
-      script.src = "/assets/libredwg-web.js";
-      script.async = true;
-      
-      script.onload = async () => {
-        // Import dynamically after script is loaded
-        const actualModule = await import(/* @vite-ignore */script.src);
-        const libredwg = await actualModule.createModule();
-        window.dispatchEvent(new CustomEvent("libredwg-ready", { detail: libredwg }));
-      };
-  
-      document.body.appendChild(script);
-    })();
-  }
-</script>
+#### Wait for DWG Converter Ready to Use
+```vue
+<template>
+  <MlCadViewer 
+    :wait="10"
+    url="https://example.com/path/to/drawing.dwg" 
+  />
+</template>
 ```
 
+### Component Features
+
+The `MlCadViewer` component includes:
+
+- **Main Menu** - File operations, view controls, and settings
+- **Toolbars** - Drawing tools, zoom controls, and selection tools
+- **Layer Manager** - Layer visibility and property management
+- **Command Line** - AutoCAD-style command input
+- **Status Bar** - Current position, zoom level, and system status
+- **Dialog Manager** - Modal dialogs for various operations
+- **File Reader** - Drag-and-drop file loading
+- **Entity Info** - Detailed information about selected entities
+- **Language Selector** - UI language switching
+- **Theme Support** - Dark/light mode toggle
+
+### Event Handling
+
+The component automatically handles various events:
+
+- **File Loading** - Supports drag-and-drop and URL-based file loading
+- **Error Messages** - Displays user-friendly error messages for failed operations
+- **Font Loading** - Handles missing fonts with appropriate notifications
+- **System Messages** - Shows status updates and operation feedback
+
+### Advanced Usage
+
+Please refer to [readme of cad-simple-viewer](../cad-simple-viewer/README.md) to learn the following advanced usage.
+
+- Register DWG converter to display drawings in DWG format
+- Define your own font loader to load fonts from your own server
+- Create drawing or modify drawing
+
 ## Available Exports
 
 ### Main Component
@@ -193,21 +232,6 @@ Copy `libredwg-web.js` to folder `public/assets` and update `index.html` by addi
 - Dark mode support
 - Element Plus integration
 
-## Dependencies
-
-This component library requires the following peer dependencies:
-
-- `vue` ^3.4.0
-- `@mlightcad/data-model`
-- `@mlightcad/libredwg-converter`
-- `@mlightcad/libredwg-web`
-- `@mlightcad/svg-renderer`
-- `@mlightcad/three-renderer`
-- `@mlightcad/cad-simple-viewer`
-- `element-plus`
-- `vue-i18n`
-- And others as specified in package.json
-
 ## Development
 
 ```bash

package/dist/app/app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/app/app.ts"],"names":[],"mappings":"AAAA,OAAO,6BAA6B,CAAA;AACpC,OAAO,oBAAoB,CAAA;AAC3B,OAAO,qBAAqB,CAAA;AAwD5B,eAAO,MAAM,mBAAmB,GAAI,WAAW,MAAM,SAGpD,CAAA;AAED,eAAO,MAAM,mBAAmB,YAG/B,CAAA"}
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/app/app.ts"],"names":[],"mappings":"AAAA,OAAO,6BAA6B,CAAA;AACpC,OAAO,oBAAoB,CAAA;AAC3B,OAAO,qBAAqB,CAAA;AAwD5B,eAAO,MAAM,mBAAmB,GAAI,WAAW,MAAM,SAIpD,CAAA;AAED,eAAO,MAAM,mBAAmB,YAG/B,CAAA"}

package/dist/component/MlCadViewer.vue.d.ts

@@ -1,16 +1,21 @@
+import { LocaleProp } from '../locale';
 interface Props {
-    locale?: 'en' | 'zh' | 'default';
+    locale?: LocaleProp;
     url?: string;
+    wait?: number;
 }
 declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
     locale: string;
     url: undefined;
+    wait: number;
 }>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
     locale: string;
     url: undefined;
+    wait: number;
 }>>> & Readonly<{}>, {
-    locale: "en" | "zh" | "default";
+    locale: LocaleProp;
     url: string;
+    wait: number;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;
 type __VLS_WithDefaults<P, D> = {

package/dist/component/MlCadViewer.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MlCadViewer.vue.d.ts","sourceRoot":"","sources":["../../src/component/MlCadViewer.vue"],"names":[],"mappings":"AA8LA,UAAU,KAAK;IACb,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAA;IAChC,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;;;;;;;;YAFU,IAAI,GAAG,IAAI,GAAG,SAAS;SAC1B,MAAM;;AAgQd,wBAMG;AAEH,KAAK,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI;KAC9B,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAC7C,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;QAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;KAAC,CAAC,GAC5C,CAAC,CAAC,CAAC,CAAC;CACP,CAAC;AACF,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,uBAAuB,CAAC,CAAC,IAAI;KAChC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAC9D;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CACzD,CAAC;AACF,KAAK,mBAAmB,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAG,GAAG,EAAE,CAAC"}
+{"version":3,"file":"MlCadViewer.vue.d.ts","sourceRoot":"","sources":["../../src/component/MlCadViewer.vue"],"names":[],"mappings":"AAuOA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAatC,UAAU,KAAK;IACb,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;;;;;;;;;;YAHU,UAAU;SACb,MAAM;UACL,MAAM;;AAmTf,wBAMG;AAEH,KAAK,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI;KAC9B,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAC7C,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;QAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;KAAC,CAAC,GAC5C,CAAC,CAAC,CAAC,CAAC;CACP,CAAC;AACF,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,uBAAuB,CAAC,CAAC,IAAI;KAChC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAC9D;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CACzD,CAAC;AACF,KAAK,mBAAmB,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAG,GAAG,EAAE,CAAC"}

package/dist/component/common/MlBaseDialog.vue.d.ts

@@ -29,9 +29,9 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
         default: () => {};
     };
 }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
     ok: (...args: any[]) => void;
     cancel: (...args: any[]) => void;
+    "update:modelValue": (...args: any[]) => void;
 }, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
     title: {
         type: StringConstructor;
@@ -54,9 +54,9 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
         default: () => {};
     };
 }>> & Readonly<{
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
     onOk?: ((...args: any[]) => any) | undefined;
     onCancel?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
 }>, {
     props: Record<string, any>;
     width: string | number;

package/dist/component/layout/MlLanguageSelector.vue.d.ts

@@ -1,3 +1,30 @@
-declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+import { LocaleProp } from '../../locale';
+interface Props {
+    currentLocale?: LocaleProp;
+}
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
+    currentLocale: undefined;
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
+    currentLocale: undefined;
+}>>> & Readonly<{}>, {
+    currentLocale: LocaleProp;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_PrettifyLocal<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};
 //# sourceMappingURL=MlLanguageSelector.vue.d.ts.map

package/dist/component/layout/MlLanguageSelector.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MlLanguageSelector.vue.d.ts","sourceRoot":"","sources":["../../../src/component/layout/MlLanguageSelector.vue"],"names":[],"mappings":"AAQA;;AA4HA,wBAKG"}
+{"version":3,"file":"MlLanguageSelector.vue.d.ts","sourceRoot":"","sources":["../../../src/component/layout/MlLanguageSelector.vue"],"names":[],"mappings":"AAQA;AA4DA,OAAO,EAAE,UAAU,EAAe,MAAM,cAAc,CAAA;AAGtD,UAAU,KAAK;IACb,aAAa,CAAC,EAAE,UAAU,CAAA;CAC3B;;;;;;mBADiB,UAAU;;AA6F5B,wBAMG;AAEH,KAAK,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI;KAC9B,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAC7C,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG;QAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;KAAC,CAAC,GAC5C,CAAC,CAAC,CAAC,CAAC;CACP,CAAC;AACF,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,uBAAuB,CAAC,CAAC,IAAI;KAChC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAC9D;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CACzD,CAAC;AACF,KAAK,mBAAmB,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAG,GAAG,EAAE,CAAC"}

package/dist/component/statusBar/MlProgress.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MlProgress.vue.d.ts","sourceRoot":"","sources":["../../../src/component/statusBar/MlProgress.vue"],"names":[],"mappings":"AAUA;;AAmKA,wBAKG"}
+{"version":3,"file":"MlProgress.vue.d.ts","sourceRoot":"","sources":["../../../src/component/statusBar/MlProgress.vue"],"names":[],"mappings":"AAUA;;AAiMA,wBAKG"}

package/dist/composable/index.d.ts

@@ -7,4 +7,5 @@ export * from './useLayouts';
 export * from './useMissedData';
 export * from './useSettings';
 export * from './useSystemVars';
+export * from './useLocale';
 //# sourceMappingURL=index.d.ts.map

package/dist/composable/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/composable/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA;AACzB,cAAc,oBAAoB,CAAA;AAClC,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/composable/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA;AACzB,cAAc,oBAAoB,CAAA;AAClC,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,aAAa,CAAA"}

package/dist/composable/useLayers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useLayers.d.ts","sourceRoot":"","sources":["../../src/composable/useLayers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AAK7D,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;IACjB,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,cAAc,uCAkD/C"}
+{"version":3,"file":"useLayers.d.ts","sourceRoot":"","sources":["../../src/composable/useLayers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AAI7D,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;IACjB,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,cAAc,uCAiD/C"}

package/dist/composable/useLocale.d.ts

@@ -0,0 +1,187 @@
+import { LocaleProp, LocaleValue } from '../locale';
+export declare function useLocale(propLocale?: LocaleProp): {
+    currentLocale: import('vue').Ref<LocaleValue, LocaleValue>;
+    effectiveLocale: import('vue').ComputedRef<LocaleProp>;
+    elementPlusLocale: import('vue').ComputedRef<{
+        name: string;
+        el: {
+            breadcrumb: {
+                label: string;
+            };
+            colorpicker: {
+                confirm: string;
+                clear: string;
+                defaultLabel: string;
+                description: string;
+                alphaLabel: string;
+            };
+            datepicker: {
+                now: string;
+                today: string;
+                cancel: string;
+                clear: string;
+                confirm: string;
+                dateTablePrompt: string;
+                monthTablePrompt: string;
+                yearTablePrompt: string;
+                selectedDate: string;
+                selectDate: string;
+                selectTime: string;
+                startDate: string;
+                startTime: string;
+                endDate: string;
+                endTime: string;
+                prevYear: string;
+                nextYear: string;
+                prevMonth: string;
+                nextMonth: string;
+                year: string;
+                month1: string;
+                month2: string;
+                month3: string;
+                month4: string;
+                month5: string;
+                month6: string;
+                month7: string;
+                month8: string;
+                month9: string;
+                month10: string;
+                month11: string;
+                month12: string;
+                weeks: {
+                    sun: string;
+                    mon: string;
+                    tue: string;
+                    wed: string;
+                    thu: string;
+                    fri: string;
+                    sat: string;
+                };
+                weeksFull: {
+                    sun: string;
+                    mon: string;
+                    tue: string;
+                    wed: string;
+                    thu: string;
+                    fri: string;
+                    sat: string;
+                };
+                months: {
+                    jan: string;
+                    feb: string;
+                    mar: string;
+                    apr: string;
+                    may: string;
+                    jun: string;
+                    jul: string;
+                    aug: string;
+                    sep: string;
+                    oct: string;
+                    nov: string;
+                    dec: string;
+                };
+            };
+            inputNumber: {
+                decrease: string;
+                increase: string;
+            };
+            select: {
+                loading: string;
+                noMatch: string;
+                noData: string;
+                placeholder: string;
+            };
+            dropdown: {
+                toggleDropdown: string;
+            };
+            mention: {
+                loading: string;
+            };
+            cascader: {
+                noMatch: string;
+                loading: string;
+                placeholder: string;
+                noData: string;
+            };
+            pagination: {
+                goto: string;
+                pagesize: string;
+                total: string;
+                pageClassifier: string;
+                page: string;
+                prev: string;
+                next: string;
+                currentPage: string;
+                prevPages: string;
+                nextPages: string;
+                deprecationWarning: string;
+            };
+            dialog: {
+                close: string;
+            };
+            drawer: {
+                close: string;
+            };
+            messagebox: {
+                title: string;
+                confirm: string;
+                cancel: string;
+                error: string;
+                close: string;
+            };
+            upload: {
+                deleteTip: string;
+                delete: string;
+                preview: string;
+                continue: string;
+            };
+            slider: {
+                defaultLabel: string;
+                defaultRangeStartLabel: string;
+                defaultRangeEndLabel: string;
+            };
+            table: {
+                emptyText: string;
+                confirmFilter: string;
+                resetFilter: string;
+                clearFilter: string;
+                sumText: string;
+            };
+            tour: {
+                next: string;
+                previous: string;
+                finish: string;
+            };
+            tree: {
+                emptyText: string;
+            };
+            transfer: {
+                noMatch: string;
+                noData: string;
+                titles: string[];
+                filterPlaceholder: string;
+                noCheckedFormat: string;
+                hasCheckedFormat: string;
+            };
+            image: {
+                error: string;
+            };
+            pageHeader: {
+                title: string;
+            };
+            popconfirm: {
+                confirmButtonText: string;
+                cancelButtonText: string;
+            };
+            carousel: {
+                leftArrow: string;
+                rightArrow: string;
+                indicator: string;
+            };
+        };
+    }>;
+    setLocale: (newLocale: LocaleValue) => void;
+    clearStoragePreference: () => void;
+    isControlled: import('vue').ComputedRef<boolean>;
+};
+//# sourceMappingURL=useLocale.d.ts.map

package/dist/composable/useLocale.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLocale.d.ts","sourceRoot":"","sources":["../../src/composable/useLocale.ts"],"names":[],"mappings":"AAKA,OAAO,EAAQ,UAAU,EAAC,WAAW,EAAE,MAAM,WAAW,CAAA;AAIxD,wBAAgB,SAAS,CAAC,UAAU,CAAC,EAAE,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAwBjB,WAAW;;;EA2D1C"}

package/dist/index.css

@@ -1 +1 @@
-@charset "UTF-8";body{margin:0;display:flex}body,html{height:100%}.canvas{top:0;height:calc(100vh - var(--ml-status-bar-height));width:100%;display:block;outline:none}.el-dialog{padding-bottom:8px;padding-top:8px}.el-dialog__headerbtn{height:36px;width:36px}html.dark{color-scheme:dark;--el-color-primary: #409eff;--el-color-primary-light-3: rgb(51, 117, 185);--el-color-primary-light-5: rgb(42, 89, 138);--el-color-primary-light-7: rgb(33, 61, 91);--el-color-primary-light-8: rgb(29, 48, 67);--el-color-primary-light-9: rgb(24, 34, 43);--el-color-primary-dark-2: rgb(102, 177, 255);--el-color-success: #67c23a;--el-color-success-light-3: rgb(78, 142, 47);--el-color-success-light-5: rgb(62, 107, 39);--el-color-success-light-7: rgb(45, 72, 31);--el-color-success-light-8: rgb(37, 55, 28);--el-color-success-light-9: rgb(28, 37, 24);--el-color-success-dark-2: rgb(133, 206, 97);--el-color-warning: #e6a23c;--el-color-warning-light-3: rgb(167, 119, 48);--el-color-warning-light-5: rgb(125, 91, 40);--el-color-warning-light-7: rgb(83, 63, 32);--el-color-warning-light-8: rgb(62, 48, 28);--el-color-warning-light-9: rgb(41, 34, 24);--el-color-warning-dark-2: rgb(235, 181, 99);--el-color-danger: #f56c6c;--el-color-danger-light-3: rgb(178, 82, 82);--el-color-danger-light-5: rgb(133, 64, 64);--el-color-danger-light-7: rgb(88, 46, 46);--el-color-danger-light-8: rgb(65, 38, 38);--el-color-danger-light-9: rgb(42, 29, 29);--el-color-danger-dark-2: rgb(247, 137, 137);--el-color-error: #f56c6c;--el-color-error-light-3: rgb(178, 82, 82);--el-color-error-light-5: rgb(133, 64, 64);--el-color-error-light-7: rgb(88, 46, 46);--el-color-error-light-8: rgb(65, 38, 38);--el-color-error-light-9: rgb(42, 29, 29);--el-color-error-dark-2: rgb(247, 137, 137);--el-color-info: #909399;--el-color-info-light-3: rgb(107, 109, 113);--el-color-info-light-5: rgb(82, 84, 87);--el-color-info-light-7: rgb(57, 58, 60);--el-color-info-light-8: rgb(45, 45, 47);--el-color-info-light-9: rgb(32, 33, 33);--el-color-info-dark-2: rgb(166, 169, 173);--el-box-shadow: 0px 12px 32px 4px rgba(0, 0, 0, .36), 0px 8px 20px rgba(0, 0, 0, .72);--el-box-shadow-light: 0px 0px 12px rgba(0, 0, 0, .72);--el-box-shadow-lighter: 0px 0px 6px rgba(0, 0, 0, .72);--el-box-shadow-dark: 0px 16px 48px 16px rgba(0, 0, 0, .72), 0px 12px 32px #000000, 0px 8px 16px -8px #000000;--el-bg-color-page: #0a0a0a;--el-bg-color: #141414;--el-bg-color-overlay: #1d1e1f;--el-text-color-primary: #E5EAF3;--el-text-color-regular: #CFD3DC;--el-text-color-secondary: #A3A6AD;--el-text-color-placeholder: #8D9095;--el-text-color-disabled: #6C6E72;--el-border-color-darker: #636466;--el-border-color-dark: #58585B;--el-border-color: #4C4D4F;--el-border-color-light: #414243;--el-border-color-lighter: #363637;--el-border-color-extra-light: #2B2B2C;--el-fill-color-darker: #424243;--el-fill-color-dark: #39393A;--el-fill-color: #303030;--el-fill-color-light: #262727;--el-fill-color-lighter: #1D1D1D;--el-fill-color-extra-light: #191919;--el-fill-color-blank: transparent;--el-mask-color: rgba(0, 0, 0, .8);--el-mask-color-extra-light: rgba(0, 0, 0, .3)}html.dark .el-button{--el-button-disabled-text-color: rgba(255, 255, 255, .5)}html.dark .el-card{--el-card-bg-color: var(--el-bg-color-overlay)}html.dark .el-empty{--el-empty-fill-color-0: var(--el-color-black);--el-empty-fill-color-1: #4b4b52;--el-empty-fill-color-2: #36383d;--el-empty-fill-color-3: #1e1e20;--el-empty-fill-color-4: #262629;--el-empty-fill-color-5: #202124;--el-empty-fill-color-6: #212224;--el-empty-fill-color-7: #1b1c1f;--el-empty-fill-color-8: #1c1d1f;--el-empty-fill-color-9: #18181a}:root{--ml-status-bar-height: 30px}body{font-family:Inter,system-ui,Avenir,Helvetica Neue,Helvetica,PingFang SC,Hiragino Sans GB,Microsoft YaHei,微软雅黑,Arial,sans-serif;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;margin:0}a{color:var(--el-color-primary)}code{border-radius:2px;padding:2px 4px;background-color:var(--el-color-primary-light-9);color:var(--elcolor-primary)}.ml-dialog-header-bottom-line[data-v-8df470d5]{margin-left:-16px;margin-top:6px;margin-bottom:6px;width:calc(100% + 64px)}.ml-dialog-footer-top-line[data-v-8df470d5]{margin-left:-16px;margin-top:6px;margin-bottom:6px;width:calc(100% + 32px)}.ml-toggle-button[data-v-48d6b055]{border:none;padding:0;cursor:pointer;width:var(--a97b120a);height:var(--a97b120a)}.ml-layer-list{width:100%;font-size:small;min-width:100%}.ml-layer-list .el-table__header,.ml-layer-list .el-table__body{border-bottom:1px solid var(--el-border-color)}.ml-layer-list-cell{display:flex;align-items:center;justify-content:center}.ml-layer-list-color{width:20px;height:20px}.ml-layer-manager[data-v-d49ba2cb]{left:2px;top:55px;width:400px;height:500px}.ml-layer-list-wrapper[data-v-d49ba2cb]{overflow:auto;width:100%;display:flex;align-items:flex-start;justify-content:flex-start}.autocomplete-container[data-v-082845cb]{position:fixed;left:50%;bottom:40px;transform:translate(-50%);width:80%;max-width:600px;z-index:1000}.autocomplete-input[data-v-082845cb]{width:100%}.ml-entity-info[data-v-5f45b19d]{position:fixed;width:180px;left:var(--504f44a9);top:var(--4d65ff1a);margin:6px}.ml-entity-info-title[data-v-5f45b19d]{font-weight:700;margin-bottom:16px;margin-top:0}.ml-entity-info-text[data-v-5f45b19d]{margin:6px}.ml-language-selector[data-v-de5200f8]{position:fixed;right:40px;top:20px;z-index:1000}.ml-main-menu-container[data-v-8c0c738e]{position:fixed;left:40px;top:20px;z-index:1000}.ml-main-menu-icon[data-v-8c0c738e],.ml-main-menu-icon[data-v-8c0c738e]:hover{outline:none;border:none}.ml-vertical-toolbar-container{position:fixed;right:30px;top:50%;transform:translateY(-50%)}.ml-point-style-button[data-v-29692d7d]{border:none;padding:0;cursor:pointer;width:30px}.ml-progress[data-v-799ce32b]{width:100px}.ml-setting-button[data-v-666f03a3],.ml-warning-button[data-v-3411a3ec]{border:none;padding:0;cursor:pointer;width:30px}.ml-status-bar[data-v-ee6f13c4]{box-sizing:border-box}.ml-status-bar-left-button-group[data-v-ee6f13c4]{border:none;box-sizing:border-box;height:var(--ml-status-bar-height)}.ml-status-bar-layout-button[data-v-ee6f13c4]{box-sizing:border-box}.ml-status-bar-right-button-group[data-v-ee6f13c4]{border:none;padding:0;height:var(--ml-status-bar-height)}.ml-status-bar-current-pos[data-v-ee6f13c4]{border:none;height:100%}.ml-file-name{position:absolute;top:0;left:50%;transform:translate(-50%);text-align:center;width:100%;margin-top:20px}
+@charset "UTF-8";body{margin:0;display:flex}body,html{height:100%}.canvas{top:0;height:calc(100vh - var(--ml-status-bar-height));width:100%;display:block;outline:none}.el-dialog{padding-bottom:8px;padding-top:8px}.el-dialog__headerbtn{height:36px;width:36px}html.dark{color-scheme:dark;--el-color-primary: #409eff;--el-color-primary-light-3: rgb(51, 117, 185);--el-color-primary-light-5: rgb(42, 89, 138);--el-color-primary-light-7: rgb(33, 61, 91);--el-color-primary-light-8: rgb(29, 48, 67);--el-color-primary-light-9: rgb(24, 34, 43);--el-color-primary-dark-2: rgb(102, 177, 255);--el-color-success: #67c23a;--el-color-success-light-3: rgb(78, 142, 47);--el-color-success-light-5: rgb(62, 107, 39);--el-color-success-light-7: rgb(45, 72, 31);--el-color-success-light-8: rgb(37, 55, 28);--el-color-success-light-9: rgb(28, 37, 24);--el-color-success-dark-2: rgb(133, 206, 97);--el-color-warning: #e6a23c;--el-color-warning-light-3: rgb(167, 119, 48);--el-color-warning-light-5: rgb(125, 91, 40);--el-color-warning-light-7: rgb(83, 63, 32);--el-color-warning-light-8: rgb(62, 48, 28);--el-color-warning-light-9: rgb(41, 34, 24);--el-color-warning-dark-2: rgb(235, 181, 99);--el-color-danger: #f56c6c;--el-color-danger-light-3: rgb(178, 82, 82);--el-color-danger-light-5: rgb(133, 64, 64);--el-color-danger-light-7: rgb(88, 46, 46);--el-color-danger-light-8: rgb(65, 38, 38);--el-color-danger-light-9: rgb(42, 29, 29);--el-color-danger-dark-2: rgb(247, 137, 137);--el-color-error: #f56c6c;--el-color-error-light-3: rgb(178, 82, 82);--el-color-error-light-5: rgb(133, 64, 64);--el-color-error-light-7: rgb(88, 46, 46);--el-color-error-light-8: rgb(65, 38, 38);--el-color-error-light-9: rgb(42, 29, 29);--el-color-error-dark-2: rgb(247, 137, 137);--el-color-info: #909399;--el-color-info-light-3: rgb(107, 109, 113);--el-color-info-light-5: rgb(82, 84, 87);--el-color-info-light-7: rgb(57, 58, 60);--el-color-info-light-8: rgb(45, 45, 47);--el-color-info-light-9: rgb(32, 33, 33);--el-color-info-dark-2: rgb(166, 169, 173);--el-box-shadow: 0px 12px 32px 4px rgba(0, 0, 0, .36), 0px 8px 20px rgba(0, 0, 0, .72);--el-box-shadow-light: 0px 0px 12px rgba(0, 0, 0, .72);--el-box-shadow-lighter: 0px 0px 6px rgba(0, 0, 0, .72);--el-box-shadow-dark: 0px 16px 48px 16px rgba(0, 0, 0, .72), 0px 12px 32px #000000, 0px 8px 16px -8px #000000;--el-bg-color-page: #0a0a0a;--el-bg-color: #141414;--el-bg-color-overlay: #1d1e1f;--el-text-color-primary: #E5EAF3;--el-text-color-regular: #CFD3DC;--el-text-color-secondary: #A3A6AD;--el-text-color-placeholder: #8D9095;--el-text-color-disabled: #6C6E72;--el-border-color-darker: #636466;--el-border-color-dark: #58585B;--el-border-color: #4C4D4F;--el-border-color-light: #414243;--el-border-color-lighter: #363637;--el-border-color-extra-light: #2B2B2C;--el-fill-color-darker: #424243;--el-fill-color-dark: #39393A;--el-fill-color: #303030;--el-fill-color-light: #262727;--el-fill-color-lighter: #1D1D1D;--el-fill-color-extra-light: #191919;--el-fill-color-blank: transparent;--el-mask-color: rgba(0, 0, 0, .8);--el-mask-color-extra-light: rgba(0, 0, 0, .3)}html.dark .el-button{--el-button-disabled-text-color: rgba(255, 255, 255, .5)}html.dark .el-card{--el-card-bg-color: var(--el-bg-color-overlay)}html.dark .el-empty{--el-empty-fill-color-0: var(--el-color-black);--el-empty-fill-color-1: #4b4b52;--el-empty-fill-color-2: #36383d;--el-empty-fill-color-3: #1e1e20;--el-empty-fill-color-4: #262629;--el-empty-fill-color-5: #202124;--el-empty-fill-color-6: #212224;--el-empty-fill-color-7: #1b1c1f;--el-empty-fill-color-8: #1c1d1f;--el-empty-fill-color-9: #18181a}:root{--ml-status-bar-height: 30px}body{font-family:Inter,system-ui,Avenir,Helvetica Neue,Helvetica,PingFang SC,Hiragino Sans GB,Microsoft YaHei,微软雅黑,Arial,sans-serif;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;margin:0}a{color:var(--el-color-primary)}code{border-radius:2px;padding:2px 4px;background-color:var(--el-color-primary-light-9);color:var(--elcolor-primary)}.ml-dialog-header-bottom-line[data-v-8df470d5]{margin-left:-16px;margin-top:6px;margin-bottom:6px;width:calc(100% + 64px)}.ml-dialog-footer-top-line[data-v-8df470d5]{margin-left:-16px;margin-top:6px;margin-bottom:6px;width:calc(100% + 32px)}.ml-toggle-button[data-v-48d6b055]{border:none;padding:0;cursor:pointer;width:var(--a97b120a);height:var(--a97b120a)}.ml-layer-list{width:100%;font-size:small;min-width:100%}.ml-layer-list .el-table__header,.ml-layer-list .el-table__body{border-bottom:1px solid var(--el-border-color)}.ml-layer-list-cell{display:flex;align-items:center;justify-content:center}.ml-layer-list-color{width:20px;height:20px}.ml-layer-manager[data-v-d49ba2cb]{left:2px;top:55px;width:400px;height:500px}.ml-layer-list-wrapper[data-v-d49ba2cb]{overflow:auto;width:100%;display:flex;align-items:flex-start;justify-content:flex-start}.autocomplete-container[data-v-082845cb]{position:fixed;left:50%;bottom:40px;transform:translate(-50%);width:80%;max-width:600px;z-index:1000}.autocomplete-input[data-v-082845cb]{width:100%}.ml-entity-info[data-v-5f45b19d]{position:fixed;width:180px;left:var(--504f44a9);top:var(--4d65ff1a);margin:6px}.ml-entity-info-title[data-v-5f45b19d]{font-weight:700;margin-bottom:16px;margin-top:0}.ml-entity-info-text[data-v-5f45b19d]{margin:6px}.ml-language-selector[data-v-1b9f7bc0]{position:fixed;right:40px;top:20px;z-index:1000}.ml-main-menu-container[data-v-8c0c738e]{position:fixed;left:40px;top:20px;z-index:1000}.ml-main-menu-icon[data-v-8c0c738e],.ml-main-menu-icon[data-v-8c0c738e]:hover{outline:none;border:none}.ml-vertical-toolbar-container{position:fixed;right:30px;top:50%;transform:translateY(-50%)}.ml-point-style-button[data-v-29692d7d]{border:none;padding:0;cursor:pointer;width:30px}.ml-progress[data-v-5d48a084]{width:100px}.ml-setting-button[data-v-666f03a3],.ml-warning-button[data-v-3411a3ec]{border:none;padding:0;cursor:pointer;width:30px}.ml-status-bar[data-v-ee6f13c4]{box-sizing:border-box}.ml-status-bar-left-button-group[data-v-ee6f13c4]{border:none;box-sizing:border-box;height:var(--ml-status-bar-height)}.ml-status-bar-layout-button[data-v-ee6f13c4]{box-sizing:border-box}.ml-status-bar-right-button-group[data-v-ee6f13c4]{border:none;padding:0;height:var(--ml-status-bar-height)}.ml-status-bar-current-pos[data-v-ee6f13c4]{border:none;height:100%}.ml-file-name{position:absolute;top:0;left:50%;transform:translate(-50%);text-align:center;width:100%;margin-top:20px}