Skip to content

fix(react): recreate SelectionArea instance when props change #262

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
simonwep merged 2 commits into from
Feb 15, 2026
Merged

fix(react): recreate SelectionArea instance when props change #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebc88de
fix(react): recreate SelectionArea instance when props change
Feb 8, 2026
4fc6b8b
fix(core): use coalesce operator for default values
simonwep Feb 15, 2026
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
65 changes: 48 additions & 17 deletions packages/preact/src/SelectionArea.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import VanillaSelectionArea from '@viselect/vanilla';
import {SelectionEvents, PartialSelectionOptions} from '@viselect/vanilla';
import {createContext, createRef, FunctionalComponent, JSX} from 'preact';
import {useEffect, useContext, useState} from 'preact/hooks';
import {createContext, JSX, FunctionalComponent} from 'preact';
import {useEffect, useContext, useState, useMemo, useRef} from 'preact/hooks';

export interface SelectionAreaProps extends PartialSelectionOptions, JSX.HTMLAttributes<HTMLDivElement> {
id?: string;
Expand All @@ -18,39 +18,70 @@ const SelectionContext = createContext<VanillaSelectionArea | undefined>(undefin
export const useSelection = () => useContext(SelectionContext);

export const SelectionArea: FunctionalComponent<SelectionAreaProps> = props => {
const {
boundaries,
document: doc,
selectables,
startAreas,
container,
behaviour,
features,
onBeforeStart,
onBeforeDrag,
onStart,
onMove,
onStop,
className,
id,
children,
...rest
} = props;

const [instance, setInstance] = useState<VanillaSelectionArea | undefined>(undefined);
const root = createRef<HTMLDivElement>();
const root = useRef<HTMLDivElement>(null);

// Use refs for callbacks to avoid recreating the instance when only callbacks change
const callbacksRef = useRef({onBeforeStart, onBeforeDrag, onStart, onMove, onStop});
callbacksRef.current = {onBeforeStart, onBeforeDrag, onStart, onMove, onStop};

// Stable serialization of object props for dependency comparison
const behaviourKey = useMemo(() => JSON.stringify(behaviour), [behaviour]);
const featuresKey = useMemo(() => JSON.stringify(features), [features]);

useEffect(() => {
/* eslint-disable @typescript-eslint/no-unused-vars */
const {boundaries = root.current, onBeforeStart, onBeforeDrag, onStart, onMove, onStop, ...opt} = props;
const boundaryElement = boundaries ?? root.current;

const selection = new VanillaSelectionArea({
boundaries: boundaries as HTMLElement,
...opt
boundaries: boundaryElement as HTMLElement,
document: doc,
selectables,
startAreas,
container,
behaviour,
features
});

selection.on('beforestart', evt => props.onBeforeStart?.(evt));
selection.on('beforedrag', evt => props.onBeforeDrag?.(evt));
selection.on('start', evt => props.onStart?.(evt));
selection.on('move', evt => props.onMove?.(evt));
selection.on('stop', evt => props.onStop?.(evt));
selection.on('beforestart', evt => callbacksRef.current.onBeforeStart?.(evt));
selection.on('beforedrag', evt => callbacksRef.current.onBeforeDrag?.(evt));
selection.on('start', evt => callbacksRef.current.onStart?.(evt));
selection.on('move', evt => callbacksRef.current.onMove?.(evt));
selection.on('stop', evt => callbacksRef.current.onStop?.(evt));

setInstance(selection);

return () => {
selection.destroy();
setInstance(undefined);
};
}, []);
}, [boundaries, doc, selectables, startAreas, container, behaviourKey, featuresKey]);

return (
<SelectionContext.Provider value={instance}>
{props.boundaries ? (
props.children
{boundaries ? (
children
) : (
<div ref={root} className={props.className} id={props.id}>
{props.children}
<div ref={root} className={className} id={id} {...rest}>
{children}
</div>
)}
</SelectionContext.Provider>
Expand Down
61 changes: 46 additions & 15 deletions packages/react/src/SelectionArea.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import VanillaSelectionArea from '@viselect/vanilla';
import {SelectionEvents, PartialSelectionOptions} from '@viselect/vanilla';
import React, {useEffect, createContext, useContext, useRef, useState} from 'react';
import React, {useEffect, createContext, useContext, useRef, useState, useMemo} from 'react';

export interface SelectionAreaProps extends PartialSelectionOptions, React.HTMLAttributes<HTMLDivElement> {
id?: string;
Expand All @@ -17,39 +17,70 @@ const SelectionContext = createContext<VanillaSelectionArea | undefined>(undefin
export const useSelection = () => useContext(SelectionContext);

export const SelectionArea: React.FunctionComponent<SelectionAreaProps> = props => {
const {
boundaries,
document: doc,
selectables,
startAreas,
container,
behaviour,
features,
onBeforeStart,
onBeforeDrag,
onStart,
onMove,
onStop,
className,
id,
children,
...rest
} = props;

const [instance, setInstance] = useState<VanillaSelectionArea | undefined>(undefined);
const root = useRef<HTMLDivElement>(null);

// Use refs for callbacks to avoid recreating the instance when only callbacks change
const callbacksRef = useRef({onBeforeStart, onBeforeDrag, onStart, onMove, onStop});
callbacksRef.current = {onBeforeStart, onBeforeDrag, onStart, onMove, onStop};

// Stable serialization of object props for dependency comparison
const behaviourKey = useMemo(() => JSON.stringify(behaviour), [behaviour]);
const featuresKey = useMemo(() => JSON.stringify(features), [features]);

useEffect(() => {
/* eslint-disable @typescript-eslint/no-unused-vars */
const {boundaries = root.current, onBeforeStart, onBeforeDrag, onStart, onMove, onStop, ...opt} = props;
const boundaryElement = boundaries ?? root.current;

const selection = new VanillaSelectionArea({
boundaries: boundaries as HTMLElement,
...opt
boundaries: boundaryElement as HTMLElement,
document: doc,
selectables,
startAreas,
container,
behaviour,
features
});

selection.on('beforestart', evt => props.onBeforeStart?.(evt));
selection.on('beforedrag', evt => props.onBeforeDrag?.(evt));
selection.on('start', evt => props.onStart?.(evt));
selection.on('move', evt => props.onMove?.(evt));
selection.on('stop', evt => props.onStop?.(evt));
selection.on('beforestart', evt => callbacksRef.current.onBeforeStart?.(evt));
selection.on('beforedrag', evt => callbacksRef.current.onBeforeDrag?.(evt));
selection.on('start', evt => callbacksRef.current.onStart?.(evt));
selection.on('move', evt => callbacksRef.current.onMove?.(evt));
selection.on('stop', evt => callbacksRef.current.onStop?.(evt));

setInstance(selection);

return () => {
selection.destroy();
setInstance(undefined);
};
}, []);
}, [boundaries, doc, selectables, startAreas, container, behaviourKey, featuresKey]);

return (
<SelectionContext.Provider value={instance}>
{props.boundaries ? (
props.children
{boundaries ? (
children
) : (
<div ref={root} className={props.className} id={props.id}>
{props.children}
<div ref={root} className={className} id={id} {...rest}>
{children}
</div>
)}
</SelectionContext.Provider>
Expand Down
44 changes: 19 additions & 25 deletions packages/vanilla/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,45 +65,39 @@ export default class SelectionArea extends EventTarget<SelectionEvents> {
super();

this._options = {
selectionAreaClass: 'selection-area',
selectionContainerClass: undefined,
selectables: [],
document: window.document,
startAreas: ['html'],
boundaries: ['html'],
container: 'body',
...opt,
selectionAreaClass: opt.selectionAreaClass ?? 'selection-area',
selectionContainerClass: opt.selectionContainerClass ?? undefined,
selectables: opt.selectables ?? [],
document: opt.document ?? window.document,
startAreas: opt.startAreas ?? ['html'],
boundaries: opt.boundaries ?? ['html'],
container: opt.container ?? 'body',

behaviour: {
overlap: 'invert',
intersect: 'touch',
triggers: [0],
...opt.behaviour,
overlap: opt.behaviour?.overlap ?? 'invert',
intersect: opt.behaviour?.intersect ?? 'touch',
triggers: opt.behaviour?.triggers ?? [0],
startThreshold: opt.behaviour?.startThreshold ?
typeof opt.behaviour.startThreshold === 'number' ?
opt.behaviour.startThreshold :
{x: 10, y: 10, ...opt.behaviour.startThreshold} : {x: 10, y: 10},
scrolling: {
speedDivider: 10,
manualSpeed: 750,
...opt.behaviour?.scrolling,
speedDivider: opt.behaviour?.scrolling?.speedDivider ?? 10,
manualSpeed: opt.behaviour?.scrolling?.manualSpeed ?? 750,
startScrollMargins: {
x: 0,
y: 0,
...opt.behaviour?.scrolling?.startScrollMargins,
x: opt.behaviour?.scrolling?.startScrollMargins?.x ?? 0,
y: opt.behaviour?.scrolling?.startScrollMargins?.y ?? 0
}
}
},

features: {
range: true,
touch: true,
deselectOnBlur: false,
...opt.features,
range: opt.features?.range ?? true,
touch: opt.features?.touch ?? true,
deselectOnBlur: opt.features?.deselectOnBlur ?? false,
singleTap: {
allow: true,
intersect: 'native',
...opt.features?.singleTap,
allow: opt.features?.singleTap?.allow ?? true,
intersect: opt.features?.singleTap?.intersect ?? 'native',
}
}
};
Expand Down