# @featureflip/react 中文文档

规范地址：https://npmcn.com/package/%40featureflip/react/

版本：2\.19\.1
npm 元数据更新时间：2026-11-09T16:14:33.702Z
中文译文更新时间：2026-11-14T13:01:34.467Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40featureflip/react
原文对照：https://npmcn.com/package/%40featureflip/react/?lang=original
项目主页：https://featureflip.io/docs/sdks/react/
源码仓库：https://github.com/canopy-labs/featureflip-react

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：29.1 kB，19 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.19\.0
- 运行依赖：0 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，@featureflip/browser ^2\.19\.1
- 首次发布：2026-04-02T05:00:02.371Z
- 最新版本发布：2026-11-09T16:14:33.495Z
- 近 30 天下载量：2623（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：33（近 12 个月 33 个）

## 中文简介

SDK对 Featureflip 的回放 - 特性旗评价的回放绑定

## 安装

```sh
npm install @featureflip/react
```

也可以使用：`pnpm add @featureflip/react`、`yarn add @featureflip/react`、`bun add @featureflip/react`

## README

# @ featureflip/反应

反应约束 [特性flip](https://featureflip.io/) 特征旗评价.

## 安装

```bash
npm install @featureflip/react @featureflip/browser
```

## 快速启动

包装您的应用程序 `FeatureflipProvider`,然后使用 `useFeatureFlag` 在任何组件.

```tsx
import { FeatureflipProvider, useFeatureFlag } from '@featureflip/react';

function App() {
  return (
    <FeatureflipProvider clientKey="your-client-sdk-key">
      <Banner />
    </FeatureflipProvider>
  );
}

function Banner() {
  const showBanner = useFeatureFlag('show-banner', false);
  if (!showBanner) return null;
  return <div>New feature available!</div>;
}
```

## 提供者道具

| Prop | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `clientKey` | `string` | **(必须)** | 客户端 SDK 密钥 |
| `context` | `Record<string, unknown>` | `undefined` | 评价背景(用户属性) |
| `baseUrl` | `string` | `undefined` | 评价 API 基础 URL |
| `streaming` | `boolean` | `undefined` | 启用 SSE 流线 |
| `sendEvaluationEvents` | `boolean` | `true` | 被传递到浏览器SDK;参见其README. |
| `bootstrap` | `Record<string, unknown> | 'localStorage'` | `undefined` | 第一个服务器响应前要渲染的值 。 被传递到浏览器SDK;参见其README. |

提供者创建 `FeatureflipClient` 内部和电话 `initialize()` 上马了 它清理(呼叫) `close()`在卸载.

与一个 `bootstrap` 对象(例如,旗下值您在渲染页面时评价的服务器), `useFeatureFlag` 返回第一个参数上的这些值,并 `useFeatureflipStatus()` 报告 `isReady: true` 立即; 服务器的值在到达时替换 。 在服务器渲染提供者使用时 `FeatureflipClient.forServerRender`,它只服务于拖曳值,不提出请求,也不在请求之间共享.

## 钩子

### `useFeatureFlag<T>(key: string, defaultValue: T): T`

返回旗的估值值。 当旗帜值通过流转而改变时,组件会自动重递,或者 `identify()`类型 `defaultValue` 确定使用哪种变异方法(`boolVariation`, (中文(简体) ), `stringVariation`, (中文(简体) ), `numberVariation`,或 `jsonVariation`) (中文(简体) ).

```tsx
const enabled = useFeatureFlag('new-checkout', false);
const color = useFeatureFlag('button-color', 'blue');
const limit = useFeatureFlag('rate-limit', 100);
const config = useFeatureFlag('ui-config', { sidebar: true });
```

### `useFeatureflipStatus(): { isReady, isError, error }`

返回客户端初始化状态 。 用于显示装入状态 .

```tsx
function App() {
  const { isReady, isError, error } = useFeatureflipStatus();

  if (isError) return <div>Error: {error?.message}</div>;
  if (!isReady) return <div>Loading...</div>;

  return <Main />;
}
```

### `useFeatureflipClient(): FeatureflipClient`

返回基础 `FeatureflipClient` 例如: `identify`) (中文(简体) ).

## 在登录时识别

当上下文道具改变时,提供者会自动调用 `identify()` 并重新评价所有旗帜。 您也可以打电话 `identify` 直接说.

```tsx
function LoginPage() {
  const client = useFeatureflipClient();

  async function handleLogin(userId: string) {
    // ... authenticate ...
    await client.identify({ user_id: userId, plan: 'pro' });
  }

  return <button onClick={() => handleLogin('123')}>Log in</button>;
}
```

## 测试

使用 `TestFeatureflipProvider` 在测试中提供预定的旗帜值——没有网络呼叫,没有初始化延迟.

```tsx
import { TestFeatureflipProvider } from '@featureflip/react';
import { render, screen } from '@testing-library/react';

test('renders banner when flag is on', () => {
  render(
    <TestFeatureflipProvider flags={{ 'show-banner': true }}>
      <Banner />
    </TestFeatureflipProvider>,
  );

  expect(screen.getByText('New feature available!')).toBeInTheDocument();
});
```

`TestFeatureflipProvider` 用途 `FeatureflipClient.forTesting()` 内部和设定 `isReady: true` 马上.

## 许可证

阿帕奇 - 2.0

## 常见问题

### @featureflip/react 是什么？

SDK对 Featureflip 的回放 - 特性旗评价的回放绑定

### 如何安装 @featureflip/react？

在项目目录运行 npm install @featureflip/react，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0 \|\| ^19\.0\.0）、@featureflip/browser（^2\.19\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @featureflip/react 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @featureflip/react 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @featureflip/react 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.19\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @featureflip/react 可以商用吗？

@featureflip/react 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @featureflip/react 的下载量有多少？

根据 npm 官方下载统计，@featureflip/react 在 2026/10/15 – 2026/11/13 这 30 天内被下载 2,623 次，日均约 87 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @featureflip/react 还在维护吗？

最新版本 2\.19\.1 发布于 2026/11/10（4 天前）；至今共发布 33 个版本，其中过去 12 个月发布了 33 个；首次发布于 2026/04/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。