@preact-hooks/instance
TypeScript icon, indicating that this package has built-in type declarations

1.0.6 • Public • Published

Preact Hooks - Instance

Inspired by donovan/use-instance

version MIT License

A custom Preact Hook that provides a sensible alternative to useRef for storing instance variables.


Table of Contents

Why?

See more in-depth explanation at: donovan/use-instance.

  • useRef is weird.
  • The fact that you have to access it via .current is strange.
  • You treat the object returned by useInstance just like you would this in a class component, so you're already familiar with how it works.
  • Use useRef if you're dealing with actual DOM elements.
  • Use useInstance for instance properties and methods.

Installation

This package has Preact 10+ as a peer dependency.

npm install @preact-hooks/instance or yarn add @preact-hooks/instance

You can also load it via the unpkg CDN

https://unpkg.com/@preact-hooks/instance will download the latest UMD bundle.

Docs

For usage and examples see donovan/use-instance.

LICENSE

MIT

Dependencies (0)

    Dev Dependencies (14)

    Package Sidebar

    Install

    npm i @preact-hooks/instance

    Weekly Downloads

    2

    Version

    1.0.6

    License

    MIT

    Unpacked Size

    7.39 kB

    Total Files

    7

    Last publish

    Collaborators

    • mihar-22