> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qonto.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ui

[@qonto/embed-sdk](../README) / ui

# Variable: ui

> `const` **ui**: `object` = `uiElementsNamespace.ui`

The ui namespace contains all the functions related to UI Elements.
It can be accessed like this:

```ts theme={null}
import { ui } from '@qonto/embed-sdk/ui';
```

Then, the ui object contains the functions to perform UI Element operations:

```ts theme={null}
await ui.createUIElement(/* params here */);
```

## Type declaration

### createUIElement()

> **createUIElement**: (`createUIElementParams`) => `Promise`\<`void`>

Creates a UI element based on the provided settings and appends it to the specified parent container.
As the bare minimum, the `uiElementSettings` must include the `uiElementName`, and the `operationSettings`
must include the `uiParentElementId` where the new element will be appended. This function requires
authentication, which can be passed via the OperationSettings object.

#### Parameters

##### createUIElementParams

[`UIElementParams`](../-internal-/interfaces/UIElementParams)\<`unknown`>

Parameters for creating the UI element, including settings for the element
and operation:

* `uiElementSettings` - Settings for the UI element to be created. Must include `uiElementName`, which
  determines the type of element to create. Example: `{ uiElementName: 'transfer-list' }`.
* `operationSettings` - Settings for the operation, including the `uiParentElementId` where the new element
  will be appended. Must also include authentication details if required.

#### Returns

`Promise`\<`void`>

#### Throws

InvalidParametersError - Thrown if required parameters are missing or invalid in `uiElementSettings`
or `operationSettings`.

#### Throws

EmbedUIElementError - Thrown if the specified parent container element cannot be found in the DOM.