Source code for ipyforcegraph.behaviors.tooltip

"""On-hover tooltip behaviors for ``ipyforcegraph`` nodes and links."""

# Copyright (c) 2023 ipyforcegraph contributors.
# Distributed under the terms of the Modified BSD License.

from typing import Any, Optional

import ipywidgets as W
import traitlets as T

from ._base import Behavior, TFeature, _make_trait


@W.register
class NodeTooltip(Behavior):
    """Customize node tooltips, displayed on hover.

    These may be strings or full HTML.
    """

    _model_name: str = T.Unicode("NodeTooltipModel").tag(sync=True)

    label: TFeature = _make_trait(
        "the label to display when hovering over the ``node``, can be ``Column`` or ``Nunjucks`` template",
        stringy=False,
    )

    def __init__(self, label: Optional[TFeature] = None, **kwargs: Any):
        kwargs["label"] = label
        super().__init__(**kwargs)


@W.register
class LinkTooltip(Behavior):
    """Customize link tooltips, displayed on hover.

    These may be strings or full HTML.
    """

    _model_name: str = T.Unicode("LinkTooltipModel").tag(sync=True)

    label: TFeature = _make_trait(
        "the label to display when hovering over the ``link``, can be ``Column`` or ``Nunjucks`` template",
        stringy=False,
    )

    def __init__(self, label: Optional[TFeature] = None, **kwargs: Any):
        kwargs["label"] = label
        super().__init__(**kwargs)