File size: 1,690 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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
import {
useTranslation as originalUseTranslation,
} from 'react-i18next'
import { TFunction, i18n } from 'i18next'
import { TranslateFunctions, createFunctions } from '../../utils/translate-functions.factory.js'
/**
* Extends {@link TranslateFunctions}. Apart from that it also returns all the properties
* defined below.
*
* ```javascript
* import { useTranslation } from 'adminjs'
*
* const MyComponent = () => {
* const { translateButton } = useTranslation()
*
* return (
* <Box>
* <Button variant="contained" onClick={...}>{translateButton('save')}<Button>
* </Box>
* )
* }
* ```
*
* @memberof useTranslation
* @alias UseTranslationResponse
*
* @property {TranslateFunction} ... All functions defined in {@link TranslateFunctions}
*/
export type UseTranslationResponse = TranslateFunctions & {
t: TFunction;
/**
* Current i18n instance.
*/
i18n: i18n;
/**
* Indicates if translation system is ready. In AdminJS it is always ready :).
*/
ready: boolean;
}
/**
* @classdesc
* Extends the useTranslation hook from react-i18next library.
*
* Returns all the {@link TranslateFunctions} + methods returned by the original
* useTranslation method from react-i18next like: `i18n` instance and `ready` flag.
*
* @class
* @subcategory Hooks
* @bundle
* @hideconstructor
* @returns {UseTranslationResponse}
*/
export const useTranslation = (): UseTranslationResponse => {
// eslint-disable-next-line no-shadow
const { i18n, ...rest } = originalUseTranslation()
const translateFunctions = createFunctions(i18n)
return {
...rest,
i18n,
...translateFunctions,
}
}
export default useTranslation
|