@streetscape.gl/monochrome/src/float-panel/README.md

A toolkit of React components for streetscape.gl

# FloatPanel

A stateless component that renders a floating panel.

**Features**

- Move
- Resize
- Minimize
- Constrain inside bounds

## Usage

```js
import {FloatPanel} from '@streetscape.gl/monochrome';

const View = () => {
  return <FloatPanel title="My Window" x={0} y={10} width={200} height={200} />;
};
```

## API Reference

## Props

- `title` **(string|Element)** - content to display in the title bar. If empty, the title bar will
  be hidden.
- `x` **(number)** - position from the left in pixels
- `y` **(number)** - position from the top in pixels
- `width` **(number)** - width of the panel
- `height` **(number)** - height of the panel
- `className` **(string, optional)** - additional class name for the container
- `parentWidth` **(number, optional)** - width of the parent window
- `parentHeight` **(number, optional)** - height of the parent window. If parent window size is
  specified, the panel cannot be moved outside of its bounds.
- `minimized` **(boolean, optional)** - whether the panel is minimized (show only title bar)
- `movable` **(boolean, optional)** - whether the panel can be moved, default true
- `resizable` **(boolean, optional)** - whether the panel can be resized, default false
- `minimizable` **(boolean, optional)** - whether the panel can be minimized, default true
- `onUpdate` **(function, optional)** - callback when user move/resize/minimize the panel
- `onMoveEnd` **(function, optional)** - callback when user stops moving the panel
- `onResizeEnd` **(function, optional)** - callback when user stops resizing the panel
- `style` **(object, optional)** - cursom CSS overrides. See "styling" section below.

### Styling

The `style` prop expects an object that may contain the following keys:

- `wrapper` - wrapper around the whole control
- `title` - title bar of the float panel
- `content` - content of the float panel
- `resizer` - hit area of the resize button

The values define the styling overrides for the respective child components. Unless noted otherwise,
each value is an object, or a callback function.

```jsx
const floatPanelStyle = {
  resizer: {
    width: 20,
    height: 20
  },
  title: props => ({
    background: props.isActive ? 'red' : 'black'
  })
};
```

A custom style callback function will receive the following arguments:

- `props` **(object)**
  - `theme` **(object)** - the current theme
  - `isMoving` **(boolean)** - if the float panel is being moved
  - `isResizing` **(boolean)** - if the float panel is being resized