Skip to content

Commit 4822f7f

Browse files
authored
Add entrypoints to apps.md (#4589)
First proof of concept here linagora/cozy-home#2306 linagora/twake-drive#3525
2 parents a7953f4 + a6b7579 commit 4822f7f

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

docs/apps.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ filename for this file: `manifest.webapp`.
4444
| notifications | a map of notifications needed by the app (see [here](notifications.md) for more details) |
4545
| services | a map of the services associated with the app (see below for more details) |
4646
| routes | a map of routes for the app (see below for more details) |
47+
| entrypoints | a map of entrypoints for the app (see below for more details) |
4748
| mobile | information about app's mobile version (see below for more details) |
4849
| accept_from_flagship | boolean stating if the app is compatible with the Flagship app's "OS Receive" feature |
4950
| accept_documents_from_flagship | when `accept_from_flagship` is `true`, defines what can be uploaded to the app (see [here](accept-from-flagship.md) for more details) |
@@ -161,6 +162,25 @@ During the service execution, the stack will give some environment variables to
161162
- "COZY_JOB_ID" # Job ID
162163
- "COZY_COUCH_DOC" # The CouchDB document which triggers the service
163164
```
165+
166+
### Entrypoints
167+
168+
Entrypoints indicates front end routes to other apps. It contains a `name`, a `title` that can be translated, a `hash` (the front end route) and an `icon`. For example, it can indicates the front end route to create a new file in a drive application. Other apps can then directly link to the new file page by using entrypoints data:
169+
170+
```json
171+
[
172+
{
173+
"name": "new-file",
174+
"title": {
175+
"en": "New file",
176+
"fr": "Nouveau fichier"
177+
},
178+
"hash": "/file/new",
179+
"icon": "/assets/icons/new-file.svg"
180+
}
181+
]
182+
```
183+
164184
### Notifications
165185

166186
For more informations on how te declare notifications in the manifest, see the

0 commit comments

Comments
 (0)