[REF-2196] Create rx.scroll_to special event

[picklelo]

We should have a special event handler called rx.scroll_to("id") that will scroll to the element with the given id.

The current way to accomplish this is

rx.call_script(f"document.getElementById('{id}').scrollIntoView();")

But there should be a simpler API that wraps this.

_REF-2196

[Yummy-Yums]

@picklelo which folder/module does this special event go to? is it the same as rx.console_log ?

[picklelo]

@Yummy-Yums yes we can put it in the same folder. I'm thinking this can maybe just be an alias that returns the call_script above (i.e. we don't need to modify anything in the Javascript side).

[Yummy-Yums]

Will select by ID be enough for this use case? What of using the query selector i.e. Selecting by Class or that's not necessary for now

…

On Wed, Mar 13, 2024, 10:17 PM Nikhil Rao ***@***.***> wrote: @Yummy-Yums <https://github.com/Yummy-Yums> yes we can put it in the same folder. I'm thinking this can maybe just be an alias that returns the call_script above (i.e. we don't need to modify anything in the Javascript side). — Reply to this email directly, view it on GitHub <#2834 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ASS5PMGG7RBHNQWVWLVT2B3YYDGAXAVCNFSM6AAAAABEREYWZSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOJVHE4DONZSGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[picklelo]

The ID should be enough for now (we can add more fancy stuff later). You can see here for an example of how I've used this: https://github.com/picklelo/reflex-chat/blob/main/custom_components/reflex_chat/chat.py#L75

[Yummy-Yums]

@picklelo quick one, I intended to use the latter but based on our example above, a simple return call_script will work but that already returns an EventSpec , so how will the fn_name/signature be seen on the js side?

Also, will tests be necessary for this one event action?

[picklelo]

@Yummy-Yums the way you have it in your PR is exactly what I was thinking, we don't need anything on the js side for this function. Will review your PR this weekend.