Skip to content

[draft] Provider-based pin system #277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
derVedro wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

[draft] Provider-based pin system #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
37bdd73
just a proof of concept for various PinProviders
derVedro Apr 28, 2026
1b75e31
add config options, add kde bookmarks provider
derVedro Apr 30, 2026
c08dc74
schema update
derVedro May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 98 additions & 21 deletions docs/src/content/docs/dev/reference/schema.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ description: config schema humanified
- [1.18.2. Property `Rovr Config > interface > compact_mode > panels`](#interface_compact_mode_panels)
- [1.19. Property `Rovr Config > interface > mime_rules`](#interface_mime_rules)
- [1.19.1. Property `Rovr Config > interface > mime_rules > additionalProperties`](#interface_mime_rules_additionalProperties)
- [1.20. Property `Rovr Config > interface > pins_places`](#interface_pins_places)
- [1.20.1. Rovr Config > interface > pins_places > pins_places items](#interface_pins_places_items)
- [1.21. Property `Rovr Config > interface > pins_bookmarks`](#interface_pins_bookmarks)
- [1.21.1. Rovr Config > interface > pins_bookmarks > pins_bookmarks items](#interface_pins_bookmarks_items)
- [2. Property `Rovr Config > settings`](#settings)
- [2.1. Property `Rovr Config > settings > use_recycle_bin`](#settings_use_recycle_bin)
- [2.2. Property `Rovr Config > settings > copy_includes_metadata`](#settings_copy_includes_metadata)
Expand Down Expand Up @@ -352,27 +356,29 @@ description: config schema humanified

**Description:** Settings related to the user interface and experience

| Property | Type | Title/Description |
| --------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [tooltips](#interface_tooltips) | boolean | Show tooltips when your mouse is over a tooltip supported button.<br />This is not hot reloaded. |
| [nerd_font](#interface_nerd_font) | boolean | Use nerd font for rendering icons instead of weird characters and stuff.<br />Not properly hot-reloaded. |
| [use_reactive_layout](#interface_use_reactive_layout) | boolean | Hide certain elements based on the width and height of the terminal. |
| [show_progress_eta](#interface_show_progress_eta) | boolean | When copying or deleting files, show an ETA for when the action will be completed. |
| [show_progress_percentage](#interface_show_progress_percentage) | boolean | When copying or deleting files, show a percentage of how much had been completed. |
| [truncate_progress_file_path](#interface_truncate_progress_file_path) | boolean | When the process container is using file paths, truncate the file path to only view the first and last names of the path. |
| [show_line_numbers](#interface_show_line_numbers) | boolean | Add line numbers to the left gutter if you are viewing a text file. |
| [scrolloff](#interface_scrolloff) | integer | The number of files to keep above and below the cursor when moving through the file list. |
| [show_hidden_files](#interface_show_hidden_files) | boolean | Show hidden files and folders (those starting with a dot on Unix, or explicitly hidden on Windows/MacOS). |
| [image_viewer](#interface_image_viewer) | object | Settings related to the image viewer used in the preview sidebar |
| [font_preview](#interface_font_preview) | object | Settings related to the font preview used in the preview sidebar |
| [allow_tab_nav](#interface_allow_tab_nav) | boolean | Allow navigating the main app screen with \`tab\` and \`shift+tab\` |
| [append_new_tabs](#interface_append_new_tabs) | boolean | Choose whether or not to append new tabs instead of inserting them.<br />\`true\` =&gt; Append to the end of the tab list.<br />\`false\` =&gt; Insert after the active tab. |
| [double_click_delay](#interface_double_click_delay) | number | The delay between two consecutive clicks to enter into a directory, or open a file. |
| [drive_watcher_frequency](#interface_drive_watcher_frequency) | number | How often (in seconds) to check for changes in mounted drives in the sidebar. |
| [clock](#interface_clock) | object | |
| [preview_text](#interface_preview_text) | object | |
| [compact_mode](#interface_compact_mode) | object | |
| [mime_rules](#interface_mime_rules) | object | Map MIME type patterns to preview types. Uses regex patterns. Valid preview types: text, image, pdf, archive, folder, resvg, font, remime.<br />-&gt; Use 'remime' if you want a more accurate description from file(1) |
| Property | Type | Title/Description |
| --------------------------------------------------------------------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [tooltips](#interface_tooltips) | boolean | Show tooltips when your mouse is over a tooltip supported button.<br />This is not hot reloaded. |
| [nerd_font](#interface_nerd_font) | boolean | Use nerd font for rendering icons instead of weird characters and stuff.<br />Not properly hot-reloaded. |
| [use_reactive_layout](#interface_use_reactive_layout) | boolean | Hide certain elements based on the width and height of the terminal. |
| [show_progress_eta](#interface_show_progress_eta) | boolean | When copying or deleting files, show an ETA for when the action will be completed. |
| [show_progress_percentage](#interface_show_progress_percentage) | boolean | When copying or deleting files, show a percentage of how much had been completed. |
| [truncate_progress_file_path](#interface_truncate_progress_file_path) | boolean | When the process container is using file paths, truncate the file path to only view the first and last names of the path. |
| [show_line_numbers](#interface_show_line_numbers) | boolean | Add line numbers to the left gutter if you are viewing a text file. |
| [scrolloff](#interface_scrolloff) | integer | The number of files to keep above and below the cursor when moving through the file list. |
| [show_hidden_files](#interface_show_hidden_files) | boolean | Show hidden files and folders (those starting with a dot on Unix, or explicitly hidden on Windows/MacOS). |
| [image_viewer](#interface_image_viewer) | object | Settings related to the image viewer used in the preview sidebar |
| [font_preview](#interface_font_preview) | object | Settings related to the font preview used in the preview sidebar |
| [allow_tab_nav](#interface_allow_tab_nav) | boolean | Allow navigating the main app screen with \`tab\` and \`shift+tab\` |
| [append_new_tabs](#interface_append_new_tabs) | boolean | Choose whether or not to append new tabs instead of inserting them.<br />\`true\` =&gt; Append to the end of the tab list.<br />\`false\` =&gt; Insert after the active tab. |
| [double_click_delay](#interface_double_click_delay) | number | The delay between two consecutive clicks to enter into a directory, or open a file. |
| [drive_watcher_frequency](#interface_drive_watcher_frequency) | number | How often (in seconds) to check for changes in mounted drives in the sidebar. |
| [clock](#interface_clock) | object | |
| [preview_text](#interface_preview_text) | object | |
| [compact_mode](#interface_compact_mode) | object | |
| [mime_rules](#interface_mime_rules) | object | Map MIME type patterns to preview types. Uses regex patterns. Valid preview types: text, image, pdf, archive, folder, resvg, font, remime.<br />-&gt; Use 'remime' if you want a more accurate description from file(1) |
| [pins_places](#interface_pins_places) | array of enum (of string) | Provider for the pinned places in the side pane. |
| [pins_bookmarks](#interface_pins_bookmarks) | array of enum (of string) | Provider for the pinned bookmarks in the side pane. |

### <a name="interface_tooltips"></a>1.1. Property `Rovr Config > interface > tooltips`

Expand Down Expand Up @@ -805,6 +811,77 @@ Must be one of:
- "resvg"
- "font"

### <a name="interface_pins_places"></a>1.20. Property `Rovr Config > interface > pins_places`

| | |
| ------------ | --------------------------- |
| **Type** | `array of enum (of string)` |
| **Required** | No |
| **Default** | `["rovr"]` |

**Description:** Provider for the pinned places in the side pane.

| | Array restrictions |
| -------------------- | ------------------ |
| **Min items** | 1 |
| **Max items** | N/A |
| **Items unicity** | False |
| **Additional items** | False |
| **Tuple validation** | See below |

| Each item of this array must be | Description |
| ------------------------------------------------- | ----------- |
| [pins_places items](#interface_pins_places_items) | |

#### <a name="interface_pins_places_items"></a>1.20.1. Rovr Config > interface > pins_places > pins_places items

| | |
| ------------ | ------------------ |
| **Type** | `enum (of string)` |
| **Required** | No |

Must be one of:

- "empty"
- "default"
- "rovr"

### <a name="interface_pins_bookmarks"></a>1.21. Property `Rovr Config > interface > pins_bookmarks`

| | |
| ------------ | --------------------------- |
| **Type** | `array of enum (of string)` |
| **Required** | No |
| **Default** | `["rovr"]` |

**Description:** Provider for the pinned bookmarks in the side pane.

| | Array restrictions |
| -------------------- | ------------------ |
| **Min items** | 1 |
| **Max items** | N/A |
| **Items unicity** | False |
| **Additional items** | False |
| **Tuple validation** | See below |

| Each item of this array must be | Description |
| ------------------------------------------------------- | ----------- |
| [pins_bookmarks items](#interface_pins_bookmarks_items) | |

#### <a name="interface_pins_bookmarks_items"></a>1.21.1. Rovr Config > interface > pins_bookmarks > pins_bookmarks items

| | |
| ------------ | ------------------ |
| **Type** | `enum (of string)` |
| **Required** | No |

Must be one of:

- "empty"
- "rovr"
- "gtk"
- "kde"

## <a name="settings"></a>2. Property `Rovr Config > settings`

| | |
Expand Down
20 changes: 20 additions & 0 deletions src/rovr/config/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,26 @@
"application/x-font-.*": "font"
},
"description": "Map MIME type patterns to preview types. Uses regex patterns. Valid preview types: text, image, pdf, archive, folder, resvg, font, remime.\n-> Use 'remime' if you want a more accurate description from file(1)"
},
"pins_places": {
"type": "array",
"default": ["rovr"],
"description": "Provider for the pinned places in the side pane.",
"minItems": 1,
"items": {
"type": "string",
"enum": ["empty", "default", "rovr"]
}
},
"pins_bookmarks": {
"type": "array",
"default": ["rovr"],
"description": "Provider for the pinned bookmarks in the side pane.",
"minItems": 1,
"items": {
"type": "string",
"enum": ["empty", "rovr", "gtk", "kde"]
}
}
}
},
Expand Down
Loading