Skip to content

Commit

Permalink
chore: provide additional examples
Browse files Browse the repository at this point in the history
  • Loading branch information
mathuo committed Sep 30, 2023
1 parent a15e895 commit 9b7bc12
Show file tree
Hide file tree
Showing 8 changed files with 296 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .codesandbox/ci.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
"/packages/docs/sandboxes/externaldnd-dockview",
"/packages/docs/sandboxes/floatinggroup-dockview",
"/packages/docs/sandboxes/fullwidthtab-dockview",
"/packages/docs/sandboxes/headeractions-dockview",
"/packages/docs/sandboxes/ide-example",
"/packages/docs/sandboxes/groupcontol-dockview",
"/packages/docs/sandboxes/iframe-dockview",
"/packages/docs/sandboxes/keyboard-dockview",
Expand Down
9 changes: 9 additions & 0 deletions packages/docs/docs/components/dockview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import DockviewWithIFrames from '@site/sandboxes/iframe-dockview/src/app';
import DockviewFloating from '@site/sandboxes/floatinggroup-dockview/src/app';
import DockviewLockedGroup from '@site/sandboxes/lockedgroup-dockview/src/app';
import DockviewKeyboard from '@site/sandboxes/keyboard-dockview/src/app';
import IDEExample from '@site/sandboxes/ide-example/src/app';

import { attach as attachDockviewVanilla } from '@site/sandboxes/javascript/vanilla-dockview/src/app';
import { attach as attachSimpleDockview } from '@site/sandboxes/javascript/simple-dockview/src/app';
Expand Down Expand Up @@ -910,6 +911,14 @@ Keyboard shortcuts
react={DockviewKeyboard}
/>

## Application with sidebars

<MultiFrameworkContainer
height={600}
sandboxId="ide-example"
react={IDEExample}
/>

### Nested Dockviews

You can safely create multiple dockview instances within one page and nest dockviews within other dockviews.
Expand Down
32 changes: 32 additions & 0 deletions packages/docs/sandboxes/ide-example/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"name": "ide-example",
"description": "",
"keywords": [
"dockview"
],
"version": "1.0.0",
"main": "src/index.tsx",
"dependencies": {
"dockview": "*",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@types/react": "^18.0.28",
"@types/react-dom": "^18.0.11",
"typescript": "^4.9.5",
"react-scripts": "*"
},
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test --env=jsdom",
"eject": "react-scripts eject"
},
"browserslist": [
">0.2%",
"not dead",
"not ie <= 11",
"not op_mini all"
]
}
44 changes: 44 additions & 0 deletions packages/docs/sandboxes/ide-example/public/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="theme-color" content="#000000">
<!--
manifest.json provides metadata used when your web app is added to the
homescreen on Android. See https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/
-->
<link rel="manifest" href="%PUBLIC_URL%/manifest.json">
<link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200" />
<!--
Notice the use of %PUBLIC_URL% in the tags above.
It will be replaced with the URL of the `public` folder during the build.
Only files inside the `public` folder can be referenced from the HTML.
Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>React App</title>
</head>

<body>
<noscript>
You need to enable JavaScript to run this app.
</noscript>
<div id="root"></div>
<!--
This HTML file is a template.
If you open it directly in the browser, you will see an empty page.
You can add webfonts, meta tags, or analytics to this file.
The build step will place the bundled scripts into the <body> tag.
To begin the development, run `npm start` or `yarn start`.
To create a production bundle, use `npm run build` or `yarn build`.
-->
</body>

</html>
155 changes: 155 additions & 0 deletions packages/docs/sandboxes/ide-example/src/app.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
import {
GridviewReact,
GridviewReadyEvent,
IGridviewPanelProps,
GridviewComponent,
Orientation,
GridviewApi,
} from 'dockview';
import * as React from 'react';

const components = {
'left-sidebar': (props: IGridviewPanelProps<{ title: string }>) => {
return (
<div
style={{
height: '100%',
padding: '20px',
background: 'var(--dv-group-view-background-color)',
}}
>
{props.params.title}
</div>
);
},
'middle-content': (props: IGridviewPanelProps<{ title: string }>) => {
return (
<div
style={{
height: '100%',
padding: '20px',
background: 'var(--dv-group-view-background-color)',
}}
>
{props.params.title}
</div>
);
},
'right-sidebar': (props: IGridviewPanelProps<{ title: string }>) => {
return (
<div
style={{
height: '100%',
padding: '20px',
background: 'var(--dv-group-view-background-color)',
}}
>
{props.params.title}
</div>
);
},
};

const App = (props: { theme?: string }) => {
const [api, setApi] = React.useState<GridviewApi>();

const onReady = (event: GridviewReadyEvent) => {
event.api.fromJSON({
grid: {
height: 1000,
width: 1000,
orientation: Orientation.HORIZONTAL,
root: {
type: 'branch',
data: [
{
type: 'leaf',
data: {
id: 'left-sidebar-id',
component: 'left-sidebar',
snap: true,
minimumWidth: 100,
},
size: 200,
},
{
type: 'leaf',
data: {
id: 'middle-content-id',
component: 'middle-content',
},
size: 600,
},
{
type: 'leaf',
data: {
id: 'right-sidebar-id',
component: 'right-sidebar',
snap: true,
minimumWidth: 100,
},
size: 200,
},
],
},
},
});

setApi(event.api);
};

const onKeyPress = (event: React.KeyboardEvent) => {
if (!api) {
return;
}

if (event.ctrlKey) {
if (event.code === 'ArrowLeft') {
const leftSidebarPanel = api.getPanel('left-sidebar-id');
const rightSidebarPanel = api.getPanel('right-sidebar-id');

const width = rightSidebarPanel?.api.width;

if (leftSidebarPanel) {
leftSidebarPanel.api.setVisible(false);

if (rightSidebarPanel && typeof width === 'number') {
rightSidebarPanel.api.setSize({ width });
}
}
}
}

if (event.code === 'ArrowRight') {
const leftSidebarPanel = api.getPanel('left-sidebar-id');
const rightSidebarPanel = api.getPanel('right-sidebar-id');

if (leftSidebarPanel) {
leftSidebarPanel.api.setVisible(true);
leftSidebarPanel.api.setSize({ width: 200 });
}
}
};

return (
<div tabIndex={-1} style={{ height: '100%' }} onKeyDown={onKeyPress}>
<div>
{'Use '}
<span>{'Ctrl+ArrowLeft'}</span>
{' and '}
<span>{'Ctrl+ArrowRight'}</span>
{
' to show and hide the left sidebar. The right sidebar can be hidden by dragging it to the right.'
}
</div>
<GridviewReact
proportionalLayout={false}
onReady={onReady}
components={components}
className={`${props.theme || 'dockview-theme-abyss'}`}
/>
</div>
);
};

export default App;
20 changes: 20 additions & 0 deletions packages/docs/sandboxes/ide-example/src/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { StrictMode } from 'react';
import * as ReactDOMClient from 'react-dom/client';
import './styles.css';
import 'dockview/dist/styles/dockview.css';

import App from './app';

const rootElement = document.getElementById('root');

if (rootElement) {
const root = ReactDOMClient.createRoot(rootElement);

root.render(
<StrictMode>
<div className="app">
<App />
</div>
</StrictMode>
);
}
16 changes: 16 additions & 0 deletions packages/docs/sandboxes/ide-example/src/styles.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
body {
margin: 0px;
color: white;
font-family: sans-serif;
text-align: center;
}

#root {
height: 100vh;
width: 100vw;
}

.app {
height: 100%;

}
18 changes: 18 additions & 0 deletions packages/docs/sandboxes/ide-example/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"compilerOptions": {
"outDir": "build/dist",
"module": "esnext",
"target": "es5",
"lib": ["es6", "dom"],
"sourceMap": true,
"allowJs": true,
"jsx": "react-jsx",
"moduleResolution": "node",
"rootDir": "src",
"forceConsistentCasingInFileNames": true,
"noImplicitReturns": true,
"noImplicitThis": true,
"noImplicitAny": true,
"strictNullChecks": true
}
}

0 comments on commit 9b7bc12

Please sign in to comment.