Docs extension system #10400
Docs extension system #10400
Conversation
There was a problem hiding this comment.
Awesome stuff! 🥳 Just a few annotations from my side.
Also, one aspect which we missed so far is extending content via portals. See e.g. https://github.com/cernbox/web-extensions/pull/25/files#diff-af11596391b8427b4db2f25ddc99628189bbadd1227494c6e1ef24543cb4bd76 where additional content is being added to existing sidebar panels. The available portal-targets currently are:
app.files.sidebar.sharing.shared-with.topapp.files.sidebar.sharing.shared-with.topapp.files.sidebar.file.details.table
docs/extension-system/_index.md
Outdated
| ``` | ||
|
|
||
| By defining an application via `defineWebApplication` you can provide the following: | ||
| - `appInfo` - the application metadata, which is used to make the application available via the app switcher and the app registry |
There was a problem hiding this comment.
Should we link to the ApplicationInformation interface here? Or is this supposed to be a quick overview only?
| - `appInfo` - the application metadata, which is used to make the application available via the app switcher and the app registry | |
| - `appInfo` - the application metadata, which is used to make the application available via the app switcher and the app registry. |
There was a problem hiding this comment.
For now only supposed to be a quick overview. We want to come up with more details for applications, when we write about different examples for different apps (e.g. viewers/editors vs. "extension host apps" vs. custom business logic apps, etc).
| - `navItems` - the statically defined navigation items for the left sidebar. Only gets rendered when more than 1 navigation item exists at runtime. | ||
| Additional dynamic navigation items can be registered via the extension registry. | ||
| - `routes` - the routes to the different views of your application. May be referenced within the `navItems`. Authentication requirements can be defined per item. |
There was a problem hiding this comment.
Same answer as above :-) Only meant to be a quick overview for now.
| #### ListSearch | ||
|
|
||
| The listSearch object consists of: | ||
|
|
||
| - `component` - Vue component that can render the values from the SearchResult below | ||
| - `search(term: string)` - Function that exectues the search, based on a given term. The term is formatted in [KQL](https://owncloud.dev/services/search/#query-language). Please note that the returned values needs to be formatted to fit either `SearchResource` or `GenericSearchResultItem` type | ||
|
|
||
| #### PreviewSearch | ||
|
|
||
| The previewSearch object extends the listSearch with one additional attribute: | ||
|
|
||
| - `available` - Indicates whether a preview underneath the search bar is available for this search provider |
There was a problem hiding this comment.
I feel like we should explain the difference between list- and preview search here. Preview = dropdown that automatically pops up when entering a search term, list = result page when hitting enter/search icon.
There was a problem hiding this comment.
I feel we should get rid of that ... 😂
There was a problem hiding this comment.
Buuuut.... we're using it for CERN
There was a problem hiding this comment.
CERN has a search provider which only goes to the search result page and doesn't have a search preview.
|
* change: Remove skeleton app * docs: Add extension system docs --------- Co-authored-by: Pascal Wengerter <[email protected]>
Description
Introducing a first iteration on developer documentation for our extension system. Collaborative effort with @pascalwengerter
Related Issue
Types of changes