@byteluck-fe/model-driven-controls 7.0.0-1-beta9 → 7.0.0-beta.10

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

@@ -1,66 +1,156 @@
-import { LayoutControlProperty, StepButtons } from '@byteluck-fe/model-driven-core';
-declare class StepControlProperty extends LayoutControlProperty {
+/**
+ * name: rok_step
+ * description: 步骤条容器组件。用于分步骤表单、流程导航和向导式填写场景。支持方向、标签位置、尺寸、导航样式、粘性展示、步骤状态以及前后切换按钮配置。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface, StepButtons } from '@byteluck-fe/model-driven-core';
+interface StepPropertyInterface extends LayoutControlPropertyInterface {
     /**
      * 步骤条方向；horizontal：水平方向；vertical：垂直方向
-     * @defaultValue horizontal
+     * @defaultValue 'horizontal'
+     * @public
      */
     direction: 'horizontal' | 'vertical';
     /**
      * 标签放置位置；horizontal：水平方向；vertical：竖直方向
-     * @defaultValue horizontal
+     * @defaultValue 'horizontal'
+     * @public
      */
     labelPlacement: 'horizontal' | 'vertical';
     /**
-     * 大小；small：迷你； default：普通；
-     * @defaultValue default
+     * 大小；取值：small：小尺寸；default：默认尺寸；large：大尺寸；
+     * @defaultValue 'default'
+     * @public
      */
     size: 'small' | 'default' | 'large';
     /**
      * 步骤条类型；default：默认； navigation：导航
-     * @defaultValue default
+     * @defaultValue 'default'
+     * @public
      */
     type: 'default' | 'navigation';
     /**
      * 是否粘性
      * @defaultValue false
+     * @public
      */
     isSticky: boolean;
     /**
      * 步骤条间距，可输入%或px
-     * @defaultValue
+     * @defaultValue ''
+     * @public
      */
     step: string;
     /**
      * 是否居中对齐
      * @defaultValue false
+     * @public
      */
     isCenter: boolean;
     /**
      * 是否允许结束步骤点击
      * @defaultValue false
+     * @public
      */
     isStopStepClick: boolean;
     /**
      * 当前步骤的状态，wait：等待； process：进行中； finish：完成； error：错误；
-     * @defaultValue process
+     * @defaultValue 'process'
+     * @public
      */
     status: 'wait' | 'process' | 'finish' | 'error';
     /**
      * 结束步骤的状态，wait：等待； process：进行中； finish：完成； error：错误；
-     * @defaultValue finish
+     * @defaultValue 'finish'
+     * @public
      */
     stopStatus: 'wait' | 'process' | 'finish' | 'error';
     /**
      * 是否显示步骤条按钮
      * @defaultValue false
+     * @public
      */
     isShowStepButton: boolean;
     /**
      * 步骤条按钮配置
-     * @defaultValue {prev: {icon: 'iconleft', label: '上一步'}, next: {icon: 'iconxiangyou', label: '下一步'}, }
+     * @defaultValue new StepButtons()
+     * @public
+     */
+    stepButtons: StepButtons;
+}
+declare class StepControlProperty extends LayoutControlProperty implements StepPropertyInterface {
+    /**
+     * 步骤条方向；horizontal：水平方向；vertical：垂直方向
+     * @defaultValue 'horizontal'
+     * @public
+     */
+    direction: 'horizontal' | 'vertical';
+    /**
+     * 标签放置位置；horizontal：水平方向；vertical：竖直方向
+     * @defaultValue 'horizontal'
+     * @public
+     */
+    labelPlacement: 'horizontal' | 'vertical';
+    /**
+     * 大小；取值：small：小尺寸；default：默认尺寸；large：大尺寸；
+     * @defaultValue 'default'
+     * @public
+     */
+    size: 'small' | 'default' | 'large';
+    /**
+     * 步骤条类型；default：默认； navigation：导航
+     * @defaultValue 'default'
+     * @public
+     */
+    type: 'default' | 'navigation';
+    /**
+     * 是否粘性
+     * @defaultValue false
+     * @public
+     */
+    isSticky: boolean;
+    /**
+     * 步骤条间距，可输入%或px
+     * @defaultValue ''
+     * @public
+     */
+    step: string;
+    /**
+     * 是否居中对齐
+     * @defaultValue false
+     * @public
+     */
+    isCenter: boolean;
+    /**
+     * 是否允许结束步骤点击
+     * @defaultValue false
+     * @public
+     */
+    isStopStepClick: boolean;
+    /**
+     * 当前步骤的状态，wait：等待； process：进行中； finish：完成； error：错误；
+     * @defaultValue 'process'
+     * @public
+     */
+    status: 'wait' | 'process' | 'finish' | 'error';
+    /**
+     * 结束步骤的状态，wait：等待； process：进行中； finish：完成； error：错误；
+     * @defaultValue 'finish'
+     * @public
+     */
+    stopStatus: 'wait' | 'process' | 'finish' | 'error';
+    /**
+     * 是否显示步骤条按钮
+     * @defaultValue false
+     * @public
+     */
+    isShowStepButton: boolean;
+    /**
+     * 步骤条按钮配置
+     * @defaultValue new StepButtons()
+     * @public
      */
     stepButtons: StepButtons;
     constructor(props?: Partial<StepControlProperty>);
 }
 export default StepControlProperty;
-export { StepControlProperty };
+export { StepControlProperty, StepPropertyInterface };

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

@@ -1,14 +1,108 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class StepPaneControlProperty extends LayoutControlProperty {
+/**
+ * name: rok_step_pane
+ * description: 步骤项组件。用于定义步骤条中的单个步骤内容与状态。支持标题、副标题、图标、颜色、状态、描述、禁用和默认选中设置。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+interface StepPanePropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 主标题
+     * @defaultValue ''
+     * @public
+     */
     title: string;
+    /**
+     * 副标题
+     * @defaultValue ''
+     * @public
+     */
     subTitle?: string;
+    /**
+     * 是否禁用点击
+     * @defaultValue false
+     * @public
+     */
     disabled: boolean;
+    /**
+     * 步骤图标
+     * @defaultValue ''
+     * @public
+     */
     icon: string;
+    /**
+     * 步骤激活颜色；取值：primary：主色；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue ''
+     * @public
+     */
     color: string;
+    /**
+     * 步骤状态；取值：wait：等待；process：进行中；finish：完成；error：错误；
+     * @defaultValue 'wait'
+     * @public
+     */
     status: 'wait' | 'process' | 'finish' | 'error';
+    /**
+     * 步骤描述
+     * @defaultValue ''
+     * @public
+     */
     description?: string;
+    /**
+     * 是否默认选中
+     * @defaultValue false
+     * @public
+     */
+    isDefault?: boolean;
+}
+declare class StepPaneControlProperty extends LayoutControlProperty implements StepPanePropertyInterface {
+    /**
+     * 主标题
+     * @defaultValue ''
+     * @public
+     */
+    title: string;
+    /**
+     * 副标题
+     * @defaultValue ''
+     * @public
+     */
+    subTitle?: string;
+    /**
+     * 是否禁用点击
+     * @defaultValue false
+     * @public
+     */
+    disabled: boolean;
+    /**
+     * 步骤图标
+     * @defaultValue ''
+     * @public
+     */
+    icon: string;
+    /**
+     * 步骤激活颜色；取值：primary：主色；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue ''
+     * @public
+     */
+    color: string;
+    /**
+     * 步骤状态；取值：wait：等待；process：进行中；finish：完成；error：错误；
+     * @defaultValue 'wait'
+     * @public
+     */
+    status: 'wait' | 'process' | 'finish' | 'error';
+    /**
+     * 步骤描述
+     * @defaultValue ''
+     * @public
+     */
+    description?: string;
+    /**
+     * 是否默认选中
+     * @defaultValue false
+     * @public
+     */
     isDefault?: boolean;
     constructor(props?: Partial<StepPaneControlProperty>);
 }
 export default StepPaneControlProperty;
-export { StepPaneControlProperty, };
+export { StepPaneControlProperty, StepPanePropertyInterface, };

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

@@ -1,39 +1,92 @@
+/**
+ * name: rok_sub_table_column
+ * description: 子表列配置组件。用于定义明细子表中每列的标题与展示行为。支持列宽配置、固定列、标题提示和标题显隐控制。
+ */
 import { RuleItem } from 'async-validator';
-import { LayoutControlProperty, PropertyRules, MetaAutoWidth } from '@byteluck-fe/model-driven-core';
+import { LayoutControlProperty, LayoutControlPropertyInterface, PropertyRules, MetaAutoWidth } from '@byteluck-fe/model-driven-core';
 declare class SubTableColumnControlPropertyRules extends PropertyRules {
     caption: RuleItem;
     width: RuleItem;
     captionTip: RuleItem;
     constructor(props: SubTableColumnControlProperty);
 }
-declare class SubTableColumnControlProperty extends LayoutControlProperty {
+interface SubTableColumnPropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 设置宽度在移动和pc - 宽度
+     * @defaultValue new MetaAutoWidth()
+     * @public
+     */
+    metaAutoWidth: MetaAutoWidth;
+    /**
+     * 列标题
+     * @defaultValue ''
+     * @public
+     */
+    caption: string;
+    /**
+     * 是否固定列
+     * @defaultValue false
+     * @public
+     */
+    fixed: boolean;
+    /**
+     * 是否开启气泡提示
+     * @defaultValue false
+     * @public
+     */
+    isShowCaptionTip: boolean;
+    /**
+     * 气泡提示语
+     * @defaultValue ''
+     * @public
+     */
+    captionTip: string;
+    /**
+     * 隐藏标题一直为false
+     * @defaultValue false
+     * @public
+     */
+    isHideCaption: boolean;
+}
+declare class SubTableColumnControlProperty extends LayoutControlProperty implements SubTableColumnPropertyInterface {
     static readonly Rules: typeof SubTableColumnControlPropertyRules;
     /**
      * 设置宽度在移动和pc - 宽度
-     * pc 电脑端   mobile -手机端
-     * */
+     * @defaultValue new MetaAutoWidth()
+     * @public
+     */
     metaAutoWidth: MetaAutoWidth;
     /**
      * 列标题
-     * */
+     * @defaultValue ''
+     * @public
+     */
     caption: string;
     /**
      * 是否固定列
-     * */
+     * @defaultValue false
+     * @public
+     */
     fixed: boolean;
     /**
      * 是否开启气泡提示
-     * */
+     * @defaultValue false
+     * @public
+     */
     isShowCaptionTip: boolean;
     /**
      * 气泡提示语
-     * */
+     * @defaultValue ''
+     * @public
+     */
     captionTip: string;
     /**
      * 隐藏标题一直为false
-     * */
+     * @defaultValue false
+     * @public
+     */
     isHideCaption: boolean;
     constructor(props?: Partial<SubTableColumnControlProperty>);
 }
 export default SubTableColumnControlProperty;
-export { SubTableColumnControlProperty, SubTableColumnControlPropertyRules };
+export { SubTableColumnControlProperty, SubTableColumnPropertyInterface, SubTableColumnControlPropertyRules };

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

@@ -1,6 +1,12 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class SubtableRowControlProperty extends LayoutControlProperty {
+/**
+ * name: rok_sub_table_row
+ * description: 子表行容器组件。用于组织明细子表中的单行布局内容。当前继承基础布局属性，适合与子表列共同构建明细结构。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+interface SubtableRowPropertyInterface extends LayoutControlPropertyInterface {
+}
+declare class SubtableRowControlProperty extends LayoutControlProperty implements SubtableRowPropertyInterface {
     constructor(props?: Partial<SubtableRowControlProperty>);
 }
 export default SubtableRowControlProperty;
-export { SubtableRowControlProperty };
+export { SubtableRowControlProperty, SubtableRowPropertyInterface };

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

@@ -1,31 +1,72 @@
-import { LayoutControlProperty } from '@byteluck-fe/model-driven-core';
-declare class TabControlProperty extends LayoutControlProperty {
+/**
+ * name: rok_tab
+ * description: 选项卡容器组件。用于将内容分为多个页签按需切换展示。支持移动端展示方式、线条/卡片风格、页签位置、标签撑开和内容延迟渲染。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface } from '@byteluck-fe/model-driven-core';
+interface TabPropertyInterface extends LayoutControlPropertyInterface {
     /**
-     * 移动端展示样式
-     * @defaultValue vertical
+     * 移动端展示样式；取值：horizontal：横向；vertical：纵向；
+     * @defaultValue 'vertical'
+     * @public
      */
     mobileShowType: 'horizontal' | 'vertical';
     /**
      * 风格类型，line：默认样式；card：选项卡样式；
-     * @defaultValue line
+     * @defaultValue 'line'
+     * @public
      */
     type: 'line' | 'card';
     /**
      * 页签位置，top：页签在上；bottom：页签在下；left：页签在左侧；right：页签在右侧；
-     * @defaultValue top
+     * @defaultValue 'top'
+     * @public
      */
     tabPosition: 'top' | 'bottom' | 'left' | 'right';
     /**
      * 页签宽度是否自动撑开
      * @defaultValue false
+     * @public
      */
     isLabelFlat: boolean;
     /**
      * 内容是否延迟渲染
      * @defaultValue false
+     * @public
+     */
+    isDelay: boolean;
+}
+declare class TabControlProperty extends LayoutControlProperty implements TabPropertyInterface {
+    /**
+     * 移动端展示样式；取值：horizontal：横向；vertical：纵向；
+     * @defaultValue 'vertical'
+     * @public
+     */
+    mobileShowType: 'horizontal' | 'vertical';
+    /**
+     * 风格类型，line：默认样式；card：选项卡样式；
+     * @defaultValue 'line'
+     * @public
+     */
+    type: 'line' | 'card';
+    /**
+     * 页签位置，top：页签在上；bottom：页签在下；left：页签在左侧；right：页签在右侧；
+     * @defaultValue 'top'
+     * @public
+     */
+    tabPosition: 'top' | 'bottom' | 'left' | 'right';
+    /**
+     * 页签宽度是否自动撑开
+     * @defaultValue false
+     * @public
+     */
+    isLabelFlat: boolean;
+    /**
+     * 内容是否延迟渲染
+     * @defaultValue false
+     * @public
      */
     isDelay: boolean;
     constructor(props?: Partial<TabControlProperty>);
 }
 export default TabControlProperty;
-export { TabControlProperty };
+export { TabControlProperty, TabPropertyInterface };

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

@@ -1,13 +1,30 @@
-import { LayoutControlProperty, PropertyRules } from '@byteluck-fe/model-driven-core';
+/**
+ * name: rok_tab_pane
+ * description: 选项卡子页签组件。用于承载单个页签对应的内容区域。支持配置页签标题，适合与选项卡容器组合实现分组切换展示。
+ */
+import { LayoutControlProperty, LayoutControlPropertyInterface, PropertyRules } from '@byteluck-fe/model-driven-core';
 import { RuleItem } from 'async-validator';
 declare class TabPaneControlPropertyRules extends PropertyRules {
     caption: RuleItem;
     constructor(props: TabPaneControlProperty);
 }
-declare class TabPaneControlProperty extends LayoutControlProperty {
+interface TabPanePropertyInterface extends LayoutControlPropertyInterface {
+    /**
+     * 标题
+     * @defaultValue 控件名称
+     * @public
+     */
+    caption: string;
+}
+declare class TabPaneControlProperty extends LayoutControlProperty implements TabPanePropertyInterface {
     static readonly Rules: typeof TabPaneControlPropertyRules;
+    /**
+     * 标题
+     * @defaultValue 控件名称
+     * @public
+     */
     caption: string;
     constructor(props?: Partial<TabPaneControlProperty>);
 }
 export default TabPaneControlProperty;
-export { TabPaneControlProperty, TabPaneControlPropertyRules };
+export { TabPaneControlProperty, TabPaneControlPropertyRules, TabPanePropertyInterface };