Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
Scorecards supply-chain security / Scorecards analysis (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
25 lines
1.7 KiB
JSON
25 lines
1.7 KiB
JSON
{
|
|
"hookDescription": "The basic building block for creating custom snackbar.",
|
|
"parametersDescriptions": {
|
|
"autoHideDuration": {
|
|
"description": "The number of milliseconds to wait before automatically calling the <code>onClose</code> function. <code>onClose</code> should then set the state of the <code>open</code> prop to hide the Snackbar. This behavior is disabled by default with the <code>null</code> value."
|
|
},
|
|
"disableWindowBlurListener": {
|
|
"description": "If <code>true</code>, the <code>autoHideDuration</code> timer will expire even if the window is not focused."
|
|
},
|
|
"onClose": {
|
|
"description": "Callback fired when the component requests to be closed. Typically <code>onClose</code> is used to set state in the parent component, which is used to control the <code>Snackbar</code> <code>open</code> prop. The <code>reason</code> parameter can optionally be used to control the response to <code>onClose</code>, for example ignoring <code>clickaway</code>."
|
|
},
|
|
"open": { "description": "If <code>true</code>, the component is shown." },
|
|
"resumeHideDuration": {
|
|
"description": "The number of milliseconds to wait before dismissing after user interaction. If <code>autoHideDuration</code> prop isn't specified, it does nothing. If <code>autoHideDuration</code> prop is specified but <code>resumeHideDuration</code> isn't, we default to <code>autoHideDuration / 2</code> ms."
|
|
}
|
|
},
|
|
"returnValueDescriptions": {
|
|
"getRootProps": { "description": "Resolver for the root slot's props." },
|
|
"onClickAway": {
|
|
"description": "Callback fired when a "click away" event is detected."
|
|
}
|
|
}
|
|
}
|