redux-devtools/packages/react-dock
renovate[bot] 75dbf74963
chore(deps): update all non-major dependencies (#1746)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-09-16 19:24:11 -04:00
..
demo chore(deps): update all non-major dependencies (#1746) 2024-09-16 19:24:11 -04:00
src chore(deps): update typescript-eslint monorepo to v8 (major) (#1710) 2024-08-05 00:38:28 +00:00
test Convert React packages to ESM (#1650) 2024-04-07 21:04:45 +00:00
CHANGELOG.md Version Packages (#1651) 2024-04-07 21:19:20 +00:00
eslint.config.js Use flat config for ESLint (#1712) 2024-08-08 23:47:07 -04:00
jest.config.cjs Convert React packages to ESM (#1650) 2024-04-07 21:04:45 +00:00
LICENSE Add react-dock (#590) 2020-08-15 17:27:22 -04:00
package.json chore(deps): update all non-major dependencies (#1746) 2024-09-16 19:24:11 -04:00
README.md chore(*): add prettier check to CI (#598) 2020-08-19 10:07:30 -04:00
tsconfig.json Convert React packages to ESM (#1650) 2024-04-07 21:04:45 +00:00
tsconfig.test.json Convert React packages to ESM (#1650) 2024-04-07 21:04:45 +00:00

react-dock

Resizable dockable react component.

Demo

http://alexkuz.github.io/react-dock/demo/

Install

$ npm i -S react-dock

Example

render() {
  return (
    <Dock position='right' isVisible={this.state.isVisible}>
      {/* you can pass a function as a child here */}
      <div onClick={() => this.setState({ isVisible: !this.state.isVisible })}>X</div>
    </Dock>
  );
}

Dock Props

Prop Name Description
position Side to dock (left, right, top or bottom). Default is left.
fluid If true, resize dock proportionally on window resize.
size Size of dock panel (width or height, depending on position). If this prop is set, Dock is considered as a controlled component, so you need to use onSizeChange to track dock resizing. Value is a fraction of window width/height, if fluid is true, or pixels otherwise
defaultSize Default size of dock panel (used for uncontrolled Dock component)
isVisible If true, dock is visible
dimMode If none - content is not dimmed, if transparent - pointer events are disabled (so you can click through it), if opaque - click on dim area closes the dock. Default is opaque
duration Animation duration. Should be synced with transition animation in style properties
dimStyle Style for dim area
dockStyle Style for dock
zIndex Z-index for wrapper
onVisibleChange Fires when Dock wants to change isVisible (when opaque dim is clicked, in particular)
onSizeChange Fires when Dock wants to change size
children Dock content - react elements or function that returns an element. Function receives an object with these state values: { position, isResizing, size, isVisible }