Skip to main content

Watermark

When there is nothing else to display.

When Dockview is empty or a group has no panels (an empty group) you can render some fallback content which is referred to as a watermark. Both are controlled through the same provided component.

Empty state behaviour​

By default, when Dockview has no panels it renders a watermark. You can change this with noPanelsOverlay:

  • 'watermark' (default): renders your watermarkComponent when empty
  • 'emptyGroup': keeps an empty group visible instead

Keeping empty groups​

By default a group is removed as soon as its last panel is closed or dragged out. Set closeEmptyGroups to false to keep every emptied group in place, rendering its watermark, until the group itself is closed via group.api.close() or api.removeGroup(). This is useful when the grid is a fixed layout that panels come and go from.

api.removePanel(panel, { removeEmptyGroup }) overrides the option for a single call. api.closeAllGroups() and api.clear() remove the groups as well as their panels, except that closeAllGroups() keeps the last group when noPanelsOverlay is 'emptyGroup'.

Options​

The following properties can be set to configure the watermark component.