@hcl-software/魔法反应-组件
Conclated React Cuplics是一款正在HCL软件产品中使用的ui组件的集合. 此软件包取决于 材料 UI 组件库。 。 。 .
(C) 2024 HCL美国公司Apache-2.0许可证 https://www.apache.org/licenses/LICENSE-2.0
使用量
npm install @hcl-software/enchanted-react-components
import Button, { ButtonVariants } from '@hcl-software/enchanted-react-components/dist/Button/Button';
...
return (
<Button
id="button-id"
variant={ButtonVariants.CONTAINED}
onClick={() => {
console.log('click');
}}
>
Button
</Button>,
);
发展
国家预防机制目标
我们提供以下公用事业开发命令:
| 塔克语name | 命令 | 说明 |
|---|---|---|
install | npm ci | 项目依赖性的初步安装。 运行这个开始. |
clean | rm -rf node_modules 财务报告和审定财务报表 rm -rf dist | 删除所有节点等 |
build lib | npm run build | 构建软件包 |
lint | npm run lint | 运行 Linting 任务 |
build storybook | npm run build-storybook | 构建故事书 |
storybook | npm run storybook | 运行故事书实例 |
unit and integration | npm run test | 运行单元和整合测试 |
storyshots | npm run test-storyshots | 运行故事拍摄测试。 env 参数 DONT_EXIT_ON_DIFF=true 提供了一种特性,即如果检测到某些偏差,测试不会失败. |
构成部分结构
原子成分
原子元件是一个元件的最小单位. 例如:按钮或面板.
复合部分
复合元件是原子元件的组合来创造出更大的元件. 例如,具体的表格.
必要组成部分
一个先决条件组成部分是只存在于更高一级部件中的部件。 这一组成部分不应单独使用.
输出最佳做法的模块
- 每个组件文件夹结构都有自己的index.ts文件作为本地模块,用于导出默认并命名导出.
- 这个
src文件夹包含一个全局索引.ts文件,将组件输出全球,并指向每个组件文件夹的本地索引.ts文件. - 在整个项目中使用“魔法反应组件”库时,确保将新创建的组件输出到全球,用于简洁和可读出口.
他们
图书馆支持 LightNeutralGrey 财务报告和审定财务报表 LightCoolGrey 主题。 未来a DarkNeutralGrey 财务报告和审定财务报表 DarkCoolGrey 还应支持主题.
这个 LightNeutralGrey 财务报告和审定财务报表 LightCoolGrey 主题可以通过 createEnchantedTheme() 方法.
// e.g.
createEnchantedTheme(ThemeDirectionType.RTL, ThemeModeType.LIGHT_COOL_GREY);
// or
createEnchantedTheme(ThemeDirectionType.LTR, ThemeModeType.LIGHT_NEUTRAL_GREY);
"主题提供者"需要成为组件等级中的第一个组件.
import { ThemeProvider } from '@mui/material/styles';
import { ThemeDirectionType, ThemeModeType, createEnchantedTheme } from '@hcl-software/enchanted-react-components/dist/theme';
const enchantedTheme = createEnchantedTheme(ThemeDirectionType.LTR, ThemeModeType.LIGHT_NEUTRAL_GREY);
return (
<ThemeProvider theme={enchantedTheme}>
...
</ThemeProvider>
)
RTL 支持
库完全支持RTL模式. 每个新的实施部分也需要支持RTL模式.
注:
图书馆使用 stylis-plugin-rtl 财务报告和审定财务报表 stylis 实现RTL支持。 我们锁定了这个图书馆的依赖性要求 stylis 4.0.13 应付 stylis维护问题 请确保这是您项目依赖树上的依赖的解析版本 .
- 确定你的项目
stylis版本为 4.0.13,第一,运行npm ls stylis以下列表具有子依赖性的依赖stylis。 。 。 . - 接下来, 解开并重新安装这些依赖关系, 这样在重置时, 包就会被覆盖
stylis时间为4.0.13。 例如,依赖性stylis-plugin-rtl具有子依赖性stylis运行npm uninstall stylis-plugin-rtl。 。 。 . - 程е禲
npm install stylis-plugin-rtl,为了安全起见,您可能要指定此方块的 semver 到软件包中的npm install stylist-plugin-rtl@{insert-semantic-version-here}。 。 。 .
A 类 ltr 财务报告和审定财务报表 rtl 主题可以通过 createEnchantedTheme() 方法.
对于“ trl” 支持 DirectionStyleProvider 还有必要。 此组件应当将 ThemeProvider。这里有一个简短的例子:
import { ThemeProvider } from '@mui/material/styles';
import CssBaseline from '@mui/material/CssBaseline';
import DirectionStyleProvider from '@hcl-software/enchanted-react-components/dist/DirectionStyleProvider';
import { ThemeDirectionType, ThemeModeType, createEnchantedTheme } from '@hcl-software/enchanted-react-components/dist/theme';
const themeDirection = ThemeDirectionType.LTR;
const enchantedTheme = createEnchantedTheme(themeDirection, ThemeModeType.LIGHT_NEUTRAL_GREY);
return (
<DirectionStyleProvider direction={themeDirection}>
<ThemeProvider theme={enchantedTheme}>
<div dir={themeDirection}>
<CssBaseline />
<App />
</div>
</ThemeProvider>
</DirectionStyleProvider>
)
说明数字 : <CssBaseline /> 将会在页面中注入一些全局样式。 如果不需要,请将您的应用程序包入 <ScopedCssBaseline> 换句话说.
例如:
import ScopedCssBaseline from '@mui/material/ScopedCssBaseline';
...
<DirectionStyleProvider direction={themeDirection}>
<ThemeProvider theme={enchantedTheme}>
<div dir={themeDirection}>
<ScopedCssBaseline>
<App />
</ScopedCssBaseline>
</div>
</ThemeProvider>
</DirectionStyleProvider>
调试 - 类型和颜色
类型
默认的材料UI Typography变体被扩展为另外四个变体. 打字变体名称与设计打字名称一致.
默认物质 UI 变体 :
- (单位:千美元)
- 页:1
- h3 (韩语)
- h4 (中文(简体) )
- h5 (韩语)
- 小时6
- 字幕1
- 字幕2
- 体质1
- 车体1粗体
- 体质
- 机构2
- 车体2粗体
- 体型2斜体
- 标题
扩展变体 :
- 车体1粗体
- 体质
- 车体2粗体
- 体型2斜体
这个 Inter, sans-serif 目前配置为所有打字机的默认字体家族.
颜色
所有被使用过的颜色都带有了特定的名称。 这些彩色标志与设计彩色标志一致.
样式覆盖
材料UI提供了四种不同的方式来覆盖组件特定样式:
在魔法反应组件库中,我们将这些选项限制在以下三个:
- 一次性定制 > sx道具
- 可重复使用的组件
- 全球主题覆盖
CSS定制的首选和强制性方法是: Global theme override替代品只应在下列情况下使用: Global theme override 无法解决具体问题.
一次性定制
更多关于 sx prop 可见 这里。 。 。 .
可重复使用的组件
更多关于 styled() method 可见 这里。 。 。 .
export const StyledInputLabel = styled(MuiInputLabel)((theme) => {
return {
...theme.theme.typography.subtitle2,
color: theme.theme.palette.text.secondary,
margin: '0px',
span: {
paddingRight: '4px',
},
...
};
});
全球主题覆盖
更多关于 theme components override 可见 这里。 。 。 .
基本想法是在每个组成部分中增加一种具体的方法(getMui<COMP-NAME>ThemeOverrides)正在收集所有所需的CSS调整。 这种方法应该有这样的逻辑:
/**
* Override out of the box styling from mui to align with designer theme
* @returns override <COMP-NAME> component styles and prop
*/
export const getMui<COMP-NAME>ThemeOverrides = (): Components<Omit<Theme, 'components'>> => {
return {
Mui<COMP-NAME>: {
styleOverrides: {
root: ({ ownerState, theme }) => {
return ({
backgroundColor: 'red', // this is only an example
});
},
},
},
};
};
输出不能添加到 components 属性 ThemeOptions 就这样.
const themeOptions: ThemeOptions = {
components: {
...getMui<COMP-NAME>ThemeOverrides(),
},
...
};
注: 每个MUI组件只能是一次宣布,因为Global主题覆盖接受每个MUI组件一个密钥值.
故事书
对于孤立的构建 魔法反应组件库,我们正在使用 故事书故事书帮助我们以工业标准的方式提供、测试、记录和审查被魔法化的部分。 故事书是开源和免费的,被上千支队伍使用.
目前,我们已经将我们的构成部分分成了五个不同的部分。 在每个组别下,将各部分放在一组内.
- 导航
- 反馈
- 投入
- 数据显示
- 表面
简介页也是每个故事书实例的一部分.
每个组成部分应有两个具体组成部分的例子:
- 交互式示例 > 控制部分是启用的,组件可以在不同的变相/通量中测试.
- 视觉测试 > 控制区已禁用 。 此示例仅被视觉测试(storyshots)所使用,用于识别造型变化. 这一例子提供了单个页上某一部分的多数合理变化/变化.
视觉测试(弹片测试)
这个过程正在检测一些UI的分化,并将产生一些比较截图.
本地运行
-
清除故事截图图像文件夹
./src/__tests__/unit/__image_snapshots__ -
本地运行故事书.
npm run storybook -
创建基准集 。 所有图像将存储在文件夹下
./src/__tests__/unit/__image_snapshots__npm run test-storyshots -
做一些UI修改,比如: 调整主色调或者增加边框的大小, 绑定, 边框.
-
运行
test-storyshots再次命令以获取所有 UI 偏移 。 检测到的偏差将存储在文件夹下./src/__tests__/unit/__image_snapshots__/__diff_output__npm run test-storyshots
