/solidjs-use

Collection of SolidJS utilities inspired completely by VueUse

Primary LanguageTypeScriptMIT LicenseMIT

SOLIDJS-USE

Collection of SolidJS utilities inspired completely by VueUse.

CI status Docs status NPM version NPM downloads GitHub

Docs • Playground • Demo

🚀 Features

  • 🎛 Feature Rich: 300+ functions for you to choose from
  • 🎪 Interactive docs & demos
  • âš¡ Fully tree shakeable: Only take what you want, bundle size
  • 🦾 Type Strong: Written in TypeScript, with TS Docs
  • 🔩 Flexible: Configurable event filters and targets

🦄 Usage

import { useMouse } from 'solidjs-use'

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

export default Demo

Refer to documentations for more details.

📦 Install

npm i solidjs-use

Add ons

Demo

🧱 Contribute

See the Contributing Guide

🌸 Thanks

This project is heavily inspired by the following awesome projects.

And thanks to all the contributors on GitHub!

📄 License

MIT License © 2023-PRESENT dream2023

Star History Chart