From b55f43fd0b815bf8848b0d70dab90a184183dd6d Mon Sep 17 00:00:00 2001 From: hufeixiong <673632758@qq.com> Date: Tue, 20 Jul 2021 19:28:51 +0800 Subject: [PATCH] add doc --- CHANGELOG.md | 77 ++++++ package.json | 3 +- packages/dooringx-doc/src/api/1.1.md | 9 + packages/dooringx-doc/src/api/dd.md | 15 -- packages/dooringx-doc/src/changelog/1.1.md | 7 +- packages/dooringx-doc/src/docs/1.3.md | 245 ++++++++++++++++++ .../dooringx-doc/src/lib/Header/index.svelte | 4 +- packages/dooringx-doc/src/lib/Header/logo.svg | 17 ++ .../src/lib/Header/svelte-logo.svg | 1 - packages/dooringx-doc/static/favicon.png | Bin 1571 -> 4906 bytes .../dooringx-example/src/pages/iframeTest.tsx | 7 +- script/changelog.js | 34 +++ 12 files changed, 393 insertions(+), 26 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 packages/dooringx-doc/src/api/1.1.md delete mode 100644 packages/dooringx-doc/src/api/dd.md create mode 100644 packages/dooringx-doc/src/lib/Header/logo.svg delete mode 100644 packages/dooringx-doc/src/lib/Header/svelte-logo.svg create mode 100644 script/changelog.js diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2e1ba3c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,77 @@ +## changelog + +## 0.6.0 + +已支持编辑模式使用Iframe！ + +修复选中条件。 + + +## 0.5.1 + +修复右侧选中不能取消选中问题。 + +## 0.5.0 + +修复control组件宽度不够问题。 + +移除antd自定义icon，容器底部icon可配置。 + +## 0.4.2 + +修复animate错误初始值。 + +修改markline样式。 + +全局设置增加容器高度。 +## 0.4.1 + +去除lib自动导入样式。 + +## 0.4.0 + +去除runtime导出，所有属性从config中获取。 + +## 0.3.1 + +1、由uuid更换为nanoid。 + +2、control组件增加标尺控制。 + +## 0.3.0 + +1、增加标尺，ContainerWrapper需要传递config才可使用。 + +2、修改容器最小拖动667。修复画布缩放下拖拽时与鼠标距离不一致。 + +3、innerContainerDragUp需要传递config。 + +## 0.2.0 + +commander的传递进行修改，可以获得config了，commander不再从index中导出 ，需要使用时从config中获取。增加左侧类名，方便自定义。 + +## 0.1.10 + +修改eslint依赖推荐 + + +## 0.1.9 + +增加全局body设置 + +## 0.1.8 + +增加弹窗设置，移除modalContainer + +## 0.1.7 + +修改预览特殊条件显示，删除console +## 0.1.6 + +调整初始缩放，画布初始比例，增加回正画布功能。 +## 0.1.5 + +删除未作按钮，增加fixed配置 +## 0.1.4 + +基础功能 diff --git a/package.json b/package.json index d39a29b..494231f 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,8 @@ "start:doc":"lerna exec npm run start --scope=dooringx-doc", "build": "lerna exec npm run build --scope=dooringx-lib", "deploy": "lerna exec npm run deploy --scope=dooringx-doc", - "pub": "node ./script/publish.js" + "pub": "node ./script/publish.js", + "changelog": "node ./script/changelog.js" }, "private": true, "devDependencies": { diff --git a/packages/dooringx-doc/src/api/1.1.md b/packages/dooringx-doc/src/api/1.1.md new file mode 100644 index 0000000..7c02deb --- /dev/null +++ b/packages/dooringx-doc/src/api/1.1.md @@ -0,0 +1,9 @@ +--- +title: 待定 +sTitle: API +order: 1 +--- + +## 待定 + + diff --git a/packages/dooringx-doc/src/api/dd.md b/packages/dooringx-doc/src/api/dd.md deleted file mode 100644 index bbc6734..0000000 --- a/packages/dooringx-doc/src/api/dd.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: xcxzc -sTitle: vc -order: 4 ---- - -## dsas - -saff -sa -d -ad -sa -d -fsad diff --git a/packages/dooringx-doc/src/changelog/1.1.md b/packages/dooringx-doc/src/changelog/1.1.md index b308a3b..6302f0e 100644 --- a/packages/dooringx-doc/src/changelog/1.1.md +++ b/packages/dooringx-doc/src/changelog/1.1.md @@ -1,8 +1,11 @@ + --- title: CHANGELOG order: 1 --- +## changelog + ## 0.6.0 已支持编辑模式使用Iframe！ @@ -13,6 +16,7 @@ order: 1 ## 0.5.1 修复右侧选中不能取消选中问题。 + ## 0.5.0 修复control组件宽度不够问题。 @@ -26,7 +30,6 @@ order: 1 修改markline样式。 全局设置增加容器高度。 - ## 0.4.1 去除lib自动导入样式。 @@ -77,4 +80,4 @@ commander的传递进行修改，可以获得config了，commander不再从index 删除未作按钮，增加fixed配置 ## 0.1.4 -基础功能 \ No newline at end of file +基础功能 diff --git a/packages/dooringx-doc/src/docs/1.3.md b/packages/dooringx-doc/src/docs/1.3.md index 53b1655..89a2db4 100644 --- a/packages/dooringx-doc/src/docs/1.3.md +++ b/packages/dooringx-doc/src/docs/1.3.md @@ -12,4 +12,249 @@ order: 3 npm i dooringx-lib ``` +dooringx-lib在编辑时提供两种容器，可以根据需要选择使用。 + +一种是普通容器，一种是iframe容器，这2种容器在某些实现上略有不同。 + +使用普通容器即在编辑时为普通的div并非iframe，而使用iframe则编辑时看见的为iframe内容。在预览时，使用preview组件，preview可以放到任何容器，包括去使用iframe查看。 + +普通容器使用参考demo: + +```js +import { + RightConfig, + Container, + useStoreState, + innerContainerDragUp, + LeftConfig, + ContainerWrapper, + Control, +} from 'dooringx-lib'; +import { useContext } from 'react'; +import { configContext } from '@/layouts'; +import { useCallback } from 'react'; +import { PREVIEWSTATE } from '@/constant'; + +export const HeaderHeight = '40px'; + +export default function IndexPage() { + const config = useContext(configContext); + + const everyFn = () => {}; + + const subscribeFn = useCallback(() => { + localStorage.setItem(PREVIEWSTATE, JSON.stringify(config.getStore().getData())); + }, [config]); + + const [state] = useStoreState(config, subscribeFn, everyFn); + + return ( +
+
+ head + + +
+
+
+ +
+ + + <> + + + + +
+ +
+
+
+ ); +} +``` + + +iframe容器使用参考demo： + + +index.tsx +```js +import { + RightConfig, + useStoreState, + innerContainerDragUp, + LeftConfig, + IframeContainerWrapper, + Control, + useIframeHook, + IframeTarget, +} from 'dooringx-lib'; +import { useContext } from 'react'; +import { configContext } from '@/layouts'; +import { useCallback } from 'react'; +import { PREVIEWSTATE } from '@/constant'; + +export const HeaderHeight = '40px'; + +export default function IndexPage() { + const config = useContext(configContext); + + const subscribeFn = useCallback(() => { + localStorage.setItem(PREVIEWSTATE, JSON.stringify(config.getStore().getData())); + }, [config]); + + const [state] = useStoreState(config, subscribeFn); + useIframeHook(`${location.origin}/container`, config); + + return ( +
+
+ head + + +
+
+
+ +
+ + + } + > + + +
+ +
+
+
+ ); +} +``` + +container 路由： + +```js +import { configContext } from '@/layouts'; +import { useContext } from 'react'; +import { IframeContainer } from 'dooringx-lib'; + +function ContainerPage() { + const config = useContext(configContext); + return ( +
+ +
+ ); +} + +export default ContainerPage; +``` + + + +预览时preview套iframe: + +```html +
+ +
+``` +preview路由： + +```js +import { PREVIEWSTATE } from '@/constant'; +import { Preview, UserConfig } from 'dooringx-lib'; +import plugin from '../../plugin'; + +const config = new UserConfig(plugin); + +function PreviewPage() { + const data = localStorage.getItem(PREVIEWSTATE); + if (data) { + try { + const json = JSON.parse(data); + config.resetData([json]); + } catch { + console.log('err'); + } + } + return ( +
+ +
+ ); +} + +export default PreviewPage; +``` + 有关 api 部分请参考 api diff --git a/packages/dooringx-doc/src/lib/Header/index.svelte b/packages/dooringx-doc/src/lib/Header/index.svelte index b2cf1fb..dffdf82 100644 --- a/packages/dooringx-doc/src/lib/Header/index.svelte +++ b/packages/dooringx-doc/src/lib/Header/index.svelte @@ -3,7 +3,7 @@ import { base } from '$app/paths'; import Button from '../Button/index.svelte'; import Switch from '../Switch/index.svelte'; - import logo from './svelte-logo.svg'; + import logo from './logo.svg'; import { getContext } from 'svelte'; import type { Writable } from 'svelte/store'; const lang = getContext>('lang'); @@ -37,7 +37,7 @@
- +
+ dooringX图标@1x + Created with Sketch. + + + + + + + + + + + + \ No newline at end of file diff --git a/packages/dooringx-doc/src/lib/Header/svelte-logo.svg b/packages/dooringx-doc/src/lib/Header/svelte-logo.svg deleted file mode 100644 index 49492a8..0000000 --- a/packages/dooringx-doc/src/lib/Header/svelte-logo.svg +++ /dev/null @@ -1 +0,0 @@ -svelte-logo \ No newline at end of file diff --git a/packages/dooringx-doc/static/favicon.png b/packages/dooringx-doc/static/favicon.png index 825b9e65af7c104cfb07089bb28659393b4f2097..0c0b8fb810732704d668731084e1f9a98dad529d 100644 GIT binary patch literal 4906 zcmV+_6V>dAP)Px{@)<-V89^%p0bs`|kJO>FTZS zzPJ1K?VefooYXnpRrSB>ufP6!S2vLoG)>DWphY_L0LuwDQsRJOf=iCgv*?B6{dqA4x{=M2B}*lnDN) z&^RI$Dbt2Ts?tmtMKtJ2dP5St__%@M7>>a z`UT$KOl~HQ5QW=L7l0aZ&*f`kVkskaTeZkrk5=2Kfi&u3)ZDQGq_z=3 zl0e!(7Z~;%iQ{<69eMjl5AD*I(~T|k%qP{fh|>uLNrS3AiJ3U41#&*d9~cxLjK+^x zDocW5nT+xgZ!GK=9H3eI1RN~l{VVrD9m5$R9K`LU& z63y{NosX+PD0K%)y+OsNl!lSNw8{|I^fhO-F<}D_;P|9Z8=Fj6RFz_TyUHy4k_wY) zT?m-Z08lD{iDDyRj&SL50{--8`p8I_Ud6N8HWjD)jKe9~RxT{o9WfN7qwBZPrA)*_ z#+@T`ci%NCd$7tR({49i-?d0oM>$@sf5>r%nSS%Qw;pxZ$0aEw9Di-p4Pt28vp;** zrwdT$t#w4ZX<;qB+W>x?E%RajCX zDzRDm|Cx}Jwc1iFB`?^j4xAv1-CPUNBUnRpVIS${jkiENBwQRX9WV{YmHxy7MKtLS z?f(~Lt>#Y*WH2T$B=vQ|m|2GoGag-3BuW^kK`4uXGOotaTEFd}v@<(+* ziNzv-`-JY&VP=Vnisj%frY@-O8w>>YMPb94*j_DZa$Mw{c9-zWyj~h-tW4^#)f*W7 zeLnl5}Wl*Qr|ap>|O#4vAM|*gcT#q;AE<;+zUkB^{>>YI_3;-=2yPBU&i8 z6r0k8MmRH=t_;lo0v5Utn-OIIe%?_^rDZ}iC6X2CjEf)eZ0_!L-JFQ{&Ys(WbT_-J;?-txnq# zhe7a5jHUx+-b#$-Y$z+CQXxdEp)yj4+OH){#zx9W9LJZHx#||o@)W8tqx9y_sj9x2 zo@ZRtz-vTo7k1=STcKQ5u#9Ks7JplqFD}POyl-v$R`sf|Y+Vsf+g65G5K}Abyg?DH z!4fE`oJA}Bmve!zc0Z1dLQ)|{OcM6T6@@;e_5C)(Ce8D$gknFF_*7%lnL1TLO#kk3 z@7!c-u0(P(s!XDStl<8ljG2|va$qU+)LCsfHq24GCC2UevbFY~-)k(9bjf1d%A7o- zt;Nn?-;qKQ!!T@MR>`n|?Z=l*=e08nm;1XK5{7}6mC4Pat+!rJH^~L0R3wpbi933l zp4xptJeg=jXWE3y+&YY2&&i@`VWA_Sh^2s~K+XGGsTnJQE5ZyoiFLp73m^{x{jTPOsrqnTrY2)(#bkmS7V=%|G zZupcMFr!;`P`yAwyRZ`fZj4wx8@1A#TTCO;-&&SdSc7UmQ*dFBN1t_m|sM=7Hc zz+x}MVsliOnogt))+lFYRS*_-!qWMxlxwPtB;a^*rT+Bs1Cg<<)K6@LFXc#438%Z3xR+C1LAnkvDC;W{Y1#a)qN z*-_+%7CF_Rbqk%RnkY((8Hb=TWu@Xni{ufqI7Lvqoxolnp|F#{NbJ_Av};$&0tkXGCDNZ(`c^6iRc_HZL|aK zXjzGd7TWyo2QB}VNN6k$i>sfrwRy!Ci<5bMc~Dg3JpS~9g_lU6VT^WPx0z02xzbB+ zTOXfORNb?y<2pln6Cj+jsSKwLn3K+{BvI>>d&cH|e9N`jqf`P;Z`(s}`|4m#RAeCzik2EG!osf`Sg^6I)IC}jq{c>yNPNZUysz#U(PeHj zPZh=vi))yFLvQ-AgqvE#0k@V!c4Mq@>7ifw@>cw7L!Fed`yefTe+%WQN-)k;5nxOe zv2x8L3+DKnqXGTk2hFhlXbt^R#mTg(A}%}=kwmd^`Z2!C-X0{7@tMNDU35_~>y zeJD9|Mk@#iI*S!Nt=ZVpykTogZYsW>z**a$xmgj0YrXBfec){b(^rhn$>p2noG#WY zVycLh8w;EaJi@DU>;mGR2>~X4T~$mAXBS%9F`6qv<`y|qul3OtAX=KtVwZMzcIP(- z{jPAwJt0teO%=g75;t$a(C5aDq?*75+OG<+lK$xr3tmCf-DXB>?yNEAv$qeYHEtJG zz!y^u2e2#*qNyHA#AvDrYM;f0_P&h%rO%}_14+a85oW?+QEg*2z1GxB)6Hm9xM|a% z_MeZtnF3)YRGy@1Y!6<-GgV<#2^MIo$b0|kABGpchm)475a9XANBl?%+k*!caMC2E z*SV$}EXjRInQP}`vphp(-Y7;hG_1$TbTCLgjqqkL@O_Mv>CucgwTNUseyVLKZyO)cCV~^bwk&AQdIxe=VMFlq;2Bc}Xpz7V310R=lnYz=`u}>*<5-yXkfnZzYYl zOrvL2h>v4wp`3ojx(Op`!gmHLW9;d(iZe|Mdhz}V!t@$fSA?0TF7#a%Y}F2%3Q`a$ zDI(|)6u44hH%vwpkyzYVyovM7_;*v10I^j?a7=zFj>(THtft90MVJ!SDGaufAE$DL z_+*NpH~a*S_=;(%1_;A~B;AxM|FTdhR3-B=Hd6$`HsGe>2a+z8IH4je=qLZExoh|P z@j^?}*BT5nP^7UZZY#>mMZy`DdCfvnMI__oD*wY;DD(p7RYh>1bJNTU5qCE%`8q7d zEtl`Nt2OP_)!MH!S%_te*eUdsPrFMC(n<_~S4e(1@`spPD$BfLw}f46aYl{8K3!8w z^Kmk@2o+7fkQa0gd$}duz4Q{cQdojt93gF^U{})?z08Gs%kw`OF~of%6fa0!j4?-0qhmY1 zqEG#GG#+xZ`HnCvOSDZJn^%4Pz$_l5bBsAN1LcN5E4+@QkVi42v9T-#!`QDS+A^vgOjeSDtCc8g16ahcAen|%XARpI@~dnp-3Dl%-aXJc2dYqZQ; zjZ-y>DmOpR(RN=&-rfOMx(A?zGj^!~V>F#_rDYp;;$%!CKI6ezr=1{-Pc`g_vdYug z6mqS4qam__9yX}Uu^*M^y4)_2`m8Bv|DhwaYTr?s4g(K^4o|9j*fNSM-A5Oy1~$_> z_FVW5K00?%fwOJqgxrI@d%63fl7`bh{;A^~{DlAO<_o$v@O#9SW<}dF3Q9FB*sPF_ zhM#K)x>mf_5cx^W&DUigpY;7)t*(jw@Y!A(f(hVu=rGx;9`=^+4tvXf{zc0*gSa{ju%aqa` zEyrHvI{7hTM;jqlzAd9*OzD*F!|&Gcc<%kV(>(rSk1bVW>uV`*vvR4ujkKf*h_H$k zxL=xq+l1$EcvXfsbb9F1%SFF@sQtRhS0D1dy1KFW+hc7VwpOxb6#O)uuz0=Z$3 zj0fnHHD-8rDL%UF9eY|2o~gH2j6I{kQ&2h600o2HN@&e>ed%%>2J?^Y`KsjVL_DU# zQbB06zIq?+sPWN*cvamSto%ti*fI)yHSYSs>7+wL`_tyqBASTG^M%@9rL0Yg3@~^D z?wNkOWfu)bml*?gK9foNT*j7B!efe7luz#sA4DD;C43*sT*04?_68VY=dOda{dkRj z=*%N-B|aGqwv2K^zu+HAy-xly-^7e+V;~Gh2sF3Qo14F&-hlw!2oioxobW}lff&mm zbp1WH?tNqlZnxtM{z7YW-(D_0^XMYs>Bdm(;8%xf$D!ji0bMouGqE%Z;IgV;3`%Be{`(kJ?>|hpVIs49^(vWDjs^WO%R%#J zj2B0e@rw4tV*dgxu@_^IY@g(laixeaEpi@xc)I6!eztII|B}4*P4=eBREkBnsD(Ey z#@}$he0Pd(=D_>Ef%hJGUyV6l`xW{!PpcUX>Wk!z3JwcHWj@5N>~HVCOYBKUew0yS z1x>2*Psf7=EXTEySe%`Fri}tmXhPR}&gr3LGjEOlF9tjMNuGp8kwhF%o#(FzQt0pD zK`H%kMwO8Xqrec=*p1Hp>j`3uDm#;D%SKTPoixvXE4&9kbJMO;;mOjrj3S872wp76 zr6qUYE+YRskgTk9@V1Pi7I;rp-LN(-_&bb8k!KPrUQMT96n;Q64?jj(qw;rFI&Gt< zicYO+7!cH2e}^u{E6=!KW)v8J|0(IUtZZ61{Z4T*jPx)-AP12RCwC$UE6KzI1p6{F2N z1VK2vi|pOpn{~#djwYcWXTI_im_u^TJgMZ4JMOsSj!0ma>B?-(Hr@X&W@|R-$}W@Z zgj#$x=!~7LGqHW?IO8+*oE1MyDp!G=L0#^lUx?;!fXv@l^6SvTnf^ac{5OurzC#ZMYc20lI%HhX816AYVs1T3heS1*WaWH z%;x>)-J}YB5#CLzU@GBR6sXYrD>Vw(Fmt#|JP;+}<#6b63Ike{Fuo!?M{yEffez;| zp!PfsuaC)>h>-AdbnwN13g*1LowNjT5?+lFVd#9$!8Z9HA|$*6dQ8EHLu}U|obW6f z2%uGv?vr=KNq7YYa2Roj;|zooo<)lf=&2yxM@e`kM$CmCR#x>gI>I|*Ubr({5Y^rb zghxQU22N}F51}^yfDSt786oMTc!W&V;d?76)9KXX1 z+6Okem(d}YXmmOiZq$!IPk5t8nnS{%?+vDFz3BevmFNgpIod~R{>@#@5x9zJKEHLHv!gHeK~n)Ld!M8DB|Kfe%~123&Hz1Z(86nU7*G5chmyDe ziV7$pB7pJ=96hpxHv9rCR29%bLOXlKU<_13_M8x)6;P8E1Kz6G<&P?$P^%c!M5`2` zfY2zg;VK5~^>TJGQzc+33-n~gKt{{of8GzUkWmU110IgI0DLxRIM>0US|TsM=L|@F z0Bun8U!cRB7-2apz=y-7*UxOxz@Z0)@QM)9wSGki1AZ38ceG7Q72z5`i;i=J`ILzL z@iUO?SBBG-0cQuo+an4TsLy-g-x;8P4UVwk|D8{W@U1Zi z!M)+jqy@nQ$p?5tsHp-6J304Q={v-B>66$P0IDx&YT(`IcZ~bZfmn11#rXd7<5s}y zBi9eim&zQc0Dk|2>$bs0PnLmDfMP5lcXRY&cvJ=zKxI^f0%-d$tD!`LBf9^jMSYUA zI8U?CWdY@}cRq6{5~y+)#h1!*-HcGW@+gZ4B};0OnC~`xQOyH19z*TA!!BJ%9s0V3F?CAJ{hTd#*tf+ur-W9MOURF-@B77_-OshsY}6 zOXRY=5%C^*26z?l)1=$bz30!so5tfABdSYzO+H=CpV~aaUefmjvfZ3Ttu9W&W3Iu6 zROlh0MFA5h;my}8lB0tAV-Rvc2Zs_CCSJnx@d`**$idgy-iMob4dJWWw|21b4NB=LfsYp0Aeh{Ov)yztQi;eL4y5 zMi>8^SzKqk8~k?UiQK^^-5d8c%bV?$F8%X~czyiaKCI2=UH {}; - const subscribeFn = useCallback(() => { localStorage.setItem(PREVIEWSTATE, JSON.stringify(config.getStore().getData())); }, [config]); - const [state] = useStoreState(config, subscribeFn, everyFn); + const [state] = useStoreState(config, subscribeFn); useIframeHook(`${location.origin}/container`, config); return ( diff --git a/script/changelog.js b/script/changelog.js new file mode 100644 index 0000000..7461cbe --- /dev/null +++ b/script/changelog.js @@ -0,0 +1,34 @@ +/* + * @Author: yehuozhili + * @Date: 2021-07-20 17:38:03 + * @LastEditors: yehuozhili + * @LastEditTime: 2021-07-20 19:23:46 + * @FilePath: \dooringx\script\changelog.js + */ + +const fs = require('fs-extra'); +const path = require('path'); +const changelog = path.resolve(process.cwd(), 'CHANGELOG.md'); +const doclog = path.resolve( + process.cwd(), + 'packages', + 'dooringx-doc', + 'src', + 'changelog', + '1.1.md' +); +const isExist = fs.existsSync(doclog); +if (isExist) { + fs.removeSync(doclog); +} + +const prepend = ` +--- +title: CHANGELOG +order: 1 +--- + +`; + +const data = prepend + fs.readFileSync(changelog).toString(); +fs.writeFileSync(doclog, data);