Missing documentation about useSyncLanguage

[aabmets]

What is the hook import {useSyncLanguage} from 'ni18n' used for?

[rherwig]

@aabmets A use case I know of is to switch the language via a dropdown.

export default function TheLanguageSwitch() {
    const { i18n } = useSyncLanguage();

    const dropdownItems = [
        {
            value: 'de',
            text: 'DE',
        },
        {
            value: 'en',
            text: 'EN',
        },
    ];

    const handleChange = (value: string) => {
        i18n.changeLanguage(value);
    };

    return (
        <Dropdown
            items={dropdownItems}
            value="de"
            handleChange={handleChange}
        />
    );
}

[JCQuintas]

@rherwig is correct here. I thought this was documented, but it seems it isn't.

All the types/functions should be properly documented in code though, so if you are using a typescript capable editor it should pick it up. I'll try to add it to the docs when I get more time.

Feel free to add it yourself as well if you want. :)

[proustibat]

Hi @JCQuintas, I added an example in the PR, you can have a look if you want to see if it matches your expectations. Please be kind, I'm not used to contributing a lot ^^

[abdallhsamy]

i18n.changeLanguage(newLanguageCode).then(() => {
    console.log('should work');
});