文档目录4 节
- 添加新组件
- 测试您的新组件
- 用Storybook测试组件
- 出版
synapse-ui
用于Synapse的可重用ui组件
添加新组件
- 控件中创建新组件
src/ 文件夹中。
您可以将组件放入任何现有文件夹中,或者创建一个新文件夹。
- 在各自的组件文件夹中创建样式文件。
- 在新文件夹的根目录下创建index.js文件,如下所示
src/_your_folder/index.js.
- 像这样导入和导出index.js中的新组件
import Component1 from './Component1/Component1;
import Component2 from './Component2/Component2;
import Component3 from './Component3/Component3;
export {
Component1,
Component2,
Component3,
{... moreComponents}
};
测试您的新组件
- 去
package.json ,并更改 name 属性 synapse-ui-v2.
- 运行
yarn install.
- 运行
yarn build.
- 运行
yarn link.
- 然后转到将使用synapse-ui的项目目录并运行
yarn link synapse-ui-v2.
用Storybook测试组件
- 创建一个故事。JSX文件以及您的组件
- 运行
yarn install
- 运行
yarn storybook
- 在Storybook仪表板中导航到您的组件
- 有关其他背景信息,请参阅官方故事书文档 https://www.learnstorybook.com /
出版
- 运行
yarn install.
- 如果您尚未登录。运行
npm login. 一定要用npm帐户来计数。
- 运行
npm publish 命令。
- !完成了。
版本与发布记录
0.3.20-beta.11 共发布 1 个版本,首次发布于 2021/04/20;过去 12 个月发布了 0 个版本。
| 版本 | 发布日期 | 距今 |
|---|
0.3.19latest | 2021/04/20 | 5 年前 |
关于 0.3.20-beta.11 的常见问题
0.3.20-beta.11 是什么?
Synapse可重用组件库v2
如何安装 0.3.20-beta.11?
在项目目录运行 npm install 0.3.20-beta.11,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@material-ui/core(4.3.1)、node-sass(^4.13.1)、prop-types(^15.7.2)、react(^16.10.2)、react-dom(^16.10.2)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。
0.3.20-beta.11 支持 TypeScript 吗?
该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/0.3.20-beta.11 是否存在。
0.3.20-beta.11 支持 ESM 还是 CommonJS?
同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。
0.3.20-beta.11 可以商用吗?
0.3.20-beta.11 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
0.3.20-beta.11 还在维护吗?
最新版本 0.3.19 发布于 2021/04/20(5 年前);至今共发布 1 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/04/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。