@nextcloud/l10n
    TypeScript icon, indicating that this package has built-in type declarations

    1.6.0 • Public • Published

    @nextcloud/l10n

    Build Status npm Documentation

    Nextcloud L10n helpers for apps and libraries.

    Installation

    npm i -S @nextcloud/l10n
    

    Usage

    OC.L10n abstraction

    You can use helpers in this package in order generate code that also works when it's not loaded on a Nextcloud page. This is primary useful for testing. The logic will just return the original string if the global variable OC isn't found.

    In order to not break the l10n string extraction scripts, make sure to alias the imported function to match the legacy syntax:

    import {translate as t, translatePlural as n} from '@nextcloud/l10n'
    
    t('myapp', 'Hello!')
    n('myapp', '%n cloud', '%n clouds', 100)

    See the localization docs for more info.

    Independent translation

    You can use this package to translate your app or library independent of Nextcloud. For that you need .po(t) files. These can be extracted with gettext-extractor.

    import { getGettextBuilder } from '@nextcloud/l10n/gettext'
    
    const lang = 'sv'
    const po = ... // Use https://github.com/smhg/gettext-parser to read and convert your .po(t) file
    
    const gt = getGettextBuilder()
        .detectLocale()
        .addTranslation('sv', po)
        .build()

    Translate single string

    gt.gettext('my source string')

    Placeholders

    gt.gettext('this is a {placeholder}. and this is {key2}', {
        placeholder: 'test',
        key2: 'also a test',
    })

    See the developer docs for general guidelines.

    Translate plurals

    gt.ngettext('%n Mississippi', '%n Mississippi', 3)

    See the developer docs for general guidelines.

    Keywords

    Install

    npm i @nextcloud/l10n

    DownloadsWeekly Downloads

    14,173

    Version

    1.6.0

    License

    GPL-3.0-or-later

    Unpacked Size

    77.1 kB

    Total Files

    19

    Last publish

    Collaborators

    • gretadoci
    • mejo-
    • artonge
    • max-nextcloud
    • st3iny
    • marcoambrosinii
    • icewind1991
    • skjnldsv
    • christophwurst
    • juliushaertl
    • nickvergessen