@rbxts/pretty-react-hooks/out/use-mouse/README.md

Useful hooks for @rbxts/react

## 🪝 `useMouse`

```ts
function useMouse(listener?: (mouse: Vector2) => void): Binding<Vector2>;
```

Returns a binding to the position of the mouse.

If a listener is provided, it will be called when the mouse moves and once on mount.

### 📕 Parameters

-   `listener` - An optional listener to be called when the mouse moves.

### 📗 Returns

-   The position of the mouse in pixels.

### 📘 Example

```tsx
function MouseTracker() {
	const mouse = useMouse();

	return (
		<frame
			AnchorPoint={Vector2.new(1, 1)}
			Size={UDim2.fromOffset(16, 16)}
			Position={mouse.map((p) => UDim2.fromOffset(p.X, p.Y))}
		/>
	);
}
```