React Pakistan — Util Functions

React Pakistan is an open-source platform creating React software solutions for the global community.

A central library of utility functions, hooks, constants, and factories for the React Pakistan ecosystem.

Table of Contents

• Tech Stack
• Installation
• Usage
• Tests
• Ecosystem
• Contributors
• Support

Tech Stack

React · TypeScript · Styled Components · Vitest · ESLint

Installation

yarn add @react-pakistan/util-functions
# or
npm install @react-pakistan/util-functions

Development

git clone <repo-url>
cd util-functions
yarn
yarn test        # run all tests
yarn test:watch  # watch mode
yarn build       # build the library

Usage

This package has no barrel exports. Import functions directly from their file paths.

// General utilities
import { slugify } from '@react-pakistan/util-functions/general/slugify';
import { validateEmail } from '@react-pakistan/util-functions/general/validate-email';
import { formatDate } from '@react-pakistan/util-functions/general/format-date';

// Hooks
import { useDebounce } from '@react-pakistan/util-functions/hooks/use-debounce';
import { useRTL } from '@react-pakistan/util-functions/hooks/use-rtl';

// Constants
import { API_METHODS } from '@react-pakistan/util-functions/constants/api-methods';
import { COUNTRIES_TIMEZONES } from '@react-pakistan/util-functions/constants/countries-timezones';

// Local storage
import { getStorageValue } from '@react-pakistan/util-functions/local-storage/get-storage-value';

// Factories
import { genericComponentFactory } from '@react-pakistan/util-functions/factory/generic-component-factory';

Tests

156 test files · 693 tests — all passing.

Should you like this project, please consider giving a ⭐ on GitHub.

Contributors

| Contributor | GitHub | Role | |------------|--------|------| | | Taimoor Khan | Maintainer |

Ecosystem

| Library | Storybook | npm | |---------|-----------|-----| | React Commons Collection | storybook | npm | | React UI Collection | storybook | npm | | React Icon Collection | storybook | npm | | React Logo Collection | storybook | npm | | React Emoji Collection | storybook | npm | | React Native Commons Collection | docs | npm | | React Native UI Collection | docs | npm | | React Native Icon Collection | docs | npm | | React Native Logo Collection | docs | npm | | React Native Emoji Collection | docs | npm |

Support

Join the community on React Pakistan Slack.

Contact — Taimoor Khan · email