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

parts re-render on self-initiated changes #36

Open
YairMarcowMavenomics opened this issue Nov 1, 2019 · 2 comments · May be fixed by #52
Open

parts re-render on self-initiated changes #36

YairMarcowMavenomics opened this issue Nov 1, 2019 · 2 comments · May be fixed by #52
Labels
spec bug Issues in how things are 'supposed' to work

Comments

@YairMarcowMavenomics
Copy link
Contributor

The framework seems to unnecessarily call render on Parts when they change their own Properties, resulting (most obviously) in visible overlays, for example when a SlickGrid column is resized, and potentially in lost state (e.g scroll position), stickiness etc.

Things to consider:

  • Existing Parts could potentially depend on applying their own changes to themselves via render.
  • Other potential cross-cutting future API changes such as removing explicit initialize, adding onOptionsChanged.
@quigleyj-mavenomics
Copy link
Member

Tasks:

  • Review Parts and UDPs
    • Various UDPs, and possibly a built-in part or three, rely on this behavior.
  • Review SlickGrid
    • This needs careful study- the grid shouldn't be relying on this, but might be as a matter of course.
    • Review the PnL, Fund Summary, Rocket Motors, and Table Editor demos for correctness
  • Review docs
    • The existing inline part docs would still be mostly correct, they just need a few tweaks
    • We don't have other public docs on part writing, so no updates needed there
  • Extend the OptionsBag to allow "external" writes
    • Needed for eg, Part Properties editor, PartManager unit tests.
  • Update PartManager unit tests
    • Remove places where we test for old behavior
    • Ensure that we test this new behavior

@quigleyj-mavenomics quigleyj-mavenomics added the spec bug Issues in how things are 'supposed' to work label Nov 5, 2019
@quigleyj-mavenomics
Copy link
Member

Plan is to push this to a branch first to test for any real-world failures, then slowly move UDPs away from this behavior. The process of doing that should help us uncover any major spec risks that we haven't yet seen in making this change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec bug Issues in how things are 'supposed' to work
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants