reviewboard.themes.ui.base¶

Base support for defining UI themes.

class InkColorScheme(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: Enum

The Ink color scheme set by a theme.

New in version 7.0.

LIGHT = 'light'[source]¶

A light color scheme.

DARK = 'dark'[source]¶

A dark color scheme.

HIGH_CONTRAST = 'high-contrast'[source]¶

A high-contrast color scheme.

SYSTEM = 'system'[source]¶

A color scheme adapting to current system settings.

class BaseUITheme[source]¶

Bases: object

Base class for a UI theme.

New in version 7.0.

theme_id: ClassVar[str]¶

The unique ID of the theme.

This is used for registration and lookup purposes.

These only need to be unique within other UI themes.

Type:

str

name: ClassVar[StrOrPromise]¶

The displayed name of the theme.

This will be shown to the user when choosing themes. It should be localized.

Type:

str

ink_color_scheme: ClassVar[InkColorScheme]¶

The value for the data-ink-color-scheme= HTML attribute.

This informs the CSS and JavaScript of the current color scheme.

Type:

InkColorScheme

get_html_attrs(*, request: HttpRequest) → dict[str, str][source]¶

Return HTML attributes to include on the root HTML element.

By default, this sets data-theme to theme_id and data-ink-color-scheme to ink_color_scheme`.

Subclasses can override this to provide additional attributes.

Parameters:

request (django.http.HttpRequest) – The HTTP request from the client.

Returns:

The HTML attributes to include.

Return type:

dict

__annotations__ = {'ink_color_scheme': 'ClassVar[InkColorScheme]', 'name': 'ClassVar[StrOrPromise]', 'theme_id': 'ClassVar[str]'}¶