1
0
Fork 0
freesewing/packages/i18n/README.md
2019-04-19 20:09:30 +02:00

5.9 KiB

Note

: This is part of version 2 of FreeSewing.
It is a work in progress, and not ready for prime-time yet

For all questions, please come say hellp in our chatroom on Gitter.

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

@freesewing/i18n

Translations for the FreeSewing project

Freesewing logo

 freesewing
a library for made-to-measure sewing patterns

Travis build Version License Code coverage Chat on Gitter Become a Patron

i18n

These are the translation files for the Freesewing project.

We currently provide translation in 5 languages:

  • English
  • German
  • Spanish
  • French
  • Dutch

Install

npm install --save @freesewing/i18n

How to use these translations

We use these translations in our website repository to translate react components with react-intl:

import { strings } from "@freesewing/i18n";
import { IntlProvider } from "react-intl";

class Base extends React.Component {
  render() {
    const { language } = this.props;

    return (
      <IntlProvider locale={language} messages={strings[language]}>
        {...children}
      </IntlProvier>
    )
  }
}

Now all components below will be able to translate messages:

import React from "react";
import { FormattedMessage } from "react-intl";

const Example = props => {
  return <p><FormattedMessage id={"app.aboutFreesewing"} /></p>
};

export default Example;

For all details, please refer to the react-intl documentation.

We also use it in our backend repository to translate the emails we send out to users.

About FreeSewing

Where the world of makers and developers collide, that's where you'll find FreeSewing.

Our core library is a batteries-included toolbox for parametric design of sewing patterns. It's a modular system (check our list of plugins and getting started is as simple as:

npm init freesewing-pattern

The [getting started] section on freesewing.dev is a good entrypoint to our documentation, but you'll find a lot more there, including our API documentation, as well as examples, and best practices.

If you're a maker, checkout freesewing.org where you can generate our sewing patterns adapted to your measurements.

♥️ Support FreeSewing: Become a patron ♥️

FreeSewing is an open source project run by a community, and financially supported by our patrons.

If you feel what we do is worthwhile, you too should become a patron.