Options
All
  • Public
  • Public/Protected
  • All
Menu

The App class provides a container for an application, as well as various utilities for the rest of the app to use.

Hierarchy

Index

Constructors

constructor

Properties

Private _title

_title: string = ''

Private _titleCount

_titleCount: number = 0

alerts

alerts: AlertManagerState = ...

An object that manages the state of active alerts.

booted

booted: boolean = false

Whether or not the app has been booted.

cache

cache: Record<string, unknown> = {}

A local cache that can be used to store data at the application level, so that is persists between different routes.

current

current: PageState = ...

The page the app is currently on.

This object holds information about the type of page we are currently visiting, and sometimes additional arbitrary page state that may be relevant to lower-level components.

data

drawer

drawer: Drawer

An object that manages the state of the navigation drawer.

forum

forum: Forum

The forum model for this application.

history

history: null | IHistory = null

initialRoute

initialRoute: string

initializers

initializers: ItemList<(app: Application) => void> = ...

An ordered list of initializers to bootstrap the application.

modal

modal: ModalManagerState = ...

An object that manages modal state.

pane

pane: any = null

previous

previous: PageState = ...

The page the app was on before the current page.

Once the application navigates to another page, the object previously assigned to this.current will be moved to this.previous, while this.current is re-initialized.

Private requestErrorAlert

requestErrorAlert: null | number = null

The key for an Alert that was shown as a result of an AJAX request error. If present, it will be dismissed on the next successful request.

routes

routes: Record<string, FlarumGenericRoute> = {}

A map of routes, keyed by a unique route name. Each route is an object containing the following properties:

  • path The path that the route is accessed at.
  • component The Mithril component to render when this route is active.
example

app.routes.discussion = { path: '/d/:id', component: DiscussionPage };

session

session: Session

The app's session.

Stores info about the current user.

store

store: Store = ...

The app's data store.

translator

translator: Translator = ...

The app's translator.

Accessors

Private title

  • get title(): string
  • set title(val: string): void

Private titleCount

  • get titleCount(): number
  • set titleCount(val: number): void

Methods

boot

  • boot(): void

bootExtensions

  • bootExtensions(extensions: Record<string, { extend?: unknown[] }>): void

load

Protected mount

  • mount(basePath?: string): void

preloadedApiDocument

request

Protected requestErrorCatch

Protected requestErrorDefaultHandler

  • requestErrorDefaultHandler(e: unknown, isDebug: boolean, formattedErrors: string[]): void

route

  • route(name: string, params?: Record<string, unknown>): string
  • Construct a URL to the route with the given name.

    Parameters

    • name: string
    • params: Record<string, unknown> = {}

    Returns string

screen

setTitle

  • setTitle(title: string): void

setTitleCount

  • setTitleCount(count: number): void
  • Set a number to display in the <title> of the page.

    Parameters

    • count: number

      Number to display in title

    Returns void

Private showDebug

  • showDebug(error: RequestError<string>, formattedError: string[]): void

Protected transformRequestOptions

updateTitle

  • updateTitle(): void

Generated using TypeDoc version 0.22.10