# UIGridContainerElement

***

Represents a container with a grid layout in a panel.

By default, the grid items are vertically stacked, but you can change the grid to use a different layout by setting the `grid` property to a different value.

`grid` property is the exact same as CSS's shorthand property `grid`. [See the MDN documentation for more details](https://developer.mozilla.org/en-US/docs/Web/CSS/grid).

You can understand [UIPanel](/js-sdk-api-reference/ui/uipanel.md) `body` and `footer` properties as grid containers using default vertical stack layout.

### Horizontal stack

As part of CSS Grid Layout capabilities it is possible to create a horizontal stack.

#### Alignment & Distribution

On horizontal stacks, it is possible to align and distribute the items.

`verticalAlignment` is used to align the items vertically. By default, items are aligned to the top of the container. It follows the same values as CSS's `align-items` property. See [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items) for more details.

`horizontalDistribution` is used to justify the items horizontally. By default, items are justified to the start of the container. It follows the same values as CSS's `justify-content` property. See [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content) for more details.

#### Equal width columns

<figure><img src="/files/dCjGNt3foq4W0Q1aOd5x" alt="Horizontal stack"><figcaption><p>Two columns, each sharing 50% of the container width</p></figcaption></figure>

```typescript
{
  type: "Grid",
  grid: "auto-flow / 1fr 1fr",
  items: [
    { type: "TextInput", label: "Name", value: "" },
    { type: "TextInput", label: "Last name", value: "" },
  ],
}
```

### FlexibleSpace element

`FlexibleSpace` element is a handy solution to allow more control over grid layout.

If `grid` is not set, `FlexibleSpace` will add some space between the items. By using `grid` property it is possible to control FlexibleSpace's size.

#### to right align the input

<figure><img src="/files/IAALXeXY4t6iD7JzK5x8" alt="Flexible space to right align the input"><figcaption><p>Flexible space takes 50% of the container width</p></figcaption></figure>

```typescript
{
  type: "Grid",
  grid: "auto-flow / 1fr 1fr",
  items: [
    { type: "FlexibleSpace" },
    { type: "TextInput", label: "An input" , value: "" },
  ],
}
```

#### two columns of buttons with space between them

<figure><img src="/files/j9xnTQZVSZqAkrp2sADp" alt="Two groups of buttons"><figcaption><p>Two groups of buttons</p></figcaption></figure>

```typescript
{
  type: "Grid",
  grid: "auto-flow / auto auto 1fr auto auto",
  items: [
    { type: "Button", label: "A" , onClick: () => {} },
    { type: "Button", label: "B" , onClick: () => {} },
    { type: "FlexibleSpace" },
    { type: "Button", label: "C" , onClick: () => {} },
    { type: "Button", label: "D" , onClick: () => {} },
  ],
}
```

## Properties

### type

> **type**: `"Grid"`

***

### items

> **items**: ([`UIButtonElement`](/js-sdk-api-reference/ui/uibuttonelement.md) | [`UITextElement`](/js-sdk-api-reference/ui/uitextelement.md) | [`UIDividerElement`](/js-sdk-api-reference/ui/uidividerelement.md) | [`UITextInputElement`](/js-sdk-api-reference/ui/uitextinputelement.md) | [`UISelectElement`](/js-sdk-api-reference/ui/uiselectelement.md) | [`UIFlexibleSpaceElement`](/js-sdk-api-reference/ui/uiflexiblespaceelement.md) | [`UIButtonRowElement`](/js-sdk-api-reference/ui/uibuttonrowelement.md) | [`UICheckboxGroupElement`](/js-sdk-api-reference/ui/uicheckboxgroupelement.md) | [`UIRadioGroupElement`](/js-sdk-api-reference/ui/uiradiogroupelement.md) | [`UIToggleGroupElement`](/js-sdk-api-reference/ui/uitogglegroupelement.md) | [`UIIframeElement`](/js-sdk-api-reference/ui/uiiframeelement.md))\[]

The items to add to the grid container.

***

### id

> **id**: `string`

The ID of the element.

***

### grid?

> `optional` **grid**: `string`

The grid to use for the container. It is the exact same as CSS's shorthand property `grid`.

#### Example

#### horizontal stack

two columns, the first column is 50px wide, the second column takes the remaining space

```typescript
{
  type: "Grid",
  grid: "auto-flow / 50px 1fr",
  items: [...]
}
```

#### See

<https://developer.mozilla.org/en-US/docs/Web/CSS/grid> for more details.

***

### verticalAlignment?

> `optional` **verticalAlignment**: `"center"` | `"top"` | `"bottom"`

The alignment of the items in the grid. Only takes effect on horizontal stacks.

#### Default Value

`"top"`

***

### horizontalDistribution?

> `optional` **horizontalDistribution**: `"center"` | `"start"` | `"end"` | `"space-between"` | `"space-around"` | `"space-evenly"`

The distribution of the items in the grid. Only takes effect on horizontal stacks.

#### Default Value

`"start"`

***

### onCreate()?

> `optional` **onCreate**: (`args`: { `id`: `string`; }) => `void`

A function to call when the element is created.

#### Parameters

| Parameter | Type                | Description                           |
| --------- | ------------------- | ------------------------------------- |
| `args`    | { `id`: `string`; } | The arguments passed to the function. |
| `args.id` | `string`            | The id of the element.                |

#### Returns

`void`

***

### onDestroy()?

> `optional` **onDestroy**: (`args`: { `id`: `string`; }) => `void`

A function to call when the element is destroyed.

#### Parameters

| Parameter | Type                | Description                           |
| --------- | ------------------- | ------------------------------------- |
| `args`    | { `id`: `string`; } | The arguments passed to the function. |
| `args.id` | `string`            | The id of the element.                |

#### Returns

`void`


---

# 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://developers.felt.com/js-sdk-api-reference/ui/uigridcontainerelement.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.