# solidjs-use

> Collection of SolidJS utilities inspired completely by VueUse

Latest version **2.3.0** (published 2023-08-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install solidjs-use
pnpm add solidjs-use
yarn add solidjs-use
bun add solidjs-use
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.3.0 |
| Published | 2023-08-06 |
| First published | 2023-02-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 593.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 211 |
| Author | dream2023 |
| Maintainers | dream2023 |
| Keywords | solid, solidjs, solidjs-use, solid use, utils, solidjs hooks, solid hooks, hooks, solidjs-core |

## Links

- npm: https://www.npmjs.com/package/solidjs-use
- Repository: https://github.com/solidjs-use/solidjs-use
- Homepage: https://github.com/solidjs-use/solidjs-use#readme
- Issues: https://github.com/solidjs-use/solidjs-use/issues
- npm.io page: https://npm.io/package/solidjs-use

## Dependencies (2)

- [@solidjs-use/shared](https://npm.io/package/@solidjs-use/shared.md) 2.3.0
- [@types/web-bluetooth](https://npm.io/package/@types/web-bluetooth.md) ^0.0.16

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.3.0 (latest) — 2023-08-06
- 2.0.0-beta.0 (beta) — 2023-04-08
- 2.2.1 — 2023-07-02
- 2.2.0 — 2023-06-25
- 2.1.0 — 2023-05-06
- 2.0.0 — 2023-04-16
- 1.2.0 — 2023-02-19
- 1.1.0 — 2023-02-12
- 1.0.0 — 2023-02-04

## README

<h1 align="center">SOLIDJS-USE</h1>

<div align="center">

Collection of SolidJS utilities inspired completely by VueUse.

[![CI status][github-ci-image]][github-ci-url] [![Docs status][github-docs-image]][github-docs-url] [![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url] ![GitHub](https://img.shields.io/github/license/solidjs-use/solidjs-use?style=flat-square)

</div>

[github-ci-image]: https://github.com/solidjs-use/solidjs-use/actions/workflows/ci.yml/badge.svg
[github-ci-url]: https://github.com/solidjs-use/solidjs-use/actions/workflows/ci.yml
[github-docs-image]: https://github.com/solidjs-use/solidjs-use/actions/workflows/docs.yml/badge.svg
[github-docs-url]: https://github.com/solidjs-use/solidjs-use/actions/workflows/docs.yml
[npm-image]: https://img.shields.io/npm/v/solidjs-use?style=flat-square
[npm-url]: http://npmjs.org/package/solidjs-use
[download-image]: https://img.shields.io/npm/dm/solidjs-use?style=flat-square
[download-url]: https://npmjs.org/package/solidjs-use

<div align="center">

**[Docs](https://solidjs-use.github.io/solidjs-use/) • [Playground](https://solidjs-use.github.io/solidjs-use-playground/) • [Demo](https://github.com/solidjs-use/solidjs-use-vite-starter)**

</div>

[![](./show.png)](https://solidjs-use.github.io/solidjs-use)

## 🚀 Features

- 🎛 **Feature Rich**: 300+ functions for you to choose from
- 🎪 [**Interactive docs & demos**](https://solidjs-use.github.io/solidjs-use)
- ⚡ **Fully tree shakeable**: Only take what you want, [bundle size](https://solidjs-use.github.io/solidjs-use/export-size)
- 🦾 **Type Strong**: Written in [TypeScript](https://www.typescriptlang.org/), with [TS Docs](https://github.com/microsoft/tsdoc)
- 🔩 **Flexible**: Configurable event filters and targets

## 🦄 Usage

```tsx
import { useMouse } from 'solidjs-use'

const Demo = () => {
  const { x, y } = useMouse()
  return (
    <h1>
      {x()} x {y()}
    </h1>
  )
}

export default Demo
```

Refer to [documentations](https://solidjs-use.github.io/solidjs-use/) for more details.

## 📦 Install

```bash
npm i solidjs-use
```

[Add ons](https://solidjs-use.github.io/solidjs-use/add-ons.html)

## Demo

- [Vite + SolidJS + solidjs-use](https://github.com/solidjs-use/solidjs-use-vite-starter)

## 🧱 Contribute

See the [**Contributing Guide**](https://solidjs-use.github.io/solidjs-use/contributing)

## 🌸 Thanks

This project is heavily inspired by the following awesome projects.

- [vueuse](https://vueuse.org/)
- [streamich/react-use](https://github.com/streamich/react-use)
- [u3u/vue-hooks](https://github.com/u3u/vue-hooks)
- [logaretm/vue-use-web](https://github.com/logaretm/vue-use-web)
- [kripod/react-hooks](https://github.com/kripod/react-hooks)

And thanks to [all the contributors on GitHub](https://github.com/solidjs-use/solidjs-use/graphs/contributors)!

## 📄 License

[MIT License](https://github.com/solidjs-use/solidjs-use/blob/main/LICENSE) © 2023-PRESENT [dream2023](https://github.com/dream2023)

![Star History Chart](https://api.star-history.com/svg?repos=solidjs-use/solidjs-use&type=Date)

---
_Source: https://npm.io/package/solidjs-use · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._