Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation about useSyncLanguage #149

Open
aabmets opened this issue Oct 13, 2022 · 3 comments · May be fixed by #173
Open

Missing documentation about useSyncLanguage #149

aabmets opened this issue Oct 13, 2022 · 3 comments · May be fixed by #173

Comments

@aabmets
Copy link

aabmets commented Oct 13, 2022

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

@rherwig
Copy link

rherwig commented Nov 3, 2022

@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
Copy link
Owner

@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. :)

@JCQuintas JCQuintas reopened this Nov 4, 2022
proustibat added a commit to proustibat/ni18n that referenced this issue Apr 21, 2023
@proustibat
Copy link

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 ^^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants