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

SY-1093 Additional Schematic Symbols, SY-975 Fix Nested Button Element in Schematic #830

Open
wants to merge 27 commits into
base: rc
Choose a base branch
from

Conversation

pjdotson
Copy link
Contributor

Feature Pull Request Template

Key Information

Description

  • Added the following schematic symbols: Agitator, Flat Blade Agitator, Paddle Agitator, Cross Beam Agitator, Helical Agitator, Propeller Agitator, Compressor, Arrow, Text Box
  • Fix color encoding error for Tanks and Boxes.
  • Fixed an issue where a <button> would render as a descendent of another <button> in the Console DOM.

Basic Readiness Checklist

  • I have performed a self-review of my code.
  • I have added relevant tests to cover the changes to CI.
  • I have updated user facing documentation accordingly.
  • I have verified code coverage targets are met.

Migrations

  • Console - I have ensured that previous versions of stored data structures are
    properly migrated to new formats.
  • Server - I have ensured that previous versions of stored data structures are
    properly migrated to new formats.

Additional Notes

  • These changes deal with concurrency.
  • These changes affect UI.

Manual QA Additions

  • I have updated the Release Candidate template
    with necessary manual QA steps to test my change.

Breaking Changes

Please list any breaking changes to public or internal packages.

Reviwer Checklist

  • Sufficient test coverage of new additions.
  • Verified all steps in the Readiness checklists.
  • UI changes have been tested.
  • Style and formatting is consistent.
  • Reviewed any relevant changes to concurrent code for safety.
  • Sufficient comments and clarity of code.
  • Any additional documentation necessary for feature is provided and has been reviewed for clarity.

@pjdotson pjdotson added pluto Pluto UI components related console labels Sep 14, 2024
@pjdotson pjdotson self-assigned this Sep 14, 2024
@codecov-commenter
Copy link

codecov-commenter commented Sep 14, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 6.13893% with 1162 lines in your changes missing coverage. Please review.

Project coverage is 45.74%. Comparing base (674825d) to head (252e4f7).
Report is 1 commits behind head on rc.

Files with missing lines Patch % Lines
pluto/src/vis/schematic/primitives/Primitives.tsx 0.00% 554 Missing ⚠️
pluto/src/vis/schematic/Symbols.tsx 0.00% 286 Missing ⚠️
pluto/src/vis/schematic/registry.ts 0.00% 157 Missing ⚠️
pluto/src/vis/schematic/Forms.tsx 0.00% 80 Missing ⚠️
pluto/src/vis/schematic/SelectOrientation.tsx 0.00% 46 Missing ⚠️
pluto/src/select/Alignment.tsx 48.78% 21 Missing ⚠️
pluto/src/input/Text.tsx 67.85% 9 Missing ⚠️
pluto/src/button/Button.tsx 66.66% 3 Missing ⚠️
pluto/src/vis/schematic/Labeled.tsx 0.00% 3 Missing ⚠️
pluto/src/vis/diagram/Diagram.tsx 0.00% 1 Missing ⚠️
... and 2 more

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##               rc     #830      +/-   ##
==========================================
- Coverage   46.32%   45.74%   -0.59%     
==========================================
  Files        1089     1090       +1     
  Lines       68058    69044     +986     
  Branches     3503     3508       +5     
==========================================
+ Hits        31531    31584      +53     
- Misses      35482    36416     +934     
+ Partials     1045     1044       -1     
Flag Coverage Δ
aspen 50.30% <ø> (-0.11%) ⬇️
cesium 75.53% <ø> (ø)
clientpy 86.04% <ø> (ø)
clientts 61.36% <ø> (ø)
pluto 34.19% <6.13%> (-1.23%) ⬇️
synnax 28.58% <ø> (+0.07%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor Author

@pjdotson pjdotson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can make some of these a different PR, but major thoughts:

  • The "Label Alignment" feature moves the element around and not the label when the label is bigger than the element. This causes issues such as the handles for edges not matching up with the right point on the element.
  • The "text alignment" feature should have an option for justified as well.
  • Off Page Reference:
    • Should not have the label wrap width, label alignment, or second set of orientation controls.
  • Value:
    • Something is a little off with the value width. Sometimes, I update it and the value box does not re-render.
    • The orientation does not seem to do anything, it should change the label orientation.
    • Also should be able to change the orientation of the actual value
    • Should be able to change the text size of the actual value and units
  • Switch:
    • Orientation controls act very odd. They move the control chip around but not the actual orientation of the switch.
  • Button:
    • Orientation controls act very odd, they move the control chip around but not the button.
    • Don't need the label wrap width or label alignment.
    • Should be able to toggle if the control chip is visible
  • Setpoint:
    • When the units get too large, they overflow oddly.
    • I still think it should function more like a button (you only have a command channel, its display does not change based off of the response) and less like the switch.
    • When I change the color, the boxes don't change synchronously, which is super trippy.
  • Text Box:
    • Add left / center / right / alignment.
    • Be able to make the text change orientation
  • Tank / Box:
    • Box border radius should have "px" at the end
    • The orientation guide does not work
  • Move scale to percent based, and add a percentage at the end in the forms.
  • I still got these errors in my console:
    • "Warning: Received true for a non-boolean attribute visible."
    • "Warning: Received false for a non-boolean attribute focused."
    • "Warning: React does not recognize the aetherKey prop on a DOM element."
    • "Warning: React does not recognize the endIcon prop on a DOM element."

@@ -110,6 +110,7 @@ export const syncCurrent = async (
// so we move the window a smidge to emit events in order to do things like
// hide traffic lights
runtime.setPosition(xy.translate(position as xy.XY, { x: 1, y: 1 }));
runtime.setPosition(position as xy.XY);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was this line added?


// import "@synnaxlabs/pluto/dist/style.css";
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be uncommented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
console pluto Pluto UI components related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants