# dictionary.merge()

The `dictionary.merge()` function returns a [global dictionary](/sass/translator-v1.0.0/dictionary/dictionary.variables.md#usddictionary-default) merged with [`$dictionary`](#usddictionary) and/or multiple [`$dictionaries`](#usddictionaries...), optionally merged in [`$key`](#usdkey-null).

{% code lineNumbers="true" %}

```scss
// Sass.
@use 'sass:list';

// Variables.
@forward 'dictionary.variables';
@use 'dictionary.variables' as variables;

// Functions.
@use 'dictionary.get.function' as *;

// Modules.
@use '../../../map';

// The `translator.dictionary-merge()` or `dictionary.merge()` function.
@function merge($key: null, $dictionary, $dictionaries...) {
  $retrieved-dictionary: ();
  @each $dictionary in list.join(($dictionary, ), $dictionaries, comma) {
    $retrieved-dictionary: map.deep-merge($retrieved-dictionary, $dictionary);
  }

  variables.$dictionary: if(
    $key,
    map.merge(get() or (), list.append($key, $retrieved-dictionary)...),
    map.deep-merge(get() or (), $retrieved-dictionary)
  );

  @return variables.$dictionary;
}
```

{% endcode %}

{% embed url="<https://github.com/angular-package/sass/blob/main/translator/dictionary/_dictionary.merge.function.scss>" %}

### Parameters

#### `$key: null`

The optional key under which [`$dictionary`](#usddictionary) and multiple [`$dictionaries`](#usddictionaries...) are being merged.

#### `$dictionary: ()`

Dictionary of [map](https://sass-lang.com/documentation/modules/map/) type to merge with a [global dictionary](/sass/translator-v1.0.0/dictionary/dictionary.variables.md#usddictionary-default).

#### `$dictionaries...`

Additional dictionaries along with a [`$dictionary`](#usddictionary) to merge with a [global dictionary](/sass/translator-v1.0.0/dictionary/dictionary.variables.md#usddictionary-default).

### Return

The return value is [global dictionary](/sass/translator-v1.0.0/dictionary/dictionary.variables.md#usddictionary-default) merged with [`$dictionary`](#usddictionary) and/or multiple [`$dictionaries`](#usddictionaries...), optionally merged in [`$key`](#usdkey-null).

## Examples

```scss
// Use.
@use '@angular-package/sass/translator';

// Examples.
$-dictionary: (
  (extra large, 'extra large', extra-large): xl,
  (extra small, 'extra small', extra-small): xs,
  class: (prefix: class-prefix, suffix: class-suffix),
  large: lg,
  medium: md,
  prefix: spectre,
  size: s,
  small: sm,
  suffix: end,
  var: (prefix: var-prefix, suffix: var-suffix),
);

// merge in `class` key
@debug translator.dictionary-merge(class, (prefix: spectre, suffix: end)); // (word: translation, class: (prefix: spectre, suffix: end))

// merge in nested (accordion, class) key
@debug translator.dictionary-merge((accordion, class), (prefix: spectre, suffix: end)); // (word: translation, class: (prefix: spectre, suffix: end), accordion: (class: (prefix: spectre, suffix: end)))

```


---

# Agent Instructions: 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:

```
GET https://docs.angular-package.dev/sass/translator-v1.0.0/dictionary/dictionary.merge.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.