77 lines
2.3 KiB
TypeScript
77 lines
2.3 KiB
TypeScript
|
/**
|
||
|
|
* Namespace: browser.theme
|
||
|
|
* Generated from Mozilla sources. Do not manually edit!
|
||
|
|
*
|
||
|
|
* The theme API allows customizing of visual elements of the browser.
|
||
|
|
*
|
||
|
|
* Comments found in source JSON schema files:
|
||
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
||
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||
|
|
*/
|
||
|
|
import { Manifest } from "./manifest";
|
||
|
|
import { Events } from "./events";
|
||
|
|
|
||
|
|
export namespace Theme {
|
||
|
|
/**
|
||
|
|
* Info provided in the onUpdated listener.
|
||
|
|
*/
|
||
|
|
interface ThemeUpdateInfo {
|
||
|
|
/**
|
||
|
|
* The new theme after update
|
||
|
|
*/
|
||
|
|
theme: ThemeUpdateInfoThemeType;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The id of the window the theme has been applied to
|
||
|
|
* Optional.
|
||
|
|
*/
|
||
|
|
windowId?: number;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The new theme after update
|
||
|
|
*/
|
||
|
|
interface ThemeUpdateInfoThemeType {
|
||
|
|
[s: string]: unknown;
|
||
|
|
}
|
||
|
|
|
||
|
|
interface Static {
|
||
|
|
/**
|
||
|
|
* Returns the current theme for the specified window or the last focused window.
|
||
|
|
*
|
||
|
|
* @param windowId Optional. The window for which we want the theme.
|
||
|
|
*/
|
||
|
|
getCurrent(windowId?: number): Promise<any>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Make complete updates to the theme. Resolves when the update has completed.
|
||
|
|
*
|
||
|
|
* @param windowId Optional. The id of the window to update. No id updates all windows.
|
||
|
|
* @param details The properties of the theme to update.
|
||
|
|
*/
|
||
|
|
update(windowId: number | undefined, details: Manifest.ThemeType): Promise<void>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Make complete updates to the theme. Resolves when the update has completed.
|
||
|
|
*
|
||
|
|
* @param details The properties of the theme to update.
|
||
|
|
*/
|
||
|
|
update(details: Manifest.ThemeType): Promise<void>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Removes the updates made to the theme.
|
||
|
|
*
|
||
|
|
* @param windowId Optional. The id of the window to reset. No id resets all windows.
|
||
|
|
*/
|
||
|
|
reset(windowId?: number): Promise<void>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Fired when a new theme has been applied
|
||
|
|
*
|
||
|
|
* @param updateInfo Details of the theme update
|
||
|
|
*/
|
||
|
|
onUpdated: Events.Event<(updateInfo: ThemeUpdateInfo) => void>;
|
||
|
|
}
|
||
|
|
}
|