@byteluck-fe/model-driven-controls 7.0.0-props.6 → 7.0.0-props.61

package/dist/types/formControls/VueFormItem/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_vue_form_item
+ * description: 自定义表单项容器组件，用于承载 Vue 扩展控件的属性配置。适合低代码表单扩展场景，支持控件导出名、权限配置、默认值和行内编辑设置。
+ */
 import { BaseControlProperty, BaseControlPropertyInterface, BaseControlPropertyRules, BaseControlPropertyRuntimeRules, CustomPermissionItem } from '@byteluck-fe/model-driven-core';
 declare class VueFormItemPropertyRules extends BaseControlPropertyRules {
     constructor(props: VueFormItemProperty);
@@ -6,9 +10,29 @@ declare class VueFormItemPropertyRuntimeRules extends BaseControlPropertyRuntime
     constructor(props: VueFormItemProperty);
 }
 interface VueFormItemPropertyInterface extends BaseControlPropertyInterface {
+    /**
+     * 控件导出名称
+     * @defaultValue ''
+     * @public
+     */
     controlExportName: string;
+    /**
+     * 权限配置
+     * @defaultValue []
+     * @public
+     */
     permissions: CustomPermissionItem[];
+    /**
+     * 默认值
+     * @defaultValue undefined
+     * @public
+     */
     defaultValue: any;
+    /**
+     * 是否行内编辑
+     * @defaultValue false
+     * @public
+     */
     isInlineEdit: boolean;
 }
 declare class VueFormItemProperty extends BaseControlProperty implements VueFormItemPropertyInterface {

package/dist/types/formControls/VuePage/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_vue_page
+ * description: 自定义页面控件容器，用于承载 Vue 页面级扩展控件。适合页面级低代码扩展场景，支持控件导出名、权限配置、默认值和行内编辑设置。
+ */
 import { BaseControlProperty, BaseControlPropertyInterface, BaseControlPropertyRules, BaseControlPropertyRuntimeRules, CustomPermissionItem } from '@byteluck-fe/model-driven-core';
 declare class VuePagePropertyRules extends BaseControlPropertyRules {
     constructor(props: VuePageProperty);
@@ -6,9 +10,29 @@ declare class VuePagePropertyRuntimeRules extends BaseControlPropertyRuntimeRule
     constructor(props: VuePageProperty);
 }
 interface VuePagePropertyInterface extends BaseControlPropertyInterface {
+    /**
+     * 控件导出名称
+     * @defaultValue ''
+     * @public
+     */
     controlExportName: string;
+    /**
+     * 权限配置
+     * @defaultValue []
+     * @public
+     */
     permissions: CustomPermissionItem[];
+    /**
+     * 默认值
+     * @defaultValue undefined
+     * @public
+     */
     defaultValue: any;
+    /**
+     * 是否行内编辑
+     * @defaultValue false
+     * @public
+     */
     isInlineEdit: boolean;
 }
 declare class VuePageProperty extends BaseControlProperty implements VuePagePropertyInterface {

package/dist/types/formControls/WPS/property.d.ts

@@ -12,17 +12,77 @@ declare class WPSPropertyRuntimeRules extends BaseControlPropertyRuntimeRules {
     constructor(props: WPSProperty);
 }
 interface WPSPropertyInterface extends BaseControlPropertyInterface {
+    /**
+     * 内容
+     * @defaultValue '新建文档'
+     * @public
+     */
     content: string;
+    /**
+     * 是否允许新增
+     * @defaultValue true
+     * @public
+     */
     canAdd: boolean;
+    /**
+     * 允许上传本地文件
+     * @defaultValue true
+     * @public
+     */
     addLocal: boolean;
+    /**
+     * 允许新建在线文档
+     * @defaultValue true
+     * @public
+     */
     addOnline: boolean;
+    /**
+     * 是否允许下载
+     * @defaultValue true
+     * @public
+     */
     canDownload: boolean;
+    /**
+     * 是否允许编辑
+     * @defaultValue true
+     * @public
+     */
     canEdit: boolean;
+    /**
+     * 是否允许导出
+     * @defaultValue true
+     * @public
+     */
     canExport: boolean;
+    /**
+     * 是否允许删除
+     * @defaultValue false
+     * @public
+     */
     canDelete: boolean;
+    /**
+     * WPS 配置
+     * @defaultValue new WPSSetting()
+     * @public
+     */
     wpsSetting: WPSSetting;
+    /**
+     * 最大文件大小
+     * @defaultValue 10485760
+     * @public
+     */
     maxSize: AttachmentProperty['maxSize'];
+    /**
+     * 默认值
+     * @defaultValue []
+     * @public
+     */
     defaultValue: AttachmentProperty['defaultValue'];
+    /**
+     * 是否开启修订模式
+     * @defaultValue false
+     * @public
+     */
     revisionsMode: boolean;
 }
 declare class WPSProperty extends BaseControlProperty implements WPSPropertyInterface {

package/dist/types/formControls/index.d.ts

@@ -4,10 +4,22 @@ export { default as Checkbox } from './Checkbox';
 export type { CheckboxPropertyInterface } from './Checkbox';
 export { default as Cascader } from './Cascader';
 export type { CascaderPropertyInterface } from './Cascader';
+export { default as Counter } from './Counter';
+export type { CounterPropertyInterface } from './Counter';
 export { default as Radio } from './Radio';
 export type { RadioPropertyInterface } from './Radio';
 export { default as Number } from './Number';
 export type { NumberPropertyInterface } from './Number';
+export { default as Slider } from './Slider';
+export type { SliderPropertyInterface } from './Slider';
+export { default as Switch } from './Switch';
+export type { SwitchPropertyInterface } from './Switch';
+export { default as Tag } from './Tag';
+export type { TagPropertyInterface } from './Tag';
+export { default as Barcode } from './Barcode';
+export type { BarcodePropertyInterface } from './Barcode';
+export { default as QrCode } from './QrCode';
+export type { QrCodePropertyInterface } from './QrCode';
 export { default as DatePicker } from './DatePicker';
 export type { DatePickerPropertyInterface } from './DatePicker';
 export { default as DateRange } from './DateRange';

package/dist/types/framework.d.ts

@@ -1,27 +1,66 @@
 import { FieldFilterCondition, FieldFilterConditions, RightVariable, DataSourceOrderItem } from '@byteluck-fe/model-driven-core';
 export declare enum TitleConfigEnum {
+    /**
+     * 显示业务标题
+     */
     ShowBizKey = "is_show_biz_key",
+    /**
+     * 显示提交人
+     */
     ShowSubmitUser = "is_show_submit_user",
+    /**
+     * 显示提交时间
+     */
     ShowSubmitTime = "is_show_submit_time",
+    /**
+     * 显示提交部门
+     */
     ShowSubmitDept = "is_show_submit_dept",
+    /**
+     * 显示当前审批人
+     */
     ShowCurrentApprovar = "is_show_current_approvar",
+    /**
+     * 显示标题
+     */
     ShowTitle = "is_show_title"
 }
 /**
  * 时间范围类型
  */
 export declare enum DATE_CONFIG_TYPE {
+    /**
+     * 最早日期
+     */
     EARLY_DATE = "earlyDate",
+    /**
+     * 最晚日期
+     */
     LATE_DATE = "lateDate",
+    /**
+     * 不可选区间
+     */
     UN_SELECT_ABLE_INTERVAL = "unSelectAbleInterval"
 }
 /**
  * 时间限制类型
  */
 export declare enum DATE_LIMIT_TYPE {
+    /**
+     * 填写时间
+     */
     FILE_IN_TIME = "filledInTime",
+    /**
+     * 填写时间前
+     */
     BEFORE_TIME = "beforeTime",
+    /**
+     * 填写时间后
+     */
     AFTER_TIME = "afterTime",
+    /**
+     * 指定日期
+     */
     TIME_SPECIFIED = "timeSpecified"
 }
 /**
@@ -46,11 +85,29 @@ export declare class LimitTime {
     constructor(props?: LimitTime);
 }
 export declare enum SCORE_TYPE {
+    /**
+     * 点赞
+     */
     PRAISE = "praise",
+    /**
+     * 星星
+     */
     STAR = "star",
+    /**
+     * 花朵
+     */
     FLOWER = "flower",
+    /**
+     * 手势
+     */
     HAND = "hand",
+    /**
+     * 爱心
+     */
     HEART = "heart",
+    /**
+     * 笑脸
+     */
     SMILE = "smile"
 }
 export declare class Explain {
@@ -60,13 +117,49 @@ export declare class Explain {
     constructor(props?: Explain);
 }
 export declare enum LINE_STYLE {
+    /**
+     * 实线
+     */
     SOLID = "solid-line",
+    /**
+     * 虚线
+     */
     DASHED = "dashed-line",
+    /**
+     * 粗实线
+     */
     BOLD_SOLID = "bold-solid-line",
+    /**
+     * 粗虚线
+     */
     BOLD_DASHED = "bold-dashed-line",
+    /**
+     * 双实线
+     */
     DOUBLE_SOLID = "double-solid-line",
+    /**
+     * 双虚线
+     */
     DOUBLE_DASHED = "double-dashed-line"
 }
+export declare enum FONT_WEIGHT {
+    /**
+     * 常规
+     */
+    NORMAL = "normal",
+    /**
+     * 粗体
+     */
+    BOLD = "bold",
+    /**
+     * 更细
+     */
+    LIGHTER = "lighter",
+    /**
+     * 更粗
+     */
+    BOLDER = "bolder"
+}
 export declare class UndersignedPerson {
     /**
      * 签署人类型
@@ -235,46 +328,97 @@ export declare class FlexStyleConfig {
  * 加密类型
  */
 export declare enum EncryptTypeEnum {
+    /**
+     * 显示明文
+     */
     NO_MASK = "NO_MASK",
+    /**
+     * 后四位字符掩码
+     */
     LAST_FOUR_MASK = "LAST_FOUR_MASK",
+    /**
+     * 掩码显示全部字符
+     */
     ALL_MASK = "ALL_MASK"
 }
 /**
  * 新人员 内部组织 or 外部组织
  */
 export declare enum OrganizeType {
+    /**
+     * 全部
+     */
     ALL = "ALL",
+    /**
+     * 内部组织
+     */
     INTERNAL = "INTERNAL",
+    /**
+     * 外部组织
+     */
     EXTERNAL = "EXTERNAL",
+    /**
+     * 内外部组织
+     */
     INTERNAL_EXTERNAL = "INTERNAL_EXTERNAL"
 }
 /**
  * 新部门 行政 or 业务
  */
 export declare enum DepartmentType {
+    /**
+     * 行政和业务
+     */
     INTERNAL_BUSINESS = "INTERNAL_BUSINESS",
+    /**
+     * 行政
+     */
     INTERNAL = "INTERNAL",
+    /**
+     * 业务
+     */
     BUSINESS = "BUSINESS"
 }
 /**
  *  指定或者全部
  */
 export declare enum AssignType {
+    /**
+     * 全部
+     */
     ALL = "all",
+    /**
+     * 指定
+     */
     ASSIGN = "assign"
 }
 /**
  *  内部组织类型
  */
 export declare enum InternalType {
+    /**
+     * 全部
+     */
     ALL = "all",
+    /**
+     * 仅行政
+     */
     ADMIN = "admin"
 }
 /**
  * 图片压缩类型
  */
 export declare enum ImageCompressType {
+    /**
+     * 不压缩
+     */
     NO_COMPRESS = "0",
+    /**
+     * 比例压缩
+     */
     RATIO_COMPRESS = "1",
+    /**
+     * 像素压缩
+     */
     PIXEL_COMPRESS = "2"
 }

package/dist/types/layoutControls/ActionBar/property.d.ts

@@ -1,7 +1,26 @@
+/**
+ * name: rok_action_bar
+ * description: 页面操作栏容器组件。用于在表单或页面顶部、底部承载保存、提交等操作按钮。支持顶部/底部及固定定位、左右中对齐和背景透明展示。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface ActionBarPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 位置；取值：top：顶部；bottom：底部；top-fixed：固定在顶部；bottom-fixed：固定在底部；
+     * @defaultValue 'bottom'
+     * @public
+     */
     position: 'top' | 'bottom' | 'top-fixed' | 'bottom-fixed';
+    /**
+     * 背景透明
+     * @defaultValue true
+     * @public
+     */
     opacity: boolean;
+    /**
+     * 对齐方式；取值：left：左侧；middle：中间；right：右侧；
+     * @defaultValue 'right'
+     * @public
+     */
     align: 'left' | 'middle' | 'right';
 }
 declare class ActionBarControlProperty extends LayoutControlProperty implements ActionBarPropertyInterface {

package/dist/types/layoutControls/AdvancedContainer/property.d.ts

@@ -1,7 +1,21 @@
+/**
+ * name: rok_advanced_container
+ * description: 高级容器布局组件。用于搭建自定义区块、复杂内容编排和弹性布局场景。支持多种 display 模式切换，并可配置 Flex 布局能力。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 import { FlexStyleConfig } from '../../framework';
 interface AdvancedContainerPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 显示类型；取值：block：块级；inline-block：行内块；inline：行内；flex：弹性；inline-flex：行内弹性；grid：网格；inline-grid：行内网格；
+     * @defaultValue 'flex'
+     * @public
+     */
     display: 'block' | 'inline-block' | 'inline' | 'flex' | 'inline-flex' | 'grid' | 'inline-grid';
+    /**
+     * Flex 布局配置
+     * @defaultValue new FlexStyleConfig()
+     * @public
+     */
     flexConfig: FlexStyleConfig;
 }
 declare class AdvancedContainerProperty extends LayoutControlProperty implements AdvancedContainerPropertyInterface {

package/dist/types/layoutControls/CardGroup/property.d.ts

@@ -1,49 +1,71 @@
+/**
+ * name: rok_card_group
+ * description: 卡片分组容器组件。用于将表单内容按业务主题分区展示。支持标题与描述、展开收起、标签样式、边框分割线和阴影等卡片化展示能力。
+ */
 import { RuleItem } from 'async-validator';
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 declare class CardGroupControlPropertyRules extends LayoutControlProperty.Rules {
     caption: RuleItem;
 }
 interface CardGroupPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 标题信息
+     * @defaultValue '分组'
+     * @public
+     */
     caption: string;
+    /**
+     * 隐藏标题
+     * @defaultValue false
+     * @public
+     */
     isHideCaption: boolean;
     /**
      * 卡片分组是否支持展开收起；可选项： none 不支持 | open 默认展开 | close 默认关闭
-     * @defaultValue none
+     * @defaultValue 'none'
+     * @public
      */
     collapse: 'none' | 'open' | 'close';
     /**
      * 展示风格；default：默认；card：卡片；
-     * @defaultValue default
+     * @defaultValue 'default'
+     * @public
      */
     type: 'default' | 'card';
     /**
      * 描述信息
-     * @defaultValue
+     * @defaultValue ''
+     * @public
      */
     describe: string;
     /**
      * 标签位置；left：左对齐；center：居中；right：右对齐；
-     * @defaultValue left
+     * @defaultValue 'left'
+     * @public
      */
     position: 'left' | 'center' | 'right';
     /**
      * 标签类型；default：默认；warning：警告；success：成功；
-     * @defaultValue default
+     * @defaultValue 'default'
+     * @public
      */
     captionType: 'default' | 'warning' | 'success';
     /**
      * 边框类型；none：无边框；dotted：虚线；solid：实线
-     * @defaultValue none
+     * @defaultValue 'none'
+     * @public
      */
     borderType: 'none' | 'dotted' | 'solid';
     /**
      * 分割线；none：无分割线；dotted：虚线；solid：实线
-     * @defaultValue solid
+     * @defaultValue 'solid'
+     * @public
      */
     divider: 'none' | 'dotted' | 'solid';
     /**
      * 显示阴影时机；never：从不显示；always：总是显示；hover：鼠标悬浮时显示;
-     * @defaultValue never
+     * @defaultValue 'never'
+     * @public
      */
     triggerShadow: 'never' | 'hover' | 'always';
 }

package/dist/types/layoutControls/Col/property.d.ts

@@ -1,7 +1,26 @@
+/**
+ * name: rok_col
+ * description: 栅格列布局组件。用于在行容器中按列宽分配摆放控件。支持列跨度、偏移量以及是否不占满容器的布局控制。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface ColPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 占用列数
+     * @defaultValue 24
+     * @public
+     */
     span: number;
+    /**
+     * 偏移量
+     * @defaultValue 0
+     * @public
+     */
     offset: number;
+    /**
+     * 是否不占满容器
+     * @defaultValue false
+     * @public
+     */
     isNoFull: boolean;
 }
 declare class ColControlProperty extends LayoutControlProperty implements ColPropertyInterface {

package/dist/types/layoutControls/Collapse/property.d.ts

@@ -1,31 +1,32 @@
+/**
+ * name: rok_collapse
+ * description: 折叠面板容器组件。用于将内容分组折叠展示，适合信息分段收纳和按需展开查看。支持手风琴模式、边框、标题高亮条和幽灵样式。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface CollapsePropertyInterface extends LayoutControlPropertyInterface {
     /**
      * 手风琴模式，始终只有一个面板处在激活状态
      * @defaultValue false
+     * @public
      */
     accordion: boolean;
     /**
      * 带边框风格的折叠面板
      * @defaultValue true
+     * @public
      */
     bordered: boolean;
     /**
      * 是否在标题左侧显示高亮条
      * @defaultValue false
+     * @public
      */
     isShowHighlightBar: boolean;
-    /**
-     * 幽灵折叠面板，使折叠面板透明且无边框
-     * @defaultValue false
-     */
-    ghost: boolean;
 }
 declare class CollapseControlProperty extends LayoutControlProperty implements CollapsePropertyInterface {
     accordion: boolean;
     bordered: boolean;
     isShowHighlightBar: boolean;
-    ghost: boolean;
     constructor(props?: Partial<CollapseControlProperty>);
 }
 export default CollapseControlProperty;

package/dist/types/layoutControls/CollapsePane/property.d.ts

@@ -1,8 +1,13 @@
+/**
+ * name: rok_collapse_pane
+ * description: 折叠面板子项组件。用于在折叠容器中承载单个可展开区块内容。支持配置面板头标题，适合分组信息按需展开查看。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface CollapsePanePropertyInterface extends LayoutControlPropertyInterface {
     /**
      * 面板头内容
-     * @defaultValue 分组
+     * @defaultValue getLocaleText('CMD.08411774579056771')
+     * @public
      */
     header: string;
 }

package/dist/types/layoutControls/DataView/property.d.ts

@@ -7,10 +7,35 @@ declare class DataViewControlPropertyRuntimeRules extends PropertyRuntimeRules {
  * @public
  */
 interface DataViewPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 保存按钮
+     * @defaultValue new OperationItem({ content: '保存', type: 'save', isShow: false })
+     * @public
+     */
     save: OperationItem;
+    /**
+     * 取消按钮
+     * @defaultValue new OperationItem({ content: '取消', type: 'cancel', isShow: false })
+     * @public
+     */
     cancel: OperationItem;
+    /**
+     * 另存为按钮
+     * @defaultValue new OperationItem({ content: '保存草稿', type: 'saveAs', isShow: false })
+     * @public
+     */
     saveAs: OperationItem;
+    /**
+     * 打印按钮
+     * @defaultValue new OperationItem({ content: '打印', type: 'print', isShow: false })
+     * @public
+     */
     print: OperationItem;
+    /**
+     * 自定义操作项
+     * @defaultValue []
+     * @public
+     */
     custom: OperationItem[];
     /**
      * 加载中
@@ -20,6 +45,7 @@ interface DataViewPropertyInterface extends LayoutControlPropertyInterface {
     isLoading: boolean;
     /**
      * 绑定业务模型
+     * @defaultValue new DataSourceBind()
      * @public
      */
     datasourceBind: DataSourceBind;
@@ -45,6 +71,11 @@ declare class DataViewControlProperty extends LayoutControlProperty implements D
      * @public
      */
     datasourceBind: DataSourceBind;
+    /**
+     * 流程表单只读控件展现形式；disabled：禁用模式；text：文本模式；
+     * @defaultValue disabled
+     */
+    processFormReadonlyControlMode: 'disabled' | 'text';
     constructor(props?: Partial<DataViewControlProperty>);
 }
 export default DataViewControlProperty;

package/dist/types/layoutControls/Grid/property.d.ts

@@ -1,3 +1,7 @@
+/**
+ * name: rok_grid
+ * description: 网格布局容器组件。用于承载网格化排版内容和规则化布局区域。当前继承基础布局属性，适合配合网格行列子组件构建页面结构。
+ */
 import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
 interface GridPropertyInterface extends LayoutControlPropertyInterface {
 }