Skip to content

Commit

Permalink
Add docs page about desktop icons
Browse files Browse the repository at this point in the history
  • Loading branch information
wnayes committed Apr 6, 2024
1 parent 05c7347 commit 755d5ec
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions docs/docs/usage/desktop-icons.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
sidebar_position: 2
---

# Desktop Icons

Support for displaying desktop entries (icons) is built-in.

## How do I control whether desktop icons appear?

With the React configuration, desktop icons are displayed if you render the
`<DesktopEntries />` component.

## How do I specify which icons appear?

The window manager looks for `.desktop` files in your XDG Desktop user
directory. This is usually `$HOME/Desktop` (`~/Desktop`) but is configurable [as
described here](https://wiki.archlinux.org/title/XDG_user_directories).

Normally, installed packages create `.desktop` files in a system folder; they
aren't usually put into your XDG Desktop directory. This means that you should
copy the `.desktop` files that you actually want to appear into your XDG Desktop
directory to get them to appear in the window manager.

The Arch Linux wiki [mentions](https://wiki.archlinux.org/title/desktop_entries#Application_entry)
some common locations for `.desktop` files, but it may vary.

## What goes in a `.desktop` file?

The intention is to support [standard desktop files](https://wiki.archlinux.org/title/desktop_entries),
but here are some notes about what is supported currently:

### Supported properties

- `NoDisplay` and `Hidden` suppress the display of a `.desktop` file.
- `Name`: The desktop icon caption
- `Type`: "Application" or "Link"
- `Icon`: SVG or PNG icon

For type Application:

- `Exec`: Application to launch
- `Path`: Working directory when launching the application

For type Link:

- `URL`: URL to open

0 comments on commit 755d5ec

Please sign in to comment.