Skip to content

add new extension points to dev docs #709

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
kulmann wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add new extension points to dev docs #709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9626463
add new extension points to dev docs
kulmann Mar 13, 2026
bcbb4fc
fix: adjust floating action button extension point
kulmann Mar 13, 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
4 changes: 2 additions & 2 deletions docs/dev/web/extension-system/extension-types/floating-action-button-extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ id: floating-action-button-extensions

## Extension Type FloatingActionButton

This extension type allows apps to register a global action that is either displayed within the left sidebar (for desktop resolutions) or as a floating action button (for mobile resolutions). The extension point for this extension type is `global.floating-action-button`.
This extension type allows apps to register actions either displayed within the left sidebar (for desktop resolutions) or as a floating action button (for mobile resolutions). The extension point for this extension type is `app.${appId}.floating-action-button`.

:::warning
You need to take care of the visibility of your floating action button extension via the `isActive` property, otherwise you might end up overwriting other extensions' action buttons. In most cases, it makes sense to only display the button when your app is currently active.
Expand Down Expand Up @@ -55,7 +55,7 @@ const resourcesStore = useResourcesStore();

const extension = {
id: 'com.github.opencloud-eu.web.files.floating-action-button',
extensionPointIds: ['global.floating-action-button'],
extensionPointIds: ['app.files.floating-action-button'],
type: 'floatingActionButton',
icon: 'add',
label: () => $gettext('New'),
Expand Down
9 changes: 6 additions & 3 deletions docs/dev/web/extension-system/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ For building an extension you can choose from the types predefined by the OpenCl
For details, please refer to the [folder view docs](./extension-types/folder-view-extensions).
6. `CustomComponentExtension` (type `customComponent`) - An extension that can register a custom component for a render target. For details, please refer to the
[custom component docs](./extension-types/custom-component-extensions)
7. `FloatingActionButtonExtension` (type `floatingActionButton`) - An extension that can register a global action that is either displayed within the left sidebar (for desktop resolutions) or as a floating action button (for mobile resolutions). For details, please refer to the
7. `FloatingActionButtonExtension` (type `floatingActionButton`) - An extension that can register one or multiple actions, either displayed within the left sidebar (for desktop resolutions) or as a floating action button (for mobile resolutions). For details, please refer to the
[floating action button docs](./extension-types/floating-action-button-extensions).

You're free to introduce your own extension types within your application code and use the extension registry to query the available ones. However, if you have the impression
Expand All @@ -139,7 +139,11 @@ There are standardized components and places where extensions are being used aut
the `files` app. If you decide to develop an extension which fulfills the type and registers itself for the extensionPointId of the respective extension point,
your extension will be used automatically.

1. Left Sidebar for Navigation. ExtensionPointId `app.${appName}.navItems` (dynamically created for each app). Mounts extensions of type `sidebarNav`.
1. Left Sidebar for Navigation.
1. Floating Action Button (FAB). ExtensionPointId `app.${appName}.floating-action-button` (dynamically created for each app). Mounts extensions of type `floatingActionButton`.
2. Additional nav items. ExtensionPointId `app.${appName}.navItems` (dynamically created for each app). Mounts extensions of type `sidebarNav`.
3. Sidebar main area below nav items. ExtensionPointId `app.${appName}.sidebar-nav.main` (dynamically created for each app). Mounts extensions of type `customComponent`.
4. Sidebar bottom area above version info. ExtensionPointId `app.${appName}.sidebar-nav.bottom` (dynamically created for each app). Mounts extensions of type `customComponent`.
2. Global top bar
1. Center area. ExtensionPointId `app.runtime.header.center`. Mounts extensions of type `customComponent`.
2. Left area. ExtensionPointId `app.runtime.header.left`. Mounts extensions of type `customComponent`.
Expand All @@ -163,7 +167,6 @@ your extension will be used automatically.
10. Quick actions for the trash overview. ExtensionPointId `app.files.trash-quick-actions`. Mounts extensions of type `action`.
4. Global search providers. ExtensionPointId `app.search.providers`. Utilizes extensions of type `search` as search engines for the search input in the global top bar.
5. User preference panels. ExtensionPointId `app.runtime.preferences.panels`. Mounts extensions of type `customComponent`.
6. Global Floating Action button. ExtensionPointId `global.floating-action-button`. Mounts extensions of type `floatingActionButton`.

#### User Preferences for Extensions

Expand Down