dockview/packages/dockview-core/README.md
mathuo ffddc95602
chore: update docs (#429)
* chore: 1.9.0 docs
2024-01-15 20:03:20 +00:00

2.1 KiB

dockview

Zero dependency layout manager supporting tabs, groups, grids and splitviews written in TypeScript


npm version npm CI Build Coverage Quality Gate Status Bundle Phobia

Please see the website: https://dockview.dev

Features

  • Serialization / deserialization with full layout management
  • Support for split-views, grid-views and 'dockable' views
  • Themeable and customizable
  • Tab and Group docking / Drag n' Drop
  • Popout Windows
  • Floating Groups
  • Extensive API
  • Supports Shadow DOMs
  • High test coverage
  • Documentation website with live examples
  • Transparent builds and Code Analysis
  • Security at mind - verifed publishing and builds through GitHub Actions

Want to verify our builds? Go here.

Quick start

Dockview has a peer dependency on react >= 16.8.0 and react-dom >= 16.8.0. You can install dockview from npm.

npm install --save dockview-core

Within your project you must import or reference the stylesheet at dockview-core/dist/styles/dockview.css and attach a theme.

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

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

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