Skip to content

docs: add breaking changes around settings route change #518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DavideIadeluca wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add breaking changes around settings route change #518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
92b3450
docs: add documentation
DavideIadeluca Mar 21, 2026
11d77d4
style: whitespacing
DavideIadeluca Mar 21, 2026
47aefad
chore: change example
DavideIadeluca Mar 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/extend/routes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ import Link from 'flarum/common/components/Link';
<Link href="/route/known/to/mithril">Hello World!</Link>

// You'll frequently use Link with generated routes:
<Link href={app.route('settings')}>Hello World!</Link>
<Link href={app.route('index')}>Hello World!</Link>

// Link can even generate external links with the external attr:
<Link external={true} href="https://google.com">Hello World!</Link>
Expand Down
3 changes: 3 additions & 0 deletions docs/extend/update-2_0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,9 @@ There have been many changes to the core frontend codebase, including renamed or
* The `avatar` and `icon` helpers have been refactored to new `Avatar` and `Icon` components. Which now allows you to extend them to modify their behavior.
* The `Modal` component has been split into `Modal` and `FormModal`. The `Modal` component is now a simple modal that can be used for any content, while the `FormModal` component is a modal that is specifically designed for forms.
* `app.extensionData` has been removed. You must now use the `Admin` extender to register settings, permissions and custom extension pages.
* `NicknameModal.prototype` has been moved to `ChangeNicknameModal.prototype` and now requires a `user` prop.
* `ChangePasswordModal.prototype` has been moved to `RequestPasswordResetModal.prototype` and now requires a `user` prop.
* The `settings` route has been removed. Settings are now accessible at `user.settings` (`/u/:username/settings`). Extensions which extend the settings page must refactor their implementation to use `this.user` instead of `app.session.user` for fetching and saving settings.

##### <span class="notable">Notable</span>
* The admin sidebar navigation has been overhauled. Extension categories are now collapsible groups with count badges and category icons. Categories start collapsed by default, and searching auto-expands categories with matching results. The active extension's category is pre-expanded on page load. Extensions should declare their category in `composer.json` under `extra.flarum-extension.category`. See the [Extension Categories](./admin.md#extension-categories) section in the admin docs for the full list of available categories and how to register custom ones.
Expand Down