GitXplorerGitXplorer
a

react-dock

public
546 stars
76 forks
20 issues

Commits

List of commits on branch master.
Verified
bd1ffad34938896e18a4702b5931889a74bd09a8

Update README.md

aalexkuz committed 4 years ago
Unverified
b6272484099750b33bfacf4369db0a635a58745d

0.2.4

aalexkuz committed 8 years ago
Unverified
143143e245564f4420baf3403dc5dd59d381625b

fix PropTypes (#24)

bborm committed 8 years ago
Unverified
4eab4eaa2bb021d693454d75014635194e06a13d

Merge pull request #18 from julienvincent/master

aalexkuz committed 9 years ago
Unverified
370831ada8e27ea78ce2e39a67c5fc82eb4ebc81

updated babel dependency versions

jjulienvincent committed 9 years ago
Unverified
a6d2eef6c3a71104157496041449f18348b420fd

Merge pull request #17 from AllenFang/master

aalexkuz committed 9 years ago

README

The README file for this repository.

🏚

This package was merged into redux-devtools monorepo. Please refer to that repository for the latest updates, issues and pull requests.

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 }