V Vaylan UI
Overlay

Tooltip

Reveal a brief explanation on hover or keyboard focus.

Preview

Hover, focus, drag, or move the pointer across the preview to see its visual behavior.

Example

<.tooltip text="More information"><button>Info</button></.tooltip>

API contract

tooltip/1 uses declared Phoenix attributes and slots. This table is generated from the compiled component metadata.

AttributeTypeRequiredDefault Accepted values
text :string Yes — Any value matching the declared type
placement :atom No nil [nil, :top, :bottom, :left, :right]
alignment :atom No nil [nil, :start, :center, :end]
color :atom No nil [nil, :neutral, :primary, :secondary, :accent, :info, :success, :warning, :error]
open :boolean No false Any value matching the declared type
class :any No nil Any value matching the declared type
rest :global No — Any value matching the declared type
SlotRequiredSlot attributes
inner_block Yes No slot attributes
content No No slot attributes

States and behavior

Default and caller-supplied variants preserve semantic daisyUI colors and additive classes.

Keyboard and accessibility

Behavioral tests

These automated checks are applied to this component by the package and documentation test suites.

  • ExUnit

    Tooltip variants

    Checks placement, alignment, semantic color, forced-open state, custom content, and pass-through attributes.

    test/vaylan_ui/primereact_adapted_contracts_test.exs
  • Adapted

    PrimeReact scenario adaptation

    Applies independently written Phoenix assertions derived from the documented PrimeReact 10.9.9 behavior group.

    test/vaylan_ui/primereact_adapted_contracts_test.exs
  • Docs

    Preview behavior contract

    Classified as pointer. Hover, focus, drag, or move the pointer across the preview to see its visual behavior.

    examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs
  • Docs

    Stable public component page

    Renders the component name, example, API contract, accepted values, and keyboard and accessibility guidance at its stable URL.

    examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs