Skip to content

Commit

Permalink
Improve api reference descripitions
Browse files Browse the repository at this point in the history
  • Loading branch information
iamhosseindhv committed Feb 27, 2020
1 parent 2c53ecc commit 74702ed
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions src/SnackbarProvider.js
Original file line number Diff line number Diff line change
Expand Up @@ -362,19 +362,18 @@ SnackbarProvider.propTypes = {
}),
/**
* The number of milliseconds to wait before automatically calling the
* `onClose` function. `onClose` should then set the state of the `open`
* prop to hide the Snackbar. This behavior is disabled by default with
* the `null` value.
* `onClose` function. By default snackbars get closed after 5000 milliseconds.
* Set autoHideDuration to 'undefined' if you don't want snackbars to automatically close.
* Alternatively pass `persist: true` in the options parameter of enqueueSnackbar.
*/
autoHideDuration: PropTypes.number,
/**
* If `true`, the `autoHideDuration` timer will expire even if the window is not focused.
*/
disableWindowBlurListener: PropTypes.bool,
/**
* Callback fired when the component requests to be closed.
* The `reason` parameter can optionally be used to control the response to `onClose`,
* for example ignoring `clickaway`.
* Callback fired when the component is gets closed.
* The `reason` parameter can optionally be used to control the response to `onClose`.
*
* @param {object} event The event source of the callback
* @param {string} reason Can be:`"timeout"` (`autoHideDuration` expired) or: `"clickaway"`
Expand Down

0 comments on commit 74702ed

Please sign in to comment.