From 0987e9267664da84e3b43c2c02c325691d330c8a Mon Sep 17 00:00:00 2001 From: mathuo <6710312+mathuo@users.noreply.github.com> Date: Sun, 24 Apr 2022 11:26:06 +0100 Subject: [PATCH] feat: docs website --- package.json | 116 +- packages/dockview-docs/.eslintrc.json | 3 + packages/dockview-docs/.gitignore | 35 + packages/dockview-docs/README.md | 34 + .../dockview-docs/jsexamples/dockview.html | 27 + packages/dockview-docs/next-env.d.ts | 5 + packages/dockview-docs/next.config.mjs | 38 + packages/dockview-docs/package-lock.json | 8783 +++++++++++++++++ packages/dockview-docs/package.json | 37 + packages/dockview-docs/public/favicon.ico | Bin 0 -> 25931 bytes packages/dockview-docs/public/icon-link.svg | 1 + packages/dockview-docs/public/vercel.svg | 4 + .../dockview-docs/src/components/code.tsx | 70 + .../src/components/container.tsx | 19 + .../dockview-docs/src/components/footer.tsx | 7 + .../dockview-docs/src/components/header.tsx | 46 + .../src/components/navigation.tsx | 88 + .../src/components/simpleSplitview.tsx | 49 + .../dockview-docs/src/components/test.tsx | 5 + packages/dockview-docs/src/pages/_app.tsx | 33 + .../dockview-docs/src/pages/_document.tsx | 28 + packages/dockview-docs/src/pages/about.tsx | 12 + packages/dockview-docs/src/pages/basics.tsx | 9 + packages/dockview-docs/src/pages/index.mdx | 130 + .../dockview-docs/src/references/pages.ts | 49 + packages/dockview-docs/src/styles/globals.css | 43 + .../dockview-docs/src/styles/navigation.css | 45 + packages/dockview-docs/src/test.tsx | 79 + packages/dockview-docs/tsconfig.json | 24 + 29 files changed, 9761 insertions(+), 58 deletions(-) create mode 100644 packages/dockview-docs/.eslintrc.json create mode 100644 packages/dockview-docs/.gitignore create mode 100644 packages/dockview-docs/README.md create mode 100644 packages/dockview-docs/jsexamples/dockview.html create mode 100644 packages/dockview-docs/next-env.d.ts create mode 100644 packages/dockview-docs/next.config.mjs create mode 100644 packages/dockview-docs/package-lock.json create mode 100644 packages/dockview-docs/package.json create mode 100644 packages/dockview-docs/public/favicon.ico create mode 100644 packages/dockview-docs/public/icon-link.svg create mode 100644 packages/dockview-docs/public/vercel.svg create mode 100644 packages/dockview-docs/src/components/code.tsx create mode 100644 packages/dockview-docs/src/components/container.tsx create mode 100644 packages/dockview-docs/src/components/footer.tsx create mode 100644 packages/dockview-docs/src/components/header.tsx create mode 100644 packages/dockview-docs/src/components/navigation.tsx create mode 100644 packages/dockview-docs/src/components/simpleSplitview.tsx create mode 100644 packages/dockview-docs/src/components/test.tsx create mode 100644 packages/dockview-docs/src/pages/_app.tsx create mode 100644 packages/dockview-docs/src/pages/_document.tsx create mode 100644 packages/dockview-docs/src/pages/about.tsx create mode 100644 packages/dockview-docs/src/pages/basics.tsx create mode 100644 packages/dockview-docs/src/pages/index.mdx create mode 100644 packages/dockview-docs/src/references/pages.ts create mode 100644 packages/dockview-docs/src/styles/globals.css create mode 100644 packages/dockview-docs/src/styles/navigation.css create mode 100644 packages/dockview-docs/src/test.tsx create mode 100644 packages/dockview-docs/tsconfig.json diff --git a/package.json b/package.json index 7f6bdb658..31cea6df5 100644 --- a/package.json +++ b/package.json @@ -1,60 +1,60 @@ { - "name": "dockview-monorepo-root", - "private": true, - "description": "Monorepo for https://github.com/mathuo/dockview", - "scripts": { - "test": "jest", - "lint": "eslint packages/**/src/** --ext .ts,.tsx,.js,.jsx", - "package": "node scripts/package.js", - "package-all": "npm run build-demo && npm run docs && node scripts/package.js", - "build": "lerna run build --ignore dockview-demo", - "build-demo": "lerna run build --scope dockview-demo", - "docs": "lerna run docs --scope dockview", - "clean": "lerna run clean", - "bootstrap": "lerna bootstrap", - "bootstrap-no-hoist": "lerna bootstrap", - "test:cov": "jest --coverage", - "version-beta-build": "lerna version prerelease --preid beta", - "publish-app": "lerna publish" - }, - "repository": { - "type": "git", - "url": "git+https://github.com/mathuo/dockview.git" - }, - "author": "https://github.com/mathuo", - "license": "MIT", - "bugs": { - "url": "https://github.com/mathuo/dockview/issues" - }, - "homepage": "https://github.com/mathuo/dockview#readme", - "devDependencies": { - "@testing-library/dom": "^8.13.0", - "@types/jest": "^27.4.1", - "@typescript-eslint/eslint-plugin": "^5.19.0", - "@typescript-eslint/parser": "^5.19.0", - "codecov": "^3.8.3", - "cross-env": "^7.0.3", - "css-loader": "^6.7.1", - "eslint": "^8.13.0", - "fs-extra": "^10.0.1", - "gulp": "^4.0.2", - "gulp-concat": "^2.6.1", - "gulp-dart-sass": "^1.0.2", - "jest": "^27.5.1", - "jest-sonar-reporter": "^2.0.0", - "jsdom": "^19.0.0", - "lerna": "^4.0.0", - "merge2": "^1.4.1", - "rimraf": "^3.0.2", - "sass": "^1.50.0", - "sass-loader": "^12.6.0", - "style-loader": "^3.3.1", - "ts-jest": "^27.1.4", - "ts-loader": "^9.2.8", - "tslib": "^2.3.1", - "typescript": "^4.6.3", - "webpack": "^5.72.0", - "webpack-cli": "^4.9.2", - "webpack-dev-server": "^4.8.1" - } + "name": "dockview-monorepo-root", + "private": true, + "description": "Monorepo for https://github.com/mathuo/dockview", + "scripts": { + "test": "jest", + "lint": "eslint packages/**/src/** --ext .ts,.tsx,.js,.jsx", + "package": "node scripts/package.js", + "package-all": "npm run build-demo && npm run docs && node scripts/package.js", + "build": "lerna run build --scope dockview", + "build-demo": "lerna run build --scope dockview-demo", + "docs": "lerna run docs --scope dockview", + "clean": "lerna run clean", + "bootstrap": "lerna bootstrap", + "bootstrap-no-hoist": "lerna bootstrap", + "test:cov": "jest --coverage", + "version-beta-build": "lerna version prerelease --preid beta", + "publish-app": "lerna publish" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/mathuo/dockview.git" + }, + "author": "https://github.com/mathuo", + "license": "MIT", + "bugs": { + "url": "https://github.com/mathuo/dockview/issues" + }, + "homepage": "https://github.com/mathuo/dockview#readme", + "devDependencies": { + "@testing-library/dom": "^8.13.0", + "@types/jest": "^27.4.1", + "@typescript-eslint/eslint-plugin": "^5.19.0", + "@typescript-eslint/parser": "^5.19.0", + "codecov": "^3.8.3", + "cross-env": "^7.0.3", + "css-loader": "^6.7.1", + "eslint": "^8.13.0", + "fs-extra": "^10.0.1", + "gulp": "^4.0.2", + "gulp-concat": "^2.6.1", + "gulp-dart-sass": "^1.0.2", + "jest": "^27.5.1", + "jest-sonar-reporter": "^2.0.0", + "jsdom": "^19.0.0", + "lerna": "^4.0.0", + "merge2": "^1.4.1", + "rimraf": "^3.0.2", + "sass": "^1.50.0", + "sass-loader": "^12.6.0", + "style-loader": "^3.3.1", + "ts-jest": "^27.1.4", + "ts-loader": "^9.2.8", + "tslib": "^2.3.1", + "typescript": "^4.6.3", + "webpack": "^5.72.0", + "webpack-cli": "^4.9.2", + "webpack-dev-server": "^4.8.1" + } } diff --git a/packages/dockview-docs/.eslintrc.json b/packages/dockview-docs/.eslintrc.json new file mode 100644 index 000000000..bffb357a7 --- /dev/null +++ b/packages/dockview-docs/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "next/core-web-vitals" +} diff --git a/packages/dockview-docs/.gitignore b/packages/dockview-docs/.gitignore new file mode 100644 index 000000000..737d87210 --- /dev/null +++ b/packages/dockview-docs/.gitignore @@ -0,0 +1,35 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# next.js +/.next/ +/out/ + +# production +/build + +# misc +.DS_Store +*.pem + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* +.pnpm-debug.log* + +# local env files +.env*.local + +# vercel +.vercel + +# typescript +*.tsbuildinfo diff --git a/packages/dockview-docs/README.md b/packages/dockview-docs/README.md new file mode 100644 index 000000000..c87e0421d --- /dev/null +++ b/packages/dockview-docs/README.md @@ -0,0 +1,34 @@ +This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). + +## Getting Started + +First, run the development server: + +```bash +npm run dev +# or +yarn dev +``` + +Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. + +You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. + +[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. + +The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. + +## Learn More + +To learn more about Next.js, take a look at the following resources: + +- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. +- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. + +You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! + +## Deploy on Vercel + +The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. + +Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. diff --git a/packages/dockview-docs/jsexamples/dockview.html b/packages/dockview-docs/jsexamples/dockview.html new file mode 100644 index 000000000..84a4e165e --- /dev/null +++ b/packages/dockview-docs/jsexamples/dockview.html @@ -0,0 +1,27 @@ + + +
+ + + + + + + + + + + diff --git a/packages/dockview-docs/next-env.d.ts b/packages/dockview-docs/next-env.d.ts new file mode 100644 index 000000000..4f11a03dc --- /dev/null +++ b/packages/dockview-docs/next-env.d.ts @@ -0,0 +1,5 @@ +///dAMQaiH zm^r3v#$Q#2T=X>bsY#D%s!bhs^M9PMAcHbCc0FMHV{u-dwlL;a1eJ63v5U*?Q_8JO zT#50!RD619#j_Uf))0ooADz~*9&lN!bBDRUgE>Vud-i5ck%vT=r^yD*^?Mp@Q^v+V zG#-?gKlr}Eeqifb{|So?HM&g91P8|av8hQoCmQXkd?7wIJw b z_^v8bbg` SAn{I*4bH$u(RZ6*x UhuA~hc=8czK8SHEKTzSxgbwi~9(OqJB&gwb^l4+m`k*Q;_?>Y-APi1{k zAHQ)P)G)f|AyjSgcCFps)Fh6Bca*Xznq36!pV6Az&m{O8$wGFD? zY&O*3*J0;_EqM#jh6^gMQKpXV?#1?>$ml1xvh8nSN>-?H=V;nJIwB07YX$e6vLxH( zqYwQ>qxwR(i4f)DLd)-$P>T-no_c!LsN@)8`e;W@)-Hj0>nJ-}Kla4-ZdPJzI&Mce zv)V_j;(3ERN3_@I$N<^|4Lf`B;8n+bX@bHbcZTopEmDI*Jfl)-pFDvo6svPRoo@(x z);_{lY<;);XzT`dBFpRmGrr}z5u1=p C^ S-{ce6iXQlLGcItwJ^mZx{m$&DA_oEZ)B{_bYPq-HA zcH8WGoBG(aBU_j)vEy+_71T34@4dmSg!|M8Vf92Zj6WH7Q7t#OHQqWgFE3ARt+%!T z?oLovLVlnf?2c7pTc)~cc^($_8nyKwsN`RA-23ed3sdj(ys%pjjM+9JrctL;dy8a( z@en&CQmnV(()bu|Y%G1-4a(6x{aLytn$T-;(&{QIJB9vMox11U-1HpD@d(QkaJdEb zG{)+6Dos_L+O3NpWo^=gR?evp|CqEG?L&Ut#D*KLaRFOgOEK(Kq1@!EGcTfo+%A&I z=dLbB+d$u{sh?u)xP{PF8L%;YPPW53+@{>5W=Jt#wQpN;0_HYdw1{ksf_XhO4#2F= zyPx6Lx2<92L-;L5PD`zn6zwIH`Jk( $?Qw({erA$^bC;q33hv!d!>%wRhj# zal^hk+WGNg;rJtb-EB(?czvOM=H7dl=vblBwAv>}%1@{}mnpUznfq1cE^sgsL0*4I zJ##!*B?=vI_OEVis5o+_IwMIRrpQyT_Sq~ZU%oY7c5JMIADzpD!Upz9h@iWg_>>~j zOLS;wp^i$-E?4<_cp?RiS%Rd?i;f*mOz=~(&3lo<=@(nR!_Rqiprh@weZlL!t#NCc zO!QTcInq|%#>OVgobj{~ixEUec`E25zJ~*DofsQdzIa@5^nOXj2T;8O`l--(QyU ^$t?TGY^7#&FQ+2SS3B#qK*k3`ye?8jUYSajE5iBbJls75CCc(m3dk{t?- zopcER9{Z?TC)mk~gpi^kbbu>b-+a{m#8-y2^p$ka4n60w;Sc2}HMf<8JUvh CL0B&Btk)T`ctE$*qNW8L$`7!r^9T+>=<=2qaq-;ll2{`{Rg zc5a0ZUI$oG&j-qVOuKa=*v4aY#IsoM+1|c4Z)<}lEDvy;5huB@1RJPquU2U*U-;gu z=En2m+qjBzR#DEJDO`WU)hdd{Vj%^0V*KoyZ|5lzV87&g_j~NCjwv0uQVqXOb*QrQ zy|Qn`hxx(58c 70$E;L(X0uZZ72M1!6oeg)(cdKO ze0gDaTz+ohR-#d)NbAH4x{I(21yjwvBQfmpLu$)|m{XolbgF!pmsqJ#D}(ylp6uC> z{bqtcI#hT#HW=wl7>p!38sKsJ`r8}lt-q%Keqy%u(xk=yiIJiUw6|5IvkS+#?JTBl z8H5(Q?l#wzazujH!8o>1xtn8#_w+397* _cy8!pQGP%K(Ga3pAjsaTbbXJlQF_+m+-UpUUent@xM zg%jqLUExj~o^vQ3Gl*>wh=_gOr2*|U64_iXb+-111a H}$TjeajM+I20xw(((>fej-@CIz4S1pi$(#}P7`4({6QS2CaQS4NPENDp>sAqD z$bH4KGzXGffkJ7R>V>)>tC)uax{UsN*dbeNC*v}#8Y#OWYwL4t$ePR?VTyIs!wea+ z5Urmc)X|^`MG~*dS6pGSbU+gPJoq*^a=_>$n4|P^w$sMBBy@f*Z^Jg6?n5?oId6f{ z$LW4M|4m502z0t7g<#Bx%X;9<=)smFolV&(V^(7Cv2-sxbxopQ!)*#ZRhTBpx1)Fc zNm1T%bONzv6@#|dz(w02AH8OXe>kQ#1FMCzO}2J_mST)+ExmBr9cva-@?;wnmWMOk z{3_~EX_xadgJGv&H@zK_8{(x84`}+c?oSBX*Ge3VdfTt&F}yCpFP?CpW+BE^cWY0^ zb&uBN!Ja3UzYHK-CTyA5=L zEMW{l3Usky#ly=7px648W31UNV@K)&Ub&zP1c7%)`{);I4b0Q<)B}3;NMG2JH=X$U zfIW4)4n9ZM`-yRj67I)YSLDK)qfUJ_ij}a#aZN~9EXrh8eZY2&=uY%2N0UFF7<~%M zsB8=erOWZ>Ct_#^tHZ|*q`H;A)5;ycw*I cmVxi8_0Xk}aJA^ath+E;xg!x+As(M#0=)3!NJR6H&9+zd#iP(m0PIW8$ z1Y^VX`>jm`W!=WpF*{ioM?C9`yOR>@0q=u7o>BP-eSHqCgMDj!2anwH?s%i2p+Q7D zzszIf5XJpE)IG4;d_(La-xenmF(tgAxK`Y4sQ}BSJEPs6N_U2vI{8=0C_F?@7<(G; zo$~G=8p+076G;`}>{MQ>t>7cm=zGtfbdDXm6||jUU|?X?CaE?(<6bKDYKeHlz}DA8 zXT={X=yp_R;HfJ9h%?eWvQ!dRgz&Su*JfNt!Wu>|XfU &68iRikRrHRW|ZxzRR^`eIGt zIeiDgVS>IeExKVRWW8-= A= yA`}`)ZkWBrZD`hpWIxBGkh&f#ijr449~m`j6{4jiJ*C!oVA8ZC?$1RM#K(_b zL9TW)kN*Y4%^-qPpMP7d4)o?Nk#>aoYHT(*g)qmRUb?**F@pnNiy6Fv9rEiUqD(^O zzyS?nBrX63BTRYduaG(0VVG2yJRe%o&rVrLjbxTaAFTd8s;<<@Qs>u(<193R8>}2_ zuwp{7;H2a*X7_jryzriZXMg?bTuegABb^87@SsKkr2)0Gyiax8KQWstw^v #ix45EVrcEhr>!NMhprl $InQMzjSFH54x5k9qHc`@9uKQzvL4ihcq{^B zPrVR=o_ic%Y>6&rMN)hTZsI7I<3&`#(nl+3y3ys9A~ &^=4?PL&nd8)`OfG#n zwAMN$1&>K++c{^|7< 4P=2y(B{jJsQ0a#U;HTo4ZmWZYvI{+s;Td{Yzem%0*k#)vjpB zia;J&>}ICate44SFYY3vEelqStQWFihx%^vQ@Do(sOy7yR2@WNv7Y9I^yL=nZr3mb zXKV5t@=?-Sk|b{XMhA7ZGB@2hqsx}4xwCW!in#C zI@}sc Zlr3-NFJ@NFaJlhyfcw{k^vvtGl`N9xSo**rDW4S}i zM9{fMPWo%4wYDG~BZ18BD+}h|GQKc-g^{++3MY>}W_uq7jGHx{mwE9fZiPCoxN$+7 zrODGGJrOkcPQUB(FD5aoS4g~7#6NR^ma7-!>mHuJfY5kTe6PpNNKC9GGRiu^L31uG z$7v`*JknQHsYB!Tm_W{a32TM099djW%5e+j0Ve_ct}IM>XLF1Ap+YvcrLV=|CKo6S zb+ 9Nl3_YdKP6%Cxy@6TxZ>;4&nTneadr z_ES90ydCev)LV!dN=#(*f}|ZORFdvkYBni^aLbUk>BajeWIOcmHP#8S)*2U~QKI%S zyrLmtPqb&TphJ;>yAxri#;{uyk`JJqODDw%(Z=2 `1uc}br^V%>j!gS)D*q*f_-qf8&D;W1dJgQMlaH5er zN2U<%Smb7==vE}dDI8K7cKz!vs^73o9f>2sgiTzWcwY|BMYHH5%Vn7#kiw&eItCqa zIkR2~Q}>X=Ar8W|^Ms41Fm8o6IB2_j60eOeBB1Br!boW7JnoeX6Gs)?7rW0^5psc- zjS16yb>dFn>KPOF;imD}e!enuIniFzv}n$m2#gCCv4jM#ArwlzZ$7@9&XkFxZ4n!V zj3dyiwW4Ki2QG{@i>yuZXQizw_OkZI^-3otXC{!(lUpJF33gI60ak;Uqitp74|B6I zgg{b=Iz}WkhCGj1M =hu4#Aw173YxIVbISaoc z-nLZC*6Tgivd5V`K%GxhBsp@SUU60-rfc$=wb>zdJzXS&-5(NRRodFk;Kxk!S( O(a0e7oY=E( zAyS;Ow?6Q&XA+cnkCb{28_1N8H#?J!*$MmIwLq^*T_9-z^&UE@A(z9oGYtFy6EZef LrJugUA?W`A8`#=m literal 0 HcmV?d00001 diff --git a/packages/dockview-docs/public/icon-link.svg b/packages/dockview-docs/public/icon-link.svg new file mode 100644 index 000000000..60d93bb2e --- /dev/null +++ b/packages/dockview-docs/public/icon-link.svg @@ -0,0 +1 @@ + diff --git a/packages/dockview-docs/public/vercel.svg b/packages/dockview-docs/public/vercel.svg new file mode 100644 index 000000000..fbf0e25a6 --- /dev/null +++ b/packages/dockview-docs/public/vercel.svg @@ -0,0 +1,4 @@ + \ No newline at end of file diff --git a/packages/dockview-docs/src/components/code.tsx b/packages/dockview-docs/src/components/code.tsx new file mode 100644 index 000000000..24d861b9b --- /dev/null +++ b/packages/dockview-docs/src/components/code.tsx @@ -0,0 +1,70 @@ +import React from 'react'; +import Highlight, { defaultProps, Language } from 'prism-react-renderer'; +import theme from 'prism-react-renderer/themes/palenight'; + +interface CodeBlockProps { + children: string; + className?: string; + live?: boolean | string; + render?: boolean | string; + url: string; + code?: boolean | string; + center?: boolean | string; + edit?: boolean | string; +} + +export const CodeBlock = ({ + children, + className = '', + live, + render, + url, + code = true, + center = true, + edit = false, +}: CodeBlockProps) => { + if (!className) { + return ( + + {children} +
+ ); + } + + const language = className.replace(/language-/, ''); + + return ( ++ {({ className, style, tokens, getLineProps, getTokenProps }) => ( + + ); +}; diff --git a/packages/dockview-docs/src/components/container.tsx b/packages/dockview-docs/src/components/container.tsx new file mode 100644 index 000000000..aca43e0a2 --- /dev/null +++ b/packages/dockview-docs/src/components/container.tsx @@ -0,0 +1,19 @@ +import { PAGES } from '../references/pages'; +import { Navigation } from './navigation'; + +export const Container = (props: { children: React.ReactNode }) => { + return ( ++ {tokens.map((line, i) => ( ++ )} ++ {line.map((token, key) => ( + + ))} ++ ))} ++ + ); +}; diff --git a/packages/dockview-docs/src/components/footer.tsx b/packages/dockview-docs/src/components/footer.tsx new file mode 100644 index 000000000..686d6af1f --- /dev/null +++ b/packages/dockview-docs/src/components/footer.tsx @@ -0,0 +1,7 @@ +export const Footer = (props: {}) => { + return ( ++++ {props.children}++ footer ++ ); +}; diff --git a/packages/dockview-docs/src/components/header.tsx b/packages/dockview-docs/src/components/header.tsx new file mode 100644 index 000000000..96a47c911 --- /dev/null +++ b/packages/dockview-docs/src/components/header.tsx @@ -0,0 +1,46 @@ +import { DockviewReact, DockviewReadyEvent } from 'dockview'; + +const components = { + default: () => { + returnHello World; + }, +}; + +export const Header = (props: {}) => { + const onReady = (event: DockviewReadyEvent) => { + event.api.addPanel({ + id: 'panel1', + component: 'default', + }); + + event.api.addPanel({ + id: 'panel2', + component: 'default', + }); + + event.api.addPanel({ + id: 'panel3', + component: 'default', + position: { + referencePanel: 'panel2', + direction: 'right', + }, + }); + }; + + return ( +++ ); +}; diff --git a/packages/dockview-docs/src/components/navigation.tsx b/packages/dockview-docs/src/components/navigation.tsx new file mode 100644 index 000000000..aaf221541 --- /dev/null +++ b/packages/dockview-docs/src/components/navigation.tsx @@ -0,0 +1,88 @@ +import * as React from 'react'; +import { Page } from '../references/pages'; +import Link from 'next/link'; + +const LinkHeader = (props: { url: string; title: string }) => { + return ( + + {props.title} + + ); +}; + +export const CollapsibleNode = (props: { + page: Page; + children: React.ReactNode; + depth: number; +}) => { + const [expanded, setExpaned] = React.useState+ (false); + + const onClick = () => { + setExpaned(!expanded); + }; + + const cn = React.useMemo(() => { + return ['node', expanded ? 'expanded' : 'collapsed'].join(' '); + }, [expanded]); + + return ( + <> + + {props.page.url ? ( +++ ) : ( + props.page.title + )} + + {props.children} ++ > + ); +}; + +export const Node = (props: { page: Page; depth: number }) => { + if (props.page.routes) { + return ( ++ {props.page.routes.map((page) => ( + + ); + } + + return ( ++ ))} + + {props.page.url ? ( ++ ); +}; + +export const Navigation = (props: { pages: Page[] }) => { + return ( ++ ) : ( + props.page.title + )} + + {props.pages.map((page) => ( ++ ); +}; diff --git a/packages/dockview-docs/src/components/simpleSplitview.tsx b/packages/dockview-docs/src/components/simpleSplitview.tsx new file mode 100644 index 000000000..dfa95a711 --- /dev/null +++ b/packages/dockview-docs/src/components/simpleSplitview.tsx @@ -0,0 +1,49 @@ +import { + ISplitviewPanelProps, + Orientation, + SplitviewReact, + SplitviewReadyEvent, +} from 'dockview'; + +const components = { + default: (props: ISplitviewPanelProps<{ title: string }>) => { + return+ ))} + {props.params.title}; + }, +}; + +export const SimpleSplitview = () => { + const onReady = (event: SplitviewReadyEvent) => { + event.api.addPanel({ + id: 'panel_1', + component: 'default', + params: { + title: 'Panel 1', + }, + }); + + event.api.addPanel({ + id: 'panel_2', + component: 'default', + params: { + title: 'Panel 2', + }, + }); + + event.api.addPanel({ + id: 'panel_3', + component: 'default', + params: { + title: 'Panel 3', + }, + }); + }; + + return ( ++ ); +}; diff --git a/packages/dockview-docs/src/components/test.tsx b/packages/dockview-docs/src/components/test.tsx new file mode 100644 index 000000000..d8490065a --- /dev/null +++ b/packages/dockview-docs/src/components/test.tsx @@ -0,0 +1,5 @@ +import * as React from 'react'; + +export const Test = () => { + return this is a test component; +}; diff --git a/packages/dockview-docs/src/pages/_app.tsx b/packages/dockview-docs/src/pages/_app.tsx new file mode 100644 index 000000000..b93704f16 --- /dev/null +++ b/packages/dockview-docs/src/pages/_app.tsx @@ -0,0 +1,33 @@ +import { Header } from '../components/header'; +import { Footer } from '../components/footer'; +import { Container } from '../components/container'; +import { AppProps } from 'next/app'; +import '../styles/globals.css'; +import { CodeBlock } from '../components/code'; +import { MDXProvider } from '@mdx-js/react'; + +const components = { + code: CodeBlock, +} as any; + +const MyApp = (props: AppProps) => { + return ( +++ ); +}; + +export default MyApp; diff --git a/packages/dockview-docs/src/pages/_document.tsx b/packages/dockview-docs/src/pages/_document.tsx new file mode 100644 index 000000000..5e76a414d --- /dev/null +++ b/packages/dockview-docs/src/pages/_document.tsx @@ -0,0 +1,28 @@ +import { Html, Head, Main, NextScript } from 'next/document'; + +export default function Document() { + return ( + + + + + + {/* */} + + + ++ ++ + + ++ + + + ); +} diff --git a/packages/dockview-docs/src/pages/about.tsx b/packages/dockview-docs/src/pages/about.tsx new file mode 100644 index 000000000..34ffe72c4 --- /dev/null +++ b/packages/dockview-docs/src/pages/about.tsx @@ -0,0 +1,12 @@ +import * as React from 'react'; +import { Test } from '../test'; + +const Component = () => { + return ( + ++ ); +}; + +export default Component; diff --git a/packages/dockview-docs/src/pages/basics.tsx b/packages/dockview-docs/src/pages/basics.tsx new file mode 100644 index 000000000..504049760 --- /dev/null +++ b/packages/dockview-docs/src/pages/basics.tsx @@ -0,0 +1,9 @@ +import { NextPage } from 'next'; + +const Page: NextPage = (props) => { + return ( ++ basics+ ); +}; + +export default Page; diff --git a/packages/dockview-docs/src/pages/index.mdx b/packages/dockview-docs/src/pages/index.mdx new file mode 100644 index 000000000..92e58e2a6 --- /dev/null +++ b/packages/dockview-docs/src/pages/index.mdx @@ -0,0 +1,130 @@ +import { SimpleSplitview } from '../components/simpleSplitview'; + +# Introduction + +**dockview** is a zero dependency layout manager that supports tab, grids and splitviews. + +## Features + +- Themable and customizable +- Support for the serialization and deserialization of layouts +- Drag and drop support + +# Quick start + +`dockview` has a peer dependency on `react >= 16.8.0` and `react-dom >= 16.8.0`. To install `dockview` you can run: + +```shell +npm install dockview +``` + +You must also import the dockview stylesheet found under [`dockview/dict/styles/dockview.css`](https://unpkg.com/browse/dockview@latest/dist/styles/dockview.css), +depending on your solution this might be: + +```css +@import './node_modules/dockview/dist/styles/dockview.css'; +``` + +A dark and light theme are provided, one of these classes (or a custom theme) must be attached at any point above your components in the HTML tree. To cover the entire web page you might attach the class to the `body` component: + +```html + + ... + + + ... + +``` + +There are 4 components you may want to use: + +Splitview + +++ +```tsx +import { + DockviewReact, + DockviewReadyEvent, + PanelCollection, + IDockviewPanelProps, + IDockviewPanelHeaderProps, +} from 'dockview'; + +const components: PanelCollection+ = { + default: (props: IDockviewPanelProps<{ someProps: string }>) => { + return {props.params.someProps}; + }, +}; + +const headers: PanelCollection= { + customTab: (props: IDockviewPanelHeaderProps) => { + return ( + + {props.api.title} + props.api.close()}>{'[x]'} ++ ); + }, +}; + +const Component = () => { + const onReady = (event: DockviewReadyEvent) => { + event.api.addPanel({ + id: 'panel1', + component: 'default', + tabComponent: 'customTab', // optional custom header + params: { + someProps: 'Hello', + }, + }); + event.api.addPanel({ + id: 'panel2', + component: 'default', + params: { + someProps: 'World', + }, + position: { referencePanel: 'panel1', direction: 'below' }, + }); + }; + + return ( ++ ); +}; +``` + +```tsx +const components: PanelCollection = { + default: (props: IDockviewPanelProps<{ someProps: string }>) => { + return {props.params.someProps}; + }, + fancy: (props: IDockviewPanelProps) => { + return ( ++ + ); + }, +}; +``` diff --git a/packages/dockview-docs/src/references/pages.ts b/packages/dockview-docs/src/references/pages.ts new file mode 100644 index 000000000..a43cbbc2b --- /dev/null +++ b/packages/dockview-docs/src/references/pages.ts @@ -0,0 +1,49 @@ +export interface Page { + title: string; + url?: string; + routes?: Page[]; +} + +export const PAGES: Page[] = [ + { title: 'Introduction', url: '/#introduction' }, + { title: 'Basics', url: '/basics/#basics' }, + { + title: 'API', + url: '#api', + routes: [ + { + title: 'Dockview', + url: '#dockview', + routes: [ + { title: 'Item1', url: '/item1' }, + { title: 'Item2', url: '/item2' }, + ], + }, + // { + // title: 'Gridview', + // url: '#gridview', + // routes: [ + // { title: 'Item1', url: 'item1' }, + // { title: 'Item2', url: 'item2' }, + // ], + // }, + // { + // title: 'Splitview', + // url: '#splitview', + // routes: [ + // { title: 'Item1', url: 'item1' }, + // { title: 'Item2', url: 'item2' }, + // ], + // }, + // { + // title: 'Paneview', + // url: '#paneivew', + // routes: [ + // { title: 'Item1', url: 'item1' }, + // { title: 'Item2', url: 'item2' }, + // ], + // }, + ], + }, + { title: 'Guides', url: '#guides' }, +]; diff --git a/packages/dockview-docs/src/styles/globals.css b/packages/dockview-docs/src/styles/globals.css new file mode 100644 index 000000000..f223dbdf6 --- /dev/null +++ b/packages/dockview-docs/src/styles/globals.css @@ -0,0 +1,43 @@ +@import "./navigation.css"; +@import "~dockview/dist/styles/dockview.css"; + +html, +body { + padding: 0; + margin: 0; + /* font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, + Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif; */ + font-family: 'Roboto', sans-serif; +} + +a { + text-decoration: none; + color:dodgerblue; +} + +a, a:hover, a:visited, a:active { + color:dodgerblue; +} + +a:hover { + text-decoration: underline; +} + + +* { + box-sizing: border-box; +} + +.icon { + width: 16px; + height: 16px; + display: inline-block; + margin-left: 8px; +} + +.icon-link { + background-image: url(/icon-link.svg); + background-repeat: no-repeat; + background-size: 100%; + background-position: center center; +} diff --git a/packages/dockview-docs/src/styles/navigation.css b/packages/dockview-docs/src/styles/navigation.css new file mode 100644 index 000000000..b45580967 --- /dev/null +++ b/packages/dockview-docs/src/styles/navigation.css @@ -0,0 +1,45 @@ +.navigation { + padding: 30px; + background-color: lightgray; + font-size: 16px; + width: 200px; + border-radius: 15px; +} + +.node { + padding: 5px 0px; + cursor: pointer; +} + +.expandable-node::after { + +} + +.expanded::after { + border-width: 6px 4px 0px; + border-color: grey transparent transparent; + content: ''; + width: 0px; + height: 0px; + border-style: solid; + border-radius: 1px; + display: inline-block; + vertical-align: middle; + margin-left: 10px; + margin-bottom: 2px; +} + + +.collapsed::after { + border-width: 4px 6px 4px 0px; + border-color: transparent grey transparent; + content: ''; + width: 0px; + height: 0px; + border-style: solid; + border-radius: 1px; + display: inline-block; + vertical-align: middle; + margin-left: 10px; + margin-bottom: 2px; +} diff --git a/packages/dockview-docs/src/test.tsx b/packages/dockview-docs/src/test.tsx new file mode 100644 index 000000000..d657ae536 --- /dev/null +++ b/packages/dockview-docs/src/test.tsx @@ -0,0 +1,79 @@ +import { + GridviewReact, + Orientation, + GridviewReadyEvent, + DockviewReact, + DockviewReadyEvent, +} from 'dockview'; + +const components = { + default: () => { + return+ ++ {props.api.title} + props.api.close()}>{'Close'} +++ +{'Hello world'}+hello world; + }, + docking: () => { + return; + }, +}; + +export const Test = () => { + const onReady = (event: GridviewReadyEvent) => { + event.api.addPanel({ + component: 'default', + id: 'view_1', + }); + + event.api.addPanel({ + component: 'default', + id: 'view_2', + }); + + event.api.addPanel({ + component: 'docking', + id: 'view_3', + }); + }; + + return ( + + ); +}; + +const components2 = { + default: () => { + return hello world; + }, +}; + +export const Test2 = () => { + const onReady = (event: DockviewReadyEvent) => { + event.api.addPanel({ + component: 'default', + id: 'view_1', + }); + + event.api.addPanel({ + component: 'default', + id: 'view_2', + }); + + event.api.addPanel({ + component: 'default', + id: 'view_3', + }); + }; + + return ( + //++ ); +}; diff --git a/packages/dockview-docs/tsconfig.json b/packages/dockview-docs/tsconfig.json new file mode 100644 index 000000000..0b1236256 --- /dev/null +++ b/packages/dockview-docs/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "target": "es5", + "lib": ["dom", "dom.iterable", "esnext"], + "allowJs": true, + "skipLibCheck": true, + "strict": true, + "forceConsistentCasingInFileNames": true, + "noEmit": true, + "esModuleInterop": true, + "module": "esnext", + "moduleResolution": "node", + "resolveJsonModule": true, + "isolatedModules": true, + "jsx": "preserve", + "incremental": true + }, + "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "src/pages/index.msx", "src/pages/basic.stsx"], + "exclude": ["node_modules"], + "paths": { + "react": ["node_modules/react"], + "react-dom": ["node_modules/react-dom"] + } +}+ //