npm package: @gaozh1024/rn-toolkit
Description: A comprehensive React Native toolkit
Author: gaozh1024
Latest version: 1.4.23

# rn-toolkit

一个面向 React Native 的工程化工具包，提供一致的 API、类型与最佳实践，覆盖 UI 组件、动画、导航、状态栏、主题、存储与常用工具，助你更快搭建高质量应用。

## 特性

- 统一 API：跨模块保持一致的调用风格与类型定义
- 高性能动画：内置 `react-native-reanimated` 支持与预设动画
- 主题系统：亮/暗模式、可持久化与丰富样式预设
- 导航增强：规范化的路由注册、服务化导航调用
- 生产可用：脚本自动化安装与原生平台配置（iOS/Android）
- TypeScript：完备类型，便于开发与维护

## 安装与自动化配置

- 安装：

```bash
npm install @gaozh1024/rn-toolkit
```

### 必须安装的框架

- `react-native-reanimated`
- `react-native-gesture-handler`
- `react-native-screens`
- `react-native-safe-area-context`
- `@react-native-vector-icons/ionicons`
- `react-native-drawer-layout`
- `react-native-mmkv`
- `@react-native-clipboard/clipboard`
- `react-native-svg`
- `react-native-device-info`
- `react-native-localize`
- `react-native-worklets`
- `@react-navigation/native`
- `@react-navigation/native-stack`
- `@react-navigation/bottom-tabs`

> 提示：安装期间，postinstall 会自动检查缺失的依赖并安装；已存在的依赖会跳过。

### 运行 postinstall（自动安装与配置）

- 已发布包（npm）：

```bash
npx -p @gaozh1024/rn-toolkit rn-toolkit postinstall
```

- yalc/本地联动（不依赖 Registry）：

```bash
INIT_CWD="$(pwd)" node node_modules/@gaozh1024/rn-toolkit/scripts/cli.js postinstall
```

- 直接脚本触发：

```bash
INIT_CWD="$(pwd)" node node_modules/@gaozh1024/rn-toolkit/scripts/postinstall.js
```

- iOS 依赖安装：

```bash
cd ios && pod install
```

- Babel 插件（必须，置于 `plugins` 最后一行）：

```javascript
// 如执行了 postinstall 方法，则会自动为 babel.config.js 追加 'react-native-reanimated/plugin' 至 plugins 数组末尾
module.exports = {
  presets: ['module:metro-react-native-babel-preset'],
  plugins: [
    'react-native-reanimated/plugin',
  ],
};
```

- 自动化：安装期间，postinstall 会尝试：
  - 按精确版本安装必需依赖（含 Reanimated、Gesture Handler 等）
  - 自动为 `babel.config.js` 追加 `'react-native-reanimated/plugin'` 至 `plugins` 数组末尾

  ios 依赖配置：

  - 因为引用了 `@react-native-vector-icons/ionicons`，所以需要在 `info.plist` 中添加  

  ```xml
  <key>UIAppFonts</key>
  <array>
    <string>Ionicons.ttf</string>
  </array>
  ```

## 模块索引与文档

- 动画（Animation）：见 [src/animation/README.md](src/animation/README.md)
- 导航（Navigation）：见 [src/navigation/README.md](src/navigation/README.md)
- 状态栏（StatusBar）：见 [src/statusbar/README.md](src/statusbar/README.md)
- 存储（Storage）：见 [src/storage/README.md](src/storage/README.md)
- 主题（Theme）：见 [src/theme/README.md](src/theme/README.md)
- UI 组件（UI）：见 [src/components/ui/README.md](src/components/ui/README.md)
- 布局组件（Layout）：见 [src/components/layout/README.md](src/components/layout/README.md)
- 反馈组件（Feedback）：见 [src/components/feedback/README.md](src/components/feedback/README.md)

### 工具（Utils）

- 总览与快速使用：见 [src/utils/README.md](src/utils/README.md)
- 剪贴板（Clipboard）：见 [src/utils/clipboard/README.md](src/utils/clipboard/README.md)
- 设备信息（Device）：见 [src/utils/device/README.md](src/utils/device/README.md)
- 本地化（Localization）：见 [src/utils/localization/README.md](src/utils/localization/README.md)
- 权限（Permissions）：见 [src/utils/permissions/README.md](src/utils/permissions/README.md)

## 约定与最佳实践

- 统一导出：组件在各自目录 `index.ts` 导出，并在聚合出口集中导出
- 主题接入：禁止硬编码颜色，统一来自主题 tokens
- 动画：默认使用 Reanimated；兼容层仅用于特殊/开发场景降级
- 可访问性：遵循 RN 的可访问性属性与交互语义
- 文档：每个模块/组件均包含 `README.md`，含 API 与示例

## 故障排除

- 动画不工作：
  - 确认已安装 `react-native-reanimated` 与启用 Babel 插件（且位于最后）
  - 重启 Metro 并清缓存：

```bash
npm start -- --reset-cache
```

- iOS 编译失败：

```bash
cd ios && pod install
```

- 图标不显示：确认已自动/手动配置 `@react-native-vector-icons/ionicons` 的 Pod 与 Gradle
- ios 图标不显示：确认已在info.plist中添加图标字体 IonIcons.ttf

## 常见问题（FAQ）

- 是否必须使用 Reanimated？是，动画模块以 Reanimated 为默认与必须依赖
- 是否支持暗色模式？是，主题系统内置支持并可持久化
- 是否可禁用自动安装？可在宿主 `package.json -> rnToolkit` 中配置 `autoInstall: false`

## 参与贡献

- 欢迎提交 Issue/PR；遵循模块文档的“验收标准”与“目录与导出约定”

## 许可证

MIT License

### 使用 npm 安装（固定版本）

```bash
npm install --save --save-exact \
  react-native-reanimated@4.1.3 \
  react-native-gesture-handler@2.28.0 \
  react-native-screens@4.16.0 \
  react-native-safe-area-context@5.6.1 \
  react-native-vector-icons@10.3.0 \
  react-native-drawer-layout@4.1.13 \
  react-native-mmkv@3.3.3 \
  @react-native-clipboard/clipboard@1.16.3 \
  react-native-svg@15.14.0 \
  react-native-device-info@14.1.1 \
  react-native-localize@3.5.2 \
  react-native-worklets@0.6.1 \
  @react-navigation/native@7.1.17 \
  @react-navigation/native-stack@7.3.28 \
  @react-navigation/bottom-tabs@7.4.7
```

## 快速使用（Utils）

统一从聚合出口导入：

```ts
import {
  ClipboardService, useClipboard,
  DeviceInfoService, useDeviceInfo,
  LocalizationService, useLocalization,
  PermissionsService, usePermission,
} from '@gaozh1024/rn-toolkit/src/utils';
```

示例：复制文本与读取文本

```ts
await ClipboardService.copyToClipboard('Hello', { showToast: true });
const { clipboardText, getFromClipboard } = useClipboard();
await getFromClipboard();
```

示例：设备信息与本地化

```ts
const info = await DeviceInfoService.getDeviceInfo();
const { info: loc } = useLocalization();
```

示例：权限

```ts
const ok = await PermissionsService.ensureCamera({ openSettingsIfBlocked: true });
const { request } = usePermission('notification');
await request({ alert: true, sound: true, badge: true });
```