Sonner Native 使用教程

Sonner Native 使用教程

sonner-native An opinionated toast component for React Native. A port of @emilkowalski's sonner. 项目地址: https://gitcode.com/gh_mirrors/so/sonner-native

1. 项目目录结构及介绍

Sonner Native 是一个为 React Native 定制的 Toast 组件。以下是项目的目录结构及其简要介绍：

.
├── .github/                  # GitHub 工作流和模板文件
├── docs/                     # 文档目录
├── example/                  # 示例项目，用于展示组件的使用
├── src/                      # 源代码目录
│   ├── components/           # React 组件
│   ├── hooks/                # 自定义钩子
│   ├── styles/               # 样式文件
│   ├── types/                # TypeScript 类型定义
│   └── utils/                # 工具函数
├── .editorconfig             # 编辑器配置
├── .eslintignore             # ESLint 忽略文件
├── .gitattributes            # Git 属性配置
├── .gitignore                # Git 忽略文件
├── .nvmrc                    # Node.js 版本管理配置
├── .watchmanconfig           # Watchman 配置
├── .yarnrc.yml               # Yarn 配置
├── CHANGELOG.md              # 更新日志
├── CODE_OF_CONDUCT.md        # 行为准则
├── CONTRIBUTING.md           # 贡献指南
├── LICENSE                   # 许可证文件
├── README.md                 # 项目说明文件
├── babel.config.js           # Babel 配置
├── lefthook.yml              # Lefthook 配置
├── package.json              # 项目依赖和脚本
├── tsconfig.build.json       # TypeScript 编译配置（构建时）
├── tsconfig.json             # TypeScript 编译配置
└── yarn.lock                 # Yarn 锁文件

2. 项目的启动文件介绍

项目的启动主要是通过 example/ 目录中的示例应用程序来展示。以下是启动示例项目的基本步骤：

1. 克隆仓库到本地环境。
2. 切换到 example/ 目录。
3. 安装项目依赖：yarn install 或 npm install。
4. 启动开发服务器：yarn run android 或 yarn run ios。

在 example/ 目录下的 App.tsx 文件是应用的入口点，这里会导入并使用 sonner-native 组件。

3. 项目的配置文件介绍

以下是项目中一些重要配置文件的简要介绍：

• .editorconfig：用于定义项目中的编辑器配置，如缩进风格、换行符等，以确保不同开发者的编辑器设置保持一致。

• .eslintrc：ESLint 配置文件，用于定义代码质量和风格规则。

• babel.config.js：Babel 配置文件，用于定义JavaScript代码的转译规则。

• tsconfig.json：TypeScript 配置文件，用于定义TypeScript编译器的选项。

• package.json：定义项目的依赖、脚本和元数据。scripts 字段中的命令可用于执行项目的常见任务，如构建、测试等。

通过正确配置这些文件，可以确保项目遵循统一的代码风格和标准，便于维护和协作。

sonner-native An opinionated toast component for React Native. A port of @emilkowalski's sonner. 项目地址: https://gitcode.com/gh_mirrors/so/sonner-native