telegraf-i18n

Internationalization middleware for Telegraf

Showing:

Popularity

Downloads/wk

318

GitHub Stars

64

Maintenance

Last Commit

2yrs ago

Contributors

8

Package

Dependencies

3

Size (min+gzip)

43.9KB

License

MIT

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

Build Status NPM Version js-standard-style

i18n for Telegraf

Internationalization middleware for Telegraf.

Installation

$ npm install telegraf-i18n

Example

const Telegraf = require('telegraf')
const TelegrafI18n = require('telegraf-i18n')

/* 
yaml and json are ok
Example directory structure:
├── locales
│   ├── en.yaml
│   ├── en-US.yaml
│   ├── it.json
│   └── ru.yaml
└── bot.js
*/

const i18n = new TelegrafI18n({
  defaultLanguage: 'en',
  allowMissing: false, // Default true
  directory: path.resolve(__dirname, 'locales')
})

// Also you can provide i18n data directly
i18n.loadLocale('en', {greeting: 'Hello!'})

const app = new Telegraf(process.env.BOT_TOKEN)

// telegraf-i18n can save current locale setting into session.
const i18n = new TelegrafI18n({
  useSession: true,
  defaultLanguageOnMissing: true, // implies allowMissing = true
  directory: path.resolve(__dirname, 'locales')
})

app.use(Telegraf.memorySession())
app.use(i18n.middleware())

app.hears('/start', (ctx) => {
  const message = ctx.i18n.t('greeting', {
    username: ctx.from.username
  })
  return ctx.reply(message)
})

app.startPolling()

See full example.

User context

Telegraf user context props and functions:

app.use((ctx) => {
  ctx.i18n.locale()                    // Get current locale 
  ctx.i18n.locale(code)                // Set current locale  
  ctx.i18n.t(resourceKey, [context])   // Get resource value (context will be used by template engine)
});

Helpers

const { match, reply } = require('telegraf-i18n')

// In case you use custom keyboard with localized labels.
bot.hears(match('keyboard.foo'), (ctx) => ...)

//Reply helper
bot.command('help', reply('help'))

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100