Skip to content

feat: add bookmarks plugin - #132

Draft
dunarand wants to merge 5 commits into
noctalia-dev:mainfrom
dunarand:bookmarks
Draft

feat: add bookmarks plugin#132
dunarand wants to merge 5 commits into
noctalia-dev:mainfrom
dunarand:bookmarks

Conversation

@dunarand

Copy link
Copy Markdown

Plugin

  • Id: dunarand/bookmarks
  • New plugin
  • Update to an existing plugin (version bumped in plugin.toml)

What it does

Allows users to create a list of bookmarks that each get a glyhp, a label, a shell command to execute, and an optional description. Allows for 1 level deep nesting by using "folders".

Saved bookmarks are written to either the default location $NOCTALIA_STATE_HOME/plugins/data/dunarand/bookmarks/data.json, or the user can specify the file/location.

The panel can be opened via

noctalia msg panel-toggle dunarand/bookmarks:panel

or by using the bar widget shipped with the plugin.

External dependencies

None

Testing

  • Tested on Niri
  • Tested on Hyprland
  • Tested on Sway
  • Tested on another compositor:
  • Noctalia version tested against: v5.0.0-beta.6
  • Plugin API level: 13

Screenshots / Videos

preview-1 preview-2 preview-3 preview-4 preview-5 preview-6

Checklist

  • The directory name matches the part of id after the / in plugin.toml exactly.
  • It ships plugin.toml, README.md, thumbnail.webp, and translations/en.json.
  • README.md follows the
    README template, documents
    every entry id and dependency, and includes exact panel IPC commands and launcher prefixes where applicable.
  • I created thumbnail.webp with the thumbnail generator.
  • version follows semver and is bumped in this PR; plugin_api is the oldest API level this plugin requires.
  • Every non-English translation in this PR uses a locale supported by Noctalia core, and I can read, write, and
    understand that language well enough to review and maintain it (no unreviewed machine/LLM translations).
  • I did not edit catalog.toml; CI generates it.
  • This PR touches exactly one plugin directory.

Code review attestation

Plugins run as trusted, unsandboxed Luau in the user's session. Confirm:

  • The code is readable and not obfuscated, minified, or generated.
  • It does not download and execute remote code.
  • Every network call, filesystem write, and spawned process is something the description above accounts for.
  • I have the right to publish this code under the license declared in plugin.toml.

@dunarand
dunarand marked this pull request as draft July 28, 2026 23:35
@dunarand

dunarand commented Jul 28, 2026

Copy link
Copy Markdown
Author

Converted the PR to draft because I thought I've included all the features I wanted but came up with two improvements. I'll mark it "Ready for review" after I ship the features:

  1. IPC directly into search mode: noctalia msg panel-toggle dunarand/bookmarks:panel search
  2. Bookmarks can be put into or out of folders in edit mode > drag & drop

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant