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

API review and codebase improvements #1589

Open
blammit opened this issue Oct 17, 2024 · 0 comments
Open

API review and codebase improvements #1589

blammit opened this issue Oct 17, 2024 · 0 comments

Comments

@blammit
Copy link
Contributor

blammit commented Oct 17, 2024

After the 1.0.0 release it would be nice to clean up the API to make it more clear and improve ease of use. Also there are various implementation patterns/concepts that can be improved. For example:

Larger issues to resolve:

Naming:

  • ListItem-derived components are named inconsistently. E.g. we currently have ListNavigationItem, ListAlarm, AlarmLevelRadioButtonGroup. Clean up naming of ListItem-derived types #1760
  • Rename VeQuickItem isValid -> valid to avoid porting errors and inconsistent property naming
  • Rename ListItem allowed to something else. We want something like visible but named differently (show is less preferable as that sounds like a function). (Or maybe it can be removed altogether?)

Code style:

  • Review code style and maybe run clang-format and QML equivalent on git commit

Improving UI controls:

  • Ensure controls always reflect the backend data state. We can show some intermediate state that indicates the control has been pressed, e.g. for toggle switch shows a busy spinner or slides to the middle or such.

Generic improvements:

  • Some verbose patterns are duplicated (e.g. bottomContentChildren: [ ListLabel { ... } ] combo)
  • Theme value consolidation - there are way too many values, should use more generic values
  • Global.dcInputs is used for both input and output services
  • Have base classes for UI components or models where necessary
  • Rework OverviewPage to avoid the needs-relayout-retrigger
  • Use typed properties instead of var everywhere that it is possible. Helps with tooling (e.g. IDE auto-complete) and also possibly a performance improvement when accessing the Global properties.
  • Utils.js: remove unused functions and move features to C++ where it would be useful
@blammit blammit added this to the Version 1.1.0 milestone Oct 17, 2024
@blammit blammit changed the title API review and improvements API review and general codebase improvements Nov 12, 2024
@blammit blammit changed the title API review and general codebase improvements API review and codebase improvements Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant