瀏覽代碼

feat: export isLinearElement and getNonDeletedElements (#4072)

* feat: export isLinearElement and getNonDeletedElements

* fix
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.
 
 ### Features
 
+- 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).
+
 - Support [`renderTopRightUI`](https://github.com/excalidraw/excalidraw/blob/master/src/packages/excalidraw/README.md#renderTopRightUI) in mobile UI.
 
 - 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
 
 This function returns the free draw svg path for the element.
 
+#### `isLinearElement`
+
+**How to use**
+
+```js
+import { isLinearElement } from "@excalidraw/excalidraw-next";
+```
+
+**Signature**
+
+<pre>
+isLinearElement(elementType?: <a href="https://github.com/excalidraw/excalidraw/blob/master/src/element/types.ts#L80">ExcalidrawElement</a>): boolean
+</pre>
+
+This function returns true if the element is linear type (`arrow` |`line`) else returns false.
+
+#### `getNonDeletedElements`
+
+**How to use**
+
+```js
+import { getNonDeletedElements } from "@excalidraw/excalidraw-next";
+```
+
+**Signature**
+
+<pre>
+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>
+</pre>
+
+This function returns an array of deleted elements.
+
 ### Exported constants
 
 #### `FONT_FAMILY`

+ 3 - 0
src/packages/excalidraw/index.tsx

@@ -171,6 +171,7 @@ export {
   getSceneVersion,
   getElementMap,
   isInvisiblySmallElement,
+  getNonDeletedElements,
 } from "../../element";
 export { defaultLang, languages } from "../../i18n";
 export { restore, restoreAppState, restoreElements } from "../../data/restore";
@@ -183,4 +184,6 @@ export {
   loadFromBlob,
   getFreeDrawSvgPath,
 } from "../../packages/utils";
+export { isLinearElement } from "../../element/typeChecks";
+
 export { FONT_FAMILY, THEME } from "../../constants";