chore: docs

This commit is contained in:
mathuo 2024-07-23 20:42:09 +01:00
parent bdf286103f
commit e93a008fe4
No known key found for this signature in database
GPG Key ID: C6EEDEFD6CA07281
8 changed files with 30 additions and 1 deletions

View File

@ -14,7 +14,6 @@ import { DocRef } from '@site/src/components/ui/reference/docRef';
<DocRef declaration="IDockviewReactProps" />
</FrameworkSpecific>
<FrameworkSpecific framework="Vue">
<DocRef declaration="IDockviewVueProps" />
</FrameworkSpecific>

View File

@ -18,6 +18,10 @@ You may want to combine this with `locked={true}` to provide a locked grid with
<DocRef declaration="IDockviewReactProps" methods={["disableDnd"]} />
</FrameworkSpecific>
<FrameworkSpecific framework="Vue">
<DocRef declaration="IDockviewVueProps" methods={["disableDnd"]} />
</FrameworkSpecific>

View File

@ -17,6 +17,10 @@ import LiveExample from '@site/src/components/ui/exampleFrame';
<DocRef declaration="IDockviewReactProps" methods={['showDndOverlay']} />
</FrameworkSpecific>
<FrameworkSpecific framework='Vue'>
<DocRef declaration="IDockviewVueProps" methods={['showDndOverlay']} />
</FrameworkSpecific>
<FrameworkSpecific framework='JavaScript'>
<DocRef declaration="DockviewComponentOptions"
methods={['showDndOverlay']}

View File

@ -10,6 +10,11 @@ This section describes how you can customize the header component of each group.
<DocRef declaration="IDockviewReactProps" methods={['leftHeaderActionsComponent', 'rightHeaderActionsComponent', 'prefixHeaderActionsComponent']} />
</FrameworkSpecific>
<FrameworkSpecific framework='Vue'>
<DocRef declaration="IDockviewVueProps" methods={['leftHeaderActionsComponent', 'rightHeaderActionsComponent', 'prefixHeaderActionsComponent']} />
</FrameworkSpecific>
<FrameworkSpecific framework='JavaScript'>
<DocRef declaration="DockviewComponentOptions"
methods={['createLeftHeaderActionsElement', 'createRightHeaderActionsElement', 'createPrefixHeaderActionsElement']} />

View File

@ -22,6 +22,10 @@ The following properties can be set to configure the behaviours of floating grou
<DocRef declaration="IDockviewReactProps" methods={['floatingGroupBounds', 'disableFloatingGroups']} />
</FrameworkSpecific>
<FrameworkSpecific framework='Vue'>
<DocRef declaration="IDockviewVueProps" methods={['floatingGroupBounds', 'disableFloatingGroups']} />
</FrameworkSpecific>
<FrameworkSpecific framework='JavaScript'>
<DocRef declaration="DockviewComponentOptions" methods={['floatingGroupBounds', 'disableFloatingGroups']} />
</FrameworkSpecific>

View File

@ -14,6 +14,11 @@ You can register panels through the dock [option](/docs/api/dockview/options) `
<DocRef declaration="IDockviewReactProps" methods={['components']} />
</FrameworkSpecific>
<FrameworkSpecific framework='Vue'>
<DocRef declaration="IDockviewVueProps" methods={['components']} />
</FrameworkSpecific>
<FrameworkSpecific framework='JavaScript'>
<DocRef declaration="DockviewComponentOptions" methods={['components']} />
</FrameworkSpecific>

View File

@ -161,6 +161,10 @@ When a group has only one single tab you may want that tab to take the full widt
<DocRef declaration="IDockviewReactProps" methods={['singleTabMode']} />
</FrameworkSpecific>
<FrameworkSpecific framework='Vue'>
<DocRef declaration="IDockviewVueProps" methods={['singleTabMode']} />
</FrameworkSpecific>
<FrameworkSpecific framework='JavaScript'>
<DocRef declaration="DockviewComponentOptions" methods={['singleTabMode']} />
</FrameworkSpecific>

View File

@ -19,6 +19,10 @@ The following properties can be set to configure the behaviours of floating grou
<DocRef declaration="IDockviewReactProps" methods={['watermarkComponent']} />
</FrameworkSpecific>
<FrameworkSpecific framework='Vue'>
<DocRef declaration="IDockviewVueProps" methods={['watermarkComponent']} />
</FrameworkSpecific>
<FrameworkSpecific framework='JavaScript'>
<DocRef declaration="DockviewComponentOptions"
methods={['watermarkComponent', 'watermarkFrameworkComponent', 'frameworkComponentFactory']}