freesewing/markdown/dev/reference/plugins/i18n/en.md

title
@freesewing/plugin-i18n

The @freesewing/plugin-i18n plugin provides a mechanism to translate your designs. It does that by attaching to the insertText lifecycle hook to intercept all operations that add text to a design and attempt to translate the text prior to insertion.

This plugin provides the mechanism for translation, but does not come with translations itself. For this, you can use our i18n package.

Installation

npm install @freesewing/plugin-i18n

Usage

Like all build-time plugins, you load them by passing them to the freesewing.Design constructor:

import aaron from "@freesewing/aaron";
import i18n from "@freesewing/plugin-i18n";
import translations from "@freesewing/i18n";

const pattern = new aaron()
  .use(i18nPlugin, { strings: translations });

You should also pass a second argument which holds your translations. It should be structured as such:

{
  strings:
    en: {
      example: "Example"
    },
    nl: {
      example: "Voorbeeld"
    },
    // More languages can follow
  }
}