svelte-selecto
    TypeScript icon, indicating that this package has built-in type declarations

    1.18.2 • Public • Published

    Svelte Selecto

    npm version React Preact Angular Vue Svelte Lit

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

    Demo / API / Main Project

    ⚙️ Installation

    npm

    $ npm install svelte-selecto

    🚀 How to use

    <script>
    import Selecto from "svelte-selecto";
    </script>
    <Selecto
        // The container to add a selection element
        container={document.body}
        // The area to drag selection element (default: container)
        dragContainer={window}
        // Targets to select. You can register a queryselector or an Element.
        selectableTargets={[".target", document.querySelector(".target2")]}
        // Whether to select by click (default: true)
        selectByClick={true}
        // Whether to select from the target inside (default: true)
        selectFromInside={true}
        // After the select, whether to select the next target with the selected target (deselected if the target is selected again).
        continueSelect={false}
        // Determines which key to continue selecting the next target via keydown and keyup.
        toggleContinueSelect={"shift"}
        // The container for keydown and keyup events
        keyContainer={window}
        // The rate at which the target overlaps the drag area to be selected. (default: 100)
        hitRate={100}
        on:select={({ detail: e }) => {
            e.added.forEach(el => {
                el.classList.add("selected");
            });
            e.removed.forEach(el => {
                el.classList.remove("selected");
            });
        }}
        />

    ⚙️ Developments

    npm run dev

    Navigate to localhost:5000. You should see your app running. Edit a component file in src, save it, and reload the page to see your changes.

    By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the sirv commands in package.json to include the option --host 0.0.0.0.

    ⭐️ 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.

    MIT License
    
    Copyright (c) 2020 Daybrush
    
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.
    

    Install

    npm i svelte-selecto

    DownloadsWeekly Downloads

    273

    Version

    1.18.2

    License

    MIT

    Unpacked Size

    395 kB

    Total Files

    24

    Last publish

    Collaborators

    • younkue