Class Admin

Implements

IExtender<AdminApplication>

Index

Constructors

Properties

customPage generalIndexes permissions settings

Methods

customSetting extend generalIndexItems page permission setting

Constructors

constructor

new Admin(): Admin
Returns Admin

Properties

`Protected`customPage

customPage: CustomExtensionPage<ExtensionPageAttrs> | null = null

`Protected`generalIndexes

generalIndexes: {
permissions?: () => GeneralIndexItem[];
settings?: () => GeneralIndexItem[];
} = {}

`Protected`permissions

permissions: {
    permission: () => PermissionConfig | null;
    priority: number;
    type: PermissionType;
}[] = []

`Protected`settings

settings: {
    customSetting?: () => Children;
    priority: number;
    setting?: () => SettingConfigInternal | null;
}[] = []

Methods

customSetting

customSetting(setting: () => Children, priority?: number): Admin
Register a custom setting to be shown on the extension's settings page.
Parameters
- setting: () => Children
- priority: number = 0
Returns Admin
- Defined in flarum/framework/core/js/src/common/extenders/Admin.ts:26

extend

extend(app: AdminApplication, extension: IExtensionModule): void
Parameters
- app: AdminApplication
- extension: IExtensionModule
Returns void
Implementation of IExtender.extend
- Defined in flarum/framework/core/js/src/common/extenders/Admin.ts:59

generalIndexItems

generalIndexItems(
type: "settings" | "permissions",
items: () => GeneralIndexItem[],
): Admin
Register a custom general search index entry.
Parameters
- type: "settings" | "permissions"
- items: () => GeneralIndexItem[]
Returns Admin
- Defined in flarum/framework/core/js/src/common/extenders/Admin.ts:53

page

page(page: CustomExtensionPage): Admin
Register a custom page to be shown in the admin interface.
Parameters
- page: CustomExtensionPage
Returns Admin
- Defined in flarum/framework/core/js/src/common/extenders/Admin.ts:44

permission

permission(
    permission: () => PermissionConfig | null,
    type: PermissionType,
    priority?: number,
): Admin
Register a permission to be shown on the extension's permissions page.
Parameters
- permission: () => PermissionConfig | null
- type: PermissionType
- priority: number = 0
Returns Admin
- Defined in flarum/framework/core/js/src/common/extenders/Admin.ts:35

setting

setting(setting: () => SettingConfigInternal | null, priority?: number): Admin
Register a setting to be shown on the extension's settings page.
Parameters
- setting: () => SettingConfigInternal | null
- priority: number = 0
Returns Admin
- Defined in flarum/framework/core/js/src/common/extenders/Admin.ts:17