Skip to content

docs(plugins): document API 29 canvases and service menus - #230

Open
blackbartblues wants to merge 1 commit into
noctalia-dev:mainfrom
blackbartblues:docs/plugin-api-29
Open

docs(plugins): document API 29 canvases and service menus#230
blackbartblues wants to merge 1 commit into
noctalia-dev:mainfrom
blackbartblues:docs/plugin-api-29

Conversation

@blackbartblues

Copy link
Copy Markdown
Contributor

Summary

Documents the plugin API 29 capabilities introduced by noctalia-dev/noctalia#4038:

  • service.openContextMenu(request) for IPC-triggered menus at the cursor
  • free-form panel nodes with position = "absolute", x, y, zIndex, and clipChildren
  • target-local onDrop(payload, value, x, y) coordinates
  • onPress on ui.input
  • decorated = false for plugin-owned panel surfaces

Details

  • adds API 29 to the central plugin API ledger
  • supports separate service-context-menu and freeform-canvas badge keys for the same cumulative API level
  • explains lifecycle, callback, compositor-independence, and dismissal behavior for service menus
  • includes a complete sticky-note canvas example and migration-safe drag-and-drop guidance
  • records the default decorated behavior and the exact visual frame removed by decorated = false

API 28 panel context menus are already documented by #226 and are not duplicated here.

Testing

  • npm run build
  • verified generated API ledger and API 29 badges in the built pages

Dependency

This documentation should merge with or after noctalia-dev/noctalia#4038.

@blackbartblues
blackbartblues marked this pull request as ready for review August 22, 2026 20:44
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