@kne/mini-core
v2.1.6
Published
Downloads
25
Keywords
Readme
mini-core
安装
npm i --save @kne/mini-core
概述
mini-core 是一个Taro的高级组件库,它有别于 @kne/antd-taro 只提供简单的UI交互组件,它旨在解决toB类小程序应用中的复杂场景问题,例如:
- 主题色问题
- Layout问题
- 弹出页面问题
- 表单问题
- 列表下拉加载问题
- 详情页展示问题
- 筛选项问题
- 登录用户信息问题
- 显示项权限问题
- 枚举值问题
- 服务器获取数据及接口管理问题
- 解决了项目中的components开发及调试问题
它按照目前主流的形式解决了以上问题,可以作为一个应用的底层。 它提供了相对较大的组件粒度,也对应用做出了一定程度的规范。使用它能快速构建这一类型的小程序。 它提供了一个components的开发及调试环境和文档编写规范,可以使项目拥有一个良好的组件开发流程和规范,避免和业务混淆在一起
使用脚手架
- 执行初始化命令
npx @kne/npm-tools init [project-name]
选择 WeChat Miniprogram Project 模板
执行启动命令
npm run start
示例程序的使用
- 新建components目录
- 新建文件 项目根目录/temp/config/alias.js 并添加
- 按照examples规则在doc文件夹下完成对应的示例程序
- 执行npm run start
- 在小程序调试工具中打开 项目根目录/example 进行组件示例调试
module.exports = {
'@components': require.resolve('../../src/components'),
};
最佳实践
我们推荐把所有复杂逻辑都封装成组件放在components文件夹里,并且在doc里面完成对应的文档和示例,在pages里面调用时只包含简单的组件组合以及少量参数的传递。不要把业务写在pages里面,因为那通常不可维护。
把组件里面的api调用参数及逻辑全部放在项目的preset.js里面。
在开发阶段,通过mock接口数据来完成components里面具体业务组件的编写,不要硬依赖后端api。
components内的组件命名尽量可以看出派生关系和业务所属。
示例
示例代码
- AvatarPreview 照片预览
- AvatarPreview 头像预览
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components),tarojsTaro(@tarojs/taro)
const { Global, AvatarPreview } = miniCore;
const { Space, Button } = antd;
const { View } = tarojsComponents;
const { showToast } = tarojsTaro;
const demoAvatarImages = "https://avatars.githubusercontent.com/u/37367461?v=4";
const BaseExample = () => {
return (<Global preset={{
apis: {
file: {
getFileUrl: {
loader: ({params}) => {
return "https://attachment.test.fatalent.cn/attachment/Q0ol94kBBZgnCXyZKG1Y.jpg?Expires=1700814537&OSSAccessKeyId=LTAI5tAfbu2aBppB3jMj1kMt&Signature=KcJHlI8FDYMolFQFxacGzhoaA1A%3D";
}
}
}
}
}}>
<Space direction="vertical" size={30}>
<Space direction={"vertical"}>
<View>基础用法</View>
<AvatarPreview value={demoAvatarImages} />
</Space>
<Space direction={"vertical"}>
<View>点击事件</View>
<AvatarPreview
value={demoAvatarImages}
onClick={() => {
showToast({ icon: "none", title: "点击事件。。。" });
}}
/>
</Space>
</Space>
</Global>
);
};
render(<BaseExample />);
- Calendar 日历
- 展示日历组件
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components),dayjs(dayjs)
const {
Calendar,
CalendarMonthView,
CalendarMonthSelector,
CalendarMonthSwiper,
CalendarTimeStepView,
CalendarTimeLengthView,
CalendarView,
CalendarTimeRangeView,
CalendarTimeRangePopup,
CalendarRangeView,
CalendarPopup,
CalendarRangePopup,
CalendarTimeStepPopup
} = miniCore;
const { Space, Button } = antd;
const { useState } = React;
const { View } = tarojsComponents;
const BaseExample = () => {
const [value, onChange] = useState(new Date());
const [time, onTimeChange] = useState("09:15");
const [timeLength, setTimeLength] = useState(60);
const [timeRange, setTimeRange] = useState([new Date(), new Date(Date.now() + 60 * 60 * 1000)]);
const [open, setOpen] = useState(false);
const [open2, setOpen2] = useState(false);
const [open3, setOpen3] = useState(false);
const [open4, setOpen4] = useState(false);
return <Space direction="vertical" size={30}>
<Space direction="vertical">
<View>CalendarMonthView:展示一个月日期</View>
<CalendarMonthView current={value} onChange={onChange} minDate="2020-10-01" maxDate="2030-01-01"
marks={["2023-10-01", "2023-09-30"]} />
</Space>
<Space direction="vertical">
<View>CalendarTimeStepView:展示一个时间段选择</View>
<View>已选:{time}</View>
<View style={{ "--picker-height": "400px" }}>
<CalendarTimeStepView value={time} onChange={onTimeChange} />
</View>
</Space>
<Space direction="vertical">
<View>CalendarTimeLengthView:展示一个时长选择 </View>
<View>已选:{timeLength}分钟</View>
<View style={{ "--picker-height": "400px" }}>
<CalendarTimeLengthView value={timeLength} onChange={setTimeLength} />
</View>
</Space>
<Space direction="vertical">
<View>CalendarMonthSelector:展示月份选择</View>
<View style={{ "--month-selector-height": "200px" }}>
<CalendarMonthSelector value={value} minDate="2020-10-01" maxDate="2030-01-01" onChange={onChange} />
</View>
</Space>
<Space direction="vertical">
<View>CalendarMonthSwiper:展示一个月日期并且可以左右滑动切换月份</View>
<CalendarMonthSwiper current={value} onChange={onChange} minDate="2020" maxDate="2030-01-01"
marks={["2023-10-01", "2023-09-30"]} />
</Space>
<Space direction="vertical">
<View>CalendarView:完整日历视图</View>
<View style={{ "--month-selector-height": "600px" }}>
<CalendarView value={value} onChange={onChange} disabledDate={(date) => {
return dayjs(date).format("YYYY-MM-DD") === "2023-09-15";
}} />
</View>
</Space>
<Space direction="vertical">
<View>Calendar:完整日历功能</View>
<Calendar
value={value}
onChange={onChange}
extraOptions={<Button size="small">添加</Button>}
/>
</Space>
<Space direction="vertical">
<View>CalendarTimeRangeView:时间段选择器</View>
<View>已选:{dayjs(timeRange[0]).format("YYYY-MM-DD HH:mm")}~{dayjs(timeRange[1]).format("YYYY-MM-DD HH:mm")}</View>
<CalendarTimeRangeView value={timeRange} startTime="15:00" endTime="21:00" onChange={setTimeRange} />
</Space>
<Space direction="vertical">
<View>CalendarRangeView:</View>
<CalendarRangeView />
</Space>
<Space direction="vertical">
<View>CalendarTimeStepPopup:展示一个时间段选择弹窗</View>
<Button onClick={() => {
setOpen(true);
}}>点击弹出</Button>
<CalendarTimeStepPopup open={open} onOpenChange={setOpen} />
</Space>
<Space direction="vertical">
<View>CalendarPopup:展示一个日期选择弹窗</View>
<Button onClick={() => {
setOpen2(true);
}}>点击弹出</Button>
<CalendarPopup open={open2} onOpenChange={setOpen2} />
</Space>
<Space direction="vertical">
<View>CalendarRangePopup:展示一个日期范围选择弹窗</View>
<Button onClick={() => {
setOpen3(true);
}}>点击弹出</Button>
<CalendarRangePopup open={open3} onOpenChange={setOpen3} />
</Space>
<Space direction="vertical">
<View>CalendarTimeRangePopup:展示一个日期时间段范围选择弹窗</View>
<Button onClick={() => {
setOpen4(true);
}}>点击弹出</Button>
<CalendarTimeRangePopup open={open4} onOpenChange={setOpen4} value={timeRange} onChange={setTimeRange} />
</Space>
</Space>;
};
render(<BaseExample />);
- Comment 评论列表
- Comment 评论列表
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components),tarojsTaro(@tarojs/taro)
const { Comment } = miniCore;
const { Space, Button } = antd;
const { View } = tarojsComponents;
const { showToast } = tarojsTaro;
const BaseExample = () => {
return <Space direction="vertical" size={30}>
<Space direction="vertical">
<View>基础用法</View>
<Comment user={{ name: "张三" }} time={new Date()}>
评论评论评论评论评论评论评论评论评论评论评论评论评论评论
</Comment>
</Space>
<Space direction="vertical">
<View>添加事件</View>
<Comment
user={{ name: "张三" }}
time={new Date()}
action={<Button onClick={() => {
showToast({ icon: "none", title: "点击撤回..." });
}}>撤回</Button>}
>
评论评论评论评论评论评论评论评论评论评论评论评论评论评论
</Comment>
</Space>
<Space direction="vertical">
<View>自定义标题</View>
<Comment
user={{ name: "张三" }}
time={new Date()}
title={"添加了备注"}
>
评论评论评论评论评论评论评论评论评论评论评论评论评论评论
</Comment>
</Space>
<Space direction="vertical">
<View>自定义时间格式</View>
<Comment
user={{ name: "张三" }}
time={new Date()}
timeFormat={"YYYY-MM-DD"}
>
评论评论评论评论评论评论评论评论评论评论评论评论评论评论
</Comment>
</Space>
<Space direction="vertical">
<View>添加 Extra 区域内容</View>
<Comment
user={{ name: "张三" }}
time={new Date()}
action={<Button onClick={() => {
showToast({ icon: "none", title: "点击撤回..." });
}}>撤回</Button>}
title={"添加了备注"}
timeFormat={"YYYY-MM-DD"}
extra={<View>这里是Extra</View>}
>
评论评论评论评论评论评论评论评论评论评论评论评论评论评论
</Comment>
</Space>
</Space>;
};
render(<BaseExample />);
- Common 通用组件
- Common 通用组件
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components),tarojsTaro(@tarojs/taro)
const {
CommonIsJSON: isJSON,
CommonAutoComplete,
CommonFileList,
CommonListTitle,
CommonLoadingView,
CommonSelectedFooter,
CommonSelectedLabel,
} = miniCore;
const { Space, Icon } = antd;
const { View } = tarojsComponents;
const { showToast } = tarojsTaro;
const data = "data";
const dataJson = {
"title": "Warning 警告提示",
"description": "Warning 警告提示",
"code": "./warning.js",
"scope": [
{
"name": "miniCore",
"packageName": "@kne/mini-core"
},
{
"name": "antd",
"packageName": "@kne/antd-taro"
},
{
"name": "tarojsComponents",
"packageName": "@tarojs/components"
}
]
};
const fileList = [
{ fileName: "file1", id: "1" },
{ originalName: "file2", id: "2" }
];
const SubTitle = ({ children }) => {
return <View style="font-size: 16px">{children}</View>;
};
const BaseExample = () => {
return <Space direction="vertical" size={30}>
<Space direction="vertical">
<View>CommonIsJSON</View>
<Space direction="vertical">
<View>{(!!isJSON(data)).toString()}</View>
<View>{(!!isJSON(dataJson)).toString()}</View>
</Space>
</Space>
<Space direction="vertical">
<View>AutoComplete</View>
<SubTitle>输入框自动完成功能。</SubTitle>
<CommonAutoComplete placeholder={"AutoComplete--"} />
</Space>
<Space direction="vertical">
<View>FileList</View>
<SubTitle>基础用法</SubTitle>
<CommonFileList list={fileList} />
<SubTitle>可删除</SubTitle>
<CommonFileList
list={fileList}
apis={{
onDelete: ({ id, fileName, originalName }) => {
showToast({
icon: "none",
title: `ID为${id}的文件${fileName || originalName}被点击删除...`
});
}
}}
/>
</Space>
<Space direction="vertical">
<View>ListTitle</View>
<Space direction={"vertical"}>
<SubTitle>基础用法</SubTitle>
<CommonListTitle>标题</CommonListTitle>
</Space>
<Space direction={"vertical"}>
<SubTitle>副标题</SubTitle>
<CommonListTitle subtitle={"副标题"}>标题</CommonListTitle>
</Space>
<Space direction={"vertical"}>
<SubTitle>extra</SubTitle>
<CommonListTitle
subtitle={"副标题"}
extra={<Icon
type="arrow-bold-right"
className="iconfont nav-bar-icon"
onClick={() => {
showToast({ icon: "none", title: "点击 Extra" });
}}
/>}
>
标题
</CommonListTitle>
</Space>
<Space direction={"vertical"}>
<SubTitle>内标题</SubTitle>
<CommonListTitle subtitle={"副标题"} isSubheading>标题</CommonListTitle>
</Space>
</Space>
<Space direction={"vertical"}>
<View>LoadingView</View>
<Space direction={"vertical"}>
<SubTitle>基础用法</SubTitle>
<CommonLoadingView />
</Space>
<Space direction={"vertical"}>
<SubTitle>自定义加载文案</SubTitle>
<CommonLoadingView>CommonLoadingView...</CommonLoadingView>
</Space>
</Space>
<Space direction={"vertical"}>
<View>SelectedFooter</View>
<Space direction={"vertical"}>
<SubTitle>基础用法</SubTitle>
<CommonSelectedFooter />
</Space>
<Space direction={"vertical"}>
<SubTitle>修改底部按钮文案</SubTitle>
<CommonSelectedFooter confirmText={"Confirm"} resetText={"Cancel"} />
</Space>
<Space direction={"vertical"}>
<SubTitle>添加按钮事件</SubTitle>
<CommonSelectedFooter
confirmText={"Confirm"}
onConfirm={() => {
showToast({icon: 'none', title: 'on click confirm...'})
}}
resetText={"Reset"}
onReset={() => {
showToast({icon: 'none', title: 'on click reset...'})
}}
/>
</Space>
<Space direction={"vertical"}>
<SubTitle>只展示一个按钮</SubTitle>
<CommonSelectedFooter showReset={false} />
<CommonSelectedFooter showConfirm={false} />
</Space>
</Space>
<Space direction={"vertical"}>
<View>SelectedLabel</View>
<CommonSelectedLabel
maxLength={10}
value={[{ label: "测试", value: "1" }, { label: "文案", value: "2" }]}
onClose={({label, value}) => {
showToast({
icon: 'none',
title: `值为“${value}”、Label为“${label}”的数据被点击删除...`
})
}}
/>
</Space>
</Space>;
};
render(<BaseExample />);
- FetchList 获取并显示列表
- FetchList 获取并显示列表
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components),tarojsTaro(@tarojs/taro),mockData(@mock)
const { CommonFetchList, Global, usePreset } = miniCore;
const { Space, Avatar } = antd;
const { View } = tarojsComponents;
const BaseExample = () => {
const { apis } = usePreset();
return <Space direction="vertical" size={30}>
<Space direction="vertical">
<View>基础用法</View>
<CommonFetchList showTotalCount {...apis.user.getUserList}>
{
({ pageData }) => {
return (
<Space direction="vertical" style={{ padding: "10px 0", boxSizing: "border-box" }}>
{
pageData.map(item => (
<Space key={item.id} style={{ border: "1px solid #ddd", padding: "10px", boxSizing: "border-box", width: '100%' }}>
<Avatar gender={item.gender} />
<View>
<View>Name: {[item.name, item.englishName].join(",")}</View>
<View>Gender: {item.gender}</View>
<View>Email: {item.email}</View>
</View>
</Space>
))
}
</Space>
);
}
}
</CommonFetchList>
</Space>
</Space>;
};
render(<Global
preset={{
apis: {
baseURL: "https://erc.test.fatalent.cn",
user: {
getUserList: {
loader: () => {
return mockData.userList.data;
}
}
}
}
}}>
<BaseExample />
</Global>);
- Content 信息展示
- Content 信息展示
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { Content, TipsMessage } = miniCore;
const { Button, Space } = antd;
const { View } = tarojsComponents;
const BaseExample = () => {
return <Space direction={"vertical"} size={30}>
<Space direction={"vertical"}>
<View>基础用法</View>
<Content
list={[
{ label: "测试", content: "哈哈啊哈哈" },
{ label: "测试", content: "哈哈啊哈哈", tips: "哈哈哈哈", action: <Button>查看</Button> },
{ label: "tips", content: <TipsMessage content="哈哈哈哈" title="我是一个title" icon={null} /> }
]}
/>
</Space>
<Space direction={"vertical"}>
<View>数据为空时展示</View>
<Content
empty={"-此处是空数据-"}
list={[
{ label: "测试" },
{ label: "测试", tips: "哈哈哈哈" }
]}
/>
</Space>
<Space direction={"vertical"}>
<View>内容单独一行显示</View>
<Content
empty={"-"}
list={[
{ label: "测试" },
{ label: "测试", content: "哈哈啊哈哈", tips: "哈哈哈哈", block: true }
]}
/>
</Space>
<Space direction={"vertical"}>
<View>数据展示判断</View>
<Content
empty={"-"}
list={[
{ label: "测试1", content: '哈哈啊哈哈' },
{ label: "测试2", content: "哈哈啊哈哈", display: false },
{ label: "测试3", content: "哈哈啊哈哈", display: () => true }
]}
/>
</Space>
</Space>;
};
render(<BaseExample />);
- Enum 枚举值
- Enum 展示获取枚举值和批量获取枚举值
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { Enum } = miniCore;
const { Space } = antd;
const { View } = tarojsComponents;
const BaseExample = () => {
return <Space direction={"vertical"} size={30}>
<Space direction={"vertical"}>
<View>基础用法</View>
<Enum loading={null} moduleName="degreeEnum" name={30} />
</Space>
<Space direction={"vertical"}>
<View>返回值自定义</View>
<Enum moduleName="experienceEnum" name={"0-1"}>
{({ description }) => {
return "experienceEnum-" + description;
}}
</Enum>
</Space>
<Space direction={"vertical"}>
<View>展示 Enum 所有值</View>
<Enum moduleName="experienceEnum">
{experienceEnum => (
<Space split={','} size={0}>
{experienceEnum.map(item => <View>{item.description}</View>)}
</Space>
)}
</Enum>
</Space>
<Space direction={"vertical"}>
<View>Enum 一次加载多个</View>
<Enum moduleName={["experienceEnum", "political"]}>
{([experienceEnum, political]) => (
<Space direction={'vertical'}>
<Space split={','} size={0}>
{experienceEnum.map(item => <View>{item.description}</View>)}
</Space>
<Space split={','} size={0}>
{political.map(item => <View>{item.description}</View>)}
</Space>
</Space>
)}
</Enum>
</Space>
</Space>;
};
render(<BaseExample />);
- File 文件预览
- File 文件预览
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { Global, File } = miniCore;
const { Space, Icon } = antd;
const { View } = tarojsComponents;
const BaseExample = () => {
return <Global preset={{
apis: {
file: {
getFileUrl: {
loader: ({ params }) => {
return "https://attachment.test.fatalent.cn/attachment/Q0ol94kBBZgnCXyZKG1Y.jpg?Expires=1700814537&OSSAccessKeyId=LTAI5tAfbu2aBppB3jMj1kMt&Signature=KcJHlI8FDYMolFQFxacGzhoaA1A%3D";
}
}
}
}
}}>
<Space direction={"vertical"} size={30}>
<Space direction={"vertical"}>
<View>基础用法</View>
<File value="xxxxx" originalName="预览文件.jpg" />
</Space>
<Space direction={"vertical"}>
<View>修改文件图标</View>
<File value="xxxxx" originalName="预览文件.jpg" icon={<Icon className="iconfont" type="tianjia" />} />
</Space>
</Space>
</Global>;
};
render(<BaseExample />);
- Filter 筛选
- Filter 展示条件筛选器
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { Enum, Filter } = miniCore;
const { Space } = antd;
const { View } = tarojsComponents;
const { useState } = React;
const stateBarItems = [
{ key: "all", children: "全部" },
{ key: "progress", children: "进展中" },
{ key: "stop", children: "暂停" },
{ key: "close", children: "关闭" },
{ key: "other1", children: "其他1" },
{ key: "other2", children: "其他2" },
{ key: "other3", children: "其他3" },
{ key: "other4", children: "其他4超长超长超长超长" },
{ key: "other5", children: "其他5" }
];
const optionsBarItems = ({ degreeEnum, political }) => [
{ key: "mine", label: "我上传的", type: "SwitchButton" },
{
key: "political",
label: "政治面貌",
type: "ListSelect",
api: {
loader: () => {
return {
pageData: political.map(({ value, description }) => ({
value, label: description
}))
};
}
}
},
{ key: "city", label: "期望城市", type: "CitySelect" },
{ key: "currentCity", label: "现居城市", type: "CitySelect" },
{ key: "function", label: "职能", type: "FunctionSelect" },
{ key: "industry", label: "行业", type: "IndustrySelect" },
{
key: "positionUser",
label: "职位负责人",
type: "UserListSelect",
apis: {
getUserList: {
loader: () => {
return {
pageData: degreeEnum.map(({ value, description }) => ({
uid: value, name: description, description
}))
};
}
}
}
}
];
const BaseExample = () => {
const [filter4, setFilter4] = useState({
state: "stop",
option2: { mine: true, political: [{ value: "中共党员", label: "中共党员" }] }
});
return <Space direction={"vertical"} size={30}>
<View>Filter 组合</View>
<Filter filter={filter4} onChange={setFilter4}>
<Filter.SearchBar name="keyword" />
<Filter.StateBar name="state" items={stateBarItems} />
<Enum loading={null} moduleName={["degreeEnum", "political"]}>
{([degreeEnum, political]) => {
return <Filter.OptionsBar name="option2" items={optionsBarItems({ degreeEnum, political })} />;
}}
</Enum>
<Filter.OptionsBar
name="option3"
items={[
{ key: "city", label: "期望城市", type: "CitySelect" },
{ key: "currentCity", label: "现居城市", type: "CitySelect" }
]}
/>
</Filter>
</Space>;
};
render(<BaseExample />);
- FixedView 底部固定视图容器
- FixedView 底部固定视图容器
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const {FixedView,FixedButton, FixedLoadingButton} = miniCore;
const {Space} = antd;
const {View} = tarojsComponents;
const BaseExample = () => {
return (
<FixedView
noPadding
hasSafeArea
direction={'vertical'}
fixBottomExtra={<Space direction={'vertical'}><View>fixBottomExtra</View><View>fixBottomExtra2</View></Space>}
>
哈哈哈
<Space>
<FixedButton type='default'>FixedButton</FixedButton>
<FixedButton type='primary'>FixedButton</FixedButton>
</Space>
<FixedLoadingButton loading type='primary'>FixedLoadingButton</FixedLoadingButton>
</FixedView>
);
};
render(<BaseExample/>);
- FormInfo 表单
- FormInfo 展示表单组件
- miniCore(@kne/mini-core),lodash(lodash),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const {FormInfo, Global, CommonListTitle} = miniCore;
const {range} = lodash;
const {Space, Button} = antd;
const {useMemo} = React;
const {View} = tarojsComponents;
const {
FormPart,
FormList,
Form,
Input,
SalaryInput,
PhoneNumber,
CardType,
Picker,
AdvancedSelect,
AutoComplete,
CalendarTimeRange,
Calendar,
CitySelect,
IndustrySelect,
FunctionSelect,
TimeStep,
CalendarRange,
UserListSelect,
InputNumber,
InputNumberUnit,
Upload,
SubmitButton,
useFormContext,
SubList,
usePopupForm,
TextArea
} = FormInfo;
const {useRef} = React;
const BaseExample = () => {
const popupForm = usePopupForm();
const listRef = useRef();
const parentForm = useRef();
return <Global preset={{
apis: {
baseURL: "https://erc.test.fatalent.cn", resume: {
ossUpload: {
url: "/api/v1/attachment/upload"
}
}, user: {
getUserList: {
loader: () => {
return {
pageData: range(0, 20).map((index) => ({
uid: index, name: `用户${index}`, description: `用户${index}`
}))
};
}
}
}
}, enums: {
cardTypeEnum: [{"value": 1, "description": "身份证"}, {"value": 2, "description": "护照"}]
}
}}>
<CommonListTitle subtitle="(至少填写一段工作经历)" extra="添加">工作经历</CommonListTitle>
<CommonListTitle subtitle="(至少填写一段工作经历)" isSubheading extra="添加">工作经历</CommonListTitle>
<Space direction={"vertical"} size={30}>
<Space direction={"vertical"}>
<View>弹出表单</View>
<Button onClick={() => {
popupForm({
title: "新增表单",
formProps: {
onSubmit: (data) => {
console.log(data);
}
},
children: <FormPart list={[<Input.Item name="name" label="姓名" rule="REQ"/>,
<CalendarTimeRange.Item name="time" label="时间" rule="REQ"/>,
<CitySelect.Item name="city" label="城市"/>,
<FunctionSelect.Item name="function" label="职能"/>,
<TextArea.Item name="des" label="说明"/>]}/>
});
}}>点击弹出popup</Button>
</Space>
<Space direction={"vertical"}>
<View>基础用法</View>
<Form
data={{
"name": "张三",
"date-range": ["2010-01-01", "2012-01-02"],
"test2": [3],
"city": ["020"],
"industry": ["00100d4"],
"function": ["001001002"]
}}
onSubmit={(data) => {
console.log(data);
}}
>
<FormPart
title="表单标题"
list={[<Input.Item label="姓名" name="name" rule="REQ LEN-0-10"/>,
<Picker.DateRangePicker.Item name="date-range" label="时间段"/>,
<PhoneNumber.Item name="phone" label="手机"/>,
<CardType.Item name="id-card" label="身份证"/>,
<SalaryInput.Item name="salary" label="薪资" hasMonth typeEnum={({render}) => render([{
description: "年薪", value: 6
}, {description: "月薪", value: 5}, {description: "周薪", value: 4}, {
description: "日薪", value: 3
}, {description: "时薪", value: 2}])}/>,
<AdvancedSelect.Item name="test2" label="高级选择" rule="REQ" getSearchProps={() => {
return {};
}} api={{
loader: () => {
return {
pageData: [{label: "第一项", value: 1}, {
label: "第二项", value: 2, disabled: true
}, {
label: "第三项", value: 3
}]
};
}
}}/>, <CitySelect.Item name="city" label="城市选择"/>,
<IndustrySelect.Item name="industry" label="行业选择" multiple/>,
<FunctionSelect.Item name="function" label="职能选择" multiple={false}/>,
<CalendarTimeRange.Item name="time" label="面试时间" rule="REQ"/>,
<InputNumber.Item name="number" label="数字" addonAfter="元" step={2}/>,
<InputNumberUnit.Item name="date" label="试用期"/>,
<Calendar.Item name="time2" label="时间"/>, <TimeStep.Item name="timeStep" label="时间2"/>,
<CalendarRange.Item name="time3" label="时间段"/>,
<CalendarTimeRange.Item name="time2" label="面试时间2" rule="REQ" durationHidden/>,
<UserListSelect.Item name="user" label="用户" rule="REQ" disabledValues={[1, 2, 3]}/>,
<Upload.Item name="attachment" label="附件" rule="REQ"/>,
<AutoComplete.Item name="school" label="学校" rule="REQ" api={{
loader: ({data}) => {
return {
pageData: [{
label: "第一项" + data.searchText, value: 1
}, {label: "第二项" + data.searchText, value: 2, disabled: true}, {
label: "第三项" + data.searchText, value: 3
}]
};
}
}}/>, <SubmitButton>提交</SubmitButton>]}
/>
</Form>
</Space>
<Space direction={"vertical"}>
<View>列表</View>
<Form onSubmit={(data) => {
console.log(data);
}}
>
<CommonListTitle
subtitle="(填写工作经历)"
extra={<Button fill="none" onClick={() => {
listRef.current.add();
}}>添加</Button>}
>
工作经历
</CommonListTitle>
<FormList
title="列表1"
ref={listRef}
name="list1"
minLength={1}
itemTitle={({index}) => `第${index + 1}项`}
list={[<Input.Item name="name" label="名称" labelTips="哈哈哈哈"/>,
<Input.Item name="field0" label="字段"/>, <Input.Item name="field1" label="字段1"/>]}
/>
<FormList
name="list2"
title="列表2"
subtitle="副标题"
minLength={1}
itemTitle={({index}) => `第${index + 1}项`}
list={[<Input.Item name="name" label="名称"/>, <Input.Item name="field0" label="字段"/>,
<Input.Item name="field1" label="字段1"/>]}
/>
<FormList
name="list3"
title="列表3"
subtitle="副标题"
minLength={1}
itemTitle={({index}) => `第${index + 1}项`}
list={(id, item, context) => {
parentForm.current = context.formData;
return [<Input.Item name="name" label="名称"/>, <Input.Item name="field0" label="字段"/>,
<Input.Item name="field1" label="字段1"/>,
<SubList name="sub-list" title="子列表" itemTitle={({index}) => `第${index + 1}项`}
onChange={(data) => {
console.log('xxxxxx', data);
}}
listProps={[{
label: '名称',
contentRender: ({value}) => `我是${value.name}-${value.field0}`
}, {
label: '字段1', name: 'field1'
}]} minLength={2}
list={() => [<Input.Item name="name" label="名称"
onChange={() => {
console.log('xxxx', parentForm.current);
}}/>, <Input.Item name="field0" label="字段"/>,
<Input.Item name="field1" label="字段1"/>]}/>];
}}
/>
<SubmitButton>提交</SubmitButton>
</Form>
</Space>
</Space>
</Global>;
};
render(<BaseExample/>);
- HeaderContainer 页面头部容器
- HeaderContainer 页面头部容器
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsTaro(@tarojs/taro)
const { HeaderContainer } = miniCore;
const { Space, Icon } = antd;
const Taro = tarojsTaro;
const BaseExample = () => {
return <HeaderContainer
bgColor={'#6740C3'}
extra={<Space>
<Icon
type={"arrow-thin-left"}
className="iconfont"
onClick={() => Taro.navigateBack({
delta: 1
}).catch(({ errMsg }) => {
Taro.switchTab({ url: "/pages/index/index" });
})}
/>
返回
</Space>}
>
哈哈哈
</HeaderContainer>;
};
render(<BaseExample />);
- HighLight 高亮
- HighLight 展示搜索高亮
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { HighLight, HighLightProvider } = miniCore;
const { View } = tarojsComponents;
const { Space } = antd;
const BaseExample = () => {
return <Space direction={"vertical"} size={30}>
<Space direction={"vertical"}>
<View>默认标签</View>
<HighLightProvider keyword="东北">
<HighLight text="我的家在东北,松花江上呀!" />
</HighLightProvider>
</Space>
<Space direction={"vertical"}>
<View>自定义容器标签</View>
<HighLightProvider keyword={["项目需求分析", "新的技术栈"]}>
<HighLight tagName={View}
text="工作描述: 参与项目需求分析,业务模块划分↵学习一些新的技术栈↵部分功能模块代码的实现↵对自身完成代码进行简单测试↵对于电商项目的核心业务有一定经验↵后端开发RabbitMQJavaMySQLRedisSpringCloudElasticsearch微服务架构" />
</HighLightProvider>
</Space>
<Space direction={"vertical"}>
<View>忽略大小写</View>
<HighLightProvider keyword={["哈尔滨", "信息", "abs", "wang"]}>
<HighLight tagName={View} text="ABs Wang我的家在东北,松花江上呀!哈尔滨真美,信息通达" />
</HighLightProvider>
<View>区分大小写</View>
<HighLightProvider keyword={["哈尔滨", "信息", "abs", "Wang"]} caseSensitive>
<HighLight tagName={View} text="ABs Wang我的家在东北,松花江上呀!哈尔滨真美,信息通达" />
</HighLightProvider>
</Space>
</Space>;
};
render(<BaseExample />);
- InfoPage 复杂信息展示
- InfoPage 复杂信息展示
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { InfoPage, Content, Comment, Table } = miniCore;
const { Button, Steps, Space } = antd;
const { View } = tarojsComponents;
const contentList = [
{ label: "开票ID", content: "IN00001533" },
{ label: "客户名称", content: "自动化测试有限公司" },
{ label: "合同", content: "onsiteRPO合同", action: <Button>预览</Button> },
{
label: "划转人",
block: true,
content: <Table
dataSource={[
{ id: 1, name: "哈哈哈", count: 12 },
{ id: 2, name: "张三张三张三张三张三张三张三张三张三张三张三张三张三张三张三张三张三", count: 200 }
]}
columns={[{ name: "name", title: "名称" }, { name: "count", title: "数量" }]}
/>
},
{ label: "备注", content: null }
];
const stepsItems = [{
title: "第一步", description: "完成时间:2020-12-01 12:30"
}, {
title: "第二步", description: "完成时间:2020-12-01 12:30"
}, {
title: "第三步", description: "完成时间:2020-12-01 12:30"
}, {
title: "第四步", description: "完成时间:2020-12-01 12:30"
}];
const BaseExample = () => {
return (
<Space direction={"vertical"} size={30}>
<Space direction={"vertical"}>
<View>基础用法</View>
<InfoPage>
<InfoPage.Part title="开票信息">
<InfoPage.Part>
<Content list={contentList} />
</InfoPage.Part>
</InfoPage.Part>
</InfoPage>
</Space>
<Space direction={"vertical"}>
<View>带有副标题</View>
<InfoPage>
<InfoPage.Part title="开票信息">
<InfoPage.Part title="发票费用信息">
<InfoPage.Part>
发票费用信息发票费用信息发票费用信息发票费用信息发票费用信息发票费用信息发票费用信息
</InfoPage.Part>
<InfoPage.Part title="开票信息详情">
<Content list={contentList} />
</InfoPage.Part>
</InfoPage.Part>
</InfoPage.Part>
</InfoPage>
</Space>
<Space direction={"vertical"}>
<View>折叠面板</View>
<InfoPage.Part title="开票信息">
<InfoPage.Collapse items={[{
key: "1", title: "第一项", children: <Content list={[{
label: "开票ID", content: "IN00001533", tips: "哈哈哈"
}, {
label: "客户名称", content: "自动化测试有限公司"
}, {
label: "合同", content: "onsiteRPO合同", action: <Button>预览</Button>
}]} />
}, {
key: "2", title: "第二项", children: "第二项第二项第二项第二项第二项第二项第二项第二项"
}, {
key: "3", title: "第三项", children: "第三项第三项第三项第三项第三项第三项第三项第三项第三项"
}]} />
</InfoPage.Part>
</Space>
<Space direction={"vertical"}>
<View>内容自定义</View>
<InfoPage>
<InfoPage.Part title="审批流程">
<Steps current={2} items={stepsItems} />
<Steps direction="vertical" current={2} items={stepsItems} />
<Steps
direction="vertical"
current={2}
items={[{
title: "第一步",
description: <Space direction="vertical">
<Comment user={{ name: "张三" }} time={new Date()}>
评论评论评论评论评论评论评论评论评论评论评论评论评论评论
</Comment>
<Comment user={{ name: "张三" }} time={new Date()} action={<Button>撤回</Button>}>
评论评论评论评论评论评论评论评论评论评论评论评论评论评论
</Comment>
</Space>
},
{ title: "第二步", description: "完成时间:2020-12-01 12:30" },
{ title: "第三步", status: "error", description: "完成时间:2020-12-01 12:30" },
{ title: "第四步", description: "完成时间:2020-12-01 12:30" }
]}
/>
</InfoPage.Part>
</InfoPage>
</Space>
</Space>
);
};
render(<BaseExample />);
- Layout 布局
- Layout 布局
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { Layout } = miniCore;
const { View } = tarojsComponents;
const { Icon } = antd;
const BaseExample = () => {
return <Layout
hasSafeArea
toolbarList={[{
key: "/pages/index/index",
icon: (active) => active ? <Icon type="tabgongzuotai-xuanzhong" className={"iconfont"} /> :
<Icon type="tabgongzuotai-moren" className={"iconfont"} />,
title: "首页"
}, {
key: "/pages/components/index",
icon: (active) => active ? <Icon type="tabzhiwei-xuanzhong" className={"iconfont"} /> :
<Icon type="tabzhiwei-moren" className={"iconfont"} />,
title: "组件示例"
}]}
header={{
title: "layout",
bgColor: "#ff8f1f",
extra: <View>extra</View>,
backArrow: <Icon type="arrow-bold-left" className="iconfont nav-bar-icon" />
}}
>
哈哈哈
</Layout>;
};
render(<BaseExample />);
- Modal 确认对话框
- Modal 展示确认对话框
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { Modal, ModalButton, useModal } = miniCore;
const { useState } = React;
const { Button, Space } = antd;
const { View } = tarojsComponents;
const ExampleUseModal = () => {
const modal = useModal();
return <Button onClick={() => {
modal({
title: "确认解除微信关联?", content: "解除后,将无法直接通过企业微信发起聊天。"
});
}}>按钮</Button>;
};
const BaseExample = () => {
const [open, setOpen] = useState(false);
return <Space direction={"vertical"} size={30}>
<Space direction={"vertical"}>
<View>基础用法</View>
<View>
<Button onClick={() => {
setOpen(true);
}}>按钮</Button>
<Modal
open={open}
onOpenChange={setOpen}
title="确认解除微信关联?"
content="解除后,将无法直接通过企业微信发起聊天。"
/>
</View>
</Space>
<Space direction={"vertical"}>
<View>ModalButton</View>
<ModalButton title="确认解除微信关联?" content="解除后,将无法直接通过企业微信发起聊天。">点击弹出</ModalButton>
</Space>
<Space direction={"vertical"}>
<View>useModal Hook 调用</View>
<ExampleUseModal />
</Space>
</Space>;
};
render(<BaseExample />);
- Popup Form 弹出表单页面
- Popup Form 展示popup里面的表单组件
- miniCore(@kne/mini-core),lodash(lodash),antd(@kne/antd-taro)
const {FormInfo, HeaderContainer} = miniCore;
const {range} = lodash;
const {Button, Popup} = antd;
const {useState} = React;
const {
FormPart,
Input,
TextArea,
CalendarTimeRange,
Calendar,
CitySelect,
FunctionSelect,
UserListSelect,
SubmitButton,
usePopupForm
} = FormInfo;
const BaseExample = () => {
const popupForm = usePopupForm();
return <Button onClick={() => {
popupForm({
title: '新增表单',
formProps: {
onSubmit: (data) => {
console.log(data);
}
},
children: <FormPart list={[<Input.Item name="name" label="姓名" rule="REQ"/>,
<CalendarTimeRange.Item name="time" label="时间" rule="REQ"/>,
<CitySelect.Item name="city" label="城市"/>, <FunctionSelect.Item name="function" label="职能"/>,
<TextArea.Item name="des" label="说明"/>]}/>
});
}}>点击弹出popup</Button>;
};
render(<BaseExample/>);
- Popup View 弹出页面
- Popup View 弹出页面
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { usePopupView, FormInfo, FixedView, CommonListTitle, Warning } = miniCore;
const { Space, Button } = antd;
const { Text } = tarojsComponents;
const {
Form,
FormList,
FormPart,
Input,
TextArea,
CalendarTimeRange,
CitySelect,
IndustrySelect,
FunctionSelect,
SubmitButton
} = FormInfo;
const { useRef } = React;
const PopupViewButton = ({ position }) => {
const popupView = usePopupView({ position });
return (
<Button key={position} onClick={() => {
popupView({
title: position,
children: <Text>从{position}弹出</Text>
});
}}>从{position}弹出</Button>
);
};
const BaseExample = () => {
const popupView = usePopupView();
const listRef = useRef();
return (
<Space direction={"vertical"} size={30}>
<Space direction={"vertical"}>
<Text>基础用法</Text>
<Button onClick={() => {
popupView({
title: "基础用法",
children: <Text>基础用法弹窗</Text>
});
}}>点击弹出</Button>
</Space>
<Space direction={"vertical"}>
<Text>自定义弹出方向</Text>
<Space wrap>
{
["center", "top", "bottom", "left", "right"].map(position => (
<PopupViewButton key={position} position={position} />
))
}
</Space>
</Space>
<Space direction={"vertical"}>
<Text>联合表单</Text>
<Button onClick={() => {
const { close } = popupView({
className: "bg-grey", title: "欢迎页面", children: <Form onSubmit={(data) => {
console.log(data);
close();
}}>
<Warning>警告提示警告提示警告提示警告提示警告提示警告提示警告提示警告提示警告提示警告提示警告提示</Warning>
<FormPart list={[<Input.Item name="name" label="姓名" rule="REQ" />,
<CalendarTimeRange.Item name="time" label="时间" rule="REQ" />,
<CitySelect.Item name="city" label="城市" />, <FunctionSelect.Item name="function" label="职能" />,
<IndustrySelect.Item name="industry" label="行业选择" multiple />,
<TextArea.Item name="des" label="说明" />]} />
<CommonListTitle subtitle="(填写工作经历)" extra={<Button onClick={() => {
listRef.current.add();
}}>添加</Button>}>工作经历</CommonListTitle>
<FormList ref={listRef} name="list" minLength={1}
list={[<Input.Item name="name" label="名称" labelTips="哈哈哈哈哈哈" />,
<Input.Item name="field0" label="字段" />,
<Input.Item name="field1" label="字段1" />]} />
<Button onClick={() => {
popupView({
title: "下一个页面",
children: "下一个页面下一个页面下一个页面下一个页面下一个页面",
hasSafeArea: true
});
}}>点击弹出下一个页面</Button>
<FixedView>
<SubmitButton>提交</SubmitButton>
</FixedView>
</Form>
});
}}>点击弹出</Button>
</Space>
</Space>
);
};
render(<BaseExample />);
- ScrollLoader 滚动加载
- ScrollLoader 滚动加载
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { CommonScrollLoader } = miniCore;
const {Space} = antd;
const {View} = tarojsComponents;
const ScrollLoaderInner = () => {
return (
<Space direction={'vertical'}>
{
['one', 'two'].map(item => (
<View key={item} style={{padding: '10px', boxSizing: 'border-box', border: '1px solid #ddd'}}>
{item}
</View>
))
}
</Space>
)
}
const BaseExample = () => {
return (
<Space direction={'vertical'} size={30}>
<Space direction={'vertical'}>
<View>基础用法</View>
<CommonScrollLoader>
<ScrollLoaderInner />
</CommonScrollLoader>
</Space>
<Space direction={'vertical'}>
<View>加载中</View>
<CommonScrollLoader isLoading loadingTips={'正在加载数据...'}>
<ScrollLoaderInner />
</CommonScrollLoader>
</Space>
<Space direction={'vertical'}>
<View>没有更多数据</View>
<CommonScrollLoader noMore completeTips={'加载已完成,没有更多数据了'}>
<ScrollLoaderInner />
</CommonScrollLoader>
</Space>
</Space>
)
};
render(<BaseExample />);
- StateTag 状态标签
- StateTag 状态标签
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { StateTag } = miniCore;
const { Space } = antd;
const { View } = tarojsComponents;
const BaseExample = () => {
return (
<Space direction={"vertical"} size={30}>
<Space direction={"vertical"}>
<View>基础用法</View>
<StateTag type="primary">哈哈哈</StateTag>
</Space>
<Space direction={"vertical"}>
<View>不同类型</View>
<Space wrap>
{
["default", "result", "success", "progress", "danger", "info", "other", "primary"].map(type => (
<StateTag key={type} type={type}>{type}</StateTag>
))
}
</Space>
</Space>
<Space direction={"vertical"}>
<View>不展示背景色</View>
<Space wrap>
{
["default", "result", "success", "progress", "danger", "info", "other", "primary"].map(type => (
<StateTag key={type} type={type} showBackground={false}>{type}</StateTag>
))
}
</Space>
</Space>
<Space direction={"vertical"}>
<View>展示边框</View>
<Space wrap>
<StateTag type="primary" showBorder text="类型: Primary" />
{
["default", "result", "success", "progress", "danger", "info", "other", "primary"].map(type => (
<StateTag key={type} type={type} showBorder text={`${type}`} />
))
}
</Space>
</Space>
</Space>
);
};
render(<BaseExample />);
- Table 表格
- Table 表格
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { Table } = miniCore;
const { Space } = antd;
const { View } = tarojsComponents;
const dataSource = [
{ id: 1, name: "哈哈哈", count: 12 },
{ id: 2, name: "张三", count: 200 },
{ id: 3, name: "李四", count: 100 }
];
const columns = [
{ name: "name", title: "名称" },
{ name: "count", title: "数量" }
];
const BaseExample = () => {
return (
<Space direction={"vertical"} size={30}>
<Space direction={"vertical"}>
<View>基础用法</View>
<Table dataSource={dataSource} columns={columns} />
</Space>
<Space direction={"vertical"}>
<View>多列</View>
<Table
dataSource={dataSource}
columns={[{ name: "id", title: "ID" }].concat(columns)}
/>
</Space>
<Space direction={"vertical"}>
<View>自定义rowKey</View>
<Table rowKey={"name"} dataSource={dataSource} columns={columns} />
</Space>
<Space direction={"vertical"}>
<View>自定义列渲染</View>
<Table
dataSource={dataSource}
columns={[{
name: "id",
title: "ID",
render: (record, {dataSource, column}) => {
console.log(record, dataSource, column);
return record.id + '-' + record.name
}
}].concat(columns)}
/>
</Space>
</Space>
);
};
render(<BaseExample />);
- TipsMessage 提示信息
- TipsMessage 提示信息
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { TipsMessage } = miniCore;
const { Space, Icon } = antd;
const { View } = tarojsComponents;
const BaseExample = () => {
return (
<Space direction={"vertical"} size={30}>
<Space direction={"vertical"}>
<View>基础用法</View>
<TipsMessage
content={"客户下任一合同包含Hands-off条款,该客户即受Hands-off限制。默认按照最严格的赔偿责任及条款描述提交审批。"}
title={"Hands-off信息"}
/>
</Space>
<Space direction={"vertical"}>
<View>自定义弹窗 Title 图标</View>
<TipsMessage
content={"客户下任一合同包含Hands-off条款,该客户即受Hands-off限制。默认按照最严格的赔偿责任及条款描述提交审批。"}
title={"Hands-off信息"}
icon={<Icon type="tabzhiwei-xuanzhong" className={'iconfont'} />}
/>
</Space>
<Space direction={"vertical"}>
<View>取消确认按钮</View>
<TipsMessage
content={"客户下任一合同包含Hands-off条款,该客户即受Hands-off限制。默认按照最严格的赔偿责任及条款描述提交审批。"}
title={"Hands-off信息"}
cancel={{ span: 10, text: "Cancel" }}
confirm={{ span: 14, text: "Confirm" }}
/>
</Space>
</Space>
);
};
render(<BaseExample />);
- Warning 警告提示
- Warning 警告提示
- miniCore(@kne/mini-core),antd(@kne/antd-taro),tarojsComponents(@tarojs/components)
const { Warning } = miniCore;
const { Space } = antd;
const { View } = tarojsComponents;
const BaseExample = () => {
return (
<Space direction={'vertical'} size={30}>
<Space direction={'vertical'}>
<View>基础用法</View>
<Warning>哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈</Warning>
</Space>
<Space direction={'vertical'}>
<View>不同类型</View>
<Space direction={'vertical'}>
{
['success', 'info', 'error', 'warning'].map(type => (
<Warning key={type} type={type}>哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈</Warning>
))
}
</Space>
</Space>
<Space direction={'vertical'}>
<View>文字颜色根据类型改变</View>
<Space direction={'vertical'}>
{
['success', 'info', 'error', 'warning'].map(type => (
<Warning key={type} type={type} fontColorful>哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈哈</Warning>
))
}
</Space>
</Space>
</Space>
);
};
render(<BaseExample />);
API
Global
Global管理了一个全局的Context,preset及公共样式,css变量,dayjs默认插件引入,dayjs汉化语言包引入等
Global组件需要放在最外面,推荐在app.js中
常见的 preset如下:
ajax: 发送ajax请求的方法,通常为axios.create()对象。因为在项目中可能回存在给axios对象添加拦截器或者其他config的情况,所以在应用内部用到的地方均应获取该对象使用。
apis: 该应用的所有后端apis,应用内部,不管是组件还是业务在使用api时都应从这里获取,以保证后端api的可迁移性
enums: 枚举定义,应用内部用到枚举的都应该通过Enum组件获取,Enum组件会根据此配置去加载对应的枚举数据
formInfo: FormInfo组件会从此获取应用的Form预设配置
| 属性名 | 说明 | 类型 | 默认值 | |--------|------------|--------|-----| | preset | 全局preset设置 | object | {} |
AvatarPreview 照片预览
属性
| 属性名 | 说明 | 类型 | 默认值 | |---------|--------|-----------------------------------|-----| | value | 头像链接 | string | - | | onClick | 头像点击事件 | (event: React.MouseEvent) => void | - |
Calendar 日历
Comment 评论列表
属性
| 属性名 | 说明 | 类型 | 默认值 | |------------|---------|---------------------|-----------------------| | user | 行为用户 | {name: string} | {} | | title | 列表标题 | string | '添加了评论' | | time | 列表时间 | PickerDate | - | | timeFormat | 列表时间格式 | string | 'YYYY-MM-DD HH:mm:ss' | | action | 列表项动作按钮 | ReactNode | - | | extra | 列表项右侧区域 | ReactNode | string | - |
Content 内容展示
属性
| 属性名 | 说明 | 类型 | 默认值 | |-------|---------|---------------------|-----| | empty | 数据为空时展示 | ReactNode | string | '-' | | list | 每条内容数据 | ContentItem[] | [] |
ContentItem
| 属性名 | 说明 | 类型 | 默认值 | |---------|----------------|-----------------------|-----| | display | 数据为空时展示 | boolean | () => void | - | | label | 内容标题文案 | ReactNode | string | - | | content | 内容数据 | ReactNode | string | - | | block | 是否将内容数据渲染为块级元素 | boolean | - | | tips | 文案提示 | ReactNode | string | - | | action | 单条内容动作 | ReactNode | - |
Enum 显示或获取枚举值
属性
| 属性名 | 说明 | 类型 | 默认值 | |------------|----------------------------------------------------------------------------------|--------------------------------------------------------|------------------------------| | moduleName | 枚举值的名字,在preset设置的枚举对象的key,当其为数组时可以一次性获取多个枚举值列表 | string | string[] | - | | name | 枚举值的key,用来从moduleName的枚举值列表中获取对应key的值,传入该参数时moduleName不能为数组,不传时可以获取到整个枚举列表 | string | - | | children | 获取到枚举值,当组件有name传入时获取name所对应的枚举值,如果没有name传入则获取到整个枚举列表,如果moduleName为数组获取到对应的多个枚举列表 | ({description})=> void | ({enum1, enum2, ...})=> void | ({description})=>description | | loading | 加载枚举值期间显示内容 | jsx | null | | force | 在加载枚举列表时,如果之前已经加载过了默认会直接获取上次加载缓存的枚举列表,当该参数为true时则会忽略缓存从新获取枚举值列表数据 | boolean | false |
File 文件显示及预览
属性
| 属性名 | 说明 | 类型 | 默认值 | |--------------|------|-----------|-------------------------------------------| | icon | 文件图标 | ReactNode | Icon className="iconfont" type={"fujian"} | | originalName | 文件名称 | string | - | | value | 文件ID | string | - |
Filter 条件筛选
一般放在页面顶部
属性
| 属性名 | 说明 | 类型 | 默认值 | |----------|-------------|----------|-----| | filter | 筛选器的值 | object | {} | | onChange | 筛选器值修改时触发执行 | function | - |
Filter.SearchBar 关键字文本搜索
一般放在Filter顶部
| 属性名 | 说明 | 类型 | 默认值 | |-------------------|--------------------|-------------------------|-----| | name | 筛选器的key,会赋值给filter | string | - | | searchPlaceholder | 输入框为空时占位符 | string | - | | onChange | 点击搜索或输入Enter键时触发执行 | (value: string) => void | - |
Filter.StateBar 状态筛选
| 属性名 | 说明 | 类型 | 默认值 | |-------|--------------------|---------------------------------------------|-----| | name | 筛选器的key,会赋值给filter | string | - | | items | 状态列表 | {key: string,children: ReactNode|string}[] | [] |
Filter.OptionsBar 复杂多条件筛选
| 属性名 | 说明 | 类型 | 默认值 | |-------|--------------------|-------------------------------------------------------------------------|-----| | name | 筛选器的key,会赋值给filter | string | - | | items | 状态列表 | {key: string,label: string,type: string,className:string,api: Object}[] | [] |
OptionsBarItem
| 属性名 | 说明 | 类型 | 默认值 | |-----------|--------------------|----------------------------------------------------------------------------|-----| | key | 筛选器的key,会赋值给filter | string | - | | label | 筛选条件的名称 | string | - | | type | 筛选条件的类型 | CitySelect |ListSelect |UserListSelect |FunctionSelect |IndustrySelect | - | | className | 自定义筛选条件样式 | string | - | | api | 筛选条件需要远程获取数据时的接口 | string | - |
- 其他所需参数和对应type的组件参数一致
FixedView 浮动层
属性
| 属性名 | 说明 | 类型 | 默认值 | |----------------|------------|-----------|-------| | noPadding | 不要内间距 | boolean | false | | hasSafeArea | 是否需要底部安全距离 | boolean | true | | fixed | 是否固定在底部 | boolean | true | | fixBottomExtra | 固定在底部的额外显示 | ReactNode | - | | className | 自定义类名 | string | - |
FormInfo
@kne/react-form-antd-taro 的再封装,实现了基本的Form样式和风格,统一和限制了调用方法,使写法更加统一规范,实现了一些复杂选择数据的Field组件
FormInfo{FormPart}
用以显示一个表单部分,可以包含对该段表单片段的说明
| 属性名 | 说明 | 类型 | 默认值 | |--------------|----------------------|---------|-------| | list | 表单组件列表,一般为一个Field的数组 | array | [] | | title | 标题,说明该部分表单的内容 | string | - | | subtitle | 子标题,辅助说明 | string | - | | isSubheading | 是否使标题显示为一个二级标题 | boolean | false |
FormInfo{List}
用以显示一个子表单,可以通过添加一条相同格式数据,一般用在类似教育经历,工作经历场景中。可以控制最大最小条数
| 属性名 | 说明 | 类型 | 默认值 | |---------------|---------------------------------------------------|-----------------|------| | list | 表单组件列表,一般为一个Field的数组 | array | [] | | name | groupName,用来将该段表单的数据放置在对应的formData中 | string | - | | title | 标题,说明该部分表单的内容 | string | - | | subtitle | 子标题,辅助说明 | string | - | | addText | 添加按钮文案 | string | 添加 | | removeText | 删除按钮文案 | string | 删除 | | minLength | 最小个数,表单初始化会至少显示minLength条,实际条数等于minLength时将隐藏删除按钮 | number | - | | maxLength | 最大个数,实际条数等于maxLength时将隐藏添加按钮 | number | - | | isUnshift | 新增时,新一条表单时添加到表单列表最前面还是最后面 | boolean | true | | defaultLength | 初始化需要显示几段表单列表 | number | - | | itemTitle | 表单列表的二级title生成规则 | function,string | - |
FormInfo{usePopupForm}
可以弹出一个Form页面来填写信息,hooks返回一个function,调用后即可弹出页面
const popupForm = usePopupForm();
const { close } = popupForm({
title, formProps, children
});
| 属性名 | 说明 | 类型 | 默认值 | |-----------|--------------------------------------------------|--------|-----| | title | 表单弹出页面的标题 | string | - | | formProps | 传给Form的参数 | object | {} | | children | 放置在Form中的children,一般为FormPart或者FormList | jsx | - | | footer | Form的提交和取消按钮,已经默认预置号,通常不需要额外传值,除非业务上需要额外的一些设计和功能 | jsx | - |
FormInfo{fields}
表单的Field组件集合
此处将所有Field的共同参数作出说明,后面的具体Field将不包含这些共同部分
| 属性名 | 说明 | 类型 | 默认值 | |-------------|---------------------------------------------------|-----------------|-------| | name | 表单字段的名称,将作为formData的属性的一部分 | string | - | | label | 表单字段的显示文案,用以向用户说明字段的作用 | string | - | | rule | 表单字段的校验规则,以空格分开,在表单字段触发校验时串行执行校验规则,全部通过时允许提交 | string | - | | labelTips | 字段提示说明,用来向用户补充说明字段的一些注意事项 | string,function | - | | labelHidden | 是否隐藏label显示 | boolean | false | | labelRender | 一般情况label为string,当需要展示一个react组件时需要再传入该参数用以修饰label | function | - |
Field.Item
当Field需要放在FormPart或者List中,需要以此方法形式调用(目前的UI规范规定必须以此种方式调用Field,不推荐直接调用Field)如
<AdvancedSelect.Item name="name" label="label" rule="rule" />
FormInfo{fields:{AdvancedSelect}}
高级列表选择器
FormInfo{fields:{AutoComplete}}
自动完成选择器
FormInfo{fields:{Avatar}}
头像或图片上传
FormInfo{fields:{Calendar}}
复杂日期选择器
FormInfo{fields:{CardType}}
证件类型选择和证件号码输入
FormInfo{fields:{CitySelect}}
城市选择
FormInfo{fields:{FunctionSelect}}
职能选择
FormInfo{fields:{IndustrySelect}}
行业选择
FormInfo{fields:{InputNumber}}
数字输入
FormInfo{fields:{InputNumberUnit}}
带单位数字输入
FormInfo{fields:{PhoneNumber}}
手机号输入
FormInfo{fields:{SalaryInput}}
薪资输入
FormInfo{fields:{TextArea}}
多行文本
FormInfo{fields:{Upload}}
文件上传
FormInfo{fields:{UserListSelect}}
用户选择
HeaderContainer 导航头
属性
| 属性名 | 说明 | 类型 | 默认值 | |----------------|-------------------------|--------------------------|-----| | bgColor | 背景色 | string | - | | extra | 额外展示的内容 | ReactNode | - | | onHeightChange | 当HeaderContainer高度改变时触发 | (height: number) => void | - |
HighLight 文字高亮
属性
| 属性名 | 说明 | 类型 | 默认值 | |-----------|------------|--------|------| | text | 高亮区域内所有的内容 | string | - | | tagName | 高亮关键字包裹Tag | string | Text | | className | 自定义类名 | string | - |
HighLightProvider
属性
| 属性名 | 说明 | 类型 | 默认值 | |--------------------|----------|---------|------| | keyword | 需要高亮度关键字 | string | - | | caseSensitive | 区分大小写 | boolean | true | | highlightClassName | 自定义类名 | string | - |
InfoPage 显示复杂数据
属性
| 属性名 | 说明 | 类型 | 默认值 | |-----------|-------|--------|-----| | className | 自定义类名 | string | - |
InfoPage.Part 带标题内容
放置于InfoPage内部显示,如果InfoPage.Part内部再放置InfoPage.Part显示为二级标题,再放置一层则不显示标题
| 属性名 | 说明 | 类型 | 默认值 | |-------|----------------|--------|-----| | title | 标题 | string | - | | extra | 额外操作,显示于标题行最右侧 | jsx | - |
InfoPage.Collapse 折叠面板
放置于InfoPage内部显示
| 属性名 | 说明 | 类型 | 默认值 | |------------------|----------------------|------------------------|-----| | title | 标题 | string | - | | activeKey | 打开的折叠面板key | array,any | [] | | defaultActiveKey | 打开的折叠面板key,在需要非受控时使用 | array,any | - | | onChange | 折叠面板展开或收起时触发事件 | function | - | | items | 折叠面板内容列表 | InfoPageCollapseItem[] | [] |
InfoPageCollapseItem
| 属性名 | 说明 | 类型 | 默认值 | |----------|-----------------------|---------------------|-----| | key | 折叠面板key | string | - | | title | 标题 | ReactNode | string | - | | children | 放置在Collapse中的children | ReactNode | string | - |
Layout 布局
属性
| 属性名 | 说明 | 类型 | 默认值 | |-------------|----------|-------------------|------| | header | 页面导航头 | LayoutHeaderProps | - | | toolBar | 底部工具栏 | ReactNode | - | | toolBarList | 标题 | TabBarItem[] | - | | hasSafeArea | 是否显示安全区域 | boolean | true |
LayoutHeaderProps
| 属性名 | 说明 | 类型 | 默认值 | |-----------|------------------------------|------------------------------|-----| | title | 导航头部内容 | string | ReactNode | - | | bgColor | 同 HeaderContainer 中的 bgColor | string | - | | extra | 同 HeaderContainer 中的 extra | ReactNode | - | | backArrow | 返回按钮 | ReactNode | - | | onBack | 返回事件 | (router: RouterInfo) => void | - | | className | 自定义类名 | string | - |
TabBarItem
同 @kne/antd-taro 中的 TabBar 参数。