Skip to content

Commit 4181bd4

Browse files
authored
add new extension points to dev docs (#709)
* add new extension points to dev docs * fix: adjust floating action button extension point
1 parent 8e76390 commit 4181bd4

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

docs/dev/web/extension-system/extension-types/floating-action-button-extensions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ id: floating-action-button-extensions
66

77
## Extension Type FloatingActionButton
88

9-
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`.
9+
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`.
1010

1111
:::warning
1212
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.
@@ -55,7 +55,7 @@ const resourcesStore = useResourcesStore();
5555

5656
const extension = {
5757
id: 'com.github.opencloud-eu.web.files.floating-action-button',
58-
extensionPointIds: ['global.floating-action-button'],
58+
extensionPointIds: ['app.files.floating-action-button'],
5959
type: 'floatingActionButton',
6060
icon: 'add',
6161
label: () => $gettext('New'),

docs/dev/web/extension-system/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ For building an extension you can choose from the types predefined by the OpenCl
114114
For details, please refer to the [folder view docs](./extension-types/folder-view-extensions).
115115
6. `CustomComponentExtension` (type `customComponent`) - An extension that can register a custom component for a render target. For details, please refer to the
116116
[custom component docs](./extension-types/custom-component-extensions)
117-
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
117+
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
118118
[floating action button docs](./extension-types/floating-action-button-extensions).
119119

120120
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
@@ -139,7 +139,11 @@ There are standardized components and places where extensions are being used aut
139139
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,
140140
your extension will be used automatically.
141141

142-
1. Left Sidebar for Navigation. ExtensionPointId `app.${appName}.navItems` (dynamically created for each app). Mounts extensions of type `sidebarNav`.
142+
1. Left Sidebar for Navigation.
143+
1. Floating Action Button (FAB). ExtensionPointId `app.${appName}.floating-action-button` (dynamically created for each app). Mounts extensions of type `floatingActionButton`.
144+
2. Additional nav items. ExtensionPointId `app.${appName}.navItems` (dynamically created for each app). Mounts extensions of type `sidebarNav`.
145+
3. Sidebar main area below nav items. ExtensionPointId `app.${appName}.sidebar-nav.main` (dynamically created for each app). Mounts extensions of type `customComponent`.
146+
4. Sidebar bottom area above version info. ExtensionPointId `app.${appName}.sidebar-nav.bottom` (dynamically created for each app). Mounts extensions of type `customComponent`.
143147
2. Global top bar
144148
1. Center area. ExtensionPointId `app.runtime.header.center`. Mounts extensions of type `customComponent`.
145149
2. Left area. ExtensionPointId `app.runtime.header.left`. Mounts extensions of type `customComponent`.
@@ -163,7 +167,6 @@ your extension will be used automatically.
163167
10. Quick actions for the trash overview. ExtensionPointId `app.files.trash-quick-actions`. Mounts extensions of type `action`.
164168
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.
165169
5. User preference panels. ExtensionPointId `app.runtime.preferences.panels`. Mounts extensions of type `customComponent`.
166-
6. Global Floating Action button. ExtensionPointId `global.floating-action-button`. Mounts extensions of type `floatingActionButton`.
167170

168171
#### User Preferences for Extensions
169172

0 commit comments

Comments
 (0)