网络相机
安装
安装 npm 或连接到 git in package.json :
npm install --save @codaco/ui
// in package.json
{
"dependencies": {
"@codaco/ui": "git+https://[email protected]/complexdatacollective/Network-Canvas-UI.git"
}
}
部署
这是 npmjs 上的 Org 软件包 .
- 更新软件包中的版本编号。 json
npm run publish
开发(使用故事书)
运行 :
npm run storybook
浏览器窗口将打开,可实时浏览组件.
这是一个新的特性,因此并非所有组件都定义.
开发(使用网络电视)
# In UI
$ npm link
# In consuming app
$ npm link @codaco/ui
# After each change (in UI):
$ npm install
$ npm run build
$ npm install --only=production # potentially also rm -rf node_modules
恢复消费应用: npm install
构成部分
// in LocalComponent.js
import { ExampleComponent } from '@codaco/ui';
// To directly link to a component use:
// `import ComponentName from '@codaco/ui/lib/components/ComponentName'`;
const LocalComponent = props => (
<div className="local-component">
<ExampleComponent />
</div>
);
样式
您可以在主样式表中包含所有样式 :
// in main.scss
@import '~@codaco/ui/lib/styles/all';
只有某些组件的导入样式可能可行,但目前不支持.
图标
颜色
要添加新的颜色或调色板,您可以在根选择器中添加一个新的 Css 变量 :
:root {
--my-new-color: blue;
}
包括什么
构成部分列表
- 组件列表如下.
版本
这个项目使用 语义版本数字 :
AA.BB.CC
- 当您做出不兼容的 API 更改时 AA 版本,
- 当您以反相兼容的方式添加功能时, BB 版本,以及
- CC 版本,当您进行反向兼容错误修正时 .