amis-editor-core 5.2.0-beta.0

package/lib/component/RegionHLBox.d.ts

@@ -0,0 +1,20 @@
+import React from 'react';
+import { EditorStoreType } from '../store/editor';
+import { EditorManager } from '../manager';
+import { EditorNodeType } from '../store/node';
+export declare const AddBTNSvg = "<svg viewBox=\"0 0 12 12\">\n<g stroke=\"none\" stroke-width=\"1\" fill=\"none\" fill-rule=\"evenodd\">\n  <g id=\"plus\" fill=\"currentColor\" fill-rule=\"nonzero\">\n    <polygon points=\"6.6 6.6 6.6 12 5.4 12 5.4 6.6 0 6.6 0 5.4 5.4 5.4 5.4 0 6.6 0 6.6 5.4 12 5.4 12 6.6\"></polygon>\n  </g>\n</g>\n</svg>";
+export interface HighlightBoxProps {
+    store: EditorStoreType;
+    node: EditorNodeType;
+    name: string;
+    id: string;
+    className?: string;
+    title: string;
+    preferTag?: string;
+    manager: EditorManager;
+    isOnlyChildRegion: boolean;
+}
+export default class RegionHighlightBox extends React.Component<HighlightBoxProps> {
+    handleClick(): void;
+    render(): JSX.Element;
+}

package/lib/component/RegionWrapper.d.ts

@@ -0,0 +1,206 @@
+import React from 'react';
+import { EditorManager } from '../manager';
+import { RegionConfig, RendererInfo } from '../plugin';
+import { EditorStoreType } from '../store/editor';
+import { EditorNodeType } from '../store/node';
+export interface RegionWrapperProps {
+    name: string;
+    label: string;
+    placeholder?: string;
+    preferTag?: string;
+    wrapperResolve?: (dom: HTMLElement) => HTMLElement;
+    editorStore: EditorStoreType;
+    manager: EditorManager;
+    rendererName?: string;
+    regionConfig: RegionConfig;
+    node?: EditorNodeType;
+    $$editor?: RendererInfo;
+}
+/**
+ * 1.DOM标记 添加 data-region、data-region-host 和 data-renderer 属性
+ * 2.构建 Node store 节点。
+ */
+export declare class RegionWrapper extends React.Component<RegionWrapperProps> {
+    static contextType: React.Context<({
+        parentId: string;
+        parentRegion: string;
+        isCommonConfig: boolean;
+        id: string;
+        type: string;
+        label: string;
+        regionInfo: (RegionConfig & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<RegionConfig, RegionConfig, RegionConfig>>>) | undefined;
+        path: string;
+        schemaPath: string;
+        region: string;
+        preferTag: string;
+        state: any;
+        widthMutable: boolean;
+        heightMutable: boolean;
+        memberIndex: number;
+        folded: boolean;
+        patched: boolean;
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+        children: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IAnyModelType> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>>;
+    } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
+        getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
+    } & {
+        readonly info: RendererInfo;
+        setInfo(value: RendererInfo): void;
+        readonly rendererConfig: import("amis-core").RendererConfig | undefined;
+        setRendererConfig(value: import("amis-core").RendererConfig): void;
+        readonly isVitualRenderer: boolean;
+        readonly clickable: boolean;
+        readonly draggable: boolean;
+        readonly moveable: boolean;
+        readonly canMoveUp: boolean;
+        readonly canMoveDown: boolean;
+        readonly removable: boolean;
+        readonly duplicatable: boolean;
+        readonly replaceable: boolean;
+        memberImmutable(region: string): boolean;
+        readonly isRegion: boolean;
+        readonly childRegions: any[];
+        readonly uniqueChildren: any[];
+        readonly sameIdChild: any;
+        readonly singleRegion: boolean;
+        isExists(id: string): boolean;
+        getChildById(id: string): any;
+        readonly parent: any;
+        readonly ancestorField: any;
+        readonly host: any;
+        readonly firstChild: any;
+        readonly index: any;
+        readonly prevSibling: any;
+        readonly nextSibling: any;
+        readonly schema: any;
+        readonly schemaParent: any;
+        readonly isSecondFactor: boolean;
+    } & {
+        updateIsCommonConfig: (value: boolean) => void;
+        addChild(props: {
+            id: string;
+            type: string;
+            label: string;
+            path: string;
+            isCommonConfig?: boolean | undefined;
+            info?: RendererInfo | undefined;
+            region?: string | undefined;
+            getData?: (() => any) | undefined;
+            preferTag?: string | undefined;
+            schemaPath?: string | undefined;
+            regionInfo?: RegionConfig | undefined;
+            widthMutable?: boolean | undefined;
+            memberIndex?: number | undefined;
+        }): any;
+        removeChild(child: any): void;
+        toggleFold(e: React.MouseEvent<HTMLAnchorElement, MouseEvent>): void;
+        patch(store: any, force?: boolean): void;
+        updateSchema(value: any): void;
+        setComponent(value: any): void;
+        getComponent(): any;
+        calculateHighlightBox(root?: any): void;
+        resetHighlightBox(root: any): void;
+        updateState(state: any, replace?: boolean): void;
+        setWidthMutable(value: any): void;
+        setHeightMutable(value: any): void;
+    } & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IModelType<{
+        parentId: import("mobx-state-tree").IType<string | undefined, string, string>;
+        parentRegion: import("mobx-state-tree").IType<string | undefined, string, string>;
+        isCommonConfig: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        id: import("mobx-state-tree").IType<string | undefined, string, string>;
+        type: import("mobx-state-tree").IType<string | undefined, string, string>;
+        label: import("mobx-state-tree").IType<string | undefined, string, string>;
+        regionInfo: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<RegionConfig, RegionConfig, RegionConfig>>;
+        path: import("mobx-state-tree").IType<string | undefined, string, string>;
+        schemaPath: import("mobx-state-tree").IType<string | undefined, string, string>;
+        region: import("mobx-state-tree").IType<string | undefined, string, string>;
+        preferTag: import("mobx-state-tree").IType<string | undefined, string, string>;
+        state: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IType<any, any, any>, [undefined]>;
+        widthMutable: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        heightMutable: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        memberIndex: import("mobx-state-tree").IType<number | undefined, number, number>;
+        folded: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        patched: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        x: import("mobx-state-tree").IType<number | undefined, number, number>;
+        y: import("mobx-state-tree").IType<number | undefined, number, number>;
+        w: import("mobx-state-tree").IType<number | undefined, number, number>;
+        h: import("mobx-state-tree").IType<number | undefined, number, number>;
+        children: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>;
+    }, {
+        getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
+    } & {
+        readonly info: RendererInfo;
+        setInfo(value: RendererInfo): void;
+        readonly rendererConfig: import("amis-core").RendererConfig | undefined;
+        setRendererConfig(value: import("amis-core").RendererConfig): void;
+        readonly isVitualRenderer: boolean;
+        readonly clickable: boolean;
+        readonly draggable: boolean;
+        readonly moveable: boolean;
+        readonly canMoveUp: boolean;
+        readonly canMoveDown: boolean;
+        readonly removable: boolean;
+        readonly duplicatable: boolean;
+        readonly replaceable: boolean;
+        memberImmutable(region: string): boolean;
+        readonly isRegion: boolean;
+        readonly childRegions: any[];
+        readonly uniqueChildren: any[];
+        readonly sameIdChild: any;
+        readonly singleRegion: boolean;
+        isExists(id: string): boolean;
+        getChildById(id: string): any;
+        readonly parent: any;
+        readonly ancestorField: any;
+        readonly host: any;
+        readonly firstChild: any;
+        readonly index: any;
+        readonly prevSibling: any;
+        readonly nextSibling: any;
+        readonly schema: any;
+        readonly schemaParent: any;
+        readonly isSecondFactor: boolean;
+    } & {
+        updateIsCommonConfig: (value: boolean) => void;
+        addChild(props: {
+            id: string;
+            type: string;
+            label: string;
+            path: string;
+            isCommonConfig?: boolean | undefined;
+            info?: RendererInfo | undefined;
+            region?: string | undefined;
+            getData?: (() => any) | undefined;
+            preferTag?: string | undefined;
+            schemaPath?: string | undefined;
+            regionInfo?: RegionConfig | undefined;
+            widthMutable?: boolean | undefined;
+            memberIndex?: number | undefined;
+        }): any;
+        removeChild(child: any): void;
+        toggleFold(e: React.MouseEvent<HTMLAnchorElement, MouseEvent>): void;
+        patch(store: any, force?: boolean): void;
+        updateSchema(value: any): void;
+        setComponent(value: any): void;
+        getComponent(): any;
+        calculateHighlightBox(root?: any): void;
+        resetHighlightBox(root: any): void;
+        updateState(state: any, replace?: boolean): void;
+        setWidthMutable(value: any): void;
+        setHeightMutable(value: any): void;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>) | null>;
+    parentNode: EditorNodeType;
+    editorNode: EditorNodeType;
+    UNSAFE_componentWillMount(): void;
+    componentDidMount(): void;
+    componentDidUpdate(prevProps: RegionWrapperProps): void;
+    componentWillUnmount(): void;
+    /**
+     * 弄点标记
+     */
+    markDom(id: string, region: string, rendererName?: string): void;
+    render(): JSX.Element;
+}

package/lib/component/RendererThumb.d.ts

@@ -0,0 +1,22 @@
+import React from 'react';
+import { Schema } from 'amis/lib/types';
+interface ThumbProps {
+    schema: Schema;
+    theme?: string;
+    env: any;
+}
+interface ThumbStates {
+    scale: Boolean;
+}
+export declare class RendererThumb extends React.Component<ThumbProps, ThumbStates> {
+    ref: HTMLDivElement;
+    unSensor: Function;
+    constructor(props: ThumbProps);
+    env: any;
+    componentWillUnmount(): void;
+    rootRef(ref: HTMLDivElement): void;
+    syncHeight(): void;
+    handleClick(e: React.MouseEvent): void;
+    render(): JSX.Element;
+}
+export {};

package/lib/component/ScaffoldModal.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+import { EditorManager } from '../manager';
+import { EditorStoreType } from '../store/editor';
+export interface SubEditorProps {
+    store: EditorStoreType;
+    manager: EditorManager;
+    theme?: string;
+}
+export declare class ScaffoldModal extends React.Component<SubEditorProps> {
+    handleConfirm([values]: any): void;
+    buildSchema(): {
+        [x: string]: any;
+        type: string;
+        wrapWithPanel: boolean;
+        initApi: any;
+        api: any;
+        mode: "horizontal" | "inline" | "normal";
+        wrapperComponent: string;
+    };
+    amisScope: any;
+    scopeRef(scoped: any): void;
+    handleConfirmClick(): Promise<void>;
+    render(): JSX.Element;
+}

package/lib/component/SubEditor.d.ts

@@ -0,0 +1,67 @@
+import React from 'react';
+import { EditorManager } from '../manager';
+import { EditorStoreType } from '../store/editor';
+import { BuildPanelEventContext, PluginEvent, RendererInfoResolveEventContext } from '../plugin';
+export interface SubEditorProps {
+    store: EditorStoreType;
+    manager: EditorManager;
+    theme?: string;
+}
+export declare class SubEditor extends React.Component<SubEditorProps> {
+    afterResolveEditorInfo(event: PluginEvent<RendererInfoResolveEventContext>): void;
+    handleBuildPanels(event: PluginEvent<BuildPanelEventContext>): void;
+    buildSchema(): {
+        size: string;
+        title: string | undefined;
+        onClose: () => void;
+        onConfirm: ([valueRaw]: any) => void;
+        body: {
+            type: string;
+            mode: string;
+            wrapperComponent: string;
+            onValidate: (value: any) => Promise<{
+                schema: string;
+            } | undefined>;
+            onChange: () => void;
+            body: {
+                name: string;
+                asFormItem: boolean;
+                children: ({ value, onChange }: {
+                    value: any;
+                    onChange: (value: any) => void;
+                }) => JSX.Element;
+            }[];
+            tpl?: undefined;
+        } | {
+            type: string;
+            tpl: string;
+            mode?: undefined;
+            wrapperComponent?: undefined;
+            onValidate?: undefined;
+            onChange?: undefined;
+            body?: undefined;
+        };
+        actions: ({
+            children: JSX.Element | null;
+            type?: undefined;
+            label?: undefined;
+            level?: undefined;
+            actionType?: undefined;
+        } | {
+            type: string;
+            label: string;
+            level: string;
+            children?: undefined;
+            actionType?: undefined;
+        } | {
+            type: string;
+            label: string;
+            actionType: string;
+            children?: undefined;
+            level?: undefined;
+        })[][];
+        closeOnEsc: boolean;
+        bodyClassName: string;
+    };
+    render(): JSX.Element;
+}

package/lib/component/VRenderer.d.ts

@@ -0,0 +1,191 @@
+import React from 'react';
+import { RendererInfo } from '../plugin';
+import { EditorNodeType } from '../store/node';
+export interface VRendererProps extends RendererInfo {
+    path: string;
+    data?: any;
+    widthMutable?: boolean;
+}
+export declare class VRenderer extends React.Component<VRendererProps> {
+    static contextType: React.Context<({
+        parentId: string;
+        parentRegion: string;
+        isCommonConfig: boolean;
+        id: string;
+        type: string;
+        label: string;
+        regionInfo: (import("../plugin").RegionConfig & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<import("../plugin").RegionConfig, import("../plugin").RegionConfig, import("../plugin").RegionConfig>>>) | undefined;
+        path: string;
+        schemaPath: string;
+        region: string;
+        preferTag: string;
+        state: any;
+        widthMutable: boolean;
+        heightMutable: boolean;
+        memberIndex: number;
+        folded: boolean;
+        patched: boolean;
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+        children: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IAnyModelType> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>>;
+    } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
+        getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
+    } & {
+        readonly info: RendererInfo;
+        setInfo(value: RendererInfo): void;
+        readonly rendererConfig: import("amis-core").RendererConfig | undefined;
+        setRendererConfig(value: import("amis-core").RendererConfig): void;
+        readonly isVitualRenderer: boolean;
+        readonly clickable: boolean;
+        readonly draggable: boolean;
+        readonly moveable: boolean;
+        readonly canMoveUp: boolean;
+        readonly canMoveDown: boolean;
+        readonly removable: boolean;
+        readonly duplicatable: boolean;
+        readonly replaceable: boolean;
+        memberImmutable(region: string): boolean;
+        readonly isRegion: boolean;
+        readonly childRegions: any[];
+        readonly uniqueChildren: any[];
+        readonly sameIdChild: any;
+        readonly singleRegion: boolean;
+        isExists(id: string): boolean;
+        getChildById(id: string): any;
+        readonly parent: any;
+        readonly ancestorField: any;
+        readonly host: any;
+        readonly firstChild: any;
+        readonly index: any;
+        readonly prevSibling: any;
+        readonly nextSibling: any;
+        readonly schema: any;
+        readonly schemaParent: any;
+        readonly isSecondFactor: boolean;
+    } & {
+        updateIsCommonConfig: (value: boolean) => void;
+        addChild(props: {
+            id: string;
+            type: string;
+            label: string;
+            path: string;
+            isCommonConfig?: boolean | undefined;
+            info?: RendererInfo | undefined;
+            region?: string | undefined;
+            getData?: (() => any) | undefined;
+            preferTag?: string | undefined;
+            schemaPath?: string | undefined;
+            regionInfo?: import("../plugin").RegionConfig | undefined;
+            widthMutable?: boolean | undefined;
+            memberIndex?: number | undefined;
+        }): any;
+        removeChild(child: any): void;
+        toggleFold(e: React.MouseEvent<HTMLAnchorElement, MouseEvent>): void;
+        patch(store: any, force?: boolean): void;
+        updateSchema(value: any): void;
+        setComponent(value: any): void;
+        getComponent(): any;
+        calculateHighlightBox(root?: any): void;
+        resetHighlightBox(root: any): void;
+        updateState(state: any, replace?: boolean): void;
+        setWidthMutable(value: any): void;
+        setHeightMutable(value: any): void;
+    } & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IModelType<{
+        parentId: import("mobx-state-tree").IType<string | undefined, string, string>;
+        parentRegion: import("mobx-state-tree").IType<string | undefined, string, string>;
+        isCommonConfig: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        id: import("mobx-state-tree").IType<string | undefined, string, string>;
+        type: import("mobx-state-tree").IType<string | undefined, string, string>;
+        label: import("mobx-state-tree").IType<string | undefined, string, string>;
+        regionInfo: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<import("../plugin").RegionConfig, import("../plugin").RegionConfig, import("../plugin").RegionConfig>>;
+        path: import("mobx-state-tree").IType<string | undefined, string, string>;
+        schemaPath: import("mobx-state-tree").IType<string | undefined, string, string>;
+        region: import("mobx-state-tree").IType<string | undefined, string, string>;
+        preferTag: import("mobx-state-tree").IType<string | undefined, string, string>;
+        state: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IType<any, any, any>, [undefined]>;
+        widthMutable: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        heightMutable: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        memberIndex: import("mobx-state-tree").IType<number | undefined, number, number>;
+        folded: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        patched: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        x: import("mobx-state-tree").IType<number | undefined, number, number>;
+        y: import("mobx-state-tree").IType<number | undefined, number, number>;
+        w: import("mobx-state-tree").IType<number | undefined, number, number>;
+        h: import("mobx-state-tree").IType<number | undefined, number, number>;
+        children: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IAnyModelType>, [undefined]>;
+    }, {
+        getData: import("mobx-state-tree").IType<() => any, () => any, () => any>;
+    } & {
+        readonly info: RendererInfo;
+        setInfo(value: RendererInfo): void;
+        readonly rendererConfig: import("amis-core").RendererConfig | undefined;
+        setRendererConfig(value: import("amis-core").RendererConfig): void;
+        readonly isVitualRenderer: boolean;
+        readonly clickable: boolean;
+        readonly draggable: boolean;
+        readonly moveable: boolean;
+        readonly canMoveUp: boolean;
+        readonly canMoveDown: boolean;
+        readonly removable: boolean;
+        readonly duplicatable: boolean;
+        readonly replaceable: boolean;
+        memberImmutable(region: string): boolean;
+        readonly isRegion: boolean;
+        readonly childRegions: any[];
+        readonly uniqueChildren: any[];
+        readonly sameIdChild: any;
+        readonly singleRegion: boolean;
+        isExists(id: string): boolean;
+        getChildById(id: string): any;
+        readonly parent: any;
+        readonly ancestorField: any;
+        readonly host: any;
+        readonly firstChild: any;
+        readonly index: any;
+        readonly prevSibling: any;
+        readonly nextSibling: any;
+        readonly schema: any;
+        readonly schemaParent: any;
+        readonly isSecondFactor: boolean;
+    } & {
+        updateIsCommonConfig: (value: boolean) => void;
+        addChild(props: {
+            id: string;
+            type: string;
+            label: string;
+            path: string;
+            isCommonConfig?: boolean | undefined;
+            info?: RendererInfo | undefined;
+            region?: string | undefined;
+            getData?: (() => any) | undefined;
+            preferTag?: string | undefined;
+            schemaPath?: string | undefined;
+            regionInfo?: import("../plugin").RegionConfig | undefined;
+            widthMutable?: boolean | undefined;
+            memberIndex?: number | undefined;
+        }): any;
+        removeChild(child: any): void;
+        toggleFold(e: React.MouseEvent<HTMLAnchorElement, MouseEvent>): void;
+        patch(store: any, force?: boolean): void;
+        updateSchema(value: any): void;
+        setComponent(value: any): void;
+        getComponent(): any;
+        calculateHighlightBox(root?: any): void;
+        resetHighlightBox(root: any): void;
+        updateState(state: any, replace?: boolean): void;
+        setWidthMutable(value: any): void;
+        setHeightMutable(value: any): void;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>) | null>;
+    editorNode: EditorNodeType;
+    UNSAFE_componentWillMount(): void;
+    componentDidMount(): void;
+    componentDidUpdate(): void;
+    componentWillUnmount(): void;
+    /**
+     * 弄点标记
+     */
+    markDom(id: string): void;
+    render(): JSX.Element;
+}

package/lib/component/base/BackTop.d.ts

@@ -0,0 +1,26 @@
+import React from 'react';
+export interface BackTopProps {
+    visibilityHeight?: number;
+    onClick?: React.MouseEventHandler<HTMLElement>;
+    target: () => HTMLElement | Window | Document;
+    children?: React.ReactNode;
+    className?: string;
+    visible?: boolean;
+}
+export interface BackTopStates {
+    visible: boolean;
+}
+export default class BackTop extends React.Component<BackTopProps, BackTopStates> {
+    ref: React.RefObject<HTMLDivElement>;
+    scrollElem: any;
+    constructor(props: any);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    getDefaultTarget(): Document | (Window & typeof globalThis);
+    handleScroll(e: React.UIEvent<HTMLElement> | {
+        target: any;
+    }): void;
+    bindScrollEvent(): void;
+    scrollToTop(e: React.MouseEvent<HTMLDivElement>): void;
+    render(): JSX.Element;
+}

package/lib/component/base/ErrorRenderer.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+export declare class ErrorRenderer extends React.Component<any> {
+    render(): JSX.Element;
+}

package/lib/component/base/SearchCustomRendererPanel.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import { EditorStoreType } from '../../store/editor';
+import { SubRendererInfo } from '../../plugin';
+interface SearchCustomRendererProps {
+    store: EditorStoreType;
+}
+interface SearchCustomRendererStates {
+    customRenderersByOrder: Array<SubRendererInfo>;
+}
+export default class SearchCustomRendererPanel extends React.Component<SearchCustomRendererProps, SearchCustomRendererStates> {
+    localStorageKey: string;
+    constructor(props: any);
+    render(): JSX.Element | null;
+}
+export {};

package/lib/component/base/SearchPanel.d.ts

@@ -0,0 +1,83 @@
+import React from 'react';
+/**
+ * 通用搜索功能组件，附带以下功能：
+ * 1、搜索历史：会自动记录用户搜索过的关键字，方便用户下次使用；
+ * 2、自动提示补全：autoComplete 设置为 true 后，每次输入关键字后会展示当前所有含有关键字的信息（并以分类的形式展示）；
+ * 3、搜索分类：取决于当前搜索数据结构是否带tag，如果不带tag则不展示搜索分类；
+ */
+interface SearchProps {
+    allResult: Array<any>;
+    searchPanelUUID: string;
+    closeAutoComplete?: boolean;
+    externalKeyword?: string;
+    tagKey?: string;
+    onChange: (keyword: string) => void;
+    onTagChange?: (tag: string) => void;
+    immediateChange?: boolean;
+}
+interface SearchStates {
+    resultTags: Array<string>;
+    resultByTag: {
+        [propName: string]: Array<any>;
+    };
+    curKeyword: string;
+    searchResult: Array<any>;
+    searchResultByTag: {
+        [propName: string]: Array<any>;
+    };
+    visible: boolean;
+    curKeywordSearchHistory: string[];
+    toggleTagFolderStatus: boolean;
+}
+export default class SearchPanel extends React.Component<SearchProps, SearchStates> {
+    ref: React.RefObject<HTMLDivElement>;
+    curInputBox: any;
+    localStorageKey: string;
+    curTagFolded: {
+        [propName: string]: boolean;
+    };
+    lastSearchTag: string;
+    constructor(props: any);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    UNSAFE_componentWillReceiveProps(nextProps: any): void;
+    getSearchHistory(): any[];
+    /**
+     * 从搜索数据中获取分类信息，并按分类存放搜索数据，方便后续通过分类直接获取搜索数据
+     */
+    getResultTags(allResult: Array<any>): {
+        curResultTags: string[];
+        curResultByTag: {
+            [propName: string]: any[];
+        };
+    };
+    /**
+     * 根据关键字过滤数据，按分组存放
+     */
+    groupedResultByKeyword(keywords?: string): void;
+    bindFocusEvent(): void;
+    bindBlurEvent(): void;
+    updateCurKeyword(keywords: string): void;
+    changeTagFoldStatus(tagKey: string, event: any): void;
+    bindEnterEvent(event: any): void;
+    /** 删除搜索关键字 */
+    bindClearActionEvent(): void;
+    /** 组件分类tag点击事件 */
+    bindTagClickEvent(tag: string): void;
+    /** 添加搜索历史 */
+    addSearchHistory(newKeywords: string): void;
+    /** 搜索历史/点击 */
+    clickKeywordEvent(keywords: string): void;
+    deleteSearchHistory(event: any, newKeywords: string): void;
+    clearSearchHistory(event: any): void;
+    /** 将搜索记录保存到localStorage */
+    updateSearchHistory(): void;
+    /** 显示搜索关键字 */
+    renderNameByKeyword(rendererName: string, curKeyword: string): string | JSX.Element;
+    /** 判断搜索展示内容是否有滚动（交互优化） */
+    resultIsHasScroll(searchSubRenderers: {
+        [propName: string]: Array<any>;
+    }, maxShowLine: number): boolean;
+    render(): JSX.Element;
+}
+export {};