ui/settings/settings-page

Classes

SettingsPage

Defined in: app/src/ui/settings/settings-page.ts:24

The settings page: every setting that has a place on it, grouped in sections. Changes apply at once; values that a policy sets are shown but cannot be changed.

Extends

LitElement

Constructors

Constructor

new SettingsPage(): SettingsPage

Defined in: app/src/ui/settings/settings-page.ts:313

Returns

SettingsPage

Overrides

LitElement.constructor

lifecycle

connectedCallback()

connectedCallback(): void

Defined in: app/src/ui/settings/settings-page.ts:326

Invoked when the component is added to the document’s DOM.

In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

connectedCallback() {
  super.connectedCallback();
  addEventListener('keydown', this._handleKeydown);
}

Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

Returns

void

Overrides

LitElement.connectedCallback

disconnectedCallback()

disconnectedCallback(): void

Defined in: app/src/ui/settings/settings-page.ts:349

Invoked when the component is removed from the document’s DOM.

This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.

disconnectedCallback() {
  super.disconnectedCallback();
  window.removeEventListener('keydown', this._handleKeydown);
}

An element may be re-connected after being disconnected.

Returns

void

Overrides

LitElement.disconnectedCallback

Other

blockerFailed

blockerFailed: boolean

Defined in: app/src/ui/settings/settings-page.ts:298

Whether the content blocker has no usable filter data.

bridge

bridge: PageBridge | undefined

Defined in: app/src/ui/settings/settings-page.ts:309

changedOnly

changedOnly: boolean

Defined in: app/src/ui/settings/settings-page.ts:306

Whether the page shows only the settings that differ from their defaults.

current

current: string

Defined in: app/src/ui/settings/settings-page.ts:304

The section in view, which the navigation marks.

customSearch

customSearch: boolean

Defined in: app/src/ui/settings/settings-page.ts:296

i18n

i18n: Translator | undefined

Defined in: app/src/ui/settings/settings-page.ts:310

message

message: { alert: boolean; text: string; } | undefined

Defined in: app/src/ui/settings/settings-page.ts:308

The outcome of the last import, if it needs telling.

query

query: string

Defined in: app/src/ui/settings/settings-page.ts:302

What the search field holds.

revision

revision: number

Defined in: app/src/ui/settings/settings-page.ts:294

searchError

searchError: boolean

Defined in: app/src/ui/settings/settings-page.ts:295

siteError

siteError: boolean

Defined in: app/src/ui/settings/settings-page.ts:300

Whether the last site to add was not a site name.

styles

static styles: CSSResult[]

Defined in: app/src/ui/settings/settings-page.ts:38

Styles of the page, scoped to its shadow root.

Overrides

LitElement.styles

properties

static properties: object

Defined in: app/src/ui/settings/settings-page.ts:25

User-supplied object that maps property names to PropertyDeclaration objects containing options for configuring reactive properties. When a reactive property is set the element will update and render.

By default properties are public fields, and as such, they should be considered as primarily settable by element users, either via attribute or the property itself.

Generally, properties that are changed by the element should be private or protected fields and should use the state: true option. Properties marked as state do not reflect from the corresponding attribute

However, sometimes element code does need to set a public property. This should typically only be done in response to user interaction, and an event should be fired informing the user; for example, a checkbox sets its checked property when clicked and fires a changed event. Mutating public properties should typically not be done for non-primitive (object or array) properties. In other cases when an element needs to manage state, a private property set with the state: true option should be used. When needed, state properties can be initialized via public properties to facilitate complex interactions.

blockerFailed

blockerFailed: object

blockerFailed.state

state: boolean = true

changedOnly

changedOnly: object

changedOnly.state

state: boolean = true

current

current: object

current.state

state: boolean = true

customSearch

customSearch: object

customSearch.state

state: boolean = true

message

message: object

message.state

state: boolean = true

query

query: object

query.state

state: boolean = true

revision

revision: object

revision.state

state: boolean = true

searchError

searchError: object

searchError.state

state: boolean = true

siteError

siteError: object

siteError.state

state: boolean = true

Nocollapse

Overrides

LitElement.properties