@next-bricks/presentational-bricks 1.336.9 → 1.337.0

package/dist/types/brick-descriptions/index.d.ts

@@ -0,0 +1,192 @@
+import React from "react";
+import { UpdatingElement } from "@next-core/brick-kit";
+import { UseBrickConf } from "@next-core/brick-types";
+import { DescriptionsProps } from "antd/lib/descriptions";
+import { DescriptionsItemProps } from "antd/lib/descriptions/Item";
+export interface BrickDescriptionsElementProps {
+    descriptionTitle?: string;
+    descriptionList?: DescriptionListProps[];
+    itemList?: BrickDescriptionsItemProps[];
+    itemIdBrickMap?: Record<string, {
+        useBrick: UseBrickConf;
+    }>;
+    column?: number;
+    layout?: LayoutType;
+    bordered?: boolean;
+    size?: SizeType;
+    configProps?: DescriptionsProps;
+    hideGroups?: string[] | string;
+    dataSource?: Record<string, any>;
+}
+export interface BrickDescriptionsItemProps extends Partial<DescriptionsItemProps> {
+    /**
+     * 内容
+     */
+    text: string;
+    id?: string;
+    /**
+     * 所属分组
+     */
+    group?: string;
+    /**
+     * 该 item 的 text 取自 dataSource 的哪个字段
+     */
+    field?: string;
+    /**
+     * 支持为某项自定义展示构件  [#UseBrickConf](#usebrickconf)
+     */
+    useBrick?: UseBrickConf;
+    /**
+     * [已废弃]自定义该 item 的展示构件
+     */
+    component?: {
+        brick?: string;
+        properties?: any;
+    };
+}
+export interface DescriptionListProps {
+    itemList: BrickDescriptionsItemProps[];
+    descriptionTitle: string;
+    configProps?: DescriptionsProps;
+    column?: number;
+    size?: SizeType;
+    bordered?: boolean;
+    layout?: LayoutType;
+    hideGroups?: string[] | string;
+    extraBrick?: {
+        useBrick: UseBrickConf;
+    };
+}
+export declare type LayoutType = "horizontal" | "vertical";
+export declare type SizeType = "default" | "middle" | "small";
+/**
+ * @id presentational-bricks.brick-descriptions
+ * @name presentational-bricks.brick-descriptions
+ * @docKind brick
+ * @description 常用于概要信息的描述，2~3列
+ * @author lynette
+ * @slots
+ * @history
+ * 1.59.0:新增属性：`descriptionTitle`、`column`、`size`、`bordered`、`layout`
+ * @memo
+ * ### UseBrickConf
+ *
+ * | property      | type           | required | default | description                                        |
+ * | ------------- | -------------- | -------- | ------- | -------------------------------------------------- |
+ * | brick         | string         | true       | -       | 构件名称                                           |
+ * | properties    | object         | -        | -       | 构件属性                                           |
+ * | events        | BrickEventsMap | -        | -       | 事件                                               |
+ * | transform     | string\|object | -        | -       | 属性数据转换                                       |
+ * | transformFrom | string         | -        | -       | 属性数据转换来自数据源的哪个字段，不填则为整个数据 |
+ * @noInheritDoc
+ */
+export declare class BrickDescriptionsElement extends UpdatingElement implements BrickDescriptionsElementProps {
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 描述列表的标题，显示在最顶部
+     * @group basic
+     */
+    descriptionTitle: string;
+    /**
+     * @kind any[]
+     * @required false
+     * @default -
+     * @description 多个描述列表时的数据入口
+     * @group basic
+     */
+    descriptionList: DescriptionListProps[];
+    /**
+     * @kind BrickDescriptionsItemProps[]
+     * @required false
+     * @default -
+     * @description 描述列表项，扩展自 ant-design DescriptionItem 相关配置项，额外扩展项如下，其他项查阅：[DescriptionItem](https://ant.design/components/descriptions-cn/#DescriptionItem)
+     * @group basic
+     */
+    itemList: BrickDescriptionsItemProps[];
+    /**
+     * @required false
+     * @default -
+     * @description 列表项的 id 与对应构件配置的 map。一般在 itemList 属性需要动态生成，且希望自定义列的构件（itemList.useBrick）时使用。
+     * @group advanced
+     */
+    itemIdBrickMap: Record<string, {
+        useBrick: UseBrickConf;
+    }>;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 是否显示卡片
+     * @group basic
+     */
+    showCard: boolean;
+    /**
+     * @kind number|object
+     * @required false
+     * @default 3
+     * @description 一行的 DescriptionItems 数量，可以写成像素值或支持响应式的对象写法 { xs: 8, sm: 16, md: 24}
+     * @group basic
+     */
+    column: number;
+    /**
+     * @kind LayoutType
+     * @required false
+     * @default horizontal
+     * @description 描述布局
+     * @enums "horizontal"|"vertical"
+     * @group ui
+     */
+    layout: LayoutType;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否展示边框
+     * @group ui
+     */
+    bordered: boolean;
+    /**
+     * @kind SizeType
+     * @required false
+     * @default -
+     * @description 设置列表的大小。可以设置为 middle 、small, 或不填（只有设置 bordered={true} 生效）
+     * @enums "default"|"middle"|"small"
+     * @group ui
+     */
+    size: SizeType;
+    /**
+     * @kind DescriptionsProps
+     * @required false
+     * @default -
+     * @description ant-design 相关配置项,具体查阅：[Descriptions](https://ant.design/components/descriptions-cn/#Descriptions)
+     */
+    configProps: DescriptionsProps;
+    /**
+     * @kind string[] | string
+     * @required false
+     * @default -
+     * @description 设置需要隐藏的描述列表项。请先在 itemList 中定义列表项所属 group
+     */
+    hideGroups: string[] | string;
+    /**
+     * @required false
+     * @description 描述列表的操作区域构件配置，显示在右上方
+     */
+    extraBrick?: {
+        useBrick: UseBrickConf;
+    };
+    /**
+     * @kind Record<string, any>
+     * @required false
+     * @default -
+     * @deprecated
+     * @description [已废弃]数据来源，通常来源于后台
+     */
+    dataSource: Record<string, any>;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _getBrickDescriptionsNode(): React.ReactElement;
+    protected _render(): void;
+}

package/dist/types/brick-display-structs/BrickDisplayStructs.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import { FieldToDisplay } from "./index";
+interface BrickDisplayStructsProps {
+    value: any;
+    displayType: "stringify" | FieldToDisplay;
+    emptyText: string;
+}
+export declare function BrickDisplayStructs(props: BrickDisplayStructsProps): React.ReactElement;
+export {};

package/dist/types/brick-display-structs/index.d.ts

@@ -0,0 +1,66 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface BrickDisplayStructsElementProps {
+    dataSource?: Record<string, any>;
+    fields?: {
+        value: string;
+    };
+    value?: any;
+    displayType?: "stringify" | FieldToDisplay;
+}
+export interface FieldToDisplay {
+    field?: string;
+    separator: string;
+}
+/**
+ * @id presentational-bricks.brick-display-structs
+ * @name presentational-bricks.brick-display-structs
+ * @docKind brick
+ * @description 可将结构体（数组）数据以字符串的形式展示，或只展示其中的一个字段
+ * @author ice
+ * @slots
+ * @history
+ * @memo
+ * @noInheritDoc
+ */
+export declare class BrickDisplayStructsElement extends UpdatingElement implements BrickDisplayStructsElementProps {
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+    /**
+     * @kind Record<string, any>
+     * @required false
+     * @default -
+     * @description [已废弃]数据来源
+     */
+    dataSource: Record<string, any>;
+    /**
+     * @kind { value: string }
+     * @required false
+     * @default -
+     * @description 字[已废弃]段映射, 跟 dataSource 一起使用来获得运行时 value
+     */
+    fields: {
+        value: string;
+    };
+    /**
+     * @kind 结构体或数组
+     * @required false
+     * @default -
+     * @description 要展示的值
+     */
+    value: any;
+    /**
+     * @kind 'stringify' | FieldToDisplay
+     * @required true
+     * @default -
+     * @description 展示类型, 定义类型如下
+     */
+    displayType: "stringify" | FieldToDisplay;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 空文案
+     */
+    emptyText: string;
+}

package/dist/types/brick-divider/BrickDivider.d.ts

@@ -0,0 +1,12 @@
+import React from "react";
+interface BrickDividerProps {
+    type?: "horizontal" | "vertical" | "radiation";
+    dashed?: boolean;
+    dividerStyle?: React.CSSProperties;
+    dividerTitle?: string;
+    orientation?: "center" | "left" | "right";
+    plain?: boolean;
+    proportion?: number[];
+}
+export declare function BrickDivider(props: BrickDividerProps): React.ReactElement;
+export {};

package/dist/types/brick-divider/index.d.ts

@@ -0,0 +1,76 @@
+import React from "react";
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface BrickDividerElementProps {
+    dividerTitle?: string;
+    type?: "horizontal" | "vertical" | "radiation";
+    dashed?: boolean;
+    dividerStyle?: React.CSSProperties;
+    orientation?: "center" | "left" | "right";
+    plain?: boolean;
+    proportion?: number[];
+}
+/**
+ * @id presentational-bricks.brick-divider
+ * @name presentational-bricks.brick-divider
+ * @docKind brick
+ * @description 分割线
+ * @author dophi
+ * @slots
+ * @history
+ * 1.60.0:新属性 `dividerTitle` 和 `orientation`
+ * 1.204.0: 新属性 `plain` 和 `type`增加`radiation`
+ * @memo
+ * @noInheritDoc
+ */
+export declare class BrickDividerElement extends UpdatingElement implements BrickDividerElementProps {
+    /**
+     * @required false
+     * @description 标题
+     * @group basic
+     */
+    dividerTitle: string;
+    /**
+     * @required false
+     * @default "horizontal"
+     * @description 水平|垂直|放射类型,注意`radiation`是个特殊的类型，该样式是特定的
+     * @group basic
+     */
+    type: "horizontal" | "vertical" | "radiation";
+    /**
+     * @required false
+     * @default false
+     * @description 是否虚线
+     * @group basic
+     */
+    dashed: boolean;
+    /**
+     * @required false
+     * @description 分割线自定义样式
+     * @group basic
+     */
+    dividerStyle: React.CSSProperties;
+    /**
+     * @kind "center" | "left" | "right"
+     * @required false
+     * @default "center"
+     * @description 标题位置
+     * @group basic
+     */
+    orientation: "center" | "left" | "right";
+    /**
+     * @required false
+     * @default  false
+     * @description 文字是否显示为普通正文样式
+     * @group ui
+     */
+    plain: boolean;
+    /**
+     * @required  false
+     * @description  当用于数值显示的情况，eg: 如果要展示"1/3"，那么传入就是[1,3], 该字段只适配于 type 为 `radiation`
+     * @group basic
+     */
+    proportion: number[];
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/brick-form/BrickForm.d.ts

@@ -0,0 +1,73 @@
+import React from "react";
+import { WithTranslation } from "react-i18next";
+import { FormComponentProps, ValidationRule } from "@ant-design/compatible/lib/form";
+import { FormLayout } from "@ant-design/compatible/lib/form/Form";
+import { ColProps } from "antd/lib/grid";
+import { SearchInCmdb } from "./components/brick-select/BrickSelect";
+import { SwitchMap } from "./components/brick-switch/BrickSwitch";
+import { BrickOptionProps } from "./interfaces";
+import { CustomColumn } from "../brick-table/index";
+export interface FieldDefinition {
+    field: string;
+    label: string;
+    fieldPath: string;
+    component: string;
+    isRequire?: boolean;
+    valuePropName?: string;
+    properties?: any;
+    defaultValue?: boolean | string | number;
+    hideFromField?: string;
+    optionList?: string[] | BrickOptionProps[];
+    emitChangeEvent?: string;
+    emitCustomEvent?: string;
+    dataSource?: {
+        resolveName: string;
+        path?: string;
+        useIdField?: string;
+        useTextField?: string;
+    };
+    searchInCmdb?: SearchInCmdb;
+    switchMap?: SwitchMap;
+    instanceList?: {
+        query?: Record<string, any>;
+        columns: CustomColumn[];
+    };
+    computeDefaultValue?: {
+        target: string;
+        method: string;
+        args: any;
+    };
+    rules: ValidationRule & flags[];
+    configProps: Record<string, any>;
+}
+declare type flags = any;
+export interface LegacyBrickFormProps extends WithTranslation, FormComponentProps {
+    contractName?: string;
+    fields: FieldDefinition[];
+    showCancel?: boolean;
+    cancelText?: string;
+    showConfirm?: boolean;
+    confirmText?: string;
+    layout?: FormLayout;
+    labelCol?: ColProps;
+    wrapperCol?: ColProps;
+    tailFormBtnLayout?: Record<"wrapperCol", ColProps>;
+    onSubmit?(data: Record<string, any>): void;
+    onCancel?(): void;
+    onBrickFormRef: any;
+    showCard: boolean;
+    onFieldChange: (value: any, field: string) => void;
+    dispatchCustomEvent: (field: FieldDefinition, detail: any) => void;
+}
+export declare class LegacyBrickForm extends React.Component<LegacyBrickFormProps> {
+    static formItemComp: Record<string, any>;
+    constructor(props: LegacyBrickFormProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    dispatchCustomEvent(field: FieldDefinition): (query: any) => void;
+    render(): React.ReactNode;
+    handleSubmit(e: React.FormEvent): void;
+    handleFieldChange(value: any, field: string): void;
+}
+export declare const BrickForm: React.ComponentType<Omit<import("react-i18next").Subtract<import("@ant-design/compatible/lib/_util/types").Omit<LegacyBrickFormProps, "form">, import("react-i18next").WithTranslationProps>, keyof WithTranslation<N, undefined>> & import("react-i18next").WithTranslationProps>;
+export {};

package/dist/types/brick-form/components/brick-checkbox/BrickCheckbox.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+import { BrickOptionProps } from "../../interfaces";
+import { CheckboxGroupProps } from "antd/lib/checkbox";
+export interface LegacyBrickCheckboxProps {
+    configProps?: CheckboxGroupProps;
+    optionList: BrickOptionProps[];
+    onChange: Function;
+    value?: string[];
+}
+export declare function LegacyBrickCheckbox(props: LegacyBrickCheckboxProps): React.ReactElement;
+export declare const BrickCheckbox: (props: import("../wrapper-form-item/WrapperFormItem").WrapperFormItemProps) => JSX.Element;

package/dist/types/brick-form/components/brick-date-picker/BrickDatePicker.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import { DatePickerProps, MonthPickerProps, RangePickerProps, WeekPickerProps } from "antd/lib/date-picker/interface";
+export interface LegacyBrickDatePickerProps {
+    componentType?: "DatePicker" | "MonthPicker" | "RangePicker" | "WeekPicker";
+    configProps?: DatePickerProps | MonthPickerProps | RangePickerProps | WeekPickerProps;
+    onChange: Function;
+}
+export declare function LegacyBrickDatePicker({ componentType, configProps, onChange }: LegacyBrickDatePickerProps): React.ReactElement;
+export declare const BrickDatePicker: (props: import("../wrapper-form-item/WrapperFormItem").WrapperFormItemProps) => JSX.Element;

package/dist/types/brick-form/components/brick-input/BrickInput.d.ts

@@ -0,0 +1,15 @@
+import React from "react";
+import { InputProps } from "antd/lib/input";
+export declare enum LegacyBrickInputType {
+    Input = "Input",
+    Password = "Password",
+    TextArea = "TextArea"
+}
+export interface LegacyBrickInputProps {
+    configProps?: InputProps;
+    type?: LegacyBrickInputType;
+    onChange: Function;
+    value?: string;
+}
+export declare function LegacyBrickInput({ configProps, onChange, value, type }: LegacyBrickInputProps): React.ReactElement;
+export declare const BrickInput: (props: import("../wrapper-form-item/WrapperFormItem").WrapperFormItemProps) => JSX.Element;

package/dist/types/brick-form/components/brick-input-number/BrickInputNumber.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import { InputNumberProps } from "antd/lib/input-number";
+export interface LegacyBrickInputNumberProps {
+    configProps?: InputNumberProps;
+    onChange: Function;
+    value?: number;
+}
+export declare function LegacyBrickInputNumber(props: LegacyBrickInputNumberProps): React.ReactElement;
+export declare const BrickInputNumber: (props: import("../wrapper-form-item/WrapperFormItem").WrapperFormItemProps) => JSX.Element;

package/dist/types/brick-form/components/brick-instance-selector/BrickInstanceSelector.d.ts

@@ -0,0 +1,13 @@
+import React from "react";
+import { CustomColumn } from "../../../brick-table/index";
+export interface BrickInstanceSelectProps {
+    optionList: Record<string, any>[];
+    instanceList: {
+        query?: Record<string, any>;
+        columns: CustomColumn[];
+    };
+    onChange: (value: any) => void;
+    dispatchCustomEvent: (query: any) => void;
+}
+export declare function InstanceSelector(props: BrickInstanceSelectProps): React.ReactElement;
+export declare const BrickInstanceSelector: (props: import("../wrapper-form-item/WrapperFormItem").WrapperFormItemProps) => JSX.Element;

package/dist/types/brick-form/components/brick-radio/BrickRadio.d.ts

@@ -0,0 +1,12 @@
+import React from "react";
+import { RadioProps, RadioGroupProps } from "antd/lib/radio/interface";
+import { BrickOptionProps } from "../../interfaces";
+export interface LegacyBrickRadioProps {
+    componentType?: "Button" | "Radio";
+    configProps?: RadioProps | RadioGroupProps;
+    optionList?: BrickOptionProps[];
+    onChange: Function;
+    value?: string;
+}
+export declare function LegacyBrickRadio({ componentType, configProps, optionList, onChange, value }: LegacyBrickRadioProps): React.ReactElement;
+export declare const BrickRadio: (props: import("../wrapper-form-item/WrapperFormItem").WrapperFormItemProps) => JSX.Element;

package/dist/types/brick-form/components/brick-select/BrickSelect.d.ts

@@ -0,0 +1,18 @@
+import React from "react";
+import { BrickOptionProps } from "../../interfaces";
+import { SelectProps } from "antd/lib/select";
+export interface SearchInCmdb {
+    objectId: string;
+    pageSize: number;
+    attrFieldToSearch: string;
+    attrFieldToDisplay: string;
+}
+export interface LegacyBrickSelectProps {
+    configProps?: SelectProps;
+    optionList: BrickOptionProps[];
+    onChange: (value: string[]) => void;
+    value?: string | string[];
+    searchInCmdb?: SearchInCmdb;
+}
+export declare function LegacyBrickSelect({ configProps, optionList, onChange, value, searchInCmdb, }: LegacyBrickSelectProps): React.ReactElement;
+export declare const BrickSelect: (props: import("../wrapper-form-item/WrapperFormItem").WrapperFormItemProps) => JSX.Element;

package/dist/types/brick-form/components/brick-switch/BrickSwitch.d.ts

@@ -0,0 +1,14 @@
+import React from "react";
+import { SwitchProps } from "antd/lib/switch";
+export interface SwitchMap {
+    truthy: any;
+    falsy: any;
+}
+export interface LegacyBrickSwitchProps {
+    configProps?: SwitchProps;
+    onChange: Function;
+    checked?: boolean | string;
+    switchMap?: SwitchMap;
+}
+export declare function LegacyBrickSwitch({ configProps, onChange, checked, switchMap }: LegacyBrickSwitchProps): React.ReactElement;
+export declare const BrickSwitch: (props: import("../wrapper-form-item/WrapperFormItem").WrapperFormItemProps) => JSX.Element;

package/dist/types/brick-form/components/brick-time-picker/BrickTimePicker.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { TimePickerProps } from "antd/lib/time-picker";
+export interface LegacyBrickTimePickerProps {
+    configProps?: TimePickerProps;
+    onChange: Function;
+}
+export declare function LegacyBrickTimePicker({ configProps, onChange }: LegacyBrickTimePickerProps): React.ReactElement;
+export declare const BrickTimePicker: (props: import("../wrapper-form-item/WrapperFormItem").WrapperFormItemProps) => JSX.Element;

package/dist/types/brick-form/components/wrapper-form-item/WrapperFormItem.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { FormComponentProps } from "@ant-design/compatible/lib/form";
+import { FieldDefinition } from "../../BrickForm";
+import { BrickOptionProps } from "../../interfaces";
+export interface WrapperFormItemProps extends FieldDefinition, FormComponentProps {
+    allFields: FieldDefinition[];
+    optionList: string[] & BrickOptionProps[];
+    onFieldChange: (value: any, field: string) => void;
+}
+export declare function WrapperFormItem(WrapperComponent: any): (props: WrapperFormItemProps) => JSX.Element;

package/dist/types/brick-form/index.d.ts

@@ -0,0 +1,12 @@
+import { FormLayout } from "@ant-design/compatible/lib/form/Form";
+import { LegacyBrickFormProps } from "./BrickForm";
+export interface BrickFormElementProps {
+    contractName?: string;
+    fields?: LegacyBrickFormProps["fields"];
+    cancelText?: string;
+    confirmText?: string;
+    tailFormBtnLayout?: LegacyBrickFormProps["tailFormBtnLayout"];
+    layout?: FormLayout;
+    labelCol?: LegacyBrickFormProps["labelCol"];
+    wrapperCol?: LegacyBrickFormProps["wrapperCol"];
+}

package/dist/types/brick-form/interfaces/brick-component.d.ts

@@ -0,0 +1,5 @@
+export interface BrickOptionProps {
+    text: string;
+    value?: string;
+    id: string;
+}

package/dist/types/brick-form/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from "./brick-component";

package/dist/types/brick-form/processor/handleChange.d.ts

@@ -0,0 +1 @@
+export declare function handleChange(e: any, callback: Function): void;

package/dist/types/brick-form/processor/index.d.ts

@@ -0,0 +1 @@
+export * from "./handleChange";

package/dist/types/brick-general-search/BrickGeneralSearch.d.ts

@@ -0,0 +1,28 @@
+import React from "react";
+import { Input } from "antd";
+import { Size, Shape } from "./index";
+interface TestGeneralSearchProps {
+    onUpdate: (value: string) => void;
+    onChange: (value: string) => void;
+    query: string;
+    size: Size;
+    shape: Shape;
+    placeholder: string;
+    inputStyle?: any;
+    buttonStyle?: any;
+    disableAutofocus?: boolean;
+    debounceTime?: number;
+    searchTypeEnabled?: boolean;
+    searchType?: "all" | "ip";
+    onSearchTypeChange?: (value: string) => void;
+    searchBoxStyleType?: "defalut" | "round";
+    allowClear?: boolean;
+    bordered?: boolean;
+    onBlur?: (value: string) => void;
+    customSearchTypeOptions?: {
+        label: string;
+        value: string;
+    }[];
+}
+export declare const BrickGeneralSearch: React.ForwardRefExoticComponent<TestGeneralSearchProps & React.RefAttributes<Input>>;
+export {};