solidjs-use / solidjs-use

Collection of SolidJS utilities inspired completely by VueUse

Home Page:https://solidjs-use.github.io/solidjs-use/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

Collection of SolidJS utilities inspired completely by VueUse

https://solidjs-use.github.io/solidjs-use/

License:MIT License


Languages

Language:TypeScript 97.1%Language:CSS 2.0%Language:JavaScript 0.5%Language:Less 0.3%Language:HTML 0.1%