Skip to content

feat: admin search UI#4022

Merged
SychO9 merged 1 commit into2.xfrom
sm/admin-search
Sep 28, 2024
Merged

feat: admin search UI#4022
SychO9 merged 1 commit into2.xfrom
sm/admin-search

Conversation

@SychO9
Copy link
Member

@SychO9 SychO9 commented Sep 23, 2024

Part of the roadmap

Changes proposed in this pull request:

  • Adds the ability to search through the available settings and permissions.

  • Renames app.extensionData to app.registry.

  • Adds an app.generalIndex for manual indexing operations.

  • To achieve the search, we:

    • Look up settings and permissions within app.registry (formerly app.extensionData)
    • Store core settings in app.registry before displaying them (see BasicsPage changes)
    • When storing settings or permissions is not possible in app.registry (highly custom settings and permission layouts)
      • The dev can use app.generalIndex to store searchable information about said settings/permissions (see AppearencePage, MailPage, AdvancedPage).
  • Additionally, this adds an Admin extender to register settings/permissions instead of directly calling app.registry (formerly app.extensionData).

Screenshot
image
image
image

Necessity

  • Has the problem that is being solved here been clearly explained?
  • If applicable, have various options for solving this problem been considered?
  • For core PRs, does this need to be in core, or could it be in an extension?
  • Are we willing to maintain this for years / potentially forever?

Confirmed

  • Frontend changes: tested on a local Flarum installation.
  • Backend changes: tests are green (run composer test).
  • Core developer confirmed locally this works as intended.
  • Tests have been added, or are not appropriate here.

Required changes:

  • Related documentation PR: (Remove if irrelevant)
  • Related core extension PRs: (Remove if irrelevant)

@SychO9 SychO9 added type/feature extension-breaking javascript Pull requests that update Javascript code labels Sep 23, 2024
@SychO9 SychO9 added this to the 2.0 milestone Sep 23, 2024
@SychO9 SychO9 self-assigned this Sep 23, 2024
@SychO9 SychO9 requested a review from a team as a code owner September 23, 2024 15:32
@SychO9 SychO9 merged commit 5cea3d3 into 2.x Sep 28, 2024
@SychO9 SychO9 deleted the sm/admin-search branch September 28, 2024 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

extension-breaking javascript Pull requests that update Javascript code type/feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant