Skip to content

Array and edit improvements #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 22, 2025
Merged

Array and edit improvements #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69a4010
Allow moving between arrays and add explicit position to edits
Tate-CC Oct 22, 2025
d1e91ba
Remove unused mouse event + add missing sourceIndex
Tate-CC Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,15 @@ export interface EditOptions {
slug: string;
/** Optional style information */
style?: string | null;
/** The mouse event that triggered the edit */
e?: MouseEvent;
/** The coordinates of the edit, and the bounding rectangle of the element being edited */
position?: {
x: number;
y: number;
left: number;
width: number;
top: number;
height: number;
};
}

/**
Expand All @@ -215,16 +222,20 @@ export interface AddArrayItemOptions extends ArrayOptions {
index: number | null;
/** The value to insert */
value: any;
/** The mouse event that triggered the addition */
e?: MouseEvent;
/** The index to clone from if value isnt provided */
sourceIndex?: number;
}

/**
* Options for moving an array item in the v2 API
*/
export interface MoveArrayItemOptions extends ArrayOptions {
export interface MoveArrayItemOptions {
/** the identifier of the array field to move from */
fromSlug: string;
/** the identifier of the array field to move to, defaults to fromSlug if not provided */
toSlug?: string;
/** The current index of the item */
index: number;
fromIndex: number;
/** The target index for the item */
toIndex: number;
}
Expand Down