docs(cropperjs): add exported modules section

fengyuanchen · Apr 21, 2024 · 5b6ed96 · 5b6ed96
1 parent 003ffa0
commit 5b6ed96
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -122,3 +122,23 @@ Get the `<cropper-selection>` element in the Cropper container.
   - The `<cropper-selection>` element if any.
 
 Get all the `<cropper-selection>` elements in the Cropper container when there are multiple selections.
+
+## Exported Modules
+
+```js
+import {
+  // Constants
+  DEFAULT_TEMPLATE,
+
+  // Elements
+  CropperElement,
+  CropperCanvas,
+  CropperImage,
+  CropperShade,
+  CropperHandle,
+  CropperSelection,
+  CropperGrid,
+  CropperCrosshair,
+  CropperViewer,
+} from 'cropperjs';
+```
diff --git a/docs/zh/api/index.md b/docs/zh/api/index.md
@@ -122,3 +122,23 @@ Cropper 的默认模板：
   - `<cropper-selection>` 元素（如果有）。
 
 当有多个选择时，获取 Cropper 容器中的所有 `<cropper-selection>` 元素。
+
+## 导出的模块
+
+```js
+import {
+  // 常量
+  DEFAULT_TEMPLATE,
+
+  // 元素
+  CropperElement,
+  CropperCanvas,
+  CropperImage,
+  CropperShade,
+  CropperHandle,
+  CropperSelection,
+  CropperGrid,
+  CropperCrosshair,
+  CropperViewer,
+} from 'cropperjs';
+```