Nuanced Pumpkin Mavens

    configcat-react
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    ConfigCat SDK for React applications

    https://configcat.com

    ConfigCat SDK for React provides easy integration for your web application to ConfigCat.

    About

    Manage features and change your software configuration using ConfigCat feature flags , without the need to re-deploy code. A 10 minute trainable Dashboard allows even non-technical team members to manage features directly. Deploy anytime, release when confident. Target a specific group of users first with new ideas. Supports A/B/n testing and soft launching.

    ConfigCat is a hosted feature flag service. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.

    REACT CI codecov Known Vulnerabilities Reliability Rating Tree Shaking License NPM

    Getting Started

    The ConfigCat React SDK uses the Context API (requires React 16.3 or later) and Hook API (requires React 16.8 or later) to provide a better integration in your React application.

    1. Install package:

    via NPM package:

    npm i configcat-react

    2. Go to the ConfigCat Dashboard to get your SDK Key:

    SDK-KEY

    3. Import and initialize ConfigCatProvider

    In most cases you should wrap your root component with ConfigCatProvider to access ConfigCat features in child components with Context API.

    import React from "react";
    import { ConfigCatProvider } from "configcat-react";
    
    function App() {
      return (
        <ConfigCatProvider sdkKey="#YOUR_SDK_KEY#">
          {/* your application code */}
        </ConfigCatProvider>
      );
    }
    
    export default App;

    4. Get your setting value:

    The React hooks (useFeatureFlag) way:

    function ButtonComponent() {
      const { value: isAwesomeFeatureEnabled, loading } = useFeatureFlag("isAwesomeFeatureEnabled", false);
    
      return loading ? (<div>Loading...</div>) : (
        <div>Feature flag value: {isAwesomeFeatureEnabled ? 'ON' : 'OFF'}</div>
      );
    }

    The React HOC (WithConfigCatClientProps) way:

    class TestHOCComponent extends React.Component<
        WithConfigCatClientProps,
        { isAwesomeFeatureEnabled: string }
    > {
        constructor(props: WithConfigCatClientProps) {
            super(props);
    
            this.state = { isAwesomeFeatureEnabled: false, loading: true };
        }
    
        componentDidMount() {
            this.evaluateFeatureFlag();
        }
    
        componentDidUpdate(prevProps: any) {
          // To achieve hot reload on config.json updates.
          if (prevProps?.lastUpdated !== this.props.lastUpdated) {
            this.evaluateFeatureFlag();
          }
        }
    
        evaluateFeatureFlag(){
            this.props
                .getValue("isAwesomeFeatureEnabled", false)
                .then((v: boolean) => this.setState({ isAwesomeFeatureEnabled: v, loading: false }));
        }
        
        render() {
            return loading ? (<div>Loading...</div>) : (
                <div>Feature flag value: {this.state.isAwesomeFeatureEnabled ? 'ON' : 'OFF'}</div>
            );
        }
    }

    Sample/Demo app

    Polling Modes

    The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache then all requests are served from there. Read more about Polling Modes and how to use them at ConfigCat Docs.

    Sensitive information handling

    The frontend/mobile SDKs are running in your users' browsers/devices. The SDK is downloading a config.json file from ConfigCat's CDN servers. The URL path for this config.json file contains your SDK key, so the SDK key and the content of your config.json file (feature flag keys, feature flag values, targeting rules, % rules) can be visible to your users. This SDK key is read-only, it only allows downloading your config.json file, but nobody can make any changes with it in your ConfigCat account.
    Suppose you don't want your SDK key or the content of your config.json file visible to your users. In that case, we recommend you use the SDK only in your backend applications and call a backend endpoint in your frontend/mobile application to evaluate the feature flags for a specific application customer.
    Also, we recommend using sensitive targeting comparators in the targeting rules of those feature flags that are used in the frontend/mobile SDKs.

    Need help?

    https://configcat.com/support

    Contributing

    Contributions are welcome. For more info please read the Contribution Guideline.

    About ConfigCat

    Install

    npm i configcat-react

    DownloadsWeekly Downloads

    393

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    68.2 kB

    Total Files

    58

    Last publish

    Collaborators

    • pcsajtai
    • endret
    • laliconfigcat
    • sigewuzhere