0.2.0 • Published 4 months ago

@hzab/schema-descriptions v0.2.0

Weekly downloads
-
License
ISC
Repository
-
Last release
4 months ago

@hzab/schema-descriptions

通过 schema 生成的描述列表组件

组件

示例

import SchemaDes from "@hzab/schema-descriptions";

// testSchema 为 formily 生成的 schema json
<SchemaDes schema={testSchema} data={data} />;

API

InfoPanel Attributes

参数类型必填默认值说明
schemaObject-数据信息的 schema
dataObject-展示的数据
borderedBooleantrue控制是否显示边框
layoutstring布局:horizontal / vertical
columnnumber2一行的 DescriptionItems 数量,可以写成像素值或支持响应式的对象写法 { xs: 8, sm: 16, md: 24}
desConfObject2antd descriptions 的默认配置项
SlotsObject-数据展示的插槽
LabelSlotsObject-label 的插槽

Slots

  • 使用插槽进行内容的自定义渲染
  • props:
    • value 处理过后的数据
    • dataVal data 中的实际数据
    • item 当前表单项配置数据
import SchemaDes from "@hzab/schema-descriptions";

// testSchema 中存在 name 为 userName 的字段
<SchemaDes
  schema={testSchema}
  data={data}
  Slots={{
    userName(props) {
      console.log("Slots props", props);
      return "Slots-" + props.value + props.dataVal;
    },
  }}
  LabelSlots={{
    userName(props) {
      console.log("Label props", props);
      return "Label-Slots-" + props.label;
    },
  }}
/>;

组件开发流程

  • 在 config/webpack.config.js 中按需修改 alias 配置的包名,便于本地调试
  • 在 src/typings.d.ts 中按需修改 declare module 配置的包名,解决 ts 报错问题
  • npm run dev

命令

  • 本地运行:npm run dev
  • 测试环境打包编译:npm run build-flow-dev
  • 生产环境打包编译:npm run build

发布

  • 命令:npm publish --access public

  • 发布目录:

    • lib

配置

配置文件

  • 本地配置文件:config/global-config/config.local.js
  • 测试环境配置文件:config/global-config/config.flowDev.js
  • 生产环境配置文件:config/global-config/config.production.js

webpack 配置文件

  • config/webpack.config.js
0.2.0

4 months ago

0.1.0

6 months ago

0.0.9

10 months ago

0.0.8

10 months ago

0.0.7

12 months ago

0.0.6

12 months ago

0.0.5

12 months ago

0.0.4

12 months ago

0.0.3

1 year ago

0.0.2

1 year ago

0.0.1

1 year ago