redux-devtools/packages/react-dock
renovate[bot] 7b90e75e03
fix(deps): update dependency react-icons to v5 (#1604)
* fix(deps): update dependency react-icons to v5

* Update snapshot

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Nathan Bierema <nbierema@gmail.com>
2024-01-24 02:03:00 +00:00
..
demo fix(deps): update dependency react-icons to v5 (#1604) 2024-01-24 02:03:00 +00:00
src Remove prop-types (#1557) 2023-12-10 00:50:15 -05:00
test Use types in tscnofig to explicitly define global types (#1045) 2022-01-22 21:51:27 +00:00
.eslintignore Imprrove ability to tree-shake libraries (#1050) 2022-01-24 02:11:46 +00:00
.eslintrc.js chore(deps): update typescript-eslint monorepo to v6 (major) (#1436) 2023-09-03 22:56:58 -04:00
babel.config.esm.json Imprrove ability to tree-shake libraries (#1050) 2022-01-24 02:11:46 +00:00
babel.config.json Imprrove ability to tree-shake libraries (#1050) 2022-01-24 02:11:46 +00:00
CHANGELOG.md Version Packages (#1181) 2022-05-30 17:22:06 +00:00
jest.config.js chore(deps): update jest monorepo to v29 (major) (#1149) 2022-10-28 17:15:02 -04:00
LICENSE Add react-dock (#590) 2020-08-15 17:27:22 -04:00
package.json fix(deps): update all non-major dependencies (#1598) 2024-01-08 21:09:49 -05:00
README.md chore(*): add prettier check to CI (#598) 2020-08-19 10:07:30 -04:00
tsconfig.json Imprrove ability to tree-shake libraries (#1050) 2022-01-24 02:11:46 +00:00
tsconfig.test.json Use types in tscnofig to explicitly define global types (#1045) 2022-01-22 21:51:27 +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 }