Go back to top

vivaldi.themePrivate Modders API Reference

Use the vivaldi.themePrivate to access the API.

Types

#BackgroundPosition

ENUM

⚠ NO DESCRIPTION PROVIDED

  • stretch
  • center
  • repeat

    • #ThemeData

    Basic typesafe theme data.

    Properties:

    id
    string

    The id of the queried theme. This is always set.

    isInstalled
    boolean

    Is the theme installed or not.

    version
    number

    If the theme is installed, this is the version of the installed theme.

    #ThemeObject

    ThemeObject
    object

    The theme object.

    Object Properties:

    type
    any
    preserveNull
    True

    #ExportOptions

    ⚠ NO DESCRIPTION PROVIDED

    Properties:

    returnBlob
    (optional) 
    boolean

    When true, the theme archive is returned as a memory blob instead of asking the user to select the file.

    windowId
    (optional) 
    number

    Window to show the file selection dialog to select the output file. Must not be given when |returnBlob| is true.

    dialogTitle
    (optional) 
    string

    The title of the file selection dialog to select the output file. Must not be given when |returnBlob| is true.

    #ExportResult

    ⚠ NO DESCRIPTION PROVIDED

    Properties:

    success
    boolean

    True if the theme was successfully exported. False on errors or if the user cancelled operation.

    dataBlob
    (optional) 
    binary

    The exported archive as binary blob. This is given only on success and ony when |returnBlob| is true in |ExportOptions|.

    #ImportOptions

    ⚠ NO DESCRIPTION PROVIDED

    Properties:

    dataBlob
    binary

    The archive to import the theme from.

    #ImportErrorKind

    ENUM

    ⚠ NO DESCRIPTION PROVIDED

  • io
  • badArchive
  • badSettings
  • network

    • #ImportError

    ⚠ NO DESCRIPTION PROVIDED

    Properties:

    kind
    ImportErrorKind

    Generic error kind

    details
    string

    low-level error message in English

    #ImportResult

    ⚠ NO DESCRIPTION PROVIDED

    Properties:

    error
    (optional) 
    ImportError

    Error if any during the operation.

    themeID
    string

    The id of the imported theme or an empty string if the user cancels the import or on errors.

    Listeners

    How to use listeners

    Each listener type has the same functions, used for each listener API in the same way:

    .addListener(function callback)

    Adds a function to a listener for an event

    .removeListener(function callback)

    Removes a function to a listener for an event

    .hasListener(function callback)

    Returns a boolean if a function is attached to a listener for an event

    .hasListeners()

    Returns a boolean if a listener has any attached functions

    .dispatch()

    Returns array of promises dispatched to the listener

    #onThemeDownloadStarted

    Fired when the theme download is starting.

    Parameters:

    themeId
    string

    ⚠ NO DESCRIPTION PROVIDED

    #onThemeDownloadProgress

    Fired on download progress.

    Parameters:

    themeId
    string

    ⚠ NO DESCRIPTION PROVIDED

    currentValue
    integer

    Fired on download progress with the current progress value.

    #onThemeDownloadCompleted

    Fired on download and install completion.

    Parameters:

    themeId
    string

    ⚠ NO DESCRIPTION PROVIDED

    success
    boolean

    true on successful theme install.

    error
    string

    if success is false, provides an error description.

    #onThemesUpdated

    Fired if the preview or permanent theme collection has changed.

    Parameters:

    preview
    boolean

    true if preview has changed, otherwise false.

    Methods

    #export

    Export the theme into a zip file

    Parameters:

    theme
    ThemeObject

    ⚠ NO DESCRIPTION PROVIDED

    options
    ExportOptions

    ⚠ NO DESCRIPTION PROVIDED

    #import

    Import and install theme archive.

    Parameters:

    options
    ImportOptions

    ⚠ NO DESCRIPTION PROVIDED

    #download

    Download and install theme.

    Parameters:

    themeId
    string

    Theme ID of the theme to download and install. This parameter is primarily used for status events.

    url
    string

    URL to the theme to download and install.

    #getThemeData

    Get some information about the given theme id.

    Parameters:

    id
    string

    Theme ID of the theme to return data about.