use_url_components

use_url_components is a hook that returns the current URL split into components using urllib.parse.urlsplit.

Example

from deephaven import ui


@ui.component
def url_info():
    url = ui.use_url_components()
    return ui.flex(
        ui.text(f"Scheme: {url.scheme}"),
        ui.text(f"Host: {url.netloc}"),
        ui.text(f"Path: {url.path}"),
        ui.text(f"Query: {url.query}"),
        ui.text(f"Fragment: {url.fragment}"),
        direction="column",
    )


app = url_info()

Recommendations

Prefer more specific hooks over use_url_components when possible: use_path for the path, use_query_params for query strings, and use_params for route parameters.
The returned object is a standard Python SplitResult from urllib.parse, so all SplitResult attributes and methods are available.

API Reference

Get the current URL broken into components.

Returns: A SplitResult named tuple with fields scheme: URL scheme (e.g. "https")

netloc: Network location (e.g. "example.com:8080")

path: Path component

query: Query string (without leading "?")

fragment: Fragment (without leading "#")