Update overlay props #4261

tgberkeley · 2024-10-29T18:16:06Z

All Submissions:

Have you followed the guidelines stated in CONTRIBUTING.md file?
Have you checked to ensure there aren't any other open Pull Requests for the desired changed?

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

New Feature Submission:

Does your submission pass the tests?
Have you linted your code locally prior to submission?

Changes To Core Features:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your core changes, as applicable?
Have you successfully ran tests with your changes locally?

After these steps, you're ready to open a pull request.

a. Give a descriptive title to your PR.

b. Describe your changes.

c. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).

masenf · 2024-10-30T18:31:45Z

reflex/components/radix/primitives/drawer.py

    # Whether the drawer is open or not.
    open: Var[bool]

-    # Enable background scaling, it requires an element with [vaul-drawer-wrapper] data attribute to scale its background.
-    should_scale_background: Var[bool]
+    # Fires when the drawer is opened.


Suggested change

# Fires when the drawer is opened.

# Fires when the drawer is opened or closed.

masenf · 2024-10-30T18:32:34Z

reflex/components/radix/primitives/drawer.py

+    # When `False`, it allows to interact with elements outside of the drawer without closing it. Defaults to `True`.
+    modal: Var[bool]
+
+    # Direction of the drawer. This adjust the animations and the drag direction. Defaults to `"bottom"`


Suggested change

# Direction of the drawer. This adjust the animations and the drag direction. Defaults to `"bottom"`

# Direction of the drawer. This adjusts the animations and the drag direction. Defaults to `"bottom"`

masenf · 2024-10-30T18:32:46Z

reflex/components/radix/primitives/drawer.py


-    # Number between 0 and 1 that determines when the drawer should be closed.
-    close_threshold: Var[float]
+    # When `False`, it allows to interact with elements outside of the drawer without closing it. Defaults to `True`.


Suggested change

# When `False`, it allows to interact with elements outside of the drawer without closing it. Defaults to `True`.

# When `False`, it allows interaction with elements outside of the drawer without closing it. Defaults to `True`.

masenf · 2024-10-30T18:33:20Z

reflex/components/radix/primitives/drawer.py

+    # Gets triggered after the open or close animation ends, it receives an open argument with the open state of the drawer by the time the function was triggered.
+    on_animation_end: EventHandler[identity_event(bool)]
+
+    # When false dragging, clicking outside, pressing esc, etc. will not close the drawer. Use this in combination with the open prop, otherwise you won't be able to open/close the drawer.


Suggested change

# When false dragging, clicking outside, pressing esc, etc. will not close the drawer. Use this in combination with the open prop, otherwise you won't be able to open/close the drawer.

# When `False`, dragging, clicking outside, pressing esc, etc. will not close the drawer. Use this in combination with the open prop, otherwise you won't be able to open/close the drawer.

masenf · 2024-10-30T18:33:48Z

reflex/components/radix/primitives/drawer.py

+    # When false dragging, clicking outside, pressing esc, etc. will not close the drawer. Use this in combination with the open prop, otherwise you won't be able to open/close the drawer.
+    dismissible: Var[bool]
+
+    # When true dragging will only be possible by the handle.


Suggested change

# When true dragging will only be possible by the handle.

# When `True`, dragging will only be possible by the handle.

masenf · 2024-10-30T18:37:01Z

reflex/components/radix/primitives/drawer.py

    # When `True`, it prevents scroll restoration. Defaults to `True`.
    preventScrollRestoration: Var[bool]

-    # Fires when the drawer is opened.
-    on_open_change: EventHandler[identity_event(bool)]
+    # Enable background scaling, it requires an element with [vaul-drawer-wrapper] data attribute to scale its background.


unclear what this means, but based on https://www.shadcn-vue.com/docs/components/drawer#scale-background, it seems vaul-drawer-wrapper isn't a "data attribute", but just a regular attribute, likely applied via special_props=[Var("vaulDrawerWrapper")], but i haven't tested it

Suggested change

# Enable background scaling, it requires an element with [vaul-drawer-wrapper] data attribute to scale its background.

# Enable background scaling, it requires container element with `vaul-drawer-wrapper` attribute to scale its background.

masenf · 2024-10-30T18:41:17Z

reflex/components/radix/themes/components/context_menu.py

+    # Whether to hide the content when the trigger becomes fully occluded. Defaults to False.
+    hide_when_detached: Var[bool]
+
+    # Fired when the dialog is closed.


This description for on_close_auto_focus doesn't seem quite right

you're right, fixed

masenf · 2024-10-30T18:41:40Z

reflex/components/radix/themes/components/context_menu.py

    on_close_auto_focus: EventHandler[empty_event]

    # Fired when the escape key is pressed.
    on_escape_key_down: EventHandler[empty_event]

-    # Fired when a pointer down event happens outside the context menu.
+    # Fired when the pointer is down outside the dialog.


Here and below the object is changed to "dialog", but this really is a "context menu"

fixed all 3

masenf · 2024-10-30T18:43:42Z

reflex/components/radix/themes/components/context_menu.py

+    # When true, prevents the user from interacting with the item.
+    disabled: Var[bool]
+
+    # Optional text used for typeahead purposes. By default the typeahead behavior will use the .textContent of the item. Use this when the content is complex, or you have non-textual content inside.


comment mentions .textContent, but the prop is called text_value, which seems confusing

Tom Gotsman added 8 commits October 29, 2024 16:12

hover card and one prop for dialog

a15737a

add missing props of drawer

756a7ca

fix context and dropdown menu

f45dcd9

add popover props

c59ea23

fix hover card and alert dialog final

418f4a7

fix pyi

5194cde

update drawer pyi

a7284db

pyi fix again

3b628b5

masenf reviewed Oct 30, 2024

View reviewed changes

Tom Gotsman added 5 commits November 1, 2024 09:01

fix from masen changes

1777608

fix pyi

c1e2c5b

merge main

088dcbf

fix pyi again

319e81d

ruff fix

9554af3

picklelo approved these changes Nov 1, 2024

View reviewed changes

tgberkeley merged commit b70f33d into main Nov 1, 2024
27 of 29 checks passed

masenf deleted the update-overlay-props branch December 12, 2024 07:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update overlay props #4261

Update overlay props #4261

tgberkeley commented Oct 29, 2024

masenf Oct 30, 2024

tgberkeley Nov 1, 2024

masenf Oct 30, 2024

tgberkeley Nov 1, 2024

masenf Oct 30, 2024

tgberkeley Nov 1, 2024

masenf Oct 30, 2024

tgberkeley Nov 1, 2024

masenf Oct 30, 2024

tgberkeley Nov 1, 2024

masenf Oct 30, 2024

tgberkeley Nov 1, 2024

masenf Oct 30, 2024

tgberkeley Nov 1, 2024

masenf Oct 30, 2024

tgberkeley Nov 1, 2024

masenf Oct 30, 2024

tgberkeley Nov 1, 2024

	# Fires when the drawer is opened.
	# Fires when the drawer is opened or closed.

	# Direction of the drawer. This adjust the animations and the drag direction. Defaults to `"bottom"`
	# Direction of the drawer. This adjusts the animations and the drag direction. Defaults to `"bottom"`

	# When `False`, it allows to interact with elements outside of the drawer without closing it. Defaults to `True`.
	# When `False`, it allows interaction with elements outside of the drawer without closing it. Defaults to `True`.

	# When false dragging, clicking outside, pressing esc, etc. will not close the drawer. Use this in combination with the open prop, otherwise you won't be able to open/close the drawer.
	# When `False`, dragging, clicking outside, pressing esc, etc. will not close the drawer. Use this in combination with the open prop, otherwise you won't be able to open/close the drawer.

	# When true dragging will only be possible by the handle.
	# When `True`, dragging will only be possible by the handle.

	# Enable background scaling, it requires an element with [vaul-drawer-wrapper] data attribute to scale its background.
	# Enable background scaling, it requires container element with `vaul-drawer-wrapper` attribute to scale its background.

Update overlay props #4261

Update overlay props #4261

Conversation

tgberkeley commented Oct 29, 2024

All Submissions:

Type of change

New Feature Submission:

Changes To Core Features:

After these steps, you're ready to open a pull request.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment