n8n/packages/editor-ui/src/i18n/README.md

# i18n in n8n

## Scope

n8n allows for internalization of the majority of UI text:

- base text, e.g. menu display items in the left-hand sidebar menu,
- node text, e.g. parameter display names and placeholders in the node view,
- header text, e.g. node display names and descriptions in the nodes panel.

Currently, n8n does _not_ allow for internalization of:

- messages from outside the `editor-ui` package, e.g. `No active database connection`,
- node subtitles, e.g. `create: user` or `getAll: post` below the node name on the canvas,
- new version notification contents in the updates panel, e.g. `Includes node enhancements`,
- deeply nested parameters inside `collection` and `fixedCollection` (untested feature).

## Locale identifiers

A locale identifier is a language code compatible with the [`Accept-Language` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language), e.g. `de` (German), `es` (Spanish), `ja` (Japanese). Regional variants of locale identifiers are not supported, i.e. use `de`, not `de-AT`. For a list of all locale identifiers, refer to the [639-1 column in the ISO 639-1 codes article](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).

By default, n8n runs in the `en` (English) locale. To have it to run in a different locale, set the `N8N_DEFAULT_LOCALE` environment variable. If it has been set and is not `en`, n8n will use the UI strings for that locale - for any untranslated UI strings, n8n fall back to `en`.

```sh
export N8N_DEFAULT_LOCALE=de
npm run start
```

## Base text

Base text is directly rendered with no dependencies. Base text is supplied by the user in one file per locale in the `/editor-ui` package.

### Locating base text

Each base text file is located at `/packages/editor-ui/src/i18n/locales/{localeIdentifier}.ts` and exports an object where keys are Vue component names (and their containing dirs if any) and references to parts of those Vue components.

```js
export default {
	nodeCreator: {
		categoryNames: {
			coreNodes: '🇩🇪 Core Nodes',
			analytics: '🇩🇪 Analytics',
			communication: '🇩🇪 Communication',
		},
    // ...
```

### Translating base text

1. For the new locale identifier, e.g. `de`, copy the `en` base text and rename it:

```sh
cp ./packages/editor-ui/src/i18n/locales/en.ts ./packages/editor-ui/src/i18n/locales/de.ts
```

2. Check in the UI for a base text string to translate, and find it in the newly created base text file.

> **Note**: If you cannot find a string in the new base text file, either it does not belong to base text (i.e., the string might be part of header text, credential text, or node text), or the string might belong to the backend, where i18n is currently unsupported.

3. Translate the string value - do not change the key. In the examples below, a string starting with 🇩🇪 stands for a translated string.

Optionally, remove any untranslated strings from the new base text file. Untranslated strings in the new base text file will automatically fall back to the `en` base text file.

#### Reusable base text

As a convenience, the base text file may contain the special key `reusableBaseText`, allowing for a string to be translated once and reused elsewhere in the base text file:

```js
export default {
	reusableBaseText: {
		save: '🇩🇪 Save',
	},
	duplicateWorkflowDialog: {
		enterWorkflowName: '🇩🇪 Enter workflow name',
		save: '@:reusableBaseText.save',
	},
	saveButton: {
		save: '@:reusableBaseText.save',
		saving: '🇩🇪 Saving',
		saved: '🇩🇪 Saved',
	},
```

To [localize decimal values](https://vue-i18n.intlify.dev/guide/essentials/number.html#basic-usage), add this key to the base text:

```js
export default {
	numberFormats: {
		decimal: {
			style: 'decimal',
		},
	},
	// ...
}
```

#### Interpolation

Some base text strings feature [interpolation](https://kazupon.github.io/vue-i18n/guide/formatting.html#named-formatting) with a variable in curly braces, e.g. `Execution ID {activeExecutionId} was stopped`. In case of interpolation, the translated string must not modify the variable: `Die Ausführung mit der ID {activeExecutionId} wurde gestoppt`.

## Dynamic text

Dynamic text is **text that relies on node-related data** in order to be rendered. Node-related data is supplied by the user in multiple files in the `/nodes-base` package. Dynamic text is mostly visible in the node view, i.e. the node on the canvas and the node parameters modal.

### Locating dynamic text

Dynamic text is divided into files located in `/translations` dirs alongside the translated nodes:

```
GitHub
  ├── GitHub.node.ts
  ├── GitHubTrigger.node.ts
  └── translations
      ├── de.ts
      ├── es.ts
      └── ja.ts
```

Each translation file may contain the translations for one or both (regular and trigger) nodes.

In the examples below, the node source is located at `/packages/nodes-base/nodes/Github/GitHub.node.ts` and the node translation is located at `/packages/nodes-base/nodes/Github/translations/de.ts`.

***

In case of grouping dirs, e.g. `Google`, `Aws`, and `Microsoft`, the `/translations` dir must also be located alongside the `*.node.ts` file:

```
Google
  └── Drive
      ├── GoogleDrive.node.ts
      └── translations
          ├── de.js
          ├── es.ts
          └── ja.ts
```

And same for nodes in versioned dirs:

```
Mattermost
  └── Mattermost.node.ts
      └── v1
          ├── Mattermost.node.ts
          ├── actions
		  ├── methods
		  ├── transport
          └── translations
		       ├── de.js
               ├── es.ts
               └── ja.ts
```

### Translating dynamic text

Each node translation is an object with a key that matches the node's `description.name`:

```js
export class Github implements INodeType {
	description: INodeTypeDescription = {
		displayName: 'GitHub',
		description: 'Consume GitHub API',
		name: 'github', // ← key to use in translation
		icon: 'file:github.svg',
		group: ['input'],
		version: 1,
		// ...
```

```js
module.exports = {
	github: {}, // ↑ key from node's description.name
	githubTrigger: {}, // ↑ key from node's description.name
};
```

The object inside allows for three keys: `header`, `credentialsModal` and `nodeView`. These are the _sections_ of each node translation:

```js
module.exports = {
	github: {
		header: {},
		credentialsModal: {},
		nodeView: {},
    },
	githubTrigger: {
		header: {},
		credentialsModal: {},
		nodeView: {},
    },
};
```

> Note: These three keys as well as all keys described below are optional. Remember that, in case of missing sections or keys pointing to missing translations, n8n will fall back to the `en` locale.

#### `header` section

The `header` section points to an object that may contain only two keys, `displayName` and `description`, matching the node's `description.displayName` and `description.description`. These are used in the nodes panel, in the node view and in the node credentials modal.

```js
export class Github implements INodeType {
	description: INodeTypeDescription = {
		displayName: 'GitHub',
		description: 'Consume GitHub API',
		name: 'github',
		icon: 'file:github.svg',
		group: ['input'],
		version: 1,
		// ...
```

```js
module.exports = {
	github: {
		header: {
			displayName: '🇩🇪 GitHub',
			description: '🇩🇪 Consume GitHub API',
		},
	},
};
```

<p align="center">
    <img src="img/header1.png">
    &nbsp;&nbsp;&nbsp;&nbsp;
    <img src="img/header2.png">
    &nbsp;&nbsp;&nbsp;&nbsp;
    <img src="img/header3.png">
</p>

<p align="center">
    <img src="img/header4.png">
    &nbsp;&nbsp;&nbsp;&nbsp;
    <img src="img/header5.png">
</p>

#### `credentialsModal` section

The `credentialsModal` section points to an object having a key that matches the node credential `name`:

In the examples below, the node credential source is located at `/packages/nodes-base/credentials/GithubApi.credentials.ts`.

```js
export class GithubApi implements ICredentialType {
	name = 'githubApi'; // ← key to use in translation
	displayName = 'Github API';
	documentationUrl = 'github';
	properties: INodeProperties[] = [
	// ...
```

```js
module.exports = {
	github: {
		header: {},
		credentialsModal: {
			githubApi: {} // ↑ key from node credential name
		},
		nodeView: {},
	},
};
```

The node credential `name` key points to an object containing translation keys that match the node's credential parameter names:

```js
export class GithubApi implements ICredentialType {
	name = 'githubApi';
	displayName = 'Github API';
	documentationUrl = 'github';
	properties: INodeProperties[] = [
		{
			displayName: 'Github Server',
			name: 'server', // ← key to use in translation
			type: 'string',
			default: 'https://api.github.com',
			description: 'The server to connect to. Only has to be set if Github Enterprise is used.',
		},
		{
			displayName: 'User',
			name: 'user', // ← key to use in translation
			type: 'string',
			default: '',
		},
		{
			displayName: 'Access Token',
			name: 'accessToken', // ← key to use in translation
			type: 'string',
			default: '',
		},
	];
}
```

```js
module.exports = {
	github: {
		header: {
			// ...
		},
		credentialsModal: {
			githubApi: {
				server: {} // ↑ key from node credential parameter name
				user: {} // ↑ key from node credential parameter name
				accessToken: {} // ↑ key from node credential parameter name
			},
		},
		nodeView: {
			// ...
		},
	},
};
```

The object for each node credential parameter allows for the keys `displayName`, `description`, and `placeholder`. Their values will be rendered instead of the English text.

```js
module.exports = {
	github: {
		header: {},
		credentialsModal: {
			githubApi: {
				server: {
					displayName: '🇩🇪 Github Server',
					description: '🇩🇪 The server to connect to. Only has to be set if Github Enterprise is used.',
				},
				user: {
					placeholder: '🇩🇪 Hans',
				},
				accessToken: {
					placeholder: '🇩🇪 123',
				},
			},
		},
		nodeView: {},
	},
};
```

<p align="center">
    <img src="img/cred.png">
</p>

#### `nodeView` section

The `nodeView` section points to an object containing translation keys that match the node's operational parameters.

```js
export class Github implements INodeType {
	description: INodeTypeDescription = {
		displayName: 'GitHub',
		name: 'github',
		// ...
		properties: [
			{
				displayName: 'Resource',
				name: 'resource', // ← key to use in translation
				type: 'options',
				options: [],
				default: 'issue',
				description: 'The resource to operate on.',
			},
		// ...
```

```js
module.exports = {
	github: {
		header: {},
		credentialsModal: {},
		nodeView: {
			resource: {}, // ↑ key from node parameter name
		},
	},
};
```

> Note: Other than in the `*.node.ts` file, operational parameters may also be found in `*Description.ts` files in the same dir, e.g. `UserDescription.ts`.

A node parameter allows for different translation keys depending on parameter type.

#### `string`, `number` and `boolean` parameters

Allowed keys: `displayName`, `description`, and `placeholder`.

```js
{
	displayName: 'Repository Owner', // translatable
	name: 'owner',
	type: 'string',
	required: true,
	// ...
	placeholder: 'n8n-io', // translatable
	description: 'Owner of the repository.', // translatable
},
```

```js
module.exports = {
	github: {
		header: {},
		credentialsModal: {},
		nodeView: {
			owner: {
				displayName: '🇩🇪 Repository Owner',
				placeholder: '🇩🇪 n8n-io',
				description: '🇩🇪 Owner of the repository.',
			},
		},
	},
};
```

<p align="center">
    <img src="img/node1.png">
</p>

TODO i18n
[IMAGE OF NODE VIEW MODAL WHERE `string` parameter IS USED]

#### `options` parameter

Allowed keys: `displayName`, `description`, and `placeholder`.

Allows subkeys: `options.{optionName}.displayName` and `options.{optionName}.description`.

```js
{
	displayName: 'Resource', // translatable
	name: 'resource',
	type: 'options',
	options: [
		{
			name: 'File', // translatable
			value: 'file',
		},
		{
			name: 'Issue', // translatable
			value: 'issue',
		},
	],
	default: 'issue',
	description: 'The resource to operate on.', // translatable
},
```

```js
module.exports = {
	github: {
		header: {},
		credentialsModal: {},
		nodeView: {
			resource: {
				displayName: '🇩🇪 Resource',
				description: '🇩🇪 The resource to operate on.',
				options: {
					file: {
						displayName: '🇩🇪 File',
					},
					issue: {
						displayName: '🇩🇪 Issue',
					},
				},
			},
		},
	},
};
```

<p align="center">
    <img src="img/node2.png">
</p>

#### `collection` and `fixedCollection` parameters

Allowed keys: `displayName`, `description`, `placeholder`, and `multipleValueButtonText`.

```js
{
	displayName: 'Labels', // translatable
	name: 'labels',
	type: 'collection',
	typeOptions: {
		multipleValues: true,
		multipleValueButtonText: 'Add Label', // translatable
	},
	displayOptions: {
		show: {
			operation: [
				'create',
			],
			resource: [
				'issue',
			],
		},
	},
	default: { 'label': '' },
	options: [
		{
			displayName: 'Label', // translatable
			name: 'label',
			type: 'string',
			default: '',
			description: 'Label to add to issue.', // translatable
		},
	],
},
```

```js
// node translation: /packages/nodes-base/nodes/Github/translations/de.ts
module.exports = {
	github: {
		header: {},
		credentialsModal: {},
		nodeView: {
			// collection
			labels: {
				displayName: '🇩🇪 Labels',
				multipleValueButtonText: '🇩🇪 Add Label',
			},
			// collection item - same level of nesting
			label: {
				displayName: '🇩🇪 Label',
				description: '🇩🇪 Label to add to issue.',
			},
		},
	},
};
```

To reduce excessive nesting, a parameter inside a collection's `options` parameter sits at the same level of nesting as the containing collection in the `nodeView` section.

<p align="center">
    <img src="img/node3.png">
</p>

#### Reusable dynamic text

Also, the base text file may contain the special key `reusableDynamicText`, allowing for a node parameter to be translated once and reused elsewhere in other node parameter translations.

Currently only the keys `oauth.clientId` and `oauth.clientSecret` are supported - these two translations to be reused in all node credential parameters.

```js
export default {
	reusableDynamicText: {
		oauth2: {
			clientId: '🇩🇪 Client ID',
			clientSecret: '🇩🇪 Client Secret',
		},
	},
```

# Building translations

## Base text

When translating a base text file at `/packages/editor-ui/src/i18n/locales/{localeIdentifier}.ts`:

1. Open a terminal:

```sh
export N8N_DEFAULT_LOCALE=de
npm run start
```

2. Open another terminal:

```sh
export N8N_DEFAULT_LOCALE=de
cd packages/editor-ui
npm run dev
```

Changing the base text file will trigger a rebuild of the client at `http://localhost:8080`.

## Dynamic text

When translating a dynamic text file at `/packages/nodes-base/nodes/{node}/translations/{localeIdentifier}.ts`,

1. Open a terminal:

```sh
export N8N_DEFAULT_LOCALE=de
npm run start
```

2. Open another terminal:

```sh
export N8N_DEFAULT_LOCALE=de
cd packages/nodes-base
npm run build:translations
npm run watch
```

After changing the dynamic text file:

1. Stop and restart the first terminal.
2. Refresh the browser at `http://localhost:5678`

If a `headerText` section was changed, run `npm run build:translations` again.

> **Note**: To translate base and dynamic text simultaneously, open three terminals following the steps in both sections (opening the first terminal only once) and browse at `http://localhost:8080`.