Escape Hatches

deephaven.ui offers a versatile API for building comprehensive UI layouts. However, there may be scenarios where the provided API does not cover specific customization needs. In such cases, three “escape hatches” are available to enable additional customization of deephaven.ui components.

Avoid using these options unless necessary.

1. ui.html - Provides a set of functions for creating raw HTML elements.
2. UNSAFE_class_name - Allows a custom A CSS class to apply to most deephaven.ui components.
3. UNSAFE_style - Allows a custom A CSS style to apply to most deephaven.ui components.

ui.html

deephaven.ui provides a large list of components for building a UI. If you need a UI element that is not available, you can use ui.html to inject html tags into your UI.

from deephaven import ui

component_with_html = ui.view(
    ui.heading("HTML inside a component"),
    ui.html.div(
        ui.html.h1("Welcome to Deephaven"),
        ui.html.p("This is a custom HTML component."),
        id="html_div",
    ),
)

UNSAFE_class_name

If a component’s styling props are not sufficient, you can set the UNSAFE_class_name prop, which sets the HTML className attribute on the element. To do this, you must use ui.html to define a class name.

from deephaven import ui

unsafe_class_name = ui.panel(
    ui.html.style(
        """
        .my_class { background: red !important;}
        """
    ),
    ui.button("test", UNSAFE_class_name="my_class"),
    ui.html.div("test", class_name="my_class"),
)

UNSAFE_style

Rather than define a class name as above, you can use the UNSAFE_style prop, which allows you to set style props directly on a component using a dict.

from deephaven import ui

unsafe_style = ui.panel(
    ui.button("test", UNSAFE_style={"background": "red"}),
    ui.button("test", UNSAFE_style={"background": "green"}),
)