React Use Config

What is React Use Config?

React Use Config provides the useConfigParam hook to retrieve configuration values with the following priority:

1. Query Parameters: Extracted directly from the URL.
2. Environment Variables: With the prefix REACT_APP_.
3. Default Values: Used when no other option is available.

Features

• Retrieve parameters dynamically from multiple sources.
• Automatic boolean conversion for true and false.
• Customizable default values.
• Lightweight and easy to integrate.

Configuration Retrieval Funnel

The following diagram demonstrates the priority order for retrieving configuration values:

Getting Started

Follow these steps to start using React Use Config:

1. Install the package:

npm install react-use-config

2. Import the hook in your project:

import useConfigParam from 'react-use-config';

3. Example usage:

const geoServer = useConfigParam('geoServer', 'http://localhost:8080/geoserver');
console.log(geoServer); // Output based on priority
                

Contribute

We welcome contributions! Open an issue or submit a pull request on the GitHub Repository.

Learn More

For more details, visit the GitHub Repository.