创世纪快速设计系统
这个包是一个设计系统(Rapid). 它建在顶上 foundation-ui ,并提供了一组无需附加配置即可使用的组件.
API 文档
安装
要在应用程序中启用此模块, 请遵循以下步骤 .
- 添加
@genesislcap/rapid-design-system作为你package.json文档。 当您改变您的项目的依赖性时, 请确保您运行$ npm run bootstrap再次指挥。 您可以在 软件包.json 基础 页 次.
{
"dependencies": {
"@genesislcap/rapid-design-system'": "latest"
},
}
建立设计系统
设置包括提供和登记设计系统组件 rapid-design-system 或其他地点。 这是你怎么做到的:
提供设计系统并登记所有部件
简单来说,在 components.ts 文件(或应用程序级设置的条目点),您提供了使用 provideDesignSystem 在设计系统上登记组件。 举个例子:
import { baseComponents, provideDesignSystem } from '@genesislcap/rapid-design-system';
provideRapidDesignSystem().register(baseComponents);
在上述例子中, baseComponents 是同一设计系统组成部分的集合。 如果需要,您也可以注册额外的组件(即使来自其他设计系统,其前缀为 rapid- (见本报告).
登记特定组成部分
如果要注册特定组件,可以通过从设计系统导入并注册进行. 举个例子:
import { rapidButton, rapidDesignSystemProvider, provideDesignSystem } from '@genesislcap/rapid-design-system';
provideRapidDesignSystem().register(
/**
* Design system provider element used to declaratively apply rapid config to every dom node in the host tree.
*/
rapidDesignSystemProvider(),
/**
* Button component
*/
rapidButton()
);
在上述例子中, rapid-button 将是唯一在快速设计系统中注册的组件。 YOu还可以同时注册多个组件:
import { provideDesignSystem, rapidButton, rapidCard, rapidDesignSystemProvider, rapidnModal } from '@genesislcap/rapid-design-system';
provideDesignSystem().register(
/**
* Design system provider element used to declaratively apply rapid config to every dom node in the host tree.
*/
rapidDesignSystemProvider(),
/**
* Components that will be registered in the Rapid Design System
*/
rapidButton(),
rapidCard(),
rapidModal()
);
登记第三方部分
我们提供一些不属于设计系统包的"第三方"组件. 这些可以与其他设计系统组件一样进行注册. 举个例子:
import { foundationLayoutComponents } from '@genesislcap/foundation-layout';
import { baseComponents, provideDesignSystem } from '@genesislcap/rapid-design-system';
import { g2plotChartsComponents } from '@genesislcap/g2plot-chart';
import { gridComponents } from '@genesislcap/grid-pro';
provideDesignSystem().register(
baseComponents,
/**
* Third-party components
*/
foundationLayoutComponents,
g2plotChartsComponents,
gridComponents
);
上面的例子记录了来自快速设计系统、基础布局、G2Plot Charts和Grid Pro的快速UI组件.
他们 flexlayout-react
flexlayout-react 是第三方对接
应用程序安装本身的布局( 它没有被捆绑到基金会) 。 快速设计
系统拥有 单一真相来源 对于它的外观,所以主题永远不能掉出
跨应用程序同步。 平台主题 自成一体的样式表——出品人
flexlayout-react 基础主题 加号 快速的符号覆盖,所以应用程序应该 永远
导入 flexlayout-react本地的样式表或复制覆盖 .
从快速设计符号中解析出颜色, 所以渲染 flexlayout-react a 项下
<rapid-design-system-provider> (CSS自定义属性跨越阴影边界继承).
// Light DOM: install once at app bootstrap (injects into document, idempotent).
import { installRapidFlexLayoutReactStyles } from '@genesislcap/rapid-design-system';
installRapidFlexLayoutReactStyles();
// Shadow DOM: adopt the shared, cached stylesheet into the shadow root that hosts <Layout>.
import { getRapidFlexLayoutReactStyleSheet } from '@genesislcap/rapid-design-system';
shadowRoot.adoptedStyleSheets = [...shadowRoot.adoptedStyleSheets, getRapidFlexLayoutReactStyleSheet()];
也导出 : rapidFlexLayoutReactStyleText (滚动 CSS 字符串), rapidFlexLayoutReactStyles
(预算外) ElementStyles),以及 RAPID_FLEXLAYOUT_REACT_VERSION (单位:千美元) flexlayout-react 版本
主题目标——见可选 flexlayout-react 相容性依赖性
范围).
保持主题
- 编辑外观 : 变动
src/flexlayout-react-theme/flexlayout-react.overrides.css,则 运行pnpm --filter @genesislcap/rapid-design-system flexlayout:generate(软件包构建) 自动执行)。 超接被最后应用,所以它们战胜了基础主题. - 弹出
flexlayout-react数字 : 在同一变化中重新生成主题 。 建筑的再生flexlayout-react-theme.generated.ts从已安装的版本, 所以一个没有 再生使工作树出脏,并失败了CI的"检查工作树"大门.
许可证
注:该项目提供前端依赖性,并使用下一节所列许可部件;因此,开发期间需要对这些部件发放许可证。 联系人 创世纪全球 更多细节.
许可组件
创世纪低码平台