flagr-feature-react/README.md

react module for using flagr-feature-typescript

# flagr-feature-react

[![image](https://img.shields.io/npm/v/flagr-feature-react?color=CC3534&logo=npm)](https://www.npmjs.com/package/flagr-feature-react)

## Usage

```tsx
import { useFlagr, FlagrContextProvider } from 'flagr-feature-react';

const ID = 'user_123';
const SOME_URL = 'flagrUrl';
const APP_TAGS = ['local'];
const OPTIONAL_CONTEXT = undefined;

const MyApp = () => (
  <FlagrContextProvider
    flagrUrl={SOME_URL}
    tags={APP_TAGS}
    context={OPTIONAL_CONTEXT}
    id={ID}
  >
    <MyComponent />
  </FlagrContextProvider>
);

const MyComponent = () => {
  const { match, loaded } = useFlagr();

  return (
    <>
      {!loaded && 'loading'}
      {loaded && match?.('someFeature') ? 'new hotness' : 'old and busted'}
    </>
  );
};
```

## Installation

Requires npm 7

```bash
npm install
```

## Development

```bash
npm run dev
```

## Deployment

```bash
npm run build
```

## Publishing

This is handled by GitHub actions