Skip to content

feat(shell-panel): Add displayMode and heightScale properties and deprecate detached and detachedHeightScale #6919

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

Merged
merged 37 commits into from
May 15, 2023

Conversation

driskull
Copy link
Member

@driskull driskull commented May 4, 2023

Related Issue: #6388

Summary

  • Adds the property displayMode on the calcite-shell-panel.
    • DisplayMode = "dock" | "float" | "overlay";
  • Deprecates the property detachedHeightScale on the calcite-shell-panel, use heightScale instead.
  • Deprecates the property detached on the calcite-shell-panel, use displayMode instead.
  • Deprecates the CSS property --calcite-shell-panel-detached-max-height, use --calcite-shell-panel-max-height instead.
  • Moves the resize handle to inside of the content node.
  • Test app
  • tests

Future

  • It would be nice if content-behind on the shell and the displayMode on the shell-panel were tied together more in order to prevent unwanted display combinations

@github-actions github-actions bot added the enhancement Issues tied to a new feature or request. label May 4, 2023
@driskull driskull added the pr ready for visual snapshots Adding this label will run visual snapshot testing. label May 5, 2023
macandcheese added a commit that referenced this pull request May 6, 2023
## Summary
Adding additional "left" and "right" animation classes, to support
#6919 and other future
needs.

- Adds `calcite-animate__in-left` and `calcite-animate__in-right`
classes.
- Updates demo page with new classes, and updates demo page "Reset"
button functionality.
- Q - I am imagining for now components will set the correct animation
where needed based on `rtl`. Not sure if there's a better way to make
these rtl / ltr supportive with the classes themselves.
@driskull driskull changed the title feat(shell-panel): Add overlaid property to overlay the content only feat(shell-panel): Add displayMode property and deprecate detached property. May 8, 2023
@driskull driskull marked this pull request as ready for review May 8, 2023 20:53
@driskull driskull requested a review from a team as a code owner May 8, 2023 20:53
@driskull driskull added pr ready for visual snapshots Adding this label will run visual snapshot testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels May 8, 2023
@jcfranco jcfranco changed the title feat(shell-panel): Add displayMode property and deprecate detached property. feat(shell-panel): Add displayMode property and deprecate detached property. May 9, 2023
Copy link
Member

@jcfranco jcfranco left a comment

Choose a reason for hiding this comment

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

✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨
✨✨🐚🐚🐚✨✨🐚🐚✨✨✨🐚🐚✨✨🐚✨✨✨🐚✨
✨🐚✨✨✨✨🐚✨✨🐚✨🐚✨✨🐚✨🐚✨✨✨🐚✨
✨🐚✨✨✨✨🐚✨✨🐚✨🐚✨✨🐚✨🐚✨✨✨🐚✨
✨🐚✨✨✨✨🐚✨✨🐚✨🐚✨✨🐚✨🐚✨✨✨✨✨
✨✨🐚🐚🐚✨✨🐚🐚✨✨✨🐚🐚✨✨🐚🐚🐚✨🐚✨
✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨✨

Should we update the usage files as well? I think we could do an independent pass at all components. cc @geospatialem

@@ -0,0 +1 @@
export type DisplayMode = "docked" | "detached" | "overlaid";
Copy link
Member

Choose a reason for hiding this comment

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

WDYT about these not being in the past (dock | detach | overlay)? Not sure about detach though. Maybe isolate or separate?

Copy link
Member Author

Choose a reason for hiding this comment

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

@macandcheese what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

It seems to match other tenses (escapeDisabled, textEnabled) - and keeps the existing detached nomenclature. I think isolate or separate is... maybe less clear?

Copy link
Member

Choose a reason for hiding this comment

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

It seems to match other tenses (escapeDisabled, textEnabled)

Those are prop names and not the values. I don't think we have anything similar for existing modes. I could be wrong.

and keeps the existing detached nomenclature. I think isolate or separate is... maybe less clear?

Nothing good ol' doc won't fix, although I do hear you on isolate and separate. Do you think detach would still be less clear?

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree since they are now values and not properties we should probably have them to not be past tense.

@macandcheese can you come up with the values? I think the only one in question is detach right? What about "float"?

Copy link
Contributor

@macandcheese macandcheese May 9, 2023

Choose a reason for hiding this comment

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

Ah, yeah that makes sense. None of the suggestions are … speaking to me, lol, but I guess “float” seems to make the most sense if we don’t want to just use “detach”? cc @asangma

Copy link
Member

@jcfranco jcfranco May 9, 2023

Choose a reason for hiding this comment

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

👍🏼 for float! 🎪🤡🎈

But, I'll defer to y'all whether it's detach or float.

}

/**
* Specifies the display mode - `"docked"` (full height, displays adjacent to center content), `"detached"` (not full height, content separated detached from action bar, displays on top of center content),
Copy link
Member

Choose a reason for hiding this comment

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

+@geospatialem for editorial consideration

Copy link
Member

Choose a reason for hiding this comment

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

nitpick:

.....content is separated from calcite-action-bar, displays....

@driskull driskull added pr ready for visual snapshots Adding this label will run visual snapshot testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels May 9, 2023
@driskull
Copy link
Member Author

driskull commented May 9, 2023

Ready for review again.

@macandcheese macandcheese added pr ready for visual snapshots Adding this label will run visual snapshot testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels May 12, 2023
@macandcheese macandcheese removed the pr ready for visual snapshots Adding this label will run visual snapshot testing. label May 12, 2023
@macandcheese macandcheese added the pr ready for visual snapshots Adding this label will run visual snapshot testing. label May 12, 2023
@macandcheese macandcheese added pr ready for visual snapshots Adding this label will run visual snapshot testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels May 12, 2023
@macandcheese
Copy link
Contributor

@ashetland @SkyeSeitz could you take a look at this Chromatic build? A few expected height changes and new story. Thanks!

@macandcheese macandcheese added pr ready for visual snapshots Adding this label will run visual snapshot testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels May 15, 2023
@driskull driskull merged commit c34d2b8 into master May 15, 2023
@driskull driskull deleted the dris0000/shell-panel-overlaid branch May 15, 2023 19:14
@github-actions github-actions bot added this to the 2023 May Priorities milestone May 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Issues tied to a new feature or request. pr ready for visual snapshots Adding this label will run visual snapshot testing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants