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

0.1.0 • Public • Published

use-svelte

A collection of Svelte Actions / Directives.

Shortcut

Keyboard shortcuts for elements

import { shortcut } from "use-svelte";

<div
  use:shortcut={{
    shift: true,
    control: true,
    code: "KeyA",
    fn: () => trigger(),
  }}
  on:click={() => trigger()}
></div>;

If fn not supplied, it will trigger the on:click event instead.

Lazy

Lazy load action for images

import { lazy } from "use-svelte";

<img src="placeholder" use:lazy={{src: 'lazy load'}}>

Tooltip

An awesome tooltip action

import { tooltip } from "use-svelte";

<div use:tooltip content="some content"></div>;

To customize the default styling, override the use_svelte_tooltip class in our css.

ClickOutside

Something you'll be definitely using: a clickOutside event.

import { clickOutside } from "use-svelte";

<div use:clickOutside on:clickOutside={() => close()}></div>;

Autofocus

Will autofocus on element once the page is loaded

import { autofocus } from "use-svelte";

<input autofocus />;

Click to Copy

Click to copy

import { clickToCopy } from "use-svelte";

<svelte:window on:copySuccess={() => whatever()} on:copyError={() => whatever()}/>

<div use:clickToCopy>
	Click to copy this text
</div>

// OR
<div id="text">This is some text</div>

<button use:clickToCopy={'#text'}>Click to copy above text</button>

Contributing

  1. Fork this repository
  2. Create your feature branch: git checkout -b branch-name
  3. Commit your changes: git commit -am 'commit-message-here'
  4. Push to the branch: git push origin branch-name
  5. Submit a pull request

Credits

Robert (@treboryx)

License

MIT License

Copyright (c) 2022 treboryx.

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.

Readme

Keywords

Package Sidebar

Install

npm i use-svelte

Weekly Downloads

2

Version

0.1.0

License

MIT

Unpacked Size

17.6 kB

Total Files

11

Last publish

Collaborators

  • rowboat