Add documentation to notifyListeners function

WordPress · Apr 26, 2022 · 8a2e041 · 8a2e041
1 parent f8690db
commit 8a2e041
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/react-native-aztec/src/AztecInputState.js b/packages/react-native-aztec/src/AztecInputState.js
@@ -35,6 +35,12 @@ export const removeFocusChangeListener = ( listener ) => {
 	}
 };
 
+/**
+ *	Notifies listeners about changes in focus.
+ *
+ * @param {Object}  event           Event data to be notified to listeners.
+ * @param {boolean} event.isFocused True if any Aztec view is currently focused.
+ */
 const notifyListeners = ( { isFocused } ) => {
 	focusChangeListeners.forEach( ( listener ) => {
 		listener( { isFocused } );