# Layouts

**Kind**: module | **Library**: @interopio/desktop | **Access**: `io.layouts`

**Source**: https://docs.interop.io/desktop/reference/javascript/layouts/index.html

The Layouts API allows you to save the arrangement and context of any set of apps running in io.Connect Desktop as a named Layout and later restore it.
You can also choose a default Global Layout which io.Connect Desktop will load upon startup.

The Layouts library supports different types of Layouts - Global, App Default, Workspace.

The Layouts API is accessible via the [`io.layouts`](https://docs.interop.io/desktop/reference/javascript/layouts/api/index.md) object.

## Interfaces

- [API](https://docs.interop.io/desktop/reference/javascript/layouts/api/index.md): Layouts API.
- [Configuration](https://docs.interop.io/desktop/reference/javascript/layouts/configuration/index.md): Configuration for the Layouts library.
- [GetContentsOptions](https://docs.interop.io/desktop/reference/javascript/layouts/getcontentsoptions/index.md): Options for retrieving the contents of Global or Workspace Layouts via the `getLayoutContents()` method.
- [GetRestoredLayoutsInfoResult](https://docs.interop.io/desktop/reference/javascript/layouts/getrestoredlayoutsinforesult/index.md): Describes the currently active Layout (ID, type, name and participating app instances), as well as any previously active Layouts that still have running instances of their participating apps.
- [HibernateResult](https://docs.interop.io/desktop/reference/javascript/layouts/hibernateresult/index.md): Describes the result returned from hibernating a Layout.
- [HibernationOptions](https://docs.interop.io/desktop/reference/javascript/layouts/hibernationoptions/index.md): Options for hibernating Layouts.
- [ImportLayoutResult](https://docs.interop.io/desktop/reference/javascript/layouts/importlayoutresult/index.md): Describes the result returned from importing Layouts.
- [Layout](https://docs.interop.io/desktop/reference/javascript/layouts/layout/index.md): Describes a Layout.
- [LayoutComponent](https://docs.interop.io/desktop/reference/javascript/layouts/layoutcomponent/index.md): Describes a Layout component - an app participating in the Layout and its state.
- [LayoutContents](https://docs.interop.io/desktop/reference/javascript/layouts/layoutcontents/index.md): Describes the contents of Global or Workspace Layouts retrieved via the `getLayoutContents()` method.
- [LayoutModifiedEvent](https://docs.interop.io/desktop/reference/javascript/layouts/layoutmodifiedevent/index.md): Describes a modified Layout and the reason for its modification.
- [LayoutResult](https://docs.interop.io/desktop/reference/javascript/layouts/layoutresult/index.md): Describes the base result returned by methods for
- [LayoutSummary](https://docs.interop.io/desktop/reference/javascript/layouts/layoutsummary/index.md): Summarized description of a Layout.
- [NewLayoutOptions](https://docs.interop.io/desktop/reference/javascript/layouts/newlayoutoptions/index.md): Options for saving a new Layout.
- [ResetLayoutOptions](https://docs.interop.io/desktop/reference/javascript/layouts/resetlayoutoptions/index.md): Options for resetting a Layout.
- [RestoredInstance](https://docs.interop.io/desktop/reference/javascript/layouts/restoredinstance/index.md): Describes an app instance participating in a restored or resumed Layout.
- [RestoredLayoutDetails](https://docs.interop.io/desktop/reference/javascript/layouts/restoredlayoutdetails/index.md): Describes a currently active Layout, or a previously active Layout that may still have running instances of its participating apps.
- [RestoredLayoutInstanceInfo](https://docs.interop.io/desktop/reference/javascript/layouts/restoredlayoutinstanceinfo/index.md): Describes an app instance participating in a Layout.
- [RestoreOptions](https://docs.interop.io/desktop/reference/javascript/layouts/restoreoptions/index.md): Options for restoring a Layout.
- [RestoreResumeResult](https://docs.interop.io/desktop/reference/javascript/layouts/restoreresumeresult/index.md): Describes the result returned from restoring or resuming a Layout.
- [ResumeOptions](https://docs.interop.io/desktop/reference/javascript/layouts/resumeoptions/index.md): Options for resuming a Layout.
- [SaveRequestContext](https://docs.interop.io/desktop/reference/javascript/layouts/saverequestcontext/index.md): Context passed as an argument to the callback for handling Layout save request events.
- [SaveRequestResponse](https://docs.interop.io/desktop/reference/javascript/layouts/saverequestresponse/index.md): Result returned in response to a request for saving a Layout.

## Type Aliases

- [ImportMode](https://docs.interop.io/desktop/reference/javascript/layouts/importmode/index.md): Mode for importing Layouts.
- [LayoutType](https://docs.interop.io/desktop/reference/javascript/layouts/layouttype/index.md): The supported Layout types are `"Global"`, `"ApplicationDefault"` and `"Workspace"`.
- [Mode](https://docs.interop.io/desktop/reference/javascript/layouts/mode/index.md): Layouts library initialization mode: