Add busy param to docs

2017-02-14 10:34:43 +00:00 · 2017-02-14 10:34:43 +00:00 · 43a740df15
parent ba3e62e395
commit 43a740df15
1 changed files with 2 additions and 0 deletions
--- a/src/components/views/login/InteractiveAuthEntryComponents.js
+++ b/src/components/views/login/InteractiveAuthEntryComponents.js
@ -33,6 +33,8 @@ import MatrixClientPeg from '../../../MatrixClientPeg';
 * stageParams:            params from the server for the stage being attempted
 * errorText:              error message from a previous attempt to authenticate
 * submitAuthDict:         a function which will be called with the new auth dict
+ * busy:                   a boolean indicating whether the auth logic is doing something
+ *                         the user needs to wait for.
 *
 * Each component may also provide the following functions (beyond the standard React ones):
 *    focus: set the input focus appropriately in the form.