> For the complete documentation index, see [llms.txt](https://developer.usemultiplier.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.usemultiplier.com/multiplier-embed-sdks/label-customization.md).

# Label customization

This guide explains how to customize internationalization (i18n) strings in the Partner SDK through client configuration.

### Customizing Translations through GlobalConfig

You can provide custom translations by using the `setI18n` method on the GlobalConfig builder:

```tsx
import { MultiplierGlobalConfigProvider, createGlobalConfig } from '@Multiplier-Core/partner-sdk-react';

function App() {
  const config = createGlobalConfig()
    // Other configuration...
    .setI18n({  
      // Custom translations to override defaults
      resources: {
        'contract-onboarding.company': {
          'main.description-v2': 'Custom onboarding description for your company',
          'main.assessment.link': 'Use our custom assessment tool.'
        },
        'common': {
          'button.submit': 'Send Application'
        }
      }
    })
    .build();

  return (
    <MultiplierGlobalConfigProvider config={config}>
      {/* Your app components */}
    </MultiplierGlobalConfigProvider>
  );
}
```

### How to Identify Translation Keys

Use the following steps to find the exact namespace and key you need to override:

{% stepper %}
{% step %}

#### Enable CI mode

Set `cimode: true` in your i18n config.
{% endstep %}

{% step %}

#### Navigate to the page

Open the page with the text you want to override.
{% endstep %}

{% step %}

#### Observe displayed key

The text will be displayed as `namespace:key` instead of the actual translated text.
{% endstep %}

{% step %}

#### Note down namespace and key

Record the namespace and key for use in your `resources` overrides.
{% endstep %}
{% endstepper %}

For example, you might see:

```
contract-onboarding.company:main.description-v2
```

In this case:

* `contract-onboarding.company` is the namespace
* `main.description-v2` is the key

### Configuring Custom Translations

Once you've identified the keys you want to override, add them to your `resources` object in the i18n config:

```typescript
const i18nConfig = {
  resources: {
    // Namespace
    "contract-onboarding.company": {
      // Keys and custom values
      "main.description-v2": "Your custom description",
      "main.assessment.link": "Your custom link text"
    }
  }
};
```

### Best Practices

* Be Selective: Only override translations that actually need customization
* Maintain Structure: Keep the same structure of namespaces and keys as the original translations
* Test Overrides: After adding overrides, test the application to ensure the new translations appear correctly
* Development Workflow: Use CI mode during development to identify keys, then disable it in production

### Structure Format

The `resources` object should follow this structure:

```typescript
{
  [namespace: string]: {
    [key: string]: string
  }
}
```

Where:

* `namespace` is the translation namespace (e.g., 'contract-onboarding.company', 'common')
* `key` is the specific translation key within that namespace
* The string value is your custom translation text

### Troubleshooting

<details>

<summary>Common issues and checks</summary>

* If your custom translation isn't appearing, double-check the namespace and key spelling.
* Ensure you've set up the i18n configuration before rendering your components.
* If you're using CI mode but keys aren't showing, verify that `cimode` is set to `true` in your config.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.usemultiplier.com/multiplier-embed-sdks/label-customization.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.