@corets/use-translator/dist/index.d.ts

React hooks for the @corets/translator package

import { ObservableTranslator, TranslateFunctionFactoryOptions, TranslateFunction } from '@corets/translator';
import * as react from 'react';
import { ReactNode } from 'react';

declare type TranslatorLanguage = {
    current: string;
    fallback: string | undefined;
    available: string[];
    set: (language: string) => void;
};
declare type UseTranslator = (translator?: ObservableTranslator) => ObservableTranslator;
declare type UseTranslate = (translator?: ObservableTranslator, options?: TranslateFunctionFactoryOptions) => TranslateFunction;
declare type UseLanguage = (translator?: ObservableTranslator) => TranslatorLanguage;

declare const TranslatorContext: react.Context<ObservableTranslator | null>;

declare const useTranslator: UseTranslator;

declare const useTranslate: UseTranslate;

declare const useLanguage: UseLanguage;

declare type TranslatorProviderProps = {
    instance: ObservableTranslator;
    children?: ReactNode;
};
declare const TranslatorProvider: (props: TranslatorProviderProps) => JSX.Element;

export { TranslatorContext, TranslatorLanguage, TranslatorProvider, TranslatorProviderProps, UseLanguage, UseTranslate, UseTranslator, useLanguage, useTranslate, useTranslator };