@ionaco/react-utils v1.0.1

Iona React Utilities

This package is a utility library containing several useful components, helper functions, and custom hooks for React.js.

API documentation

Documentation can be found here. Documentation is also available in a cleaner HTML version which can be found under /docs/html.

Installation

Using npm

npm install @ionaco/react-utils --save

Using yarn

yarn add @ionaco/react-utils

Usage

To import a function or component from this library:

import { Drawer, useEventListener } from '@ionaco/react-utils';

Development

To start development:

• Use npm v10.16+
• Clone this repository
• Run npm install
• run npm run dev

Documenting

This library uses TypeDoc built from JSDoc to generate documentation. Follow the JSDoc link on how to properly document the library. To generate API docs:

• Run npm run doc

Building

• Run npm run build

Testing

To be added

Contributing

We encourage devs from Iona to add their contribution to this repoistory. Please create a feature branch with the convention feat/*. When complete, create a pull request describing the feature. Pull requests will be reviewed by lead and senior developers and will be merged to the master branch.