Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

dockview

Package Overview
Dependencies
Maintainers
1
Versions
149
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

dockview

Zero dependency layout manager supporting tabs, grids and splitviews with ReactJS support

  • 0.0.19
  • unpublished
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2.6K
decreased by-0.04%
Maintainers
1
Weekly downloads
 
Created
Source

dockview

Zero dependency layout manager supporting tabs, grids and splitviews with ReactJS support


stability-experimental npm version CI Build Coverage Quality Gate Status Bundle Phobia

A zero dependency layout manager based on the layering of split-view components with ReactJS support.

  • View the live demo here.
  • Storybook demo here.
  • Code examples here.
  • Generated TypeDocs can be found here.

Want to inspect the deployed package? Go to https://unpkg.com/browse/dockview@latest/

Features

  • Simple splitviews, nested splitviews (i.e. gridviews) supporting full layout managment with dockable and tabular views
  • Extensive API support at the component level and at the indivdual view level
  • Themable and customizable
  • Serialization / deserialization
  • Tabular views with Drag and Drop support
  • Documentation and examples

Largly inspired by code IDE editors such as VSCode. Parts of the core resizable panelling is based upon an implementation found in the VSCode sources of a splitview and gridview.

Installation

You can install the project from npm. The project comes with TypeScript typings.

npm install --save dockview

Setup

You must import or reference the stylesheet at dockview/dist/styles/dockview.css. For example:

@import '~dockview/dist/styles/dockview.css';

You should also attach a dockview theme to an element containing your components. For example:

<body classname="dockview-theme-light">
</body>

dockview has a peer dependency on react >= 16.8.0 and react-dom >= 16.8.0 which is the version that introduced React Hooks.

FAQ

Can I use this library without React?

In theory, yes. The library is written in plain-old JS and the parts written in ReactJS are merely wrappers around the plain-old JS components. Currently everything is published as one package though so maybe that's something to change in the future.

Can I use this library with AngularJS/Vue.js or any other arbitrarily named JavaScript library/framework?

Yes but with some extra work. Dockview is written in plain-old JS so you can either interact directly with the plain-old JS components or create a wrapper using your prefered library/framework. The React wrapper may give some ideas on how this wrapper implementation could be done for other libraries/frameworks. Maybe that's something to change in the future.

Sandbox examples

API Documentation

Splitview

Component Api Panel Api

Gridview

Component Api Panel Api

Dockview

Component Api Panel Api

Paneview

Component Api Panel Api

Theming

The theme can be customized using the below set of CSS properties. You can find the built in themes here which could be used as an example to extend upon or build your own theme.

CSS PropertyDescription
General
--dv-active-sash-colorThe background color a dividing sash during an interaction
--dv-separator-borderThe color of the seperator between panels
Paneview
--dv-paneview-header-border-color-
--dv-paneview-active-outline-colorThe primary accent color, used for example to highlight the active panel in Paneviews
Dockview -> Dragging
--dv-drag-over-background-colorThe overlay color applied to a group when a moving tab is dragged over
Dockview -> Tabs container
--dv-tabs-and-actions-container-font-size-
--dv-tabs-and-actions-container-heightDefault tab height
--dv-tabs-and-actions-container-background-color-
--dv-tabs-container-scrollbar-color-
--dv-group-view-background-color-
Dockview -> Tabs (see dockviewComponent.scss)
--dv-activegroup-visiblepanel-tab-background-colorThe background color of the tab for the visible panel in the active group
--dv-activegroup-hiddenpanel-tab-background-colorThe background color of the tab for the hidden panel/s in the active group
--dv-inactivegroup-visiblepanel-tab-background-colorThe background color of the tab for the visible panel in groups other than the active group
--dv-inactivegroup-hiddenpanel-tab-background-colorThe background color of the tab for the hidden panel/s in groups other than the active group
--dv-activegroup-visiblepanel-tab-colorThe color of the tab for the visible panel in the active group
--dv-activegroup-hiddenpanel-tab-colorThe color of the tab for the hidden panel/s in the active group
--dv-inactivegroup-visiblepanel-tab-colorThe color of the tab for the visible panel in groups other than the active group
--dv-inactivegroup-hiddenpanel-tab-colorThe color of the tab for the hidden panel/s in groups other than the active group
--dv-tab-divider-color-
--dv-tab-close-iconDefault tab close icon
--dv-tab-dirty-iconDefault tab dirty icon

Keywords

FAQs

Package last updated on 06 Jun 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc