@byteluck-fe/model-driven-controls 7.0.0-props.8 → 7.0.0-props.80

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_score
+ * description: 评分组件，用于采集用户打分结果。适合满意度评价、服务评分等场景，支持多种评分图标、半选、评分说明、当前分数和总分配置。
+ */
 import { RuleItem } from 'async-validator';
 import { BaseControlProperty, BaseControlPropertyInterface, BaseControlPropertyRules, BaseControlPropertyRuntimeRules } from '@byteluck-fe/model-driven-core';
 import { Explain, SCORE_TYPE } from '../../framework';
@@ -10,24 +14,48 @@ declare class ScoreControlPropertyRuntimeRules extends BaseControlPropertyRuntim
     constructor(props: ScoreProperty);
 }
 interface ScorePropertyInterface extends BaseControlPropertyInterface {
+    /**
+     * 总分值
+     * @defaultValue 5
+     * @public
+     */
     totalScore: number;
+    /**
+     * 评分类型；取值：praise：点赞；star：星星；flower：花朵；hand：手势；heart：爱心；smile：笑脸；
+     * @defaultValue 'star'
+     * @public
+     */
     scoreType: SCORE_TYPE;
+    /**
+     * 是否显示评分说明
+     * @defaultValue true
+     * @public
+     */
     isShowExplain: boolean;
+    /**
+     * explain
+     * @defaultValue Array(this.totalScore)
+          .fill(undefined)
+          .map()
+     * @public
+     */
     explain: Explain[];
-    defaultValue: number;
     /**
-     * 是否支持半选
-     * @defaultValue false
+     * 默认值
+     * @defaultValue 0
+     * @public
      */
-    canHalf: boolean;
+    defaultValue: number;
     /**
-     * 分数说明文字颜色
-     * @defaultValue
+     * 分数说明文字颜色；取值：primary：主色；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue 'primary'
+     * @public
      */
-    explainColor: string;
+    explainColor: 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'blue';
     /**
      * 是否显示当前分数
      * @defaultValue false
+     * @public
      */
     isShowCurrentScore: boolean;
 }
@@ -39,8 +67,7 @@ declare class ScoreProperty extends BaseControlProperty implements ScoreProperty
     isShowExplain: boolean;
     explain: Explain[];
     defaultValue: number;
-    canHalf: boolean;
-    explainColor: string;
+    explainColor: 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'blue';
     isShowCurrentScore: boolean;
     constructor(props?: Partial<ScoreProperty>);
 }

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_search_date_range
+ * description: 搜索日期区间组件，用于在查询条件中选择开始和结束日期。适合列表筛选、报表检索等场景，支持日期类型、常用时间、范围限制和国际化配置。
+ */
 import { BaseControlProperty, BaseControlPropertyInterface, BaseControlPropertyRuntimeRules } from '@byteluck-fe/model-driven-core';
 import { DateType } from '@byteluck-fe/model-driven-shared';
 import { LimitDate } from '../../framework';
@@ -5,16 +9,71 @@ declare class SearchDateRangePropertyRuntimeRules extends BaseControlPropertyRun
     constructor(props: SearchDateRangeProperty);
 }
 interface SearchDateRangePropertyInterface extends BaseControlPropertyInterface {
+    /**
+     * 最小值
+     * @defaultValue ''
+     * @public
+     */
     rangeMin: number | '';
+    /**
+     * 最大值
+     * @defaultValue ''
+     * @public
+     */
     rangeMax: number | '';
+    /**
+     * 日期区间开始的提示文字
+     * @defaultValue '开始日期'
+     * @public
+     */
     placeholderStart: string;
+    /**
+     * 日期区结束的提示文字
+     * @defaultValue '结束日期'
+     * @public
+     */
     placeholderEnd: string;
+    /**
+     * 日期展示类型；取值：year：年；month：年月；date：年月日；datehour：年月日时；datemin：年月日时分；datetime：年月日时分秒；custom：自定义；
+     * @defaultValue 'date'
+     * @public
+     */
     dateType: DateType;
+    /**
+     * 日期格式化字符串
+     * @defaultValue ''
+     * @public
+     */
     dateFormat: string;
+    /**
+     * 常用时间配置
+     * @defaultValue []
+     * @public
+     */
     commonTimeSetting: string[];
+    /**
+     * 默认值设置方式；取值：custom：自定义；now：当前时间；
+     * @defaultValue 'custom'
+     * @public
+     */
     setValueType: 'custom' | 'now';
+    /**
+     * 默认值
+     * @defaultValue ['', '']
+     * @public
+     */
     defaultValue: string[];
+    /**
+     * 日期限制范围
+     * @defaultValue []
+     * @public
+     */
     limitDateList: Array<LimitDate>;
+    /**
+     * 是否国际化
+     * @defaultValue false
+     * @public
+     */
     isInternational: boolean;
 }
 declare class SearchDateRangeProperty extends BaseControlProperty implements SearchDateRangePropertyInterface {

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_search_input
+ * description: 搜索单行文本组件，用于列表筛选、条件查询等场景。适合输入关键字快速发起检索，继承文本输入的基础配置能力。
+ */
 import { InputProperty, InputPropertyInterface } from '../Input';
 import { BaseControlPropertyRuntimeRules } from '@byteluck-fe/model-driven-core';
 interface SearchInputPropertyInterface extends InputPropertyInterface {

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

@@ -1,12 +1,41 @@
+/**
+ * name: rok_search_number_range
+ * description: 搜索数字区间组件，用于作为查询条件输入最小值和最大值。适合报表筛选、列表检索等场景，支持区间占位提示、数值上下限和必填校验。
+ */
 import { BaseControlProperty, BaseControlPropertyInterface, BaseControlPropertyRuntimeRules } from '@byteluck-fe/model-driven-core';
 declare class SearchNumberRangePropertyRuntimeRules extends BaseControlPropertyRuntimeRules {
     constructor(props: SearchNumberRangeProperty);
 }
 interface SearchNumberRangePropertyInterface extends BaseControlPropertyInterface {
+    /**
+     * 最小值
+     * @defaultValue ''
+     * @public
+     */
     rangeMin: number | '';
+    /**
+     * 最大值
+     * @defaultValue ''
+     * @public
+     */
     rangeMax: number | '';
+    /**
+     * 数字区间开始的提示文字
+     * @defaultValue '最小值'
+     * @public
+     */
     placeholderStart: string;
+    /**
+     * 数字区结束的提示文字
+     * @defaultValue '最大值'
+     * @public
+     */
     placeholderEnd: string;
+    /**
+     * 默认值
+     * @defaultValue ['', '']
+     * @public
+     */
     defaultValue: [number | '', number | ''];
 }
 declare class SearchNumberRangeProperty extends BaseControlProperty implements SearchNumberRangePropertyInterface {

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

@@ -1,20 +1,64 @@
+/**
+ * name: rok_select
+ * description: 单选下拉组件，用于从固定选项或数据源中选择一个值。适合状态、类别、枚举字段等场景，支持自定义选项、数据源、查看详情、按钮样式和 AI 内容搜索。
+ */
 import { BaseControlProperty, BaseControlPropertyInterface, OptionAndDataSourcePropertyRules, OptionSetting, DataSourceBind, MultistageFillingItem, FormBind, RuleItem } from '@byteluck-fe/model-driven-core';
 declare class SelectControlPropertyRules extends OptionAndDataSourcePropertyRules {
     formBind: RuleItem;
     constructor(props: SelectProperty);
 }
 interface SelectPropertyInterface extends BaseControlPropertyInterface {
+    /**
+     * 选项
+     * @defaultValue [{ label: '选项一', value: '选项一' }, ...]
+     * @public
+     */
     options: Array<OptionSetting>;
+    /**
+     * 是否默认展开选项
+     * @defaultValue true
+     * @public
+     */
     defaultShowOptions: boolean;
+    /**
+     * 选项配置方式；取值：custom：自定义；datasource：数据源；
+     * @defaultValue 'custom'
+     * @public
+     */
     optionConfig: 'custom' | 'datasource';
+    /**
+     * 默认值
+     * @defaultValue ''
+     * @public
+     */
     defaultValue: string;
+    /**
+     * 数据源绑定
+     * @defaultValue new DataSourceBind()
+     * @public
+     */
     datasourceBind: DataSourceBind;
+    /**
+     * 多级填充
+     * @defaultValue []
+     * @public
+     */
     multistageFilling: MultistageFillingItem[];
+    /**
+     * 允许复制选项
+     * @defaultValue false
+     * @public
+     */
     allowCopyOptions: boolean;
+    /**
+     * 是否开启填充
+     * @defaultValue false
+     * @public
+     */
     openMultistageFilling: boolean;
     /**
      * 表单打开方式
-     * @defaultValue []
+     * @defaultValue 'window'
      * @public
      */
     viewFormModelType?: string;
@@ -26,26 +70,22 @@ interface SelectPropertyInterface extends BaseControlPropertyInterface {
     canViewForm: boolean;
     /**
      * 选择表单
-     * @defaultValue 空
+     * @defaultValue new FormBind()
      * @public
      */
     formBind?: FormBind;
     /**
-     * ai 显示内容搜索 false | true
+     * 是否开启 AI 内容搜索
      * @defaultValue false
      * @public
      */
     aiContentSearch: boolean;
     /**
      * 选项类型；default：默认；button：按钮；
-     * @defaultValue default
+     * @defaultValue 'default'
+     * @public
      */
     type: 'default' | 'button';
-    /**
-     * 是否开启设置选项自定义颜色；仅当选项设置为自定义时该设置生效；
-     * @defaultValue false
-     */
-    isUseCustomColor: boolean;
 }
 declare class SelectProperty extends BaseControlProperty implements SelectPropertyInterface {
     static readonly Rules: typeof SelectControlPropertyRules;
@@ -62,7 +102,6 @@ declare class SelectProperty extends BaseControlProperty implements SelectProper
     formBind?: FormBind;
     aiContentSearch: boolean;
     type: 'default' | 'button';
-    isUseCustomColor: boolean;
     constructor(props?: Partial<SelectProperty>);
 }
 export default SelectProperty;

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_select_multiple
+ * description: 多选下拉组件，用于从选项集合中选择多个值。适合标签分类、人员角色等场景，支持自定义选项、数据源、查看详情、按钮样式和 AI 内容搜索。
+ */
 import { BaseControlProperty, BaseControlPropertyInterface, BaseControlPropertyRuntimeRules, OptionAndDataSourcePropertyRules, OptionSetting, DataSourceBind, MultistageFillingItem, FormBind, RuleItem } from '@byteluck-fe/model-driven-core';
 declare class SelectMultipleControlPropertyRules extends OptionAndDataSourcePropertyRules {
     formBind: RuleItem;
@@ -7,16 +11,51 @@ declare class SelectMultipleControlPropertyRuntimeRules extends BaseControlPrope
     constructor(props: SelectMultipleProperty);
 }
 interface SelectMultiplePropertyInterface extends BaseControlPropertyInterface {
+    /**
+     * 选项
+     * @defaultValue [{ label: '选项一', value: '选项一' }, ...]
+     * @public
+     */
     options: Array<OptionSetting>;
+    /**
+     * 是否默认展开选项
+     * @defaultValue true
+     * @public
+     */
     defaultShowOptions: boolean;
+    /**
+     * 选项配置方式；取值：custom：自定义；datasource：数据源；
+     * @defaultValue 'custom'
+     * @public
+     */
     optionConfig: 'custom' | 'datasource';
+    /**
+     * 默认值
+     * @defaultValue []
+     * @public
+     */
     defaultValue: string[];
+    /**
+     * 数据源绑定
+     * @defaultValue new DataSourceBind()
+     * @public
+     */
     datasourceBind: DataSourceBind;
+    /**
+     * 多级填充
+     * @defaultValue []
+     * @public
+     */
     multistageFilling?: MultistageFillingItem[];
+    /**
+     * 是否开启填充
+     * @defaultValue false
+     * @public
+     */
     openMultistageFilling: boolean;
     /**
      * 表单打开方式
-     * @defaultValue []
+     * @defaultValue 'window'
      * @public
      */
     viewFormModelType?: string;
@@ -28,26 +67,22 @@ interface SelectMultiplePropertyInterface extends BaseControlPropertyInterface {
     canViewForm: boolean;
     /**
      * 选择表单
-     * @defaultValue 空
+     * @defaultValue new FormBind()
      * @public
      */
     formBind?: FormBind;
     /**
-     * ai 显示内容搜索 false | true
+     * 是否开启 AI 内容搜索
      * @defaultValue false
      * @public
      */
     aiContentSearch: boolean;
     /**
      * 选项类型；default：默认；button：按钮；
-     * @defaultValue default
+     * @defaultValue 'default'
+     * @public
      */
     type: 'default' | 'button';
-    /**
-     * 是否开启设置选项自定义颜色；仅当选项设置为自定义时该设置生效；
-     * @defaultValue false
-     */
-    isUseCustomColor: boolean;
 }
 declare class SelectMultipleProperty extends BaseControlProperty implements SelectMultiplePropertyInterface {
     static readonly Rules: typeof SelectMultipleControlPropertyRules;
@@ -64,7 +99,6 @@ declare class SelectMultipleProperty extends BaseControlProperty implements Sele
     formBind?: FormBind;
     aiContentSearch: boolean;
     type: 'default' | 'button';
-    isUseCustomColor: boolean;
     constructor(props?: Partial<SelectMultipleProperty>);
 }
 export default SelectMultipleProperty;

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

@@ -1,3 +1,7 @@
+/**
+ * name: rok_select_relation
+ * description: 关联单选组件，用于从关联列表或数据源中选择一条业务记录。适合关联客户、项目、单据等场景，支持列表绑定、详情查看、搜索、已选明细展示和数据填充。
+ */
 import { BaseControlProperty, BaseControlPropertyInterface, OptionAndDataSourcePropertyRules, OptionSetting, DataSourceBind, MultistageFillingItem, SelectedContentConfig, ListBind, FormBind, OptionDisplayConfigItem } from '@byteluck-fe/model-driven-core';
 import { RuleItem } from 'async-validator';
 declare class SelectRelationControlPropertyRules extends OptionAndDataSourcePropertyRules {
@@ -17,10 +21,10 @@ interface SelectRelationPropertyInterface extends BaseControlPropertyInterface {
      */
     options: Array<OptionSetting>;
     /**
-     * 选项配置
+     * 选项配置；取值：custom：自定义；datasource：数据源；
      * @defaultValue 'datasource'
      * @public
-     * */
+     */
     optionConfig: 'custom' | 'datasource';
     /**
      * 默认值
@@ -30,11 +34,13 @@ interface SelectRelationPropertyInterface extends BaseControlPropertyInterface {
     defaultValue: string;
     /**
      * 绑定列表页
+     * @defaultValue new ListBind()
      * @public
      */
     listPageBind: ListBind;
     /**
      * 关联数据源
+     * @defaultValue new DataSourceBind()
      * @public
      */
     datasourceBind: DataSourceBind;
@@ -46,7 +52,7 @@ interface SelectRelationPropertyInterface extends BaseControlPropertyInterface {
     multistageFilling?: MultistageFillingItem[];
     /**
      * 表单打开方式
-     * @defaultValue []
+     * @defaultValue 'window'
      * @public
      */
     viewFormModelType?: string;
@@ -58,26 +64,51 @@ interface SelectRelationPropertyInterface extends BaseControlPropertyInterface {
     canViewForm: boolean;
     /**
      * 选择表单
-     * @defaultValue 空
+     * @defaultValue new FormBind()
      * @public
      */
     formBind?: FormBind;
     /**
-     * 数据填充-查看/编辑页面生效
+     * 是否开启数据填充，仅在查看/编辑页面生效
      * @defaultValue false
      * @public
      */
     openMultistageFilling: boolean;
+    /**
+     * 展示已选明细
+     * @defaultValue false
+     * @public
+     */
     showSelectedDetail: boolean;
+    /**
+     * 展示已选内容配置字段
+     * @defaultValue new SelectedContentConfig()
+     * @public
+     */
     selectedContentConfig: SelectedContentConfig;
+    /**
+     * 选项展示配置
+     * @defaultValue []
+     * @public
+     */
     optionDisplayConfig: OptionDisplayConfigItem[];
+    /**
+     * 是否支持搜索
+     * @defaultValue false
+     * @public
+     */
     canSearch: boolean;
     /**
-     * ai 显示内容搜索 false | true
+     * 是否开启 AI 内容搜索
      * @defaultValue false
      * @public
      */
     aiContentSearch: boolean;
+    /**
+     * 默认展开选项
+     * @defaultValue false
+     * @public
+     */
     defaultShowOptions: boolean;
 }
 declare class SelectRelationProperty extends BaseControlProperty implements SelectRelationPropertyInterface {

package/dist/types/formControls/Slider/designer.d.ts

@@ -0,0 +1,15 @@
+import { DesignerFormControl, Schema, SettingOption } from '@byteluck-fe/model-driven-core';
+import { FieldTypes } from '@byteluck-fe/model-driven-shared';
+import SliderProperty from './property';
+declare class SliderControl extends DesignerFormControl {
+    static controlEventKeys: string[];
+    static get controlName(): string;
+    static get controlType(): string;
+    static get controlIcon(): string;
+    static controlFieldType: FieldTypes;
+    static readonly setting: SettingOption[];
+    readonly props: SliderProperty;
+    constructor(props?: Partial<Schema<'slider'>>);
+}
+export default SliderControl;
+export { SliderControl as DesignerSliderControl };

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

@@ -0,0 +1,12 @@
+import Designer from './designer';
+import Runtime from './runtime';
+import Property from './property';
+declare const _default: {
+    Designer: typeof Designer;
+    Runtime: typeof Runtime;
+    Property: typeof Property;
+};
+export default _default;
+export * from './designer';
+export * from './runtime';
+export * from './property';

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

@@ -0,0 +1,72 @@
+/**
+ * name: rok_slider
+ * description: 滑块组件，用于在连续范围内快速选择数值。适合进度、权重、阈值等场景，支持默认值、最小值、最大值、步长、提示标签和控制按钮配置。
+ */
+import { RuleItem } from 'async-validator';
+import { BaseControlProperty, BaseControlPropertyInterface, BaseControlPropertyRules, BaseControlPropertyRuntimeRules, OptionSetting } from '@byteluck-fe/model-driven-core';
+interface SliderPropertyInterface extends BaseControlPropertyInterface {
+    /**
+     * 默认值
+     * @defaultValue ''
+     * @public
+     */
+    defaultValue: number | '';
+    /**
+     * 最小值
+     * @defaultValue 0
+     * @public
+     */
+    min: number | '';
+    /**
+     * 最大值
+     * @defaultValue 100
+     * @public
+     */
+    max: number | '';
+    /**
+     * 步长
+     * @defaultValue 1
+     * @public
+     */
+    step: number;
+    /**
+     * 是否显示输入框
+     * @defaultValue true
+     * @public
+     */
+    showInput: boolean;
+    /**
+     * 是否展示标记
+     * @defaultValue false
+     * @public
+     */
+    showMarks?: boolean;
+    /**
+     * 标记
+     * @defaultValue []
+     * @public
+     */
+    marks?: Array<OptionSetting>;
+}
+declare class SliderPropertyRules extends BaseControlPropertyRules {
+    defaultValue: RuleItem[];
+    max: RuleItem;
+    constructor(props: SliderProperty);
+}
+declare class SliderPropertyRuntimeRules extends BaseControlPropertyRuntimeRules {
+    constructor(props: SliderProperty);
+}
+declare class SliderProperty extends BaseControlProperty implements SliderPropertyInterface {
+    static readonly Rules: typeof SliderPropertyRules;
+    static readonly RuntimeRules: typeof SliderPropertyRuntimeRules;
+    defaultValue: number | '';
+    min: number | '';
+    max: number | '';
+    step: number;
+    showInput: boolean;
+    showMarks: boolean;
+    marks: Array<OptionSetting>;
+    constructor(props?: Partial<SliderProperty>);
+}
+export default SliderProperty;
+export { SliderProperty, SliderPropertyInterface, SliderPropertyRules, SliderPropertyRuntimeRules, };

package/dist/types/formControls/Slider/runtime.d.ts

@@ -0,0 +1,12 @@
+import { RuntimeFormControl } from '@byteluck-fe/model-driven-core';
+import { FieldTypes } from '@byteluck-fe/model-driven-shared';
+import SliderProperty from './property';
+import { Schema } from '@byteluck-fe/model-driven-core';
+declare class SliderControl extends RuntimeFormControl {
+    static get controlType(): string;
+    static controlFieldType: FieldTypes;
+    readonly props: SliderProperty;
+    constructor(props?: Partial<Schema<'slider'>>);
+}
+export default SliderControl;
+export { SliderControl as RuntimeSliderControl };

package/dist/types/formControls/Switch/designer.d.ts

@@ -0,0 +1,15 @@
+import { DesignerFormControl, Schema, SettingOption } from '@byteluck-fe/model-driven-core';
+import { FieldTypes } from '@byteluck-fe/model-driven-shared';
+import SwitchProperty from './property';
+declare class SwitchControl extends DesignerFormControl {
+    static controlEventKeys: string[];
+    static get controlName(): string;
+    static get controlIcon(): string;
+    static get controlType(): string;
+    static controlFieldType: FieldTypes;
+    static readonly setting: SettingOption[];
+    readonly props: SwitchProperty;
+    constructor(props?: Partial<Schema<'switch'>>);
+}
+export default SwitchControl;
+export { SwitchControl as DesignerSwitchControl };

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

@@ -0,0 +1,12 @@
+import Designer from './designer';
+import Runtime from './runtime';
+import Property from './property';
+declare const _default: {
+    Designer: typeof Designer;
+    Runtime: typeof Runtime;
+    Property: typeof Property;
+};
+export default _default;
+export * from './designer';
+export * from './runtime';
+export * from './property';