admin-bro/types/src/frontend/hooks/use-translation.d.ts

Admin panel for apps written in node.js

import { TFunction, i18n } from 'i18next';
import { TranslateFunctions } from '../../utils/translate-functions.factory';
/**
 * Extends {@link TranslateFunctions}. Apart from that it also returns all the properties
 * defined below.
 *
 * ```javascript
 * import { useTranslation } from 'admin-bro'
 *
 * const MyComponent = () => {
 *   const { translateButton } = useTranslation()
 *
 *   return (
 *     <Box>
 *       <Button variant="primary" onClick={...}>{translateButton('save')}<Button>
 *     </Box>
 *   )
 * }
 * ```
 *
 * @memberof useTranslation
 * @alias UseTranslationResponse
 *
 * @property {TranslateFunction} ... All functions defined in {@link TranslateFunctions}
 */
export declare type UseTranslationResponse = TranslateFunctions & {
    t: TFunction;
    /**
     * Current i18n instance.
     */
    i18n: i18n;
    /**
     * Indicates if translation system is ready. In AdminBro 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 declare const useTranslation: () => UseTranslationResponse;
export default useTranslation;