Module "hooks/useSrefActive"

useSrefActive

• useSrefActive(stateName: string, params?: object, activeClass: string, options?: TransitionOptions): ActiveLinkProps

• A hook to create a link to a state and track its active status.

  This hook returns link (anchor tag) props for a given state reference. The resulting props can be spread onto an anchor tag. If the referenced state (and params) is active, then the activeClass is returned as the className prop.

  The props returned from this hook are:

  • href: the browser URL of the referenced state
  • onClick: a mouse event handler that will active the referenced state
  • className: the activeClass parameter when the state (or any child state) is active, otherwise an empty string

  Example:

  function HomeLink() {
    const sref = useSref('home', null, 'active');
    return <a {...sref}>Home</a>
  }

  Example:

  function UserLink({ userId, username }) {
    const sref = useSref('users.user', { userId: userId }, 'active');
    return <a {...sref}>{username}</a>
  }

  This hook is a variation of the useSref hook.

  Parameters

  • stateName: string

    The name of the state to link to

  • Default value params: object = {}

    Any parameter values

  • activeClass: string

    A css class string to use when the state is active

  • Default value options: TransitionOptions = {}

    Transition options used when the onClick handler fires.

  Returns ActiveLinkProps