Skip to content
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.

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

feat: app settings #4885

Draft
wants to merge 6 commits into
base: develop
Choose a base branch
from
Draft

feat: app settings #4885

wants to merge 6 commits into from

Conversation

jarekdanielak
Copy link
Contributor

Proposed Changes

This lays a foundation for allowing components and plugins to utilize app settings.

Includes:

  • Settings config provider to read and write settings.json
  • Settings API as a central place to store and control settings.
  • Settings Plugin with UI (modal) to change settings.
  • Example of providing and using settings by client-test plugin.

To do:

  • Refactor and clean up in the Settings API
  • Add (some) flags as settings
  • Auto-save feature
  • Search feature
  • Only save / call listeners / write file when the new values are different
  • UI design
  • Tests

Closes #2913

Related to https://github.com/camunda/product-hub/issues/2491

Checklist

To ensure you provided everything we need to look at your PR:

  • Brief textual description of the changes present
  • Visual demo attached
  • Steps to try out present, i.e. using the @bpmn-io/sr tool
  • Related issue linked via Closes {LINK_TO_ISSUE} or Related to {LINK_TO_ISSUE}

@bpmn-io-tasks bpmn-io-tasks bot added the in progress Currently worked on label Mar 5, 2025
@jarekdanielak
Copy link
Contributor Author

This is still very much work in progress, but you can already bring the modal with Cmd/Ctrl + , and change the color of the heart icon in the status bar or force cloud BPMN editor linting.

image

@jarekdanielak
Copy link
Contributor Author

Some implementation details were discussed in our Hour of Code.

@barmac
Copy link
Collaborator

barmac commented Mar 6, 2025

Cmd/Ctrl + ,

Good one. This is the same shortcut as in Google Chrome and VSCode.

@nikku
Copy link
Member

nikku commented Mar 6, 2025

Cmd/Ctrl + ,

Does not work for me (Linux, German keyboard), no shortcut on Linux / Windows exists for Chrome

@jarekdanielak
Copy link
Contributor Author

jarekdanielak commented Mar 6, 2025

Do we want:

a) Universal shortcut that works for all platforms, but is not a standard across different apps.
b) Standard shortcut for macOS and no / different shortcut for other platforms.

I vote B, but I'm slightly biased. 🍎

Btw. the Settings are also available under the File menu.

@barmac
Copy link
Collaborator

barmac commented Mar 6, 2025

@philippfromme How about shortcuts in Windows?

@nikku
Copy link
Member

nikku commented Mar 6, 2025

I vote B, but I'm slightly biased. 🍎

Know the context. Shortcuts should pick up folks in the domain / context they operate. No value to unify things. Mac user does not care for 🪟 shortcuts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in progress Currently worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Be able to configure preferences / settings / flags via UI
3 participants