Module vx-hooks/useMouse

useMouse

• useMouse(): { addEvent: () => void; cancelEvent: () => void; state: Ref<{ clientX?: undefined | number; clientY?: undefined | number; pageX?: undefined | number; pageY?: undefined | number; screenX?: undefined | number; screenY?: undefined | number }> }

• 获取鼠标位置信息

  summary

  绑定 document mousemove 事件, 获取鼠标位置信息

  example

   const { state, addEvent, cancelEvent } = useMouse()
  
   // 鼠标移动，获取当前鼠标位置信息
   // mousemove to clientX: 10 clientY: 10
   // state: { clientX: 10, clientY: 10 }
   
   //解绑
   cancelEvent()
  
   //再次绑定
   addEvent() 
  
  

  Returns { addEvent: () => void; cancelEvent: () => void; state: Ref<{ clientX?: undefined | number; clientY?: undefined | number; pageX?: undefined | number; pageY?: undefined | number; screenX?: undefined | number; screenY?: undefined | number }> }

  • addEvent: () => void

    • • (): void

      • Returns void

  • cancelEvent: () => void

    • • (): void

      • Returns void

  • state: Ref<{ clientX?: undefined | number; clientY?: undefined | number; pageX?: undefined | number; pageY?: undefined | number; screenX?: undefined | number; screenY?: undefined | number }>