VA 移动设计系统 - 组件包
组件包是包含组件本身的VA移动设计系统的核心.
消费者
组件软件包假设您已经有一个可运行的 React Industrial app, 无论是使用 Expo 或 React Industrial CLI; 参见 反应本地文档 如果你没有.
一旦有运行中的应用程序:
- 添加
@department-of-veterans-affairs/mobile-component-library 作为您的软件包管理器的依赖( 如纱线)
- 添加
@department-of-veterans-affairs/mobile-assets 作为依附关系
- 注:资产组合之外,
react, (中文(简体) ), react-native,以及 react-native-gesture-handler 还预期需要依赖管理组件包
- 锁定自定义字体 在您的应用程序的资产包中
- 从
@department-of-veterans-affairs/mobile-component-library 包含在 .jsx/.tsx 文件内, 并包含在显示逻辑中, 类似于您将如何内置的 React 本地组件
说明: 林定包被高度推荐,因此随着组件包的演化,您会自动收到林定分解的警告;它应该被设定为与组件包相同的版本.
有关可用组件的文件可通过下列途径查找: 文档网站 以及 我们的故事本问题和议题可针对 我们的DSVA Slack频道。 。 。 .
贡献者
先决条件
- 安装 节点.js
- 安装 国家核查团
- 安装 线条 4.0.2
安装
- 清除还原
git clone [email protected]:department-of-veterans-affairs/va-mobile-library.git
-
从根目录( F)va-mobile-library运行 nvm use。如果您没有安装活动节点版本(您将看到出错)运行 nvm install v20.19.2 (将 v.20.19.2 替换为 . nvmrc 文件所列出的版本),然后运行 nvm use 启动它.
-
导航到组件包
cd va-mobile-library/packages/components
- 安装依赖关系
yarn
接下来
yarn tokens:build
- 启动应用程序
- 物理设备
- 安装 Expo Go 应用程序 应用程序存储 或者说 播放存储
- 说明: 强烈建议关闭 Expo Go 的自动更新,因为它只与最新的 Expo SDK 兼容,并将停止更新工作,直到项目 SDK 升级,包括复杂的依赖性更新。 Android允许下载旧版APK作为工作绕道,但iOS无法降级.
- 运行
yarn start
- 使用设备相机扫描在控制台上出现的 QR 码
- 模拟器
- 运行
yarn start
- 新闻
i 在 iOS 模拟器上运行或 a 运行在Android模拟器上(你可能需要在Android Studio中设置一个仿真器才能工作)
- 网页浏览器
- 运行
yarn storybook:web
Yarn 命令
| 命令 | 说明 |
start | 启动 Metro Bundler 选项, 可在不同的平台运行应用程序 . 说明: 要在网络上运行, 请使用 yarn storybook:web 命令下方 |
android | 在上次使用的 Android 模拟器/设备上运行应用程序 |
buildIcons | 运行脚本以构建资产包中的图标 |
ios | 在上次使用的iOS模拟器/设备上运行应用程序 |
storybook:build | 生成静态版本的故事手册以供部署 |
storybook:deploy | 部署故事本 homepage 内 package.json |
storybook:generate | 生成 .rnstorybook/storybook.requires.js 它告诉 React 原住民在哪里找到商店,因为它不支持动态的进口 |
storybook:watch | 监视新创建的故事并重生 storybook.requires.js |
storybook:web | 建立和启动网络开发服务器 |
test | 运行单元测试 |
关于 @department-of-veterans-affairs/mobile-component-library 的常见问题
@department-of-veterans-affairs/mobile-component-library 是什么?
VA 设计系统移动组件库
如何安装 @department-of-veterans-affairs/mobile-component-library?
在项目目录运行 npm install @department-of-veterans-affairs/mobile-component-library,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^19.0.0)、react-native(>=0.71.7)、react-native-gesture-handler(^2.12.0)、react-native-safe-area-context(^4.10.5)、@department-of-veterans-affairs/mobile-assets(^0.15.1)、@department-of-veterans-affairs/mobile-tokens(^0.24.0)、@department-of-veterans-affairs/va-design-system-assets(^0.3.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。
@department-of-veterans-affairs/mobile-component-library 支持 TypeScript 吗?
该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/department-of-veterans-affairs__mobile-component-library 是否存在。
@department-of-veterans-affairs/mobile-component-library 支持 ESM 还是 CommonJS?
以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。
@department-of-veterans-affairs/mobile-component-library 可以商用吗?
@department-of-veterans-affairs/mobile-component-library 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
@department-of-veterans-affairs/mobile-component-library 的下载量有多少?
根据 npm 官方下载统计,@department-of-veterans-affairs/mobile-component-library 在 2026/10/12 – 2026/11/10 这 30 天内被下载 4,612 次,日均约 154 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@department-of-veterans-affairs/mobile-component-library 还在维护吗?
最新版本 0.37.0 发布于 2026/09/30(1 个月前);至今共发布 300 个版本,其中过去 12 个月发布了 19 个;首次发布于 2023/08/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。