solid-dockview v1.0.1

solid-dockview

Docking Layout for Solid.js, based on dockview-core

GitHub | Example | Documentation

Get Started

npm install solid-dockview dockview-core

import { DockPanel, DockView } from "solid-dockview";
import "dockview-core/dist/styles/dockview.css";

const App = () => {
  return (
    <DockView class="dockview-theme-dracula" style="height: 80vh">
      <DockPanel title="Hello">World</DockPanel>
      <DockPanel title="Panel2">Hey</DockPanel>
    </DockView>
  );
};

Caveats

control dockview with api

solid-dockview is a wrapper around dockview-core, and you can gain the original DockviewComponent or DockPanelComponent instances.

You can find documentation for dockview-core:

• Dockview API
• Dockview Panel API

<DockView
  class="dockview-theme-light"
  onReady={({ dockview }) => {
    console.log("dockview ready", dockview);
    // TODO: store `dockview` and use its APIs

    // Note: panels are not initialized yet.
    // to wait them, use onMount(() => { ... }) to wait for next update
  }}
>
  <DockPanel
    title="Hello"
    onCreate={({ panel, dockview }) => {
      console.log("panel created", panel, dockview);
      panel.api.setSize({ width: 300 });
      // TODO: store `panel` and use its APIs through panel.api.
    }}
  >
    World
  </DockPanel>
</DockView>

panel content overflow

By default dockview doesn't restrict the content area's style, thus your content can overflow the panel.

To fix this, inside the <DockPanel>, you can wrap your content with <div style="width: 100%; height: 100%; overflow: auto">

However, it could be tedious to do this for every panel. If you want to apply this style to all panels, you can add the following to your css:

.solid-dockview-panel-content {
  display: block;
  position: relative;
  height: 100%;
  width: 100%;
  overflow: auto;
}

And for specific panels, you can still override the class name with <DockPanel class="my-panel-content-style">

placeholder for empty groups

In dockview, you can use Watermark to show a placeholder when a group is empty. All you need to do is to provide a watermarkComponent to <DockView>.

<DockView class="dockview-theme-light" watermarkComponent={MyWatermark}>
  {/* your panels */}
</DockView>

In your watermark component, you can use group and close to control the group. Beware that group can be undefined when nothing is docked.

import { DockViewWatermarkProps } from "solid-dockview";

function MyWatermark({ group, close }: DockViewWatermarkProps) {
  return (
    <div style="display: flex; align-items: center; height: 100%; justify-content: center; color: #CCC; flex-flow: column">

      <p><strong>Nothing to display</strong></p>
      <p>Wanna open some file?</p>

      {!!group && (
        <p>
          <button onClick={close}>close this group</button>
        </p>
      )}
    </div>
  );
}