Column

Create a new column

new Column(props: ContentItemProps): any
Parameters
Returns
any

ContentItemProps

React properties for the ContentItem component.

ContentItemProps

Type: {type: string, children: ChildrenArray<any>, itemRef: function (GoldenLayoutItem): any?}

Properties
type (string)
children (ChildrenArray<any>)
itemRef (function (GoldenLayoutItem): any?)

ContentItem

Create a new GoldenLayout ContentItem.

Note: You probably don't want to use this class directly, see:

new ContentItem(props: ContentItemProps)

Extends React.Component

Parameters

createGoldenLayoutComponent

Convert a React Component's constructor to a GoldenLayout React Component.

createGoldenLayoutComponent(Component: ComponentBuilder, options: Object): GLReactItem<ComponentBuilder>
Parameters
Component (ComponentBuilder) The constructor for the React Component
Returns
GLReactItem<ComponentBuilder>

GoldenLayoutComponentProps

React properties for the GoldenLayoutComponent component.

GoldenLayoutComponentProps

Type: {children: ChildrenArray<any>, className: string?, goldenLayoutRef: function (GoldenLayout): any?}

Properties
children (ChildrenArray<any>)
className (string?)
goldenLayoutRef (function (GoldenLayout): any?)

GoldenLayoutComponent

Create a GoldenLayout instance

new GoldenLayoutComponent(props: GoldenLayoutComponentProps)

Extends React.PureComponent

Parameters
Example
import 'golden-layout/src/css/goldenlayout-base.css';
import 'golden-layout/src/css/goldenlayout-dark-theme.css';
import GoldenLayout, { Row, Stack, createGoldenLayoutComponent } from 'react-golden-layout';
...
<GoldenLayout>
    <Row>
        <Stack>
            {
              // To apply properties to a React component, use createGoldenLayoutComponent
            }
            {createGoldenLayoutComponent(Foo, { isClosable: false, title: "Foo's Title" })}
        </Stack>
        <Stack>
            {
              // If you don't want any special settings you can just pass
              // React components directly.
            }
            {Bar}
        </Stack>
    </Row>
</GoldenLayout>

Row

Create a new Row

new Row(props: ContentItemProps): any
Parameters
Returns
any

StackProps

React properties for the Stack component.

StackProps

Type: {children: ChildrenArray<any>, itemRef: function (GoldenLayoutItem): any?, headerRef: function (GoldenLayoutHeader): any?, headerPosition: (false | "top" | "left" | "right" | "bottom")?, showPopoutIcon: boolean?, showMaximiseIcon: boolean?, showCloseIcon: boolean?}

Properties
children (ChildrenArray<any>)
itemRef (function (GoldenLayoutItem): any?)
headerRef (function (GoldenLayoutHeader): any?)
headerPosition ((false | "top" | "left" | "right" | "bottom")?)
showPopoutIcon (boolean?)
showMaximiseIcon (boolean?)
showCloseIcon (boolean?)

Stack

Create a new Stack

new Stack(props: StackProps): any
Parameters
props (StackProps)
Returns
any

GoldenLayoutItem

A GoldenLayout Item, see GoldenLayout's documentation.

GoldenLayoutItem

Type: Object

GoldenLayoutHeader

A GoldenLayout Header object, see GoldenLayout's documentation.

GoldenLayoutHeader

Type: Object

React.PureComponent

A React component

React.PureComponent

React.Component

A React component

React.Component

GoldenLayout

A GoldenLayout instance, see GoldenLayout's documentation.

GoldenLayout