docs: add tsdoc for certain element props (#2673)
Co-authored-by: Panayiotis Lipiridis <lipiridis@gmail.com>
This commit is contained in:
parent
3b0fb1562d
commit
3aab81bc35
@ -27,11 +27,21 @@ type _ExcalidrawElementBase = Readonly<{
|
|||||||
width: number;
|
width: number;
|
||||||
height: number;
|
height: number;
|
||||||
angle: number;
|
angle: number;
|
||||||
|
/** Random integer used to seed shape generation so that the roughjs shape
|
||||||
|
doesn't differ across renders. */
|
||||||
seed: number;
|
seed: number;
|
||||||
|
/** Integer that is sequentially incremented on each change. Used to reconcile
|
||||||
|
elements during collaboration or when saving to server. */
|
||||||
version: number;
|
version: number;
|
||||||
|
/** Random integer that is regenerated on each change.
|
||||||
|
Used for deterministic reconciliation of updates during collaboration,
|
||||||
|
in case the versions (see above) are identical. */
|
||||||
versionNonce: number;
|
versionNonce: number;
|
||||||
isDeleted: boolean;
|
isDeleted: boolean;
|
||||||
|
/** List of groups the element belongs to.
|
||||||
|
Ordered from deepest to shallowest. */
|
||||||
groupIds: readonly GroupId[];
|
groupIds: readonly GroupId[];
|
||||||
|
/** Ids of (linear) elements that are bound to this element. */
|
||||||
boundElementIds: readonly ExcalidrawLinearElement["id"][] | null;
|
boundElementIds: readonly ExcalidrawLinearElement["id"][] | null;
|
||||||
}>;
|
}>;
|
||||||
|
|
||||||
|
@ -51,6 +51,10 @@ Please add the latest change on the top under the correct section.
|
|||||||
|
|
||||||
- Bump ini from 1.3.5 to 1.3.7 in /src/packages/excalidraw [#2500](https://github.com/excalidraw/excalidraw/pull/2500)
|
- Bump ini from 1.3.5 to 1.3.7 in /src/packages/excalidraw [#2500](https://github.com/excalidraw/excalidraw/pull/2500)
|
||||||
|
|
||||||
|
### Docs
|
||||||
|
|
||||||
|
- Document some of the more exotic element props [#2673](https://github.com/excalidraw/excalidraw/pull/2673)
|
||||||
|
|
||||||
## 0.1.1
|
## 0.1.1
|
||||||
|
|
||||||
#### Fix
|
#### Fix
|
||||||
|
Loading…
x
Reference in New Issue
Block a user