@guardian/interactive-component-library
一组用于交互式页面的可重用组件, 使用 Preact 写入 原子设计 原则.
在新客户端项目中安装组件库
npm install @guardian/interactive-component-library
为这个寄存器贡献力量
建设项目需要节点v16.18.1或更高.
- 克隆此寄存器
- 运行
corepack enable以启用 pnpm - 安装依赖关系
pnpm i - 运行
pnpm dev以启动本地的故事书服务器
原子设计
组成部分库的结构按照 原子设计 原则,使用下三级.
- 文章(从
atoms(由于明显的原因) - 分子
- 有机体
粒子是构成其他所有事物的构件(如按钮)的最低等元件. 分子代表更复杂的组分(如一表),并往往依赖于粒子组分. 有机体将前两个关卡合并为一个交互页面的不同部分,例如KeySeats.
文件夹使用相同的命名结构,其中 particles, (中文(简体) ), molecules 财务报告和审定财务报表 organisms 文件夹在 src/lib/components,以区分三个不同的级别.
添加新组件
在相应的目录中创建您新组件的文件夹 。 文件夹的名称应为您在 凯巴布案,也就是说. src/lib/components/particles/my-new-component。 。 。 .
文件夹应包含以下内容:
index.jsx包含实际组件的代码[component-name].stories.jsx包含如何使用组件的实例,写入为 故事书故事docs.mdx故事书中组件的额外文档( 可选)
当地开发和测试
在开发期间,你往往会想看到一个组件在您正在研究的互动页面中的样子,而不重建并发布新版本的组件库. 为了方便工作流程,我们使用 npm-链接。 。 。 .
这是如何设置:
cd ~/projects/interactive-component-library # go into the package directory
npm link # creates global link
cd ~/projects/interactive-project # go into your project directory
npm link @guardian/interactive-component-library # link-install the package
你干完后,快跑开 pnpm build:lib:watch 来包装库并重建文件更改.
返回您的项目指定的版本 package.json数字 :
npm uninstall --no-save @guardian/interactive-component-library && npm install
出版新版本
要出版新版组件库,请遵循这些步骤:
- 创建新发行 在 GitHub (不要忘记写一些发行笔记)
- 出版发行 触发工作流程 将图书馆包装并公布在国家预防机制登记册上。 如果发布动作失败, 您也可以手动触发
- 发布动作还创建出一个拉出请求来突起版本号. 合并拉动请求以完成释放
脚本
总是预用 pnpm数字 :
dev: 启动故事书,促进地方发展build: 构建静态故事书项目build:lib: 将组件库建入 数字 文件夹build:lib:watch: 与先前的命令相同, 但是它看/src文件夹和更改后的重建
测试童话书中的暗模式
在工具栏中使用日/月按钮在光和暗模式之间切换.
启用暗模式 .ios 财务报告和审定财务报表 .dark-mode 分类到 <body> 元素,它反过来使故事预览呈现出深色模式颜色(此行为可以自定义于 .storybook/preview.scss) (中文(简体) ).
注意使用此按钮启用暗模式不影响
prefers-color-schemeCSS 媒体专题节目。如果组件使用prefers-color-scheme直接, 您还需要更改您的系统或浏览器设置, 才能看到样式生效 .