mobx-ui-statelets API Reference

Class HoverState

constructor

  • Instantiates a generic UI state.

    Parameters

    Returns HoverState

devOptions

devOptions: StateDevOptions

Development-time settings

isHovered

  • get isHovered(): boolean

  • Returns true if the presentational layer has reported that the corresponding element representing this state is being hovered on.

    Returns boolean

name

  • get name(): null | string

  • Returns the UI state's debug name.

    Returns null | string

reportHover

  • reportHover(): void

  • The presentational layer should report the corresponding state that the element is being hovered.

    Returns void

reportUnhover

  • reportUnhover(): void

  • The presentational layer should report to the corresponding state that the element is no longer being hovered.

    Returns void

Generated using TypeDoc