Skip to content

OGS-GmbH/react-hooks

Repository files navigation

We're OGS, check out our work on github.com/ogs-gmbh

React Hooks

Composable Hooks for React applications.

Preview

license badge workflow badge npm badge

  • Easy to Set Up
    Simple configuration lets you use our hooks quickly.

  • Hooks for everyone's needs
    Extensive collection of React hooks

  • Type-Safe Integration
    Fully compatible with TypeScript.

  • Composable and Scalable
    Designed for composability, allowing hooks to be combined seamlessly.

Getting Started

Important

We're offering an extensive API-Reference covered with in-depth usage examples of this project.

To get a starting point, simply refer to our documentation at ogs-gmbh.github.io/react-hooks.

Prerequisites

  • Node.js version 18 or higher
  • A package manager: e.g. npm, pnpm, ...

Installation

Using npm:

$ npm install @ogs-gmbh/react-hooks
Using a different package managers?

Using yarn:

$ pnpm add @ogs-gmbh/react-hooks

Using pnpm:

$ pnpm add @ogs-gmbh/react-hooks

Using bun:

$ bun add @ogs-gmbh/react-hooks

Usage

We offer various React Hooks. Each React Hook shows its usage and is documented. Please check the list below:

Hook Use-Case
useInitialize Call only on immediate component render, not on subsequent updates
useKey Detect Key-Events
useLatencyBoundState Like React's useState, but with delay
useLazyEffect Calling the effect only on updates, not on the first render
useMounted Checking if the component is mounted
useMountedEffect Calling the effect only when the component is mounted
useMountedState Checking if the component is mounted
usePreviousState Getting the previous state value
usePromise Handling promises

License

The MIT License (MIT) - Please have a look at the LICENSE file for more details.

Contributing

Contributions are always welcome and greatly appreciated. Whether you want to report a bug, suggest a new feature, or improve the documentation, your input helps make the project better for everyone.

Feel free to submit a pull request, issue or feature request.

Issues and Feature Requests

Reporting an issue or creating a feature request is made by creating a new issue on this repository.

You can create a new issue or feature request here.

Pull Requests

GitHub offers a solid guideline for contributing to open source projects through pull requests, covering key practices. These best practices provide a reliable starting point for making effective contributions.

You can find the guidelines here.

Code Of Conduct

We are committed to keeping a welcoming, inclusive, and respectful community for everyone. To help us achieve this, we kindly ask that you adhere to our Code of Conduct.

Disclaimer

All trademarks and registered trademarks mentioned are property of their respective owners and are used for identification purposes only. Use of these names does not imply endorsement or affiliation.

This project is a trademark of OGS Gesellschaft für Datenverarbeitung und Systemberatung mbH. The License does not grant rights to use the trademark without permission.


OGS Logo

Gesellschaft für Datenverarbeitung und Systemberatung mbH

Imprint | Contact | Careers