Raxol.UI.Components.HintDisplay (Raxol v0.5.0)
View SourceDisplays contextual hints and keyboard shortcuts.
Summary
Functions
Handles events for the HintDisplay component. Typically does not handle direct events.
Initializes the HintDisplay component state from props.
Callback implementation for Raxol.UI.Components.Base.Component.mount/1
.
Renders the HintDisplay component if visible and hints are present.
Callback implementation for Raxol.UI.Components.Base.Component.unmount/1
.
Updates the HintDisplay component state in response to messages.
Functions
@spec handle_event(term(), map(), %Raxol.UI.Components.HintDisplay{ hints: term(), id: term(), position: term(), style: term(), visible: term() }) :: {%Raxol.UI.Components.HintDisplay{ hints: term(), id: term(), position: term(), style: term(), visible: term() }, list()}
Handles events for the HintDisplay component. Typically does not handle direct events.
@spec init(map()) :: %Raxol.UI.Components.HintDisplay{ hints: term(), id: term(), position: term(), style: term(), visible: term() }
Initializes the HintDisplay component state from props.
Callback implementation for Raxol.UI.Components.Base.Component.mount/1
.
@spec render( %Raxol.UI.Components.HintDisplay{ hints: term(), id: term(), position: term(), style: term(), visible: term() }, map() ) :: any()
Renders the HintDisplay component if visible and hints are present.
Callback implementation for Raxol.UI.Components.Base.Component.unmount/1
.
@spec update(term(), %Raxol.UI.Components.HintDisplay{ hints: term(), id: term(), position: term(), style: term(), visible: term() }) :: {%Raxol.UI.Components.HintDisplay{ hints: term(), id: term(), position: term(), style: term(), visible: term() }, list()}
Updates the HintDisplay component state in response to messages.