summaryrefslogtreecommitdiffstats
path: root/README.md
blob: e8fb07cd2ed4162f00b78d6ee657cc326926d7e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# xdg-desktop-portal-tde

## What is this?

This is an implementation of the [FreeDesktop Portals API](https://flatpak.github.io/xdg-desktop-portal).

This implementation exposes TDE APIs to applications which use the Portals API. As a result, these applications
can transparently use native APIs and dialogs.

Read more about the portals API on its official [website](https://flatpak.github.io/xdg-desktop-portal/docs/introduction.html).

## How do I use this?
Before using this, make sure you have the `xdg-desktop-portal` package installed and running on your system.

Some applications respect the `GTK_USE_PORTAL=1` and `GDK_DEBUG=portals` environment variables (most GTK applications and
some Chromium-based browsers, e.g. Vivaldi).

To make Firefox use the Portals API, go to `about:config`, search for options that start with "widget.use-xdg-desktop-portal" and,
if they are set to 2, set them to 1.

## State of implementation

Currently implemented are the following interfaces:
* Account - request user information (user ID, full name, user icon)
* Email - request to send an e-mail via the system e-mail client
* FileChooser - request a file dialog

The following implementations are planned (listed in no particular order):
* Screenshot - request a screenshot
* App Chooser - show a "Open with..." dialog for a file
* Clipboard - request clipboard access (*)
* OpenURI - request to open a URL
* Secret - integration with TDEWallet
* Access - show a grant access dialog
* Wallpaper - request to change the user's wallpaper
* Print - request a file to be printed

(*) Needs Session interface implementation

Additionaly, it must be noted that the implementation does not currently support the Documents portal API (and therefore sandboxed applications).