File size: 890 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
import { useDispatch } from 'react-redux'
import { type NoticeMessage } from '../interfaces/noticeMessage.interface.js'
import { addNotice, type AddNoticeResponse } from '../store/actions/add-notice.js'
/**
* @memberof useNotice
* @alias AddNotice
*/
export type AddNotice = (notice: NoticeMessage) => AddNoticeResponse
/**
* @classdesc
* Hook which allows you to add notice message to the app.
*
* ```javascript
* import { useNotice, Button } from 'adminjs'
*
* const myComponent = () => {
* const sendNotice = useNotice()
* return (
* <Button onClick={() => sendNotice({ message: 'I am awesome' })}>I am awesome</Button>
* )
* }
* ```
*
* @class
* @subcategory Hooks
* @bundle
* @hideconstructor
*/
export const useNotice = (): AddNotice => {
const dispatch = useDispatch()
return (notice) => dispatch(addNotice(notice))
}
export default useNotice
|