# WorkspaceLayout

**Kind**: interface | **Module**: [Workspaces](https://docs.interop.io/desktop/reference/javascript/workspaces/index.md)

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

An object describing a workspace layout.

## Properties

- **`components`** (`Array<WorkspaceComponent>`, required)
  The components of the workspace layout. This collection can contain only one element and it must be a workspace component.
- **`metadata`** (`any`, optional)
  An object containing various layout metadata.
- **`name`** (`string`, required)
  An unique string name and identifier of the layout
- **`type`** (`"Workspace"`, required)
  The type of the workspace element.

## Related types

- [Workspace](https://docs.interop.io/desktop/reference/javascript/workspaces/workspace/index.md)
- [WorkspaceComponent](https://docs.interop.io/desktop/reference/javascript/workspaces/workspacecomponent/index.md)