i18n | @next-book/publisher

Index

Variables

Functions

Variables

Const default

default: i18n

Const resources

resources: { cs: { annotations: { add-note: string; confirm-destroy: string; default-style-neutral: string; default-style-okay: string; default-style-omg: string; default-style-red-flag: string; edit-note: string; highlights: string; no-annotations-in-chapter: string; no-notes-in-chapter: string; notes: string; show-all: string; update-note: string; work-desk: string }; common: { note: string; toggle-full-screen: string }; controls: { annotations: string; options: string; show-annotations: string; show-options: string; show-toc: string; toc: string }; navigation: { about: string; chapter: string; continue: string; continueReading: string; go: string; minutes-left: string; minutes-left-long: string; next-chapter: string; nthChapterNthSentence: string; nthSentence: string; prev-chapter: string; progress: string; progress-long: string; return: string; sentence: string; seqReturnAnotherChapter: string; seqReturnThisChapter: string; show-tips: string; start: string; title-page: string; turn-to: string }; offline: { cache-available: string; cacheUpdateRequested: string; nosw: string; problem: string; unsecure: string; updateCache: string }; onboarding: { annotations: string; annotations-heading: string; close: string; intro: string; intro-head: string; intro-hide: string; intro-show: string; next: string; pagination: string; pagination-heading: string; read-offline: string; remember: string; remember-heading: string }; options: { about-this-book: string; annotation-styles: string; basic-style: string; basic-style-label: string; change-does-overwrite-existing: string; color-scheme: string; color-scheme-auto: string; color-scheme-auto-explanation: string; color-scheme-dark: string; color-scheme-light: string; color-scheme-sepia: string; create-quick-note: string; font-size: string; generated-at: string; invisible-nav-label: string; offline-mode: string; revision: string }; research: { agree: string; decline: string; plea-title: string; researcher: string } }; en: { annotations: { add-note: string; confirm-destroy: string; default-style-neutral: string; default-style-okay: string; default-style-omg: string; default-style-red-flag: string; edit-note: string; highlights: string; no-annotations-in-chapter: string; no-notes-in-chapter: string; notes: string; show-all: string; update-note: string; work-desk: string }; common: { note: string; toggle-full-screen: string }; controls: { annotations: string; options: string; show-annotations: string; show-options: string; show-toc: string; toc: string }; navigation: { about: string; chapter: string; continue: string; continueReading: string; go: string; minutes-left: string; minutes-left-long: string; next-chapter: string; nthChapterNthSentence: string; nthSentence: string; prev-chapter: string; progress: string; progress-long: string; return: string; sentence: string; seqReturnAnotherChapter: string; seqReturnThisChapter: string; show-tips: string; start: string; title-page: string; turn-to: string }; offline: { cache-available: string; cacheUpdateRequested: string; nosw: string; problem: string; unsecure: string; updateCache: string }; onboarding: { annotations: string; annotations-heading: string; close: string; intro: string; intro-head: string; intro-hide: string; intro-show: string; next: string; pagination: string; pagination-heading: string; read-offline: string; remember: string; remember-heading: string }; options: { about-this-book: string; annotation-styles: string; basic-style: string; basic-style-label: string; change-does-overwrite-existing: string; color-scheme: string; color-scheme-auto: string; color-scheme-auto-explanation: string; color-scheme-dark: string; color-scheme-light: string; color-scheme-sepia: string; create-quick-note: string; font-size: string; generated-at: string; invisible-nav-label: string; offline-mode: string; revision: string }; research: { agree: string; decline: string; plea-title: string; researcher: string } } } = ...

Type declaration

cs: { annotations: { add-note: string; confirm-destroy: string; default-style-neutral: string; default-style-okay: string; default-style-omg: string; default-style-red-flag: string; edit-note: string; highlights: string; no-annotations-in-chapter: string; no-notes-in-chapter: string; notes: string; show-all: string; update-note: string; work-desk: string }; common: { note: string; toggle-full-screen: string }; controls: { annotations: string; options: string; show-annotations: string; show-options: string; show-toc: string; toc: string }; navigation: { about: string; chapter: string; continue: string; continueReading: string; go: string; minutes-left: string; minutes-left-long: string; next-chapter: string; nthChapterNthSentence: string; nthSentence: string; prev-chapter: string; progress: string; progress-long: string; return: string; sentence: string; seqReturnAnotherChapter: string; seqReturnThisChapter: string; show-tips: string; start: string; title-page: string; turn-to: string }; offline: { cache-available: string; cacheUpdateRequested: string; nosw: string; problem: string; unsecure: string; updateCache: string }; onboarding: { annotations: string; annotations-heading: string; close: string; intro: string; intro-head: string; intro-hide: string; intro-show: string; next: string; pagination: string; pagination-heading: string; read-offline: string; remember: string; remember-heading: string }; options: { about-this-book: string; annotation-styles: string; basic-style: string; basic-style-label: string; change-does-overwrite-existing: string; color-scheme: string; color-scheme-auto: string; color-scheme-auto-explanation: string; color-scheme-dark: string; color-scheme-light: string; color-scheme-sepia: string; create-quick-note: string; font-size: string; generated-at: string; invisible-nav-label: string; offline-mode: string; revision: string }; research: { agree: string; decline: string; plea-title: string; researcher: string } }
- annotations: { add-note: string; confirm-destroy: string; default-style-neutral: string; default-style-okay: string; default-style-omg: string; default-style-red-flag: string; edit-note: string; highlights: string; no-annotations-in-chapter: string; no-notes-in-chapter: string; notes: string; show-all: string; update-note: string; work-desk: string }
  - add-note: string
  - confirm-destroy: string
  - default-style-neutral: string
  - default-style-okay: string
  - default-style-omg: string
  - default-style-red-flag: string
  - edit-note: string
  - highlights: string
  - no-annotations-in-chapter: string
  - no-notes-in-chapter: string
  - notes: string
  - show-all: string
  - update-note: string
  - work-desk: string
- common: { note: string; toggle-full-screen: string }
  - note: string
  - toggle-full-screen: string
- controls: { annotations: string; options: string; show-annotations: string; show-options: string; show-toc: string; toc: string }
  - annotations: string
  - options: string
  - show-annotations: string
  - show-options: string
  - show-toc: string
  - toc: string
- navigation: { about: string; chapter: string; continue: string; continueReading: string; go: string; minutes-left: string; minutes-left-long: string; next-chapter: string; nthChapterNthSentence: string; nthSentence: string; prev-chapter: string; progress: string; progress-long: string; return: string; sentence: string; seqReturnAnotherChapter: string; seqReturnThisChapter: string; show-tips: string; start: string; title-page: string; turn-to: string }
  - about: string
  - chapter: string
  - continue: string
  - continueReading: string
  - go: string
  - minutes-left: string
  - minutes-left-long: string
  - next-chapter: string
  - nthChapterNthSentence: string
  - nthSentence: string
  - prev-chapter: string
  - progress: string
  - progress-long: string
  - return: string
  - sentence: string
  - seqReturnAnotherChapter: string
  - seqReturnThisChapter: string
  - show-tips: string
  - start: string
  - title-page: string
  - turn-to: string
- offline: { cache-available: string; cacheUpdateRequested: string; nosw: string; problem: string; unsecure: string; updateCache: string }
  - cache-available: string
  - cacheUpdateRequested: string
  - nosw: string
  - problem: string
  - unsecure: string
  - updateCache: string
- onboarding: { annotations: string; annotations-heading: string; close: string; intro: string; intro-head: string; intro-hide: string; intro-show: string; next: string; pagination: string; pagination-heading: string; read-offline: string; remember: string; remember-heading: string }
  - annotations: string
  - annotations-heading: string
  - close: string
  - intro: string
  - intro-head: string
  - intro-hide: string
  - intro-show: string
  - next: string
  - pagination: string
  - pagination-heading: string
  - read-offline: string
  - remember: string
  - remember-heading: string
- options: { about-this-book: string; annotation-styles: string; basic-style: string; basic-style-label: string; change-does-overwrite-existing: string; color-scheme: string; color-scheme-auto: string; color-scheme-auto-explanation: string; color-scheme-dark: string; color-scheme-light: string; color-scheme-sepia: string; create-quick-note: string; font-size: string; generated-at: string; invisible-nav-label: string; offline-mode: string; revision: string }
  - about-this-book: string
  - annotation-styles: string
  - basic-style: string
  - basic-style-label: string
  - change-does-overwrite-existing: string
  - color-scheme: string
  - color-scheme-auto: string
  - color-scheme-auto-explanation: string
  - color-scheme-dark: string
  - color-scheme-light: string
  - color-scheme-sepia: string
  - create-quick-note: string
  - font-size: string
  - generated-at: string
  - invisible-nav-label: string
  - offline-mode: string
  - revision: string
- research: { agree: string; decline: string; plea-title: string; researcher: string }
  - agree: string
  - decline: string
  - plea-title: string
  - researcher: string
en: { annotations: { add-note: string; confirm-destroy: string; default-style-neutral: string; default-style-okay: string; default-style-omg: string; default-style-red-flag: string; edit-note: string; highlights: string; no-annotations-in-chapter: string; no-notes-in-chapter: string; notes: string; show-all: string; update-note: string; work-desk: string }; common: { note: string; toggle-full-screen: string }; controls: { annotations: string; options: string; show-annotations: string; show-options: string; show-toc: string; toc: string }; navigation: { about: string; chapter: string; continue: string; continueReading: string; go: string; minutes-left: string; minutes-left-long: string; next-chapter: string; nthChapterNthSentence: string; nthSentence: string; prev-chapter: string; progress: string; progress-long: string; return: string; sentence: string; seqReturnAnotherChapter: string; seqReturnThisChapter: string; show-tips: string; start: string; title-page: string; turn-to: string }; offline: { cache-available: string; cacheUpdateRequested: string; nosw: string; problem: string; unsecure: string; updateCache: string }; onboarding: { annotations: string; annotations-heading: string; close: string; intro: string; intro-head: string; intro-hide: string; intro-show: string; next: string; pagination: string; pagination-heading: string; read-offline: string; remember: string; remember-heading: string }; options: { about-this-book: string; annotation-styles: string; basic-style: string; basic-style-label: string; change-does-overwrite-existing: string; color-scheme: string; color-scheme-auto: string; color-scheme-auto-explanation: string; color-scheme-dark: string; color-scheme-light: string; color-scheme-sepia: string; create-quick-note: string; font-size: string; generated-at: string; invisible-nav-label: string; offline-mode: string; revision: string }; research: { agree: string; decline: string; plea-title: string; researcher: string } }
- annotations: { add-note: string; confirm-destroy: string; default-style-neutral: string; default-style-okay: string; default-style-omg: string; default-style-red-flag: string; edit-note: string; highlights: string; no-annotations-in-chapter: string; no-notes-in-chapter: string; notes: string; show-all: string; update-note: string; work-desk: string }
  - add-note: string
  - confirm-destroy: string
  - default-style-neutral: string
  - default-style-okay: string
  - default-style-omg: string
  - default-style-red-flag: string
  - edit-note: string
  - highlights: string
  - no-annotations-in-chapter: string
  - no-notes-in-chapter: string
  - notes: string
  - show-all: string
  - update-note: string
  - work-desk: string
- common: { note: string; toggle-full-screen: string }
  - note: string
  - toggle-full-screen: string
- controls: { annotations: string; options: string; show-annotations: string; show-options: string; show-toc: string; toc: string }
  - annotations: string
  - options: string
  - show-annotations: string
  - show-options: string
  - show-toc: string
  - toc: string
- navigation: { about: string; chapter: string; continue: string; continueReading: string; go: string; minutes-left: string; minutes-left-long: string; next-chapter: string; nthChapterNthSentence: string; nthSentence: string; prev-chapter: string; progress: string; progress-long: string; return: string; sentence: string; seqReturnAnotherChapter: string; seqReturnThisChapter: string; show-tips: string; start: string; title-page: string; turn-to: string }
  - about: string
  - chapter: string
  - continue: string
  - continueReading: string
  - go: string
  - minutes-left: string
  - minutes-left-long: string
  - next-chapter: string
  - nthChapterNthSentence: string
  - nthSentence: string
  - prev-chapter: string
  - progress: string
  - progress-long: string
  - return: string
  - sentence: string
  - seqReturnAnotherChapter: string
  - seqReturnThisChapter: string
  - show-tips: string
  - start: string
  - title-page: string
  - turn-to: string
- offline: { cache-available: string; cacheUpdateRequested: string; nosw: string; problem: string; unsecure: string; updateCache: string }
  - cache-available: string
  - cacheUpdateRequested: string
  - nosw: string
  - problem: string
  - unsecure: string
  - updateCache: string
- onboarding: { annotations: string; annotations-heading: string; close: string; intro: string; intro-head: string; intro-hide: string; intro-show: string; next: string; pagination: string; pagination-heading: string; read-offline: string; remember: string; remember-heading: string }
  - annotations: string
  - annotations-heading: string
  - close: string
  - intro: string
  - intro-head: string
  - intro-hide: string
  - intro-show: string
  - next: string
  - pagination: string
  - pagination-heading: string
  - read-offline: string
  - remember: string
  - remember-heading: string
- options: { about-this-book: string; annotation-styles: string; basic-style: string; basic-style-label: string; change-does-overwrite-existing: string; color-scheme: string; color-scheme-auto: string; color-scheme-auto-explanation: string; color-scheme-dark: string; color-scheme-light: string; color-scheme-sepia: string; create-quick-note: string; font-size: string; generated-at: string; invisible-nav-label: string; offline-mode: string; revision: string }
  - about-this-book: string
  - annotation-styles: string
  - basic-style: string
  - basic-style-label: string
  - change-does-overwrite-existing: string
  - color-scheme: string
  - color-scheme-auto: string
  - color-scheme-auto-explanation: string
  - color-scheme-dark: string
  - color-scheme-light: string
  - color-scheme-sepia: string
  - create-quick-note: string
  - font-size: string
  - generated-at: string
  - invisible-nav-label: string
  - offline-mode: string
  - revision: string
- research: { agree: string; decline: string; plea-title: string; researcher: string }
  - agree: string
  - decline: string
  - plea-title: string
  - researcher: string

Functions

Const t

t<TKeys>(key: "options:revision" | "options:font-size" | "options:color-scheme" | "options:color-scheme-auto" | "options:color-scheme-auto-explanation" | "options:color-scheme-dark" | "options:color-scheme-light" | "options:color-scheme-sepia" | "options:basic-style" | "options:basic-style-label" | "options:invisible-nav-label" | "options:about-this-book" | "options:generated-at" | "options:offline-mode" | "options:annotation-styles" | "options:create-quick-note" | "options:change-does-overwrite-existing" | "common:toggle-full-screen" | "common:note" | "controls:options" | "controls:toc" | "controls:annotations" | "controls:show-toc" | "controls:show-annotations" | "controls:show-options" | "offline:cache-available" | "offline:problem" | "offline:nosw" | "offline:unsecure" | "offline:updateCache" | "offline:cacheUpdateRequested" | "onboarding:next" | "onboarding:annotations" | "onboarding:intro-head" | "onboarding:intro" | "onboarding:intro-show" | "onboarding:intro-hide" | "onboarding:pagination-heading" | "onboarding:pagination" | "onboarding:remember-heading" | "onboarding:remember" | "onboarding:annotations-heading" | "onboarding:close" | "onboarding:read-offline" | "annotations:work-desk" | "annotations:no-annotations-in-chapter" | "annotations:no-notes-in-chapter" | "annotations:highlights" | "annotations:notes" | "annotations:add-note" | "annotations:edit-note" | "annotations:update-note" | "annotations:show-all" | "annotations:confirm-destroy" | "annotations:default-style-okay" | "annotations:default-style-red-flag" | "annotations:default-style-omg" | "annotations:default-style-neutral" | "navigation:title-page" | "navigation:about" | "navigation:start" | "navigation:return" | "navigation:continueReading" | "navigation:continue" | "navigation:chapter" | "navigation:sentence" | "navigation:nthSentence" | "navigation:turn-to" | "navigation:progress" | "navigation:progress-long" | "navigation:minutes-left" | "navigation:minutes-left-long" | "navigation:nthChapterNthSentence" | "navigation:prev-chapter" | "navigation:next-chapter" | "navigation:seqReturnAnotherChapter" | "navigation:seqReturnThisChapter" | "navigation:go" | "navigation:show-tips" | "research:plea-title" | "research:researcher" | "research:agree" | "research:decline", options?: string | TOptions<StringMap>): GetDictValue<TKeys, { annotations: { add-note: string; confirm-destroy: string; default-style-neutral: string; default-style-okay: string; default-style-omg: string; default-style-red-flag: string; edit-note: string; highlights: string; no-annotations-in-chapter: string; no-notes-in-chapter: string; notes: string; show-all: string; update-note: string; work-desk: string }; common: { note: string; toggle-full-screen: string }; controls: { annotations: string; options: string; show-annotations: string; show-options: string; show-toc: string; toc: string }; navigation: { about: string; chapter: string; continue: string; continueReading: string; go: string; minutes-left: string; minutes-left-long: string; next-chapter: string; nthChapterNthSentence: string; nthSentence: string; prev-chapter: string; progress: string; progress-long: string; return: string; sentence: string; seqReturnAnotherChapter: string; seqReturnThisChapter: string; show-tips: string; start: string; title-page: string; turn-to: string }; offline: { cache-available: string; cacheUpdateRequested: string; nosw: string; problem: string; unsecure: string; updateCache: string }; onboarding: { annotations: string; annotations-heading: string; close: string; intro: string; intro-head: string; intro-hide: string; intro-show: string; next: string; pagination: string; pagination-heading: string; read-offline: string; remember: string; remember-heading: string }; options: { about-this-book: string; annotation-styles: string; basic-style: string; basic-style-label: string; change-does-overwrite-existing: string; color-scheme: string; color-scheme-auto: string; color-scheme-auto-explanation: string; color-scheme-dark: string; color-scheme-light: string; color-scheme-sepia: string; create-quick-note: string; font-size: string; generated-at: string; invisible-nav-label: string; offline-mode: string; revision: string }; research: { agree: string; decline: string; plea-title: string; researcher: string } }>

- Defined in src/i18n.ts:54
Type safe translation function

remarks

Check only the keys of fallback language. Type checking may be slow given huge number of translation strings in configs.

Type parameters
- TKeys: string
Parameters
- key: "options:revision" | "options:font-size" | "options:color-scheme" | "options:color-scheme-auto" | "options:color-scheme-auto-explanation" | "options:color-scheme-dark" | "options:color-scheme-light" | "options:color-scheme-sepia" | "options:basic-style" | "options:basic-style-label" | "options:invisible-nav-label" | "options:about-this-book" | "options:generated-at" | "options:offline-mode" | "options:annotation-styles" | "options:create-quick-note" | "options:change-does-overwrite-existing" | "common:toggle-full-screen" | "common:note" | "controls:options" | "controls:toc" | "controls:annotations" | "controls:show-toc" | "controls:show-annotations" | "controls:show-options" | "offline:cache-available" | "offline:problem" | "offline:nosw" | "offline:unsecure" | "offline:updateCache" | "offline:cacheUpdateRequested" | "onboarding:next" | "onboarding:annotations" | "onboarding:intro-head" | "onboarding:intro" | "onboarding:intro-show" | "onboarding:intro-hide" | "onboarding:pagination-heading" | "onboarding:pagination" | "onboarding:remember-heading" | "onboarding:remember" | "onboarding:annotations-heading" | "onboarding:close" | "onboarding:read-offline" | "annotations:work-desk" | "annotations:no-annotations-in-chapter" | "annotations:no-notes-in-chapter" | "annotations:highlights" | "annotations:notes" | "annotations:add-note" | "annotations:edit-note" | "annotations:update-note" | "annotations:show-all" | "annotations:confirm-destroy" | "annotations:default-style-okay" | "annotations:default-style-red-flag" | "annotations:default-style-omg" | "annotations:default-style-neutral" | "navigation:title-page" | "navigation:about" | "navigation:start" | "navigation:return" | "navigation:continueReading" | "navigation:continue" | "navigation:chapter" | "navigation:sentence" | "navigation:nthSentence" | "navigation:turn-to" | "navigation:progress" | "navigation:progress-long" | "navigation:minutes-left" | "navigation:minutes-left-long" | "navigation:nthChapterNthSentence" | "navigation:prev-chapter" | "navigation:next-chapter" | "navigation:seqReturnAnotherChapter" | "navigation:seqReturnThisChapter" | "navigation:go" | "navigation:show-tips" | "research:plea-title" | "research:researcher" | "research:agree" | "research:decline"
  
  Key of the translation from the fallback language dictionary.
- Optional options: string | TOptions<StringMap>
Returns GetDictValue<TKeys, { annotations: { add-note: string; confirm-destroy: string; default-style-neutral: string; default-style-okay: string; default-style-omg: string; default-style-red-flag: string; edit-note: string; highlights: string; no-annotations-in-chapter: string; no-notes-in-chapter: string; notes: string; show-all: string; update-note: string; work-desk: string }; common: { note: string; toggle-full-screen: string }; controls: { annotations: string; options: string; show-annotations: string; show-options: string; show-toc: string; toc: string }; navigation: { about: string; chapter: string; continue: string; continueReading: string; go: string; minutes-left: string; minutes-left-long: string; next-chapter: string; nthChapterNthSentence: string; nthSentence: string; prev-chapter: string; progress: string; progress-long: string; return: string; sentence: string; seqReturnAnotherChapter: string; seqReturnThisChapter: string; show-tips: string; start: string; title-page: string; turn-to: string }; offline: { cache-available: string; cacheUpdateRequested: string; nosw: string; problem: string; unsecure: string; updateCache: string }; onboarding: { annotations: string; annotations-heading: string; close: string; intro: string; intro-head: string; intro-hide: string; intro-show: string; next: string; pagination: string; pagination-heading: string; read-offline: string; remember: string; remember-heading: string }; options: { about-this-book: string; annotation-styles: string; basic-style: string; basic-style-label: string; change-does-overwrite-existing: string; color-scheme: string; color-scheme-auto: string; color-scheme-auto-explanation: string; color-scheme-dark: string; color-scheme-light: string; color-scheme-sepia: string; create-quick-note: string; font-size: string; generated-at: string; invisible-nav-label: string; offline-mode: string; revision: string }; research: { agree: string; decline: string; plea-title: string; researcher: string } }>

Corresponding translation for the key.