Options
All
  • Public
  • Public/Protected
  • All
Menu

Module src/admin

Index

References

Namespaces

Classes

Interfaces

Type aliases

Properties

Variables

Functions

Type literals

References

app

Re-exports app

Type aliases

Extension

Extension: { description?: string; extra: { flarum-extension: { title: string } }; icon?: { name: string }; id: string; links: { authors?: { link?: string; name?: string }[]; discuss?: string; documentation?: string; donate?: string; source?: string; support?: string; website?: string }; name: string; version: string }

Type declaration

  • Optional description?: string
  • extra: { flarum-extension: { title: string } }
    • flarum-extension: { title: string }
      • title: string
  • Optional icon?: { name: string }
    • name: string
  • id: string
  • links: { authors?: { link?: string; name?: string }[]; discuss?: string; documentation?: string; donate?: string; source?: string; support?: string; website?: string }
    • Optional authors?: { link?: string; name?: string }[]
    • Optional discuss?: string
    • Optional documentation?: string
    • Optional donate?: string
    • Optional source?: string
    • Optional support?: string
    • Optional website?: string
  • name: string
  • version: string

Properties

default

default: { Application: typeof Application; Component: typeof Component; Fragment: typeof Fragment; Model: typeof Model; Session: typeof Session; Store: typeof Store; Translator: typeof Translator; components/Alert: typeof Alert; components/AlertManager: typeof AlertManager; components/Badge: typeof Badge; components/Button: typeof Button; components/Checkbox: typeof Checkbox; components/ColorPreviewInput: typeof ColorPreviewInput; components/Dropdown: typeof Dropdown; components/EditUserModal: typeof EditUserModal; components/FieldSet: typeof FieldSet; components/GroupBadge: typeof GroupBadge; components/Link: typeof Link; components/LinkButton: typeof LinkButton; components/LoadingIndicator: typeof LoadingIndicator; components/Modal: typeof Modal; components/ModalManager: typeof ModalManager; components/Navigation: typeof Navigation; components/Page: typeof Page; components/Placeholder: typeof Placeholder; components/RequestErrorModal: typeof RequestErrorModal; components/Select: typeof Select; components/SelectDropdown: typeof SelectDropdown; components/Separator: typeof Separator; components/SplitDropdown: typeof SplitDropdown; components/Switch: typeof Switch; components/TextEditor: typeof TextEditor; components/TextEditorButton: typeof TextEditorButton; components/Tooltip: typeof Tooltip; extend: any; helpers/avatar: (user: null | User, attrs?: ComponentAttrs) => Mithril.Vnode; helpers/fullTime: (time: Date) => Mithril.Vnode; helpers/highlight: (string: string, phrase?: string | RegExp, length?: number) => Mithril.Vnode<any, any> | string; helpers/humanTime: (time: Date) => Mithril.Vnode; helpers/icon: (fontClass: string, attrs?: Attributes) => Mithril.Vnode; helpers/listItems: <Attrs>(rawItems: ModdedChildrenWithItemName[], customTag?: VnodeElementTag<Attrs, Component<Attrs, {}>>, attributes?: Attrs) => Mithril.Vnode[]; helpers/punctuateSeries: (items: Children[]) => Children; helpers/userOnline: (user: User) => Mithril.Vnode<{}, {}> | null; helpers/username: (user: undefined | null | false | User) => Mithril.Vnode; models/Discussion: typeof Discussion; models/Forum: typeof Forum; models/Group: typeof Group; models/Notification: typeof Notification; models/Post: typeof Post; models/User: typeof User; resolvers/DefaultResolver: typeof DefaultResolver; states/PaginatedListState: typeof PaginatedListState; utils/BasicEditorDriver: typeof BasicEditorDriver; utils/Drawer: typeof Drawer; utils/ItemList: typeof ItemList; utils/RequestError: typeof RequestError; utils/ScrollListener: typeof ScrollListener; utils/Stream: typeof Stream; utils/SubtreeRetainer: typeof SubtreeRetainer; utils/abbreviateNumber: (number: number) => string; utils/anchorScroll: (element: string | HTMLElement | Element | SVGElement, callback: () => void) => void; utils/classList: (...inputs: ClassValue[]) => string; utils/computed: <T, M>(...args: [...string[], (...args: unknown[]) => T]) => () => T; utils/escapeRegExp: (input: string) => string; utils/evented: { handlers: Record<string, unknown>; getHandlers: any; off: any; on: any; one: any; trigger: any }; utils/extract: <T, K>(object: T, property: K) => T[K]; utils/extractText: (vdom: Children) => string; utils/focusTrap: __module; utils/formatNumber: (number: number, locale?: string) => string; utils/humanTime: (time: undefined | null | string | number | Date | Dayjs) => string; utils/insertText: (textarea: HTMLTextAreaElement, __namedParameters: SelectionRange) => void; utils/isDark: (hexcolor: String) => boolean; utils/isObject: (obj: unknown) => obj is object; utils/liveHumanTimes: () => void; utils/mapRoutes: (routes: Record<string, FlarumGenericRoute>, basePath?: string) => Record<string, RouteResolver<Record<string, unknown>, Component<{ routeName: string }, undefined>, Record<string, unknown>>>; utils/mixin: (Parent: object, ...mixins: Record<string, any>[]) => object; utils/patchMithril: (global: any) => void; utils/proxifyCompat: (compat: Record<string, unknown>, namespace: string) => Record<string, unknown>; utils/setRouteWithForcedRefresh: (route: string, params?: null, options?: RouteOptions) => void; utils/string: __module; utils/stringToColor: (string: string) => string; utils/styleSelectedText: (textarea: HTMLTextAreaElement, styleArgs: StyleArgs) => void; utils/subclassOf: (A: any, B: any) => any; utils/throttleDebounce: __module; utils/withAttr: (key: string, cb: Function) => () => void } & { AdminApplication: typeof AdminApplication; components/AdminHeader: typeof AdminHeader; components/AdminNav: typeof AdminNav; components/AdminPage: typeof AdminPage; components/AppearancePage: typeof AppearancePage; components/BasicsPage: typeof BasicsPage; components/DashboardPage: typeof DashboardPage; components/DashboardWidget: typeof DashboardWidget; components/EditCustomCssModal: typeof EditCustomCssModal; components/EditCustomFooterModal: typeof EditCustomFooterModal; components/EditCustomHeaderModal: typeof EditCustomHeaderModal; components/EditGroupModal: typeof EditGroupModal; components/ExtensionLinkButton: typeof ExtensionLinkButton; components/ExtensionPage: typeof ExtensionPage; components/ExtensionPermissionGrid: typeof ExtensionPermissionGrid; components/ExtensionsWidget: typeof ExtensionsWidget; components/HeaderPrimary: typeof HeaderPrimary; components/HeaderSecondary: typeof HeaderSecondary; components/LoadingModal: typeof LoadingModal; components/MailPage: typeof MailPage; components/PermissionDropdown: typeof PermissionDropdown; components/PermissionGrid: typeof PermissionGrid; components/PermissionsPage: typeof PermissionsPage; components/SessionDropdown: typeof SessionDropdown; components/SettingDropdown: typeof SettingDropdown; components/SettingsModal: typeof SettingsModal; components/StatusWidget: typeof StatusWidget; components/UploadImageButton: typeof UploadImageButton; components/UserListPage: typeof UserListPage; routes: (app: AdminApplication) => void; utils/ExtensionData: typeof ExtensionData; utils/generateElementId: (size?: number) => string; utils/getCategorizedExtensions: () => {}; utils/isExtensionEnabled: (name: any) => any; utils/saveSettings: (settings: any) => Promise<any> }

Variables

app

app: AdminApplication = ...

compat

compat: Record<string, unknown> = ...

Functions

default

Type literals

__type

__type

Application

Application: typeof Application = Application

Component

Component: typeof Component = Component

Fragment

Fragment: typeof Fragment = Fragment

Model

Model: typeof Model = Model

Session

Session: typeof Session = Session

Store

Store: typeof Store = Store

Translator

Translator: typeof Translator = Translator

components/Alert

components/Alert: typeof Alert = Alert

components/AlertManager

components/AlertManager: typeof AlertManager = AlertManager

components/Badge

components/Badge: typeof Badge = Badge

components/Button

components/Button: typeof Button = Button

components/Checkbox

components/Checkbox: typeof Checkbox = Checkbox

components/ColorPreviewInput

components/ColorPreviewInput: typeof ColorPreviewInput = ColorPreviewInput

components/Dropdown

components/Dropdown: typeof Dropdown = Dropdown

components/EditUserModal

components/EditUserModal: typeof EditUserModal = EditUserModal

components/FieldSet

components/FieldSet: typeof FieldSet = FieldSet

components/GroupBadge

components/GroupBadge: typeof GroupBadge = GroupBadge

components/Link

components/Link: typeof Link = Link

components/LinkButton

components/LinkButton: typeof LinkButton = LinkButton

components/LoadingIndicator

components/LoadingIndicator: typeof LoadingIndicator = LoadingIndicator

components/Modal

components/Modal: typeof Modal = Modal

components/ModalManager

components/ModalManager: typeof ModalManager = ModalManager

components/Navigation

components/Navigation: typeof Navigation = Navigation

components/Page

components/Page: typeof Page = Page

components/Placeholder

components/Placeholder: typeof Placeholder = Placeholder

components/RequestErrorModal

components/RequestErrorModal: typeof RequestErrorModal = RequestErrorModal

components/Select

components/Select: typeof Select = Select

components/SelectDropdown

components/SelectDropdown: typeof SelectDropdown = SelectDropdown

components/Separator

components/Separator: typeof Separator = Separator

components/SplitDropdown

components/SplitDropdown: typeof SplitDropdown = SplitDropdown

components/Switch

components/Switch: typeof Switch = Switch

components/TextEditor

components/TextEditor: typeof TextEditor = TextEditor

components/TextEditorButton

components/TextEditorButton: typeof TextEditorButton = TextEditorButton

components/Tooltip

components/Tooltip: typeof Tooltip = Tooltip

extend

extend: any = extend

helpers/avatar

helpers/avatar: (user: null | User, attrs?: ComponentAttrs) => Mithril.Vnode = avatar

Type declaration

    • The avatar helper displays a user's avatar.

      Parameters

      Returns Mithril.Vnode

helpers/fullTime

helpers/fullTime: (time: Date) => Mithril.Vnode = fullTime

Type declaration

    • (time: Date): Mithril.Vnode
    • The fullTime helper displays a formatted time string wrapped in a

      Parameters

      Returns Mithril.Vnode

helpers/highlight

helpers/highlight: (string: string, phrase?: string | RegExp, length?: number) => Mithril.Vnode<any, any> | string = highlight

Type declaration

    • (string: string, phrase?: string | RegExp, length?: number): Mithril.Vnode<any, any> | string
    • The highlight helper searches for a word phrase in a string, and wraps matches with the tag.

      Parameters

      • string: string

        The string to highlight.

      • Optional phrase: string | RegExp

        The word or words to highlight.

      • Optional length: number

      Returns Mithril.Vnode<any, any> | string

helpers/humanTime

helpers/humanTime: (time: Date) => Mithril.Vnode = humanTimeHelper

Type declaration

    • (time: Date): Mithril.Vnode
    • The humanTime helper displays a time in a human-friendly time-ago format (e.g. '12 days ago'), wrapped in a

      Parameters

      Returns Mithril.Vnode

helpers/icon

helpers/icon: (fontClass: string, attrs?: Attributes) => Mithril.Vnode = icon

Type declaration

    • (fontClass: string, attrs?: Attributes): Mithril.Vnode
    • The icon helper displays an icon.

      Parameters

      • fontClass: string

        The full icon class, prefix and the icon’s name.

      • attrs: Attributes = {}

        Any other attributes to apply.

      Returns Mithril.Vnode

helpers/listItems

helpers/listItems: <Attrs>(rawItems: ModdedChildrenWithItemName[], customTag?: VnodeElementTag<Attrs, Component<Attrs, {}>>, attributes?: Attrs) => Mithril.Vnode[] = listItems

Type declaration

    • The listItems helper wraps an array of components in the provided tag, stripping out any unnecessary Separator components.

      By default, this tag is an <li> tag, but this is customisable through the second function parameter, customTag.

      Type parameters

      Parameters

      Returns Mithril.Vnode[]

helpers/punctuateSeries

helpers/punctuateSeries: (items: Children[]) => Children = punctuateSeries

Type declaration

    • (items: Children[]): Children
    • The punctuateSeries helper formats a list of strings (e.g. names) to read fluently in the application's locale.

      punctuateSeries(['Toby', 'Franz', 'Dominion']) // Toby, Franz, and Dominion
      

      Parameters

      • items: Children[]

      Returns Children

      ')}

helpers/userOnline

helpers/userOnline: (user: User) => Mithril.Vnode<{}, {}> | null = userOnline

Type declaration

    • (user: User): Mithril.Vnode<{}, {}> | null
    • The useronline helper displays a green circle if the user is online

      Parameters

      Returns Mithril.Vnode<{}, {}> | null

helpers/username

helpers/username: (user: undefined | null | false | User) => Mithril.Vnode = username

Type declaration

    • (user: undefined | null | false | User): Mithril.Vnode
    • The username helper displays a user's username in a tag. If the user doesn't exist, the username will be displayed as [deleted].

      Parameters

      • user: undefined | null | false | User

      Returns Mithril.Vnode

models/Discussion

models/Discussion: typeof Discussion = Discussion

models/Forum

models/Forum: typeof Forum = Forum

models/Group

models/Group: typeof Group = Group

models/Notification

models/Notification: typeof Notification = Notification

models/Post

models/Post: typeof Post = Post

models/User

models/User: typeof User = User

resolvers/DefaultResolver

resolvers/DefaultResolver: typeof DefaultResolver = DefaultResolver

states/PaginatedListState

states/PaginatedListState: typeof PaginatedListState = PaginatedListState

utils/BasicEditorDriver

utils/BasicEditorDriver: typeof BasicEditorDriver = BasicEditorDriver

utils/Drawer

utils/Drawer: typeof Drawer = Drawer

utils/ItemList

utils/ItemList: typeof ItemList = ItemList

utils/RequestError

utils/RequestError: typeof RequestError = RequestError

utils/ScrollListener

utils/ScrollListener: typeof ScrollListener = ScrollListener

utils/Stream

utils/Stream: typeof Stream = Stream

utils/SubtreeRetainer

utils/SubtreeRetainer: typeof SubtreeRetainer = SubtreeRetainer

utils/abbreviateNumber

utils/abbreviateNumber: (number: number) => string = abbreviateNumber

Type declaration

    • (number: number): string
    • The abbreviateNumber utility converts a number to a shorter localized form.

      example

      abbreviateNumber(1234); // "1.2K"

      Parameters

      • number: number

      Returns string

utils/anchorScroll

utils/anchorScroll: (element: string | HTMLElement | Element | SVGElement, callback: () => void) => void = anchorScroll

Type declaration

    • The anchorScroll utility saves the scroll position relative to an element, and then restores it after a callback has been run.

      This is useful if a redraw will change the page's content above the viewport. Normally doing this will result in the content in the viewport being pushed down or pulled up. By wrapping the redraw with this utility, the scroll position can be anchor to an element that is in or below the viewport, so the content in the viewport will stay the same.

      Parameters

      • element: string | HTMLElement | Element | SVGElement

        The element to anchor the scroll position to.

      • callback: () => void

        The callback to run that will change page content.

          • (): void
          • Returns void

      Returns void

utils/classList

utils/classList: (...inputs: ClassValue[]) => string = classList

Type declaration

    • (...inputs: ClassValue[]): string
    • Parameters

      • Rest ...inputs: ClassValue[]

      Returns string

utils/computed

utils/computed: <T, M>(...args: [...string[], (...args: unknown[]) => T]) => () => T = computed

Type declaration

    • <T, M>(...args: [...string[], (...args: unknown[]) => T]): () => T
    • The computed utility creates a function that will cache its output until any of the dependent values are dirty.

      Type parameters

      Parameters

      • Rest ...args: [...string[], (...args: unknown[]) => T]

      Returns () => T

        • (): T
        • The computed utility creates a function that will cache its output until any of the dependent values are dirty.

          Returns T

utils/escapeRegExp

utils/escapeRegExp: (input: string) => string = escapeRegExp

Type declaration

utils/evented

utils/evented: { handlers: Record<string, unknown>; getHandlers: any; off: any; on: any; one: any; trigger: any } = evented

Type declaration

  • handlers: Record<string, unknown>
  • getHandlers:function
  • off:function
    • off(event: string, handler: Function): void
    • Unregister an event handler.

      deprecated

      Parameters

      • event: string

        The name of the event.

      • handler: Function

        The function that handles the event.

      Returns void

  • on:function
    • on(event: string, handler: Function): void
    • Register an event handler.

      deprecated

      Parameters

      • event: string

        The name of the event.

      • handler: Function

        The function to handle the event.

      Returns void

  • one:function
    • one(event: string, handler: Function): void
    • Register an event handler so that it will run only once, and then unregister itself.

      deprecated

      Parameters

      • event: string

        The name of the event.

      • handler: Function

        The function to handle the event.

      Returns void

  • trigger:function
    • trigger(event: string, ...args: any[]): void
    • Trigger an event.

      deprecated

      Parameters

      • event: string

        The name of the event.

      • Rest ...args: any[]

        Arguments to pass to event handlers.

      Returns void

utils/extract

utils/extract: <T, K>(object: T, property: K) => T[K] = extract

Type declaration

    • <T, K>(object: T, property: K): T[K]
    • The extract utility deletes a property from an object and returns its value.

      Type parameters

      • T

      • K: string | number | symbol

      Parameters

      • object: T

        The object that owns the property

      • property: K

        The name of the property to extract

      Returns T[K]

      The value of the property

utils/extractText

utils/extractText: (vdom: Children) => string = extractText

Type declaration

    • (vdom: Children): string
    • Extract the text nodes from a virtual element.

      Parameters

      • vdom: Children

      Returns string

utils/focusTrap

utils/focusTrap: __module = FocusTrap

utils/formatNumber

utils/formatNumber: (number: number, locale?: string) => string = formatNumber

Type declaration

    • (number: number, locale?: string): string
    • The formatNumber utility localizes a number into a string with the appropriate punctuation based on the provided locale otherwise will default to the users locale.

      example

      formatNumber(1234); // 1,234

      Parameters

      • number: number
      • locale: string = app.data.locale

      Returns string

utils/humanTime

utils/humanTime: (time: undefined | null | string | number | Date | Dayjs) => string = humanTime

Type declaration

    • (time: undefined | null | string | number | Date | Dayjs): string
    • The humanTime utility converts a date to a localized, human-readable time- ago string.

      Parameters

      • time: undefined | null | string | number | Date | Dayjs

      Returns string

utils/insertText

utils/insertText: (textarea: HTMLTextAreaElement, __namedParameters: SelectionRange) => void = insertText

Type declaration

utils/isDark

utils/isDark: (hexcolor: String) => boolean = isDark

Type declaration

    • The isDark utility converts a hex color to rgb, and then calcul a YIQ value in order to get the appropriate brightness value (is it dark or is it light?) See https://www.w3.org/TR/AERT/#color-contrast for references. A YIQ value >= 128 is a light color.

      Parameters

      Returns boolean

utils/isObject

utils/isObject: (obj: unknown) => obj is object = isObject

Type declaration

    • (obj: unknown): obj is object
    • Returns if the passed value is an object.

      In this context, "object" refers to any non-primitive value, including arrays, function, maps, dates, and more.

      example

      isObject({}); // true

      example

      isObject([]); // true

      example

      isObject(function () {}); // true

      example

      isObject(Object(1)); // true

      example

      isObject(null); // false

      example

      isObject(1); // false

      example

      isObject("hello world"); // false

      see

      https://github.com/jashkenas/underscore/blob/943977e34e2279503528a71ddcc2dd5f96483945/underscore.js#L87-L91

      Parameters

      • obj: unknown

      Returns obj is object

utils/liveHumanTimes

utils/liveHumanTimes: () => void = liveHumanTimes

Type declaration

    • (): void
    • The liveHumanTimes initializer sets up a loop every 1 second to update timestamps rendered with the humanTime helper.

      Returns void

utils/mapRoutes

utils/mapRoutes: (routes: Record<string, FlarumGenericRoute>, basePath?: string) => Record<string, RouteResolver<Record<string, unknown>, Component<{ routeName: string }, undefined>, Record<string, unknown>>> = mapRoutes

Type declaration

    • The mapRoutes utility converts a map of named application routes into a format that can be understood by Mithril, and wraps them in route resolvers to provide each route with the current route name.

      see

      https://mithril.js.org/route.html#signature

      Parameters

      Returns Record<string, RouteResolver<Record<string, unknown>, Component<{ routeName: string }, undefined>, Record<string, unknown>>>

utils/mixin

utils/mixin: (Parent: object, ...mixins: Record<string, any>[]) => object = mixin

Type declaration

    • (Parent: object, ...mixins: Record<string, any>[]): object
    • The mixin utility assigns the properties of a set of 'mixin' objects to the prototype of a parent object.

      example

      class MyClass extends mixin(ExistingClass, evented, etc) {}

      Parameters

      • Parent: object

        The class to extend the new class from.

      • Rest ...mixins: Record<string, any>[]

        The objects to mix in.

      Returns object

      A new class that extends Parent and contains the mixins.

utils/patchMithril

utils/patchMithril: (global: any) => void = patchMithril

Type declaration

    • (global: any): void
    • Parameters

      • global: any

      Returns void

utils/proxifyCompat

utils/proxifyCompat: (compat: Record<string, unknown>, namespace: string) => Record<string, unknown> = proxifyCompat

Type declaration

    • (compat: Record<string, unknown>, namespace: string): Record<string, unknown>
    • Parameters

      • compat: Record<string, unknown>
      • namespace: string

      Returns Record<string, unknown>

utils/setRouteWithForcedRefresh

utils/setRouteWithForcedRefresh: (route: string, params?: null, options?: RouteOptions) => void = setRouteWithForcedRefresh

Type declaration

    • (route: string, params?: null, options?: RouteOptions): void
    • Mithril 2 does not completely rerender the page if a route change leads to the same route (or the same component handling a different route). This util calls m.route.set, forcing a reonit.

      see

      https://mithril.js.org/route.html#key-parameter

      Parameters

      • route: string
      • params: null = null
      • options: RouteOptions = {}

      Returns void

utils/string

utils/string: __module = string

utils/stringToColor

utils/stringToColor: (string: string) => string = stringToColor

Type declaration

    • (string: string): string
    • Convert the given string to a unique color.

      Parameters

      • string: string

      Returns string

utils/styleSelectedText

utils/styleSelectedText: (textarea: HTMLTextAreaElement, styleArgs: StyleArgs) => void = styleSelectedText

Type declaration

utils/subclassOf

utils/subclassOf: (A: any, B: any) => any = subclassOf

Type declaration

    • (A: any, B: any): any
    • Check if class A is the same as or a subclass of class B.

      Parameters

      • A: any
      • B: any

      Returns any

utils/throttleDebounce

utils/throttleDebounce: __module = ThrottleDebounce

utils/withAttr

utils/withAttr: (key: string, cb: Function) => () => void = withAttr

Type declaration

__type

__type

AdminApplication

AdminApplication: typeof AdminApplication = AdminApplication

components/AdminHeader

components/AdminHeader: typeof AdminHeader = AdminHeader

components/AdminNav

components/AdminNav: typeof AdminNav = AdminNav

components/AdminPage

components/AdminPage: typeof AdminPage = AdminPage

components/AppearancePage

components/AppearancePage: typeof AppearancePage = AppearancePage

components/BasicsPage

components/BasicsPage: typeof BasicsPage = BasicsPage

components/DashboardPage

components/DashboardPage: typeof DashboardPage = DashboardPage

components/DashboardWidget

components/DashboardWidget: typeof DashboardWidget = DashboardWidget

components/EditCustomCssModal

components/EditCustomCssModal: typeof EditCustomCssModal = EditCustomCssModal

components/EditCustomFooterModal

components/EditCustomFooterModal: typeof EditCustomFooterModal = EditCustomFooterModal

components/EditCustomHeaderModal

components/EditCustomHeaderModal: typeof EditCustomHeaderModal = EditCustomHeaderModal

components/EditGroupModal

components/EditGroupModal: typeof EditGroupModal = EditGroupModal

components/ExtensionLinkButton

components/ExtensionLinkButton: typeof ExtensionLinkButton = ExtensionLinkButton

components/ExtensionPage

components/ExtensionPage: typeof ExtensionPage = ExtensionPage

components/ExtensionPermissionGrid

components/ExtensionPermissionGrid: typeof ExtensionPermissionGrid = ExtensionPermissionGrid

components/ExtensionsWidget

components/ExtensionsWidget: typeof ExtensionsWidget = ExtensionsWidget

components/HeaderPrimary

components/HeaderPrimary: typeof HeaderPrimary = HeaderPrimary

components/HeaderSecondary

components/HeaderSecondary: typeof HeaderSecondary = HeaderSecondary

components/LoadingModal

components/LoadingModal: typeof LoadingModal = LoadingModal

components/MailPage

components/MailPage: typeof MailPage = MailPage

components/PermissionDropdown

components/PermissionDropdown: typeof PermissionDropdown = PermissionDropdown

components/PermissionGrid

components/PermissionGrid: typeof PermissionGrid = PermissionGrid

components/PermissionsPage

components/PermissionsPage: typeof PermissionsPage = PermissionsPage

components/SessionDropdown

components/SessionDropdown: typeof SessionDropdown = SessionDropdown

components/SettingDropdown

components/SettingDropdown: typeof SettingDropdown = SettingDropdown

components/SettingsModal

components/SettingsModal: typeof SettingsModal = SettingsModal

components/StatusWidget

components/StatusWidget: typeof StatusWidget = StatusWidget

components/UploadImageButton

components/UploadImageButton: typeof UploadImageButton = UploadImageButton

components/UserListPage

components/UserListPage: typeof UserListPage = UserListPage

routes

routes: (app: AdminApplication) => void = routes

Type declaration

utils/ExtensionData

utils/ExtensionData: typeof ExtensionData = ExtensionData

utils/generateElementId

utils/generateElementId: (size?: number) => string = generateElementId

Type declaration

    • (size?: number): string
    • Generate secure URL-friendly unique ID.

      By default, the ID will have 21 symbols to have a collision probability similar to UUID v4.

      import { nanoid } from 'nanoid'
      model.id = nanoid() //=> "Uakgb_J5m9g-0JDMbcJqL"

      Parameters

      • Optional size: number

        Size of the ID. The default size is 21.

      Returns string

      A random string.

utils/getCategorizedExtensions

utils/getCategorizedExtensions: () => {} = getCategorizedExtensions

Type declaration

    • (): {}
    • Returns {}

    utils/isExtensionEnabled

    utils/isExtensionEnabled: (name: any) => any = isExtensionEnabled

    Type declaration

      • (name: any): any
      • Parameters

        • name: any

        Returns any

    utils/saveSettings

    utils/saveSettings: (settings: any) => Promise<any> = saveSettings

    Type declaration

      • Parameters

        • settings: any

        Returns Promise<any>

    Generated using TypeDoc version 0.22.10