docs: Document Hooks.mouseCapture (revery-ui#861)

taylon · May 26, 2020 · 019771a · 019771a
1 parent a0ec051
commit 019771a
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/UI_Hooks/Revery_UI_Hooks.re b/src/UI_Hooks/Revery_UI_Hooks.re
@@ -140,6 +140,14 @@ let transitionf =
 
 let spring = SpringHook.spring;
 
+/**
+ * let%hook (captureMouse, captureState) = Hooks.mouseCapture(...);
+ *
+ *   where [captureMouse] requires the initial state to be passed as its argument.
+ *
+ * Each callback is passed the current state and event data, and requires either a
+ * state value to be returned or [None] to stop the capture.
+ */
 let mouseCapture =
     (
       ~onMouseDown=(state, _evt) => Some(state),