Support host and ref options in Menu.open

[ianthomas23]

Implements enhancement #699.

This exposes the Widget.attach optional arguments host and ref in Menu.IOptions to provide greater control over exactly where in the DOM the menu div is attached.

I have kept the names and descriptions of the options the same as in Widget.attach.

[welcome]

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please make sure you followed the pull request template, as this will help us review your contribution more quickly.

You can meet the other Jovyans by joining our Discourse forum. There is also a intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

[krassowski]

With the proposed changes the menu could end up beyond the boundaries of the element. This will be potentially problematic if the parent element (host) has clips the menu off. Is my thinking correct?

I think this is fine to merge as-is, I just wonder if this should be documented.

[ianthomas23]

Yes, your thinking is correct. But it isn't a result of these changes, it was always possible for the menu to be outside of the host element. That is essentially what the ipydatagrid problem using voila was, the menu was appearing outside of the body, which I didn't think was even possible but it is correct following the rules of CSS absolute positioning.

I will add a note about this.

[krassowski]

You will need to run yarn run api and commit changes.

[fcollonval]

Thanks @ianthomas23

FYI (not requiring code changes) it is better to used the non nullish operator ?? rather than the or operator.
The reason or is used a lot in lumino is that the code predates the introduction of that operator.

The goal is to avoid the case of a falsy value being overridden by the default like 0 || 1 != 0 ?? 1 (the first equals one when the second equals 0).

[fcollonval]

in addition to the API update, you will need to lint the code with yarn lint. One of the tests is failing due to

[warn] packages/widgets/tests/src/menu.spec.ts

[ianthomas23]

Thanks for the guidance @krassowski and @fcollonval. I've added the extra documentation to Menu.open, although it could possibly be added to IOpenOptions instead, as that was my entry point into the docs. I've also switched the || to ?? in the new code whilst I was there.

[ianthomas23]

I cannot tell if the failing macos-latest webkit-headless CI run is something that I have caused or if it is unrelated.

[fcollonval]

I cannot tell if the failing macos-latest webkit-headless CI run is something that I have caused or if it is unrelated.

This is due to flakiness - I let @krassowski have a second look.

[fcollonval]

gentle ping to @krassowski

[krassowski]

Thanks!

[welcome]

Congrats on your first merged pull request in this project! 🎉

Thank you for contributing, we are very proud of you! ❤️