Selecto

Selecto.js is a component that allows you to select elements in the drag ar...

Drag and dropGesture - Touch
daybrush/selectodaybrush.com/selectoselecto

README


Selecto.js

npm versionReactPreactAngular    alt="Vue"

src="https://img.shields.io/static/v1.svg?label=&message=Vue2&style=flat-square&color=3fb984">    alt="Vue"
src="https://img.shields.io/static/v1.svg?label=&message=Vue3&style=flat-square&color=3fb984">    alt="Svelte"
src="https://img.shields.io/static/v1.svg?label=&message=Svelte&style=flat-square&color=C82B38">    alt="Lit" src="https://img.shields.io/static/v1.svg?label=&message=Lit&style=flat-square&color=4E8EE0">

Selecto.js is a component that allows you to select elements in the drag area using the mouse or touch.

Demo / API / Main Project


⚙️ Installation

npm

  1. ``` sh
  2. $ npm install selecto
  3. ```

scripts


  1. ``` html
  2. <script src="//daybrush.com/selecto/release/latest/dist/selecto.min.js"></script>
  3. ```

🚀 How to use


Option Behaviors

If you want to prevent select from inside and no click
    selectFromInside: false
    selectByClick: false (default)
If you want to include it regardless of hitTest when selecting from the inside
    selectFromInside: true (default)
    selectByClick: true
If you want to finish right away (selectStart and selectEnd occur at the same time) without dragging when selecting from inside
    selectFromInside: false
    selectByClick: true
    preventDragFromInside: true (default)
    clickBySelectEnd: false (default)
If you want to selectEnd(click) after stopping drag and mouse(touch)
    selectFromInside: false
    selectByClick: true
    clickBySelectEnd: true

  1. ``` js
  2. import Selecto from "selecto";

  4. const selecto = new Selecto({
  5.     // The container to add a selection element
  6.     container: document.body,
  7.     // Selecto's root container (No transformed container. (default: null)
  8.     rootContainer: null,
  9.     // The area to drag selection element (default: container)
  10.     dragContainer: Element,
  11.     // Targets to select. You can register a queryselector or an Element.
  12.     selectableTargets: [".target", document.querySelector(".target2")],
  13.     // Whether to select by click (default: true)
  14.     selectByClick: true,
  15.     // Whether to select from the target inside (default: true)
  16.     selectFromInside: true,
  17.     // After the select, whether to select the next target with the selected target (deselected if the target is selected again).
  18.     continueSelect: false,
  19.     // Determines which key to continue selecting the next target via keydown and keyup.
  20.     toggleContinueSelect: "shift",
  21.     // The container for keydown and keyup events
  22.     keyContainer: window,
  23.     // The rate at which the target overlaps the drag area to be selected. (default: 100)
  24.     hitRate: 100,
  25. });

  27. selecto.on("select", e => {
  28.     e.added.forEach(el => {
  29.         el.classList.add("selected");
  30.     });
  31.     e.removed.forEach(el => {
  32.         el.classList.remove("selected");
  33.     });
  34. });
  35. ```

Do you want to select accurately?

Since selecto basically checks using getBoundingClientRect, it is not accurate if the object is rotated or distorted.

If you want to check accurately, use getElementRect option with the following code

See Example

  1. ```ts
  2. import Selecto from "selecto";
  3. import { getElementInfo } from "moveable"; // (13kb function) if you use react, use react-moveable

  5. const selecto = new Selecto({
  6.     ...,
  7.     // (target: HTMLElement | SVGElement ) => { pos1: number[], pos2: number[], pos3: number[], pos4: number[] }
  8.     // pos1: left top
  9.     // pos2: right top
  10.     // pos3: left bottom
  11.     // pos4: right bottom
  12.     getElementRect: getElementInfo,
  13. });
  14. ```

📦 Packages

|Package Name| Version |Description|
|---|---|---|
|[**react-selecto**](https://github.com/daybrush/selecto/tree/master/packages/react-selecto)|[![](https://img.shields.io/npm/v/react-selecto.svg?style=flat-square)](https://npmjs.com/package/react-selecto)|A
|[**ngx-selecto**](https://github.com/daybrush/selecto/tree/master/packages/ngx-selecto)|[![](https://img.shields.io/npm/v/ngx-selecto.svg?style=flat-square)](https://npmjs.com/package/ngx-selecto)|An
|[**vue-selecto**](https://github.com/daybrush/selecto/tree/master/packages/vue-selecto)|[![](https://img.shields.io/npm/v/vue-selecto.svg?style=flat-square)](https://npmjs.com/package/vue-selecto)|A
|[**vue3-selecto**](https://github.com/daybrush/selecto/tree/master/packages/vue3-selecto)|[![](https://img.shields.io/npm/v/vue3-selecto.svg?style=flat-square)](https://npmjs.com/package/vue-selecto)|A
|[**preact-selecto**](https://github.com/daybrush/selecto/tree/master/packages/preact-selecto)|[![](https://img.shields.io/npm/v/preact-selecto.svg?style=flat-square)](https://npmjs.com/package/preact-selecto)|A
|[**svelte-selecto**](https://github.com/daybrush/selecto/tree/master/packages/svelte-selecto)|[![](https://img.shields.io/npm/v/svelte-selecto.svg?style=flat-square)](https://npmjs.com/package/svelte-selecto)|A
|[**lit-selecto**](https://github.com/daybrush/selecto/tree/master/packages/lit-selecto)|[![](https://img.shields.io/npm/v/lit-selecto.svg?style=flat-square)](https://npmjs.com/package/lit-selecto)|A


⭐️ Show Your Support

Please give a ⭐️ if this project helped you!

👏 Contributing


If you have any questions or requests or want to contribute to selecto or other packages, please write the issue or give me a Pull Request freely.

🐞 Bug Report


If you find a bug, please report to us opening a new Issue on GitHub.


📝 License


This project is MIT licensed.

  1. ```
  2. MIT License

  4. Copyright (c) 2020 Daybrush

  6. Permission is hereby granted, free of charge, to any person obtaining a copy
  7. of this software and associated documentation files (the "Software"), to deal
  8. in the Software without restriction, including without limitation the rights
  9. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. copies of the Software, and to permit persons to whom the Software is
  11. furnished to do so, subject to the following conditions:

  13. The above copyright notice and this permission notice shall be included in all
  14. copies or substantial portions of the Software.

  16. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22. SOFTWARE.
  23. ```