mirror/php-flarum
1
0
Fork 0
mirror of https://github.com/flarum/core.git synced 2025-08-06 08:27:42 +02:00
Code Issues Releases Wiki Activity

feat: add Admin.generalIndexItems extender (#4068)

Browse Source 
* feat: add `Admin.generalIndexItems` extender
* docs
This commit is contained in:
Sami Mazouz
2024-10-12 14:37:10 +01:00
committed by GitHub
parent 77f3685033
commit f83020cd1f
3 changed files with 65 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
framework/core/js/src/admin/states/GeneralSearchIndex.ts
View File

@@ -1,9 +1,28 @@
export type GeneralIndexItem = {
/**
* The unique identifier for this index item.
*/
id: string;
/**
* Optional: The tree path to this item, used for grouping in the search results.
*/
tree?: string[];
/**
* The label to display in the search results.
*/
label: string;
/**
* Optional: The description to display in the search results.
*/
help?: string;
/**
* Optional: The URL to navigate to when this item is selected.
* The default is to navigate to the extension page.
*/
link?: string;
/**
* Optional: A callback that returns a boolean indicating whether this item should be visible in the search results.
*/
visible?: () => boolean;
};

25
framework/core/js/src/common/extenders/Admin.ts
View File

@@ -2,12 +2,14 @@ import IExtender, { IExtensionModule } from './IExtender';
import type AdminApplication from '../../admin/AdminApplication';
import type { CustomExtensionPage, SettingConfigInternal } from '../../admin/utils/AdminRegistry';
import type { PermissionConfig, PermissionType } from '../../admin/components/PermissionGrid';
import Mithril from 'mithril';
import type Mithril from 'mithril';
import type { GeneralIndexItem } from '../../admin/states/GeneralSearchIndex';
export default class Admin implements IExtender<AdminApplication> {
protected settings: { setting?: () => SettingConfigInternal; customSetting?: () => Mithril.Children; priority: number }[] = [];
protected permissions: { permission: () => PermissionConfig; type: PermissionType; priority: number }[] = [];
protected customPage: CustomExtensionPage | null = null;
protected generalIndexes: { settings?: () => GeneralIndexItem[]; permissions?: () => GeneralIndexItem[] } = {};
/**
* Register a setting to be shown on the extension's settings page.
@@ -45,6 +47,15 @@ export default class Admin implements IExtender<AdminApplication> {
return this;
}
/**
* Register a custom general search index entry.
*/
generalIndexItems(type: 'settings' | 'permissions', items: () => GeneralIndexItem[]) {
this.generalIndexes[type] = items;
return this;
}
extend(app: AdminApplication, extension: IExtensionModule) {
app.registry.for(extension.name);
@@ -59,5 +70,17 @@ export default class Admin implements IExtender<AdminApplication> {
if (this.customPage) {
app.registry.registerPage(this.customPage);
}
app.generalIndex.for(extension.name);
Object.keys(this.generalIndexes).forEach((key) => {
if (key !== 'settings' && key !== 'permissions') return;
const callback = this.generalIndexes[key];
if (callback) {
app.generalIndex.add(key, callback());
}
});
}
}