diff --git a/framework/core/js/src/common/components/Input.tsx b/framework/core/js/src/common/components/Input.tsx
index 886a54cf25..a09348bdf4 100644
--- a/framework/core/js/src/common/components/Input.tsx
+++ b/framework/core/js/src/common/components/Input.tsx
@@ -1,4 +1,4 @@
-import app from '../../forum/app';
+import app from '../../common/app';
import Component from '../Component';
import Icon from './Icon';
import LoadingIndicator from './LoadingIndicator';
diff --git a/framework/core/js/src/forum/components/SearchModal.tsx b/framework/core/js/src/common/components/SearchModal.tsx
similarity index 90%
rename from framework/core/js/src/forum/components/SearchModal.tsx
rename to framework/core/js/src/common/components/SearchModal.tsx
index 6d0313477f..0fdafa3de3 100644
--- a/framework/core/js/src/forum/components/SearchModal.tsx
+++ b/framework/core/js/src/common/components/SearchModal.tsx
@@ -1,20 +1,20 @@
import app from '../app';
-import type { IFormModalAttrs } from '../../common/components/FormModal';
-import FormModal from '../../common/components/FormModal';
+import type { IFormModalAttrs } from './FormModal';
+import FormModal from './FormModal';
import type Mithril from 'mithril';
-import type SearchState from '../../common/states/SearchState';
-import KeyboardNavigatable from '../../common/utils/KeyboardNavigatable';
-import SearchManager from '../../common/SearchManager';
-import extractText from '../../common/utils/extractText';
-import Input from '../../common/components/Input';
-import Button from '../../common/components/Button';
-import Stream from '../../common/utils/Stream';
-import InfoTile from '../../common/components/InfoTile';
-import LoadingIndicator from '../../common/components/LoadingIndicator';
-import type { SearchSource } from './Search';
-import type IGambit from '../../common/query/IGambit';
-import ItemList from '../../common/utils/ItemList';
-import GambitsAutocomplete from '../../common/utils/GambitsAutocomplete';
+import type SearchState from '../states/SearchState';
+import KeyboardNavigatable from '../utils/KeyboardNavigatable';
+import SearchManager from '../SearchManager';
+import extractText from '../utils/extractText';
+import Input from './Input';
+import Button from './Button';
+import Stream from '../utils/Stream';
+import InfoTile from './InfoTile';
+import LoadingIndicator from './LoadingIndicator';
+import type IGambit from '../query/IGambit';
+import ItemList from '../utils/ItemList';
+import GambitsAutocomplete from '../utils/GambitsAutocomplete';
+import type { SearchSource } from './AbstractSearch';
export interface ISearchModalAttrs extends IFormModalAttrs {
onchange: (value: string) => void;
@@ -72,7 +72,7 @@ export default class SearchModal
this.search(value)
);
- const searchLabel = extractText(app.translator.trans('core.forum.search.placeholder'));
+ const searchLabel = extractText(app.translator.trans('core.lib.search.placeholder'));
return (
@@ -97,7 +97,7 @@ export default class SearchModal
- - {app.translator.trans('core.forum.search.options_heading')}
+ - {app.translator.trans('core.lib.search.options_heading')}
{gambits}
- - {app.translator.trans('core.forum.search.preview_heading')}
+ {!customGrouping && - {app.translator.trans('core.lib.search.preview_heading')}
}
{!shouldShowResults && (
-
- {app.translator.trans('core.forum.search.no_search_text')}
+ {app.translator.trans('core.lib.search.no_search_text')}
)}
{shouldShowResults && results}
{shouldShowResults && !results?.length && (
-
- {app.translator.trans('core.forum.search.no_results_text')}
+ {app.translator.trans('core.lib.search.no_results_text')}
)}
{loading && (
diff --git a/framework/core/js/src/common/extenders/Admin.ts b/framework/core/js/src/common/extenders/Admin.ts
new file mode 100644
index 0000000000..e53b89837f
--- /dev/null
+++ b/framework/core/js/src/common/extenders/Admin.ts
@@ -0,0 +1,63 @@
+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';
+
+export default class Admin implements IExtender {
+ protected settings: { setting?: () => SettingConfigInternal; customSetting?: () => Mithril.Children; priority: number }[] = [];
+ protected permissions: { permission: () => PermissionConfig; type: PermissionType; priority: number }[] = [];
+ protected customPage: CustomExtensionPage | null = null;
+
+ /**
+ * Register a setting to be shown on the extension's settings page.
+ */
+ setting(setting: () => SettingConfigInternal, priority = 0) {
+ this.settings.push({ setting, priority });
+
+ return this;
+ }
+
+ /**
+ * Register a custom setting to be shown on the extension's settings page.
+ */
+ customSetting(setting: () => Mithril.Children, priority = 0) {
+ this.settings.push({ customSetting: setting, priority });
+
+ return this;
+ }
+
+ /**
+ * Register a permission to be shown on the extension's permissions page.
+ */
+ permission(permission: () => PermissionConfig, type: PermissionType, priority = 0) {
+ this.permissions.push({ permission, type, priority });
+
+ return this;
+ }
+
+ /**
+ * Register a custom page to be shown in the admin interface.
+ */
+ page(page: CustomExtensionPage) {
+ this.customPage = page;
+
+ return this;
+ }
+
+ extend(app: AdminApplication, extension: IExtensionModule) {
+ app.registry.for(extension.name);
+
+ this.settings.forEach(({ setting, customSetting, priority }) => {
+ app.registry.registerSetting(setting ? setting() : customSetting!, priority);
+ });
+
+ this.permissions.forEach(({ permission, type, priority }) => {
+ app.registry.registerPermission(permission(), type, priority);
+ });
+
+ if (this.customPage) {
+ app.registry.registerPage(this.customPage);
+ }
+ }
+}
diff --git a/framework/core/js/src/common/extenders/Notification.ts b/framework/core/js/src/common/extenders/Notification.ts
index 15985f9b99..a0562f35b3 100644
--- a/framework/core/js/src/common/extenders/Notification.ts
+++ b/framework/core/js/src/common/extenders/Notification.ts
@@ -1,10 +1,9 @@
import IExtender, { IExtensionModule } from './IExtender';
import type Component from '../Component';
-import ForumApplication from '../../forum/ForumApplication';
-import type Application from '../Application';
+import type ForumApplication from '../../forum/ForumApplication';
import type { NewComponent } from '../Application';
-export default class Notification implements IExtender {
+export default class Notification implements IExtender {
private notificationComponents: Record Component> = {};
/**
@@ -19,7 +18,7 @@ export default class Notification implements IExtender {
return this;
}
- extend(app: Application, extension: IExtensionModule): void {
- Object.assign((app as unknown as ForumApplication).notificationComponents, this.notificationComponents);
+ extend(app: ForumApplication, extension: IExtensionModule): void {
+ Object.assign(app.notificationComponents, this.notificationComponents);
}
}
diff --git a/framework/core/js/src/common/extenders/PostTypes.ts b/framework/core/js/src/common/extenders/PostTypes.ts
index f361eef7e6..12cc2f9645 100644
--- a/framework/core/js/src/common/extenders/PostTypes.ts
+++ b/framework/core/js/src/common/extenders/PostTypes.ts
@@ -1,8 +1,7 @@
import IExtender, { IExtensionModule } from './IExtender';
-import Application from '../Application';
-import ForumApplication from '../../forum/ForumApplication';
+import type ForumApplication from '../../forum/ForumApplication';
-export default class PostTypes implements IExtender {
+export default class PostTypes implements IExtender {
private postComponents: Record = {};
/**
@@ -18,7 +17,7 @@ export default class PostTypes implements IExtender {
return this;
}
- extend(app: Application, extension: IExtensionModule): void {
- Object.assign((app as unknown as ForumApplication).postComponents, this.postComponents);
+ extend(app: ForumApplication, extension: IExtensionModule): void {
+ Object.assign(app.postComponents, this.postComponents);
}
}
diff --git a/framework/core/js/src/common/extenders/index.ts b/framework/core/js/src/common/extenders/index.ts
index f776f6f711..417dcf524f 100644
--- a/framework/core/js/src/common/extenders/index.ts
+++ b/framework/core/js/src/common/extenders/index.ts
@@ -5,6 +5,7 @@ import Store from './Store';
import Search from './Search';
import Notification from './Notification';
import ThemeMode from './ThemeMode';
+import Admin from './Admin';
const extenders = {
Model,
@@ -14,6 +15,7 @@ const extenders = {
Search,
Notification,
ThemeMode,
+ Admin,
};
export default extenders;
diff --git a/framework/core/js/src/forum/components/DiscussionsSearchSource.tsx b/framework/core/js/src/forum/components/DiscussionsSearchSource.tsx
index 478bcf7869..957bcc3607 100644
--- a/framework/core/js/src/forum/components/DiscussionsSearchSource.tsx
+++ b/framework/core/js/src/forum/components/DiscussionsSearchSource.tsx
@@ -52,6 +52,10 @@ export default class DiscussionsSearchSource implements SearchSource {
}) as Array;
}
+ customGrouping(): boolean {
+ return false;
+ }
+
fullPage(query: string): Mithril.Vnode {
const filter = app.search.gambits.apply('discussions', { q: query });
const q = filter.q || null;
diff --git a/framework/core/js/src/forum/components/PostsSearchSource.tsx b/framework/core/js/src/forum/components/PostsSearchSource.tsx
index f6c44b4f63..8dc9936e8c 100644
--- a/framework/core/js/src/forum/components/PostsSearchSource.tsx
+++ b/framework/core/js/src/forum/components/PostsSearchSource.tsx
@@ -52,6 +52,10 @@ export default class PostsSearchSource implements SearchSource {
}) as Array;
}
+ customGrouping(): boolean {
+ return false;
+ }
+
fullPage(query: string): Mithril.Vnode {
const filter = app.search.gambits.apply('posts', { q: query });
const q = filter.q || null;
diff --git a/framework/core/js/src/forum/components/Search.tsx b/framework/core/js/src/forum/components/Search.tsx
index b633d6f88f..44d4a7f795 100644
--- a/framework/core/js/src/forum/components/Search.tsx
+++ b/framework/core/js/src/forum/components/Search.tsx
@@ -1,130 +1,18 @@
import app from '../../forum/app';
-import Component, { ComponentAttrs } from '../../common/Component';
-import extractText from '../../common/utils/extractText';
-import Input from '../../common/components/Input';
-import SearchState from '../../common/states/SearchState';
-import SearchModal from './SearchModal';
-import type Mithril from 'mithril';
import ItemList from '../../common/utils/ItemList';
import DiscussionsSearchSource from './DiscussionsSearchSource';
import UsersSearchSource from './UsersSearchSource';
import PostsSearchSource from './PostsSearchSource';
+import AbstractSearch, { type SearchAttrs, type SearchSource as BaseSearchSource } from '../../common/components/AbstractSearch';
-export interface SearchAttrs extends ComponentAttrs {
- /** The type of alert this is. Will be used to give the alert a class name of `Alert--{type}`. */
- state: SearchState;
-}
-
-/**
- * The `SearchSource` interface defines a section of search results in the
- * search dropdown.
- *
- * Search sources should be registered with the `Search` component class
- * by extending the `sourceItems` method. When the user types a
- * query, each search source will be prompted to load search results via the
- * `search` method. When the dropdown is redrawn, it will be constructed by
- * putting together the output from the `view` method of each source.
- */
-export interface SearchSource {
- /**
- * The resource type that this search source is responsible for.
- */
- resource: string;
-
- /**
- * Get the title for this search source.
- */
- title(): string;
-
- /**
- * Check if a query has been cached for this search source.
- */
- isCached(query: string): boolean;
-
- /**
- * Make a request to get results for the given query.
- * The results will be updated internally in the search source, not exposed.
- */
- search(query: string, limit: number): Promise;
-
- /**
- * Get an array of virtual - s that list the search results for the given
- * query.
- */
- view(query: string): Array;
-
- /**
- * Get a list item for the full search results page.
- */
- fullPage(query: string): Mithril.Vnode | null;
-
- /**
- * Get to the result item page. Only called if each list item has a data-id.
- */
- gotoItem(id: string): string | null;
-}
-
-/**
- * The `Search` component displays a menu of as-you-type results from a variety
- * of sources.
- *
- * The search box will be 'activated' if the app's search state's
- * getInitialSearch() value is a truthy value. If this is the case, an 'x'
- * button will be shown next to the search field, and clicking it will clear the search.
- *
- * ATTRS:
- *
- * - state: SearchState instance.
- */
-export default class Search extends Component {
- /**
- * The instance of `SearchState` for this component.
- */
- protected searchState!: SearchState;
-
- oninit(vnode: Mithril.Vnode) {
- super.oninit(vnode);
-
- this.searchState = this.attrs.state;
- }
-
- view() {
- // Hide the search view if no sources were loaded
- if (this.sourceItems().isEmpty()) return ;
-
- const searchLabel = extractText(app.translator.trans('core.forum.header.search_placeholder'));
+export interface SearchSource extends BaseSearchSource {}
- return (
-
- {
- if (!value) this.searchState.clear();
- else this.searchState.setValue(value);
- }}
- inputAttrs={{
- onfocus: () =>
- setTimeout(() => {
- this.$('input').blur() &&
- app.modal.show(() => import('./SearchModal'), { searchState: this.searchState, sources: this.sourceItems().toArray() });
- }, 150),
- }}
- />
-
- );
+export default class Search extends AbstractSearch {
+ static initAttrs(attrs: SearchAttrs) {
+ attrs.label = app.translator.trans('core.forum.header.search_placeholder', {}, true);
+ attrs.a11yRoleLabel = app.translator.trans('core.forum.header.search_role_label', {}, true);
}
- /**
- * A list of search sources that can be used to query for search results.
- */
sourceItems(): ItemList {
const items = new ItemList();
diff --git a/framework/core/js/src/forum/components/UsersSearchSource.tsx b/framework/core/js/src/forum/components/UsersSearchSource.tsx
index afcabad542..e4ba692bef 100644
--- a/framework/core/js/src/forum/components/UsersSearchSource.tsx
+++ b/framework/core/js/src/forum/components/UsersSearchSource.tsx
@@ -70,6 +70,10 @@ export default class UsersSearchSource implements SearchSource {
});
}
+ customGrouping(): boolean {
+ return false;
+ }
+
fullPage(query: string): null {
return null;
}
diff --git a/framework/core/less/admin.less b/framework/core/less/admin.less
index 5134e067f9..30ae52d033 100644
--- a/framework/core/less/admin.less
+++ b/framework/core/less/admin.less
@@ -16,3 +16,4 @@
@import "admin/MailPage";
@import "admin/NoJs";
@import "admin/UsersListPage";
+@import "admin/GeneralSearchResult";
diff --git a/framework/core/less/admin/GeneralSearchResult.less b/framework/core/less/admin/GeneralSearchResult.less
new file mode 100644
index 0000000000..5086121c7d
--- /dev/null
+++ b/framework/core/less/admin/GeneralSearchResult.less
@@ -0,0 +1,35 @@
+.GeneralSearchResult {
+ .ExtensionIcon {
+ --size: 32px;
+ flex-shrink: 0;
+ }
+
+ &-group {
+ border-top: none;
+ }
+
+ &-tree {
+ font-weight: bold;
+
+ &-separator {
+ color: var(--muted-more-color);
+ padding: 0 8px;
+ }
+ }
+
+ &-help {
+ overflow: hidden;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+ color: var(--muted-color);
+ font-size: 12px;
+ }
+
+ &-info {
+ overflow: hidden;
+ }
+
+ mark {
+ background-color: var(--highlight-color);
+ }
+}
diff --git a/framework/core/less/common/Form.less b/framework/core/less/common/Form.less
index 06802be484..5b84779650 100644
--- a/framework/core/less/common/Form.less
+++ b/framework/core/less/common/Form.less
@@ -66,6 +66,10 @@
}
}
+.FieldSet-label:empty {
+ display: none;
+}
+
.FieldSet--min .FieldSet-items > * {
width: auto;
}
diff --git a/framework/core/less/common/root.less b/framework/core/less/common/root.less
index 062ce1728c..f76ee6c40b 100644
--- a/framework/core/less/common/root.less
+++ b/framework/core/less/common/root.less
@@ -213,6 +213,8 @@
--hero-bg: var(--control-bg);
--hero-color: var(--control-color);
+ --highlight-color: #FFE300;
+
.light-contents-vars();
.Button--color-vars(@control-success-color, @control-success-bg, 'control-success');
diff --git a/framework/core/less/common/scaffolding.less b/framework/core/less/common/scaffolding.less
index 2270925eee..58bb3e47db 100644
--- a/framework/core/less/common/scaffolding.less
+++ b/framework/core/less/common/scaffolding.less
@@ -74,7 +74,7 @@ p {
}
mark {
- background: #FFE300;
+ background: var(--highlight-color);
padding: 1px;
border-radius: var(--border-radius);
box-shadow: 0 1px 0 rgba(0, 0, 0, 0.1);
diff --git a/framework/core/locale/core.yml b/framework/core/locale/core.yml
index db81e0a6dd..41b951ad49 100644
--- a/framework/core/locale/core.yml
+++ b/framework/core/locale/core.yml
@@ -246,6 +246,8 @@ core:
header:
get_help: Get Help
log_out_button: => core.ref.log_out
+ search_placeholder: Search...
+ search_role_label: Search
# These translations are used in the modal dialog displayed when loading extensions.
loading:
@@ -331,6 +333,11 @@ core:
signup_closed_button: Closed
signup_open_button: Open
+ # These translations are used by the admin-specific search sources.
+ search_source:
+ general:
+ heading: General
+
# These translations are used generically in setting fields.
settings:
saved_message: Your changes were saved.
@@ -480,7 +487,6 @@ core:
log_in_link: => core.ref.log_in
log_out_button: => core.ref.log_out
profile_button: Profile
- search_clear_button_accessible_label: Clear search query
search_placeholder: Search Forum
search_role_label: Search Forum
session_dropdown_accessible_label: Toggle session options dropdown menu
@@ -583,17 +589,6 @@ core:
submit_button: => core.ref.rename
title: Rename Discussion
- # These translations are used by the search modal.
- search:
- gambit_plus_button_a11y_label: Add a positive filter
- gambit_minus_button_a11y_label: Add a negative filter
- title: Search
- no_results_text: It looks like there are no results here.
- no_search_text: You have not searched for anything yet.
- options_heading: Search options
- placeholder: Search...
- preview_heading: Search preview
-
# These translations are used in the Security page.
security:
browser_on_operating_system: "{browser} on {os}"
@@ -744,6 +739,32 @@ core:
rate_limit_exceeded_message: You're going a little too quickly. Please try again in a few seconds.
render_failed_message: Sorry, we encountered an error while displaying this content. If you're a user, please try again later. If you're an administrator, take a look in your Flarum log files for more information.
+ # These translations are used by gambits. Gambit keys must be in snake_case, no spaces.
+ gambits:
+ boolean_key: is
+ discussions:
+ author:
+ key: author
+ hint: username or comma-separated list of usernames
+ created:
+ key: created
+ hint: 2020-12-31 or 2020-12-31..2021-09-30
+ hidden:
+ key: hidden
+ unread:
+ key: unread
+ posts:
+ discussion:
+ key: discussion
+ hint: the ID of the discussion
+ users:
+ email:
+ key: email
+ hint: example@machine.local
+ group:
+ key: group
+ hint: singular or plural group names
+
# These translations are used in the input component.
input:
clear_button: Clear input
@@ -781,6 +802,18 @@ core:
kilo_text: K
mega_text: M
+ # These translations are used by the abstract search component and search modal.
+ search:
+ gambit_plus_button_a11y_label: Add a positive filter
+ gambit_minus_button_a11y_label: Add a negative filter
+ title: Search
+ no_results_text: It looks like there are no results here.
+ no_search_text: You have not searched for anything yet.
+ options_heading: Search options
+ placeholder: Search...
+ preview_heading: Search preview
+ search_clear_button_accessible_label: Clear search query
+
# These translations are used by search sources.
search_source:
discussions:
@@ -792,32 +825,6 @@ core:
users:
heading: => core.ref.users
- # These translations are used by gambits. Gambit keys must be in snake_case, no spaces.
- gambits:
- boolean_key: is
- discussions:
- author:
- key: author
- hint: username or comma-separated list of usernames
- created:
- key: created
- hint: 2020-12-31 or 2020-12-31..2021-09-30
- hidden:
- key: hidden
- unread:
- key: unread
- posts:
- discussion:
- key: discussion
- hint: the ID of the discussion
- users:
- email:
- key: email
- hint: example@machine.local
- group:
- key: group
- hint: singular or plural group names
-
# These translations are used to punctuate a series of items.
series:
glue_text: ", "