useSelectionLasso

React API

useSelectionLasso

Parametrit

• ref

  SelectionLasso-komponentin ref-objekti.

  Tyyppi: RefObject<HTMLDivElement> | MutableRefObject<HTMLDivElement>

• options

  Valintalassolle annettavat asetukset.

  Tyyppi: UseSelectionLassoOptions

  Parametrit

  Nimi	Tyyppi	Oletusarvo
  container	HTMLElement	-
  enabled	boolean	-
  onMouseDown	(e: MouseEvent) => void	-
  onMouseMove *pakollinen	(e: MouseEvent, insideItems: E[], outsideItems: E[]) => void	-
  onMouseUp	(e: MouseEvent) => void	-
  preventInteraction	boolean	true
  root	HTMLElement	-
  selectableItems *pakollinen	E[]	-
  selectionThreshold	number	3

Paluuarvot

• props

  Palauttaa props-objektin, jonka voi välittää SelectionLasso-komponentille.

  Tyyppi: { isActive: boolean; }

• reset

  Funktio, jonka avulla voi tarvittaessa nollata valintalasson näkyvyyden.

  Tyyppi: () => void

useSelectionLassoScroll

Parametrit

• scrollSpeed

  Tyyppi: number

  Oletusarvo: 20

• scrollThreshold

  Tyyppi: number

  Oletusarvo: 50

Paluuarvot

• onMouseUp

  Tyyppi: () => void

• onMouseMove

  Tyyppi: (e: MouseEvent) => void

useSelectionLassoSelect

Parametrit

• deselectItem

  Funktio, jota kutsutaan kun valinta poistetaan.

  Tyyppi: (item: E) => void

• multiSelectKey

  Painike, jonka avulla voidaan valita erillisiä valintaruutuja.

  Tyyppi: string | string[]

• selectableItems

  Pakollinen

  Valittavat vaihtoehdot.

  Tyyppi: E[]

• selectItem

  Funktio, jota kutsutaan kun valinta tehdään.

  Tyyppi: (item: E) => void;

Paluuarvot

• select

  Tyyppi: (insideItems: E[], outsideItems: E[]) => void

• onChange

  Tyyppi: (item: E, isSelected: boolean) => void