@iobroker/adapter-react-v5 4.6.13 → 4.7.0

package/Components/JsonConfigComponent/ConfigGeneric.d.ts

@@ -0,0 +1,88 @@
+/// <reference types="iobroker" />
+import React, { Component } from 'react';
+import type AdminConnection from './wrapper/AdminConnection';
+export declare function isObject(it: any): it is Record<string, any>;
+export interface ConfigGenericProps {
+    /** Provided props by the specific component */
+    schema: Record<string, any>;
+    registerOnForceUpdate: any;
+    attr: string;
+    data: Record<string, any>;
+    onChange: (attrOrData: string | Record<string, any>, val?: any, cb?: () => void) => void;
+    custom: boolean;
+    forceUpdate: (attrs: string[], data: Record<string, any>) => void;
+    alive: boolean;
+    originalData: Record<string, any>;
+    arrayIndex: any;
+    globalData: any;
+    systemConfig?: Record<string, any>;
+    instanceObj: ioBroker.InstanceObject;
+    customObj: Record<string, any>;
+    socket: AdminConnection;
+    changed: boolean;
+    adapterName: string;
+    instance: number;
+    common: Record<string, any>;
+    onError: (attr: string, error?: unknown) => void;
+    themeType: string;
+    commandRunning: any;
+    disabled?: boolean;
+}
+export interface ConfigGenericState {
+    confirmDialog: boolean;
+    confirmNewValue: any;
+    confirmAttr: any;
+    confirmData: any;
+    value?: any;
+    confirmDepAttr?: any;
+    confirmDepNewValue?: any;
+}
+export default class ConfigGeneric<Props extends ConfigGenericProps, State extends ConfigGenericState> extends Component<Props, State> {
+    static DIFFERENT_VALUE: string;
+    static DIFFERENT_LABEL: string;
+    static NONE_VALUE: string;
+    static NONE_LABEL: string;
+    private readonly defaultValue;
+    private isError;
+    private readonly lang;
+    private defaultSendToDone?;
+    private sendToTimeout?;
+    private noPlaceRequired;
+    constructor(props: Props);
+    componentDidMount(): void;
+    sendTo(): void;
+    componentWillUnmount(): void;
+    onUpdate: (data: Record<string, any>) => void;
+    /**
+     * Extract attribute out of data
+     *
+     * @param data
+     * @param attr
+     */
+    static getValue(data: Record<string, any>, attr: string | string[]): any;
+    static setValue(data: Record<string, any>, attr: string | string[], value: any): void;
+    getText(text: unknown, noTranslation?: boolean): string;
+    renderConfirmDialog(): React.JSX.Element;
+    getIcon(iconSettings: string | undefined | null): React.JSX.Element | null;
+    /**
+     * Trigger onChange, to activate save button on change
+     *
+     * @param attr the changed attribute
+     * @param newValue new value of the attribute
+     * @param cb optional callback function, else returns a Promise
+     */
+    onChange(attr: string, newValue: any, cb?: () => void): Promise<void>;
+    execute(func: string | Record<string, string>, defaultValue: any, data: Record<string, any>, arrayIndex: number, globalData: Record<string, any>): any;
+    executeCustom(func: string | Record<string, string>, data: Record<string, any>, customObj: Record<string, any>, instanceObj: ioBroker.InstanceObject, arrayIndex: number, globalData: Record<string, any>): any;
+    calculate(schema: Record<string, any>): {
+        error: any;
+        disabled: any;
+        hidden: any;
+        defaultValue: any;
+    };
+    onError(attr: string, error?: unknown): void;
+    renderItem(_error: unknown, _disabled: boolean, _defaultValue?: unknown): React.JSX.Element | string;
+    renderHelp(text: string, link: string, noTranslation: boolean): string | React.JSX.Element | JSX.Element[];
+    getPattern(pattern: any, data?: any): any;
+    render(): string | React.JSX.Element | null;
+}