gadgets/dist/lib/shared/themes/index.d.ts

Reusable React UI widgets - This is my widget library. There are many like it, but this one is mine...

/**
 * Handles management of themes within the gadgets library.  It contains two
 * methods: `setTheme` and `getTheme`.  By default the library is initialized
 * with the *base* theme.  A theme represents an object with key/value pairs
 * that can be used within a styled component.  The theme object is passed
 * to a styled component with the `ThemeProvider` [wrapper](https://www.styled-components.com/docs/advanced#theming)
 *
 * It contains the following themes:
 *
 * - base - the basic color scheme for the gadgets library
 * - custom - a user defined theme.  It is empty unless the user created one
 * during the `setTheme` call.
 * - dark
 * - light
 *
 * See the './lib/shared/themes/base.json' for the keys that should be used
 * within a custom object implementation.
 *
 * #### Examples:
 *
 * ```javascript
 * import {getTheme, setTheme, Theme} from 'gadgets';
 *
 * setTheme(Theme.dark);
 *
 * ...
 *
 * render(
 *     <ThemeProvider theme={getTheme()}>
 *         ...
 *     </ThemeProvider>
 * );
 * ```
 *
 * @module themes
 */
import { DefaultTheme } from "styled-components";
import { ColorType } from "../colors";
export interface BaseThemeProps {
    backgroundColor: ColorType;
    borderColor: ColorType;
    buttonColor: ColorType;
    chevronColor: ColorType;
    color: ColorType;
    fontFamily: string;
    headerForegroundColor: ColorType;
    headerBackgroundColor: ColorType;
    headerHoverColor: ColorType;
    hoverColor: ColorType;
    inputBorderColor: ColorType;
    itemAlternatingColor: ColorType;
    itemHoverColor: ColorType;
    outlineColor: ColorType;
    searchFocus: ColorType;
    searchMatch: ColorType;
    selectedBackgroundColor: ColorType;
    selectedForegroundColor: ColorType;
    titleBarBackgroundColor: ColorType;
    titleBarForegroundColor: ColorType;
    tooltipBackgroundColor: ColorType;
    tooltipForegroundColor: ColorType;
    transitionDelay: string;
}
export declare type DefaultTheme = BaseThemeProps;
export declare enum Theme {
    base = 0,
    custom = 1,
    dark = 2,
    light = 3
}
/**
 * Retrieves the object representing the requested theme.
 * @param theme {Theme} a reference to the name of the theme that should be
 * selected and set within this module.
 * @return {DefaultTheme} the key/value object that contains CSS settings
 */
export declare function getTheme(theme?: Theme): DefaultTheme;
/**
 * @return {string[]} an array of strings that represent the names of all
 * themes that are available.
 */
export declare function getThemeList(): string[];
/**
 * Sets the current internal theme to the requested name (if it exists)
 * If the requested theme doesn't exist, then the `base` theme is set.
 * @param custom {Object} a custom theme object
 * @param theme {Theme} a reference to the name of the theme that should be
 * selected and set within this module.
 * @return {DefaultTheme} a reference to the current theme object
 */
export declare function setTheme(custom: DefaultTheme, theme?: Theme): DefaultTheme;