@openshift-console/dynamic-plugin-sdk/lib/extensions/user-preferences.d.ts

Based on the concept of [webpack module federation](https://webpack.js.org/concepts/module-federation/), dynamic plugins are loaded and interpreted from remote sources at runtime. The standard way to deliver and expose dynamic plugins to Console is throug

import * as React from 'react';
import { JSONSchema7Type } from 'json-schema';
import { Extension, ExtensionDeclaration, CodeRef } from '../types';
export declare enum UserPreferenceFieldType {
    dropdown = "dropdown",
    checkbox = "checkbox",
    custom = "custom"
}
export declare type UserPreferenceDropdownField = {
    type: UserPreferenceFieldType.dropdown;
    userSettingsKey: string;
    defaultValue?: string;
    options: {
        value: string;
        label: string;
    }[];
};
export declare type UserPreferenceCheckboxFieldValue = string | number | boolean;
export declare type UserPreferenceCheckboxField = {
    type: UserPreferenceFieldType.checkbox;
    userSettingsKey: string;
    label: string;
    trueValue: UserPreferenceCheckboxFieldValue;
    falseValue: UserPreferenceCheckboxFieldValue;
    defaultValue?: UserPreferenceCheckboxFieldValue;
};
export declare type UserPreferenceCustomField = {
    type: UserPreferenceFieldType.custom;
    component: CodeRef<React.ComponentType>;
    props?: {
        [key: string]: JSONSchema7Type;
    };
};
export declare type UserPreferenceField = UserPreferenceDropdownField | UserPreferenceCheckboxField | UserPreferenceCustomField;
export declare type UserPreferenceGroup = ExtensionDeclaration<'console.user-preference/group', {
    /** ID used to identify the user preference group. */
    id: string;
    /** The label of the user preference group */
    label: string;
    /** ID of user preference group before which this group should be placed */
    insertBefore?: string;
    /** ID of user preference group after which this group should be placed */
    insertAfter?: string;
}>;
export declare type UserPreferenceItem = ExtensionDeclaration<'console.user-preference/item', {
    /** ID used to identify the user preference item and referenced in insertAfter and insertBefore to define the item order. */
    id: string;
    /** IDs used to identify the user preference groups the item would belong to. */
    groupId?: string;
    /** The label of the user preference */
    label: string;
    /** The description of the user preference. */
    description: string;
    /** The input field options used to render the values to set the user preference. */
    field: UserPreferenceField;
    /** ID of user preference item before which this item should be placed */
    insertBefore?: string;
    /** ID of user preference item after which this item should be placed */
    insertAfter?: string;
}>;
export declare const isUserPreferenceItem: (e: Extension<any>) => e is ExtensionDeclaration<"console.user-preference/item", {
    /** ID used to identify the user preference item and referenced in insertAfter and insertBefore to define the item order. */
    id: string;
    /** IDs used to identify the user preference groups the item would belong to. */
    groupId?: string;
    /** The label of the user preference */
    label: string;
    /** The description of the user preference. */
    description: string;
    /** The input field options used to render the values to set the user preference. */
    field: UserPreferenceField;
    /** ID of user preference item before which this item should be placed */
    insertBefore?: string;
    /** ID of user preference item after which this item should be placed */
    insertAfter?: string;
}>;
export declare const isUserPreferenceGroup: (e: Extension<any>) => e is ExtensionDeclaration<"console.user-preference/group", {
    /** ID used to identify the user preference group. */
    id: string;
    /** The label of the user preference group */
    label: string;
    /** ID of user preference group before which this group should be placed */
    insertBefore?: string;
    /** ID of user preference group after which this group should be placed */
    insertAfter?: string;
}>;