Skip to content

Expose restrict in EditableAnnotation #1858

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rajankonar wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Expose restrict in EditableAnnotation #1858

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
955725c
Expose restrict in EditableAnnotation
rajankonar Jul 13, 2024
093170b
comments added and reverted unwanted changes
rajankonar Jul 13, 2024
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
10 changes: 10 additions & 0 deletions packages/visx-annotation/src/components/EditableAnnotation.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ export type EditableAnnotationProps = Pick<AnnotationContextType, 'x' | 'y' | 'd
onDragMove?: ({ x, y, dx, dy, event }: HandlerArgs) => void;
/** Callback invoked on drag end. */
onDragEnd?: ({ x, y, dx, dy, event }: HandlerArgs) => void;
/** Optional x/y desired bounds for subject/label. */
restrict?: {
xMin?: number;
xMax?: number;
yMin?: number;
yMax?: number;
};
};

export type HandlerArgs = {
Expand Down Expand Up @@ -58,6 +65,7 @@ export default function EditableAnnotation({
width,
x: subjectX = 0,
y: subjectY = 0,
restrict,
}: EditableAnnotationProps) {
// chicken before the egg, we need these to reference drag state
// in drag callbacks which are defined before useDrag() state is available
Expand Down Expand Up @@ -115,6 +123,7 @@ export default function EditableAnnotation({
onDragEnd: handleDragEnd,
x: subjectX,
y: subjectY,
restrict: restrict,
});

const labelDrag = useDrag({
Expand All @@ -123,6 +132,7 @@ export default function EditableAnnotation({
onDragEnd: handleDragEnd,
x: labelDx,
y: labelDy,
restrict: restrict,
});

// enable referencing these in the callbacks defined before useDrag is called
Expand Down