浏览代码

feat: export isLinearElement and getNonDeletedElements (#4072)

* feat: export isLinearElement and getNonDeletedElements

* fix
vanilla_orig
Aakansha Doshi 3 年前
父节点
当前提交
6eecadce60
没有帐户链接到提交者的电子邮件
共有 3 个文件被更改,包括 37 次插入0 次删除
  1. 2
    0
      src/packages/excalidraw/CHANGELOG.md
  2. 32
    0
      src/packages/excalidraw/README_NEXT.md
  3. 3
    0
      src/packages/excalidraw/index.tsx

+ 2
- 0
src/packages/excalidraw/CHANGELOG.md 查看文件

@@ -17,6 +17,8 @@ Please add the latest change on the top under the correct section.
17 17
 
18 18
 ### Features
19 19
 
20
+- Export [`isLinearElement`](https://github.com/excalidraw/excalidraw/blob/master/src/packages/excalidraw/README.md#isLinearElement) and [`getNonDeletedElements`](https://github.com/excalidraw/excalidraw/blob/master/src/packages/excalidraw/README.md#getNonDeletedElements).
21
+
20 22
 - Support [`renderTopRightUI`](https://github.com/excalidraw/excalidraw/blob/master/src/packages/excalidraw/README.md#renderTopRightUI) in mobile UI.
21 23
 
22 24
 - Export `THEME` constant from the package so host can use this when passing the theme.

+ 32
- 0
src/packages/excalidraw/README_NEXT.md 查看文件

@@ -910,6 +910,38 @@ getFreeDrawSvgPath(element: <a href="https://github.com/excalidraw/excalidraw/bl
910 910
 
911 911
 This function returns the free draw svg path for the element.
912 912
 
913
+#### `isLinearElement`
914
+
915
+**How to use**
916
+
917
+```js
918
+import { isLinearElement } from "@excalidraw/excalidraw-next";
919
+```
920
+
921
+**Signature**
922
+
923
+<pre>
924
+isLinearElement(elementType?: <a href="https://github.com/excalidraw/excalidraw/blob/master/src/element/types.ts#L80">ExcalidrawElement</a>): boolean
925
+</pre>
926
+
927
+This function returns true if the element is linear type (`arrow` |`line`) else returns false.
928
+
929
+#### `getNonDeletedElements`
930
+
931
+**How to use**
932
+
933
+```js
934
+import { getNonDeletedElements } from "@excalidraw/excalidraw-next";
935
+```
936
+
937
+**Signature**
938
+
939
+<pre>
940
+getNonDeletedElements(elements: <a href="https://github.com/excalidraw/excalidraw/blob/master/src/element/types.ts#L80"> readonly ExcalidrawElement[]</a>): as readonly <a href="https://github.com/excalidraw/excalidraw/blob/master/src/element/types.ts#L90">NonDeletedExcalidrawElement[]</a>
941
+</pre>
942
+
943
+This function returns an array of deleted elements.
944
+
913 945
 ### Exported constants
914 946
 
915 947
 #### `FONT_FAMILY`

+ 3
- 0
src/packages/excalidraw/index.tsx 查看文件

@@ -171,6 +171,7 @@ export {
171 171
   getSceneVersion,
172 172
   getElementMap,
173 173
   isInvisiblySmallElement,
174
+  getNonDeletedElements,
174 175
 } from "../../element";
175 176
 export { defaultLang, languages } from "../../i18n";
176 177
 export { restore, restoreAppState, restoreElements } from "../../data/restore";
@@ -183,4 +184,6 @@ export {
183 184
   loadFromBlob,
184 185
   getFreeDrawSvgPath,
185 186
 } from "../../packages/utils";
187
+export { isLinearElement } from "../../element/typeChecks";
188
+
186 189
 export { FONT_FAMILY, THEME } from "../../constants";

正在加载...
取消
保存