# ExposedApi.Internal.UiState

[Embedding API Reference](/rubens/rubens-products/rubens-products-reference.md) / [Modules](/rubens/rubens-products/rubens-products-reference/modules.md) / [exposed-api](/rubens/rubens-products/rubens-products-reference/modules/exposed_api.md) / [\<internal>](/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md) / UiState

## Interface: UiState

[exposed-api](/rubens/rubens-products/rubens-products-reference/modules/exposed_api.md).[\<internal>](/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md).UiState

### Hierarchy

* [`SharedUiState`](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md)

  ↳ **`UiState`**

### Table of contents

#### Properties

* [activeAddon](#activeaddon)
* [currentInteractionView](#currentinteractionview)
* [currentSelection](#currentselection)
* [currentVariants](#currentvariants)
* [email](#email)
* [firstTimeRoomView](#firsttimeroomview)
* [initData](#initdata)
* [initPlannerWithObjID](#initplannerwithobjid)
* [interactionsExpanded](#interactionsexpanded)
* [isConfigurator](#isconfigurator)
* [isDesktop](#isdesktop)
* [isExpandedForConfigure](#isexpandedforconfigure)
* [isFullscreen](#isfullscreen)
* [isInIframe](#isiniframe)
* [isLandscape](#islandscape)
* [isLoadingInProgress](#isloadinginprogress)
* [isPlanner](#isplanner)
* [isPlannerEditMode](#isplannereditmode)
* [isShareLinkReady](#issharelinkready)
* [isViewer](#isviewer)
* [lastRegularViewMode](#lastregularviewmode)
* [lastSelectedVariant](#lastselectedvariant)
* [materialMultiSelect](#materialmultiselect)
* [objPosOnPlanner](#objposonplanner)
* [onlyShowAddons](#onlyshowaddons)
* [overlays](#overlays)
* [redoEnabled](#redoenabled)
* [redoEnabledPlanner](#redoenabledplanner)
* [selectedGroup](#selectedgroup)
* [showVariants](#showvariants)
* [topBarSelectedActions](#topbarselectedactions)
* [undoEnabled](#undoenabled)
* [undoEnabledPlanner](#undoenabledplanner)
* [userInitiatedSearch](#userinitiatedsearch)
* [wallsDimensions](#wallsdimensions)
* [wasDesktopBefore](#wasdesktopbefore)

### Properties

#### activeAddon

• **activeAddon**: [`Nullable`](/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md#nullable)<`UiPossibleChild`>

***

#### currentInteractionView

• **currentInteractionView**: [`Enumify`](/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md#enumify)<{ `MATERIAL_INFO`: `"material_info"` = 'material\_info'; `PARTLIST`: `"rubens_partlist"` = 'rubens\_partlist'; `SIDEBAR`: `"rubens_sidebar"` = 'rubens\_sidebar' }>

***

#### currentSelection

• **currentSelection**: [`Nullable`](/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md#nullable)<[`SceneSelection`](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.sceneselection.md)>

***

#### currentVariants

• **currentVariants**: [`Nullable`](/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md#nullable)<`RapiTagForUi`>

***

#### email

• **email**: [`Nullable`](/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md#nullable)<`string`>

***

#### firstTimeRoomView

• **firstTimeRoomView**: `boolean`

***

#### initData

• **initData**: [`Nullable`](/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md#nullable)<[`UiInitData`](/rubens/rubens-products/rubens-products-reference/interfaces/types.uiinitdata.md)>

***

#### initPlannerWithObjID

• **initPlannerWithObjID**: `boolean`

***

#### interactionsExpanded

• **interactionsExpanded**: `boolean`

**Inherited from**

[SharedUiState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md).[interactionsExpanded](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md#interactionsexpanded)

***

#### isConfigurator

• **isConfigurator**: `boolean`

***

#### isDesktop

• **isDesktop**: `boolean`

**Inherited from**

[SharedUiState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md).[isDesktop](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md#isdesktop)

***

#### isExpandedForConfigure

• **isExpandedForConfigure**: `boolean`

***

#### isFullscreen

• **isFullscreen**: `boolean`

**Inherited from**

[SharedUiState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md).[isFullscreen](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md#isfullscreen)

***

#### isInIframe

• **isInIframe**: `boolean`

***

#### isLandscape

• **isLandscape**: `boolean`

**Inherited from**

[SharedUiState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md).[isLandscape](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md#islandscape)

***

#### isLoadingInProgress

• **isLoadingInProgress**: `boolean`

***

#### isPlanner

• **isPlanner**: `boolean`

***

#### isPlannerEditMode

• **isPlannerEditMode**: `boolean`

***

#### isShareLinkReady

• **isShareLinkReady**: `boolean`

***

#### isViewer

• **isViewer**: `boolean`

***

#### lastRegularViewMode

• **lastRegularViewMode**: [`Nullable`](/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md#nullable)<`boolean`>

**Overrides**

[SharedUiState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md).[lastRegularViewMode](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md#lastregularviewmode)

***

#### lastSelectedVariant

• **lastSelectedVariant**: [`Nullable`](/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md#nullable)<[`GridViewVariantElement`](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.gridviewvariantelement.md)>

***

#### materialMultiSelect

• **materialMultiSelect**: `boolean`

***

#### objPosOnPlanner

• **objPosOnPlanner**: `PlanObjectPosition`\[]

***

#### onlyShowAddons

• **onlyShowAddons**: `boolean`

***

#### overlays

• **overlays**: [`OverlaysOpenState`](/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md#overlaysopenstate)

***

#### redoEnabled

• **redoEnabled**: `boolean`

***

#### redoEnabledPlanner

• **redoEnabledPlanner**: `boolean`

***

#### selectedGroup

• **selectedGroup**: [`Nullable`](/rubens/rubens-products/rubens-products-reference/modules/exposed_api._internal_.md#nullable)<[`ParameterGroup`](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.parametergroup.md)>

***

#### showVariants

• **showVariants**: `boolean`

***

#### topBarSelectedActions

• **topBarSelectedActions**: [`BUTTON_ACTIONS`](/rubens/rubens-products/rubens-products-reference/enums/exposed_api._internal_.button_actions.md)\[]

**Inherited from**

[SharedUiState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md).[topBarSelectedActions](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md#topbarselectedactions)

***

#### undoEnabled

• **undoEnabled**: `boolean`

***

#### undoEnabledPlanner

• **undoEnabledPlanner**: `boolean`

***

#### userInitiatedSearch

• **userInitiatedSearch**: `boolean`

***

#### wallsDimensions

• **wallsDimensions**: `WallDimensionTransferable`\[]

***

#### wasDesktopBefore

• **wasDesktopBefore**: `boolean`

**Inherited from**

[SharedUiState](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md).[wasDesktopBefore](/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.shareduistate.md#wasdesktopbefore)


---

# 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.roomle.com/rubens/rubens-products/rubens-products-reference/interfaces/exposed_api._internal_.uistate.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.