From 2e8e06687e3f5cf4ed85192be4dce2579a4927f1 Mon Sep 17 00:00:00 2001 From: Austin Sullivan Date: Wed, 22 Feb 2023 13:02:59 -0500 Subject: [PATCH] fix(docs): Convert example to fullscreen (#20) --- package.json | 3 ++- .../react-console/examples/ReactConsole.md | 2 +- .../generated/extensions/react-console/react.js | 10 ++++++++-- .../react-console/react/basic-usage.png | Bin 0 -> 6113 bytes .../module/patternfly-docs/generated/index.js | 2 +- 5 files changed, 12 insertions(+), 5 deletions(-) create mode 100644 packages/module/patternfly-docs/generated/extensions/react-console/react/basic-usage.png diff --git a/package.json b/package.json index 5691503..6210075 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,8 @@ "lint": "yarn lint:js && yarn lint:md", "test": "TZ=EST jest packages", "test:a11y": "yarn workspace @patternfly/react-console test:a11y", - "serve:a11y": "yarn workspace @patternfly/react-console serve:a11y" + "serve:a11y": "yarn workspace @patternfly/react-console serve:a11y", + "screenshots": "yarn workspace @patternfly/react-console docs:screenshots" }, "devDependencies": { "@babel/core": "^7.19.6", diff --git a/packages/module/patternfly-docs/content/extensions/react-console/examples/ReactConsole.md b/packages/module/patternfly-docs/content/extensions/react-console/examples/ReactConsole.md index 2fe75a1..d1dc46a 100644 --- a/packages/module/patternfly-docs/content/extensions/react-console/examples/ReactConsole.md +++ b/packages/module/patternfly-docs/content/extensions/react-console/examples/ReactConsole.md @@ -23,7 +23,7 @@ import '@patternfly/react-styles/src/css/components/Consoles/xterm.css'; ## Examples ### Basic Usage -```js +```js isFullscreen import React from 'react'; import { AccessConsoles, SerialConsole, VncConsole, DesktopViewer } from '@patternfly/react-console'; import { SerialConsoleCustom } from './SerialConsoleCustom.jsx'; diff --git a/packages/module/patternfly-docs/generated/extensions/react-console/react.js b/packages/module/patternfly-docs/generated/extensions/react-console/react.js index 0e7e982..949b619 100644 --- a/packages/module/patternfly-docs/generated/extensions/react-console/react.js +++ b/packages/module/patternfly-docs/generated/extensions/react-console/react.js @@ -3,6 +3,12 @@ import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfl import { AccessConsoles, SerialConsole, VncConsole, DesktopViewer } from '@patternfly/react-console'; import { SerialConsoleCustom } from '../../../content/extensions/react-console/examples/./SerialConsoleCustom.jsx'; import { debounce } from '@patternfly/react-core'; +import '@patternfly/react-styles/src/css/components/Consoles/AccessConsoles.css'; +import '@patternfly/react-styles/src/css/components/Consoles/DesktopViewer.css'; +import '@patternfly/react-styles/src/css/components/Consoles/SerialConsole.css'; +import '@patternfly/react-styles/src/css/components/Consoles/VncConsole.css'; +import '@patternfly/react-styles/src/css/components/Consoles/xterm.css'; +import srcImportbasicusage from './react/basic-usage.png'; const pageData = { "id": "React console", "section": "extensions", @@ -339,7 +345,7 @@ const pageData = { } ], "beta": true, - "examples": [ + "fullscreenExamples": [ "Basic Usage" ] }; @@ -356,7 +362,7 @@ pageData.relativeImports = { }; pageData.examples = { 'Basic Usage': props => - {\n const [status, setStatus] = React.useState('disconnected');\n const setConnected = React.useRef(debounce(() => setStatus('connected'), 3000)).current;\n const onConnect = React.useCallback(() => {\n setStatus('loading');\n setConnected();\n }, [setConnected])\n const onDisconnect = React.useCallback(() => setStatus('disconnected'), [])\n const ref = React.createRef();\n\n return (\n \n \n {\n ref.current.onDataReceived(data);\n }}\n ref={ref}\n />\n \n \n \n );\n};","title":"Basic Usage","lang":"js"}}> + {\n const [status, setStatus] = React.useState('disconnected');\n const setConnected = React.useRef(debounce(() => setStatus('connected'), 3000)).current;\n const onConnect = React.useCallback(() => {\n setStatus('loading');\n setConnected();\n }, [setConnected])\n const onDisconnect = React.useCallback(() => setStatus('disconnected'), [])\n const ref = React.createRef();\n\n return (\n \n \n {\n ref.current.onDataReceived(data);\n }}\n ref={ref}\n />\n \n \n \n );\n};","title":"Basic Usage","lang":"js","isFullscreen":true}}> }; diff --git a/packages/module/patternfly-docs/generated/extensions/react-console/react/basic-usage.png b/packages/module/patternfly-docs/generated/extensions/react-console/react/basic-usage.png new file mode 100644 index 0000000000000000000000000000000000000000..4c6067bb5ea9cbe61e84d578ce5d3a59d64d431d GIT binary patch literal 6113 zcmeHKX;72N)_#LH;5dQ|AZr4OjwonAkUfCPqN50cY$A&U1X&EL0YX?t1sRsWh=3rV zpzILYWlK;X5h7s3ggsG^HG~+pKuF-ms_*;$e?RW6y7$hHu0GXW-KXoE=XuWQB%7<2 z2Y#0S832F-moA#w0>B<+006xc{YkJQ1FwEBnDzx-bPff8{gOWh2*`aVE7*E`$?V+q zh-b{nQN+!;$j)1C4W_K|WH*_4dva{2W6P42gox;0%Am1s^K9+YpI+WgjVk95)(;J{ zal>P$M(eyTWmUUUPm}&?9RI5-wa6^+b611x>$&Lf(LS+8Ee)^&XLf&! zQS*uy@7_XE1f0LHh?JF;<+{@NFI6DuT{ENRMX$aPBmAP5QQc;Q`XoB0JES3V6Np=h zw2A%l^TFq%>+V~1?cDnPY}!C5+iHzh@i=%Y8WG-sjnyc)88zkaoW>0osfi{uWbUr} z@szOf@$vI47B+^;Ne!1{u+PxVR&O$1wG${=T|M+pgCFmm$O(TQ4G}#UmjSA~P497v zK4#h)B~sKJ8`S-(4WZnM5-BQWB@^YbvEb|)TD)JRyK|_Yo@pQ7`+AYA|5j8D4>H4P zxkkEHRBGhTZ@mxSdvU9dUdF!fTP6M~X<5M^M;<;NwL_RI&nAhebW&2+-3)1{yVGkz z!X8UNxut0zdK%3NeCAWds-8y6KosX-QFZh@Vs4FFTDIlh_d^E`Ymix*@I8BROieyzmg@nJ5QsX{z&c?i@O;Y9d8!wc_90F%=dybPy zD!82NLhs$guZ4RYYcSz=a%$3&$ju5W@U`uj>5!{Z%EfcAkf!5@n0hiKj$2ttbzy1n zC~gyH9EK`VZu5)#tgC~dDT*6!dQ>^p9)U!D%g{q@EamJf%Rt>y#7%fX-I7o4u-aI- z7bY8J8JUd6fYG{$uMcGi{D*+-cm(UQBp;eBaWKwbJiV|ZMx($ff~`?Tu~^Iq;c13p*)3m$ew_Egwcdaf^0$W*Gs-glWN z>?+8A5+SI7h;x0~-eWDHa|9fEdn#T8@@TFARl|)#ExgK}(#3CCUCB2%do|xc+S-I4 z*1p4K1TTDg<@6@#)>-$+j*zFCaEpefCc*`An3R^!fVPlOkn}o=n=at%|joJ;m>A_4AWehnS6|$SkC}FpK^5>pBsKOMt}99^nP!A>Y2$&R)fQ! zK8iHDIrE{*K0rzwk2Kne9Q*22%Q+vtyTxZuXPaOK3NqT%ZeEW2JVe`}l1D-!RBy+8 ze;4m(HW$A)FnIS5c<`d9dwc7~b>470oZU+%QQ+QB-EX4LY&0W@?h|eG2CdX^#2<~` zq^yXYt+`5aidCLY&#C5#UlASa4imvdFnh5QOHjkM|2p%ru_jy^N}Q(5E$M zWCtTI43$=H_m$k38_2J$L578O^R`wi=T$YY{qc&YPPT)%x7`aoE42E(OWbjgy*Z6> z92zKq8Q#V7H*$0WZ%jlns%yg;R0-1l&WowrYfm^!Sy@?c7E1CeIFnqyT^ulx1DtT5 zxa=WyOnt|P&0hRi&%vS8m!HO}j}5F7E+mh6?lh(O<@z`lRN>xaXZ&S2*F-30DPi3 zZ!B+87^QkQD#BX&8a|R0!DCdZ1T)sUD2LGu??C2!63e(A8q@a8O!}mP30{f=^-aEC zY5^JX`;_PLWK&f|!Cda4>RTHeFZ=ySqrao{o@5zl&AX|j;{|0$ZgJNZf(K!o?r{Vj zW+Y@=G(BL*N*OfSH4;-YRun)Tu{7D%{O2R*`rG!ahpb`i*QKS#n*tTYo~<}-rAM!k zEh~Y@=~Uec@?X02==vK?t8g4FP5YLADbs z+_#&X-)C}~t5tS38t>QcboQJ)B9^~gZlTsE+RMsnCRX}i?O8}h+g~@@d7Cssp*p9k zW5zB3cL0YyjnsV3mO z;&`6iuL4XE`4>f6i1 zhm;#vdhjVRnNZ&9Y=7nQ_Ixp>LU!c!tqal;RnBsy5i?kd$(UYddQa^6jFux%bPN z-s6QS`k}KtnnW!iYp7b0FQxEDF>YDa3DCW(lpbP>uPdjZS&-z7{T=pRnGz3>O=3Og zN4qN&r#43i#rhi%Rmx5qri zx+R>6vek(_S$y=EY@g_reOUy~uK&LDD0)VVi($pgiN4z&%sEsg|6E_0rSt3whBYx3 zYT)+peQjES-{)d8TNn$j6djzF;ZGCxuM)5IKl`-57c?L;Qq= zzl;feV{oq;=)Gm6Ho6nNguK=UR))ETskE2KPlhja2W(<(D7$vl2+w!q#Lv}A{?XB! zGID3#r*A1M6r$GP#nun>sM^D;M3Aoz9DHy1+G_yEi!_y|JCe}eS|uT$I=D8C>&Ehw zTLIV)b|vNF{^POU1?0pxr-rClazxoUVNMQ)n8qm$heFZ`^y1(h2`p?eYMS|V!4iBZ z;vH~eJ2b`kcw#a>KKw`Z_Qi!iCq4ZL`b`mZ!e_n46JD3S!-x*}a&lUK6Z3ZW!~I>PK4qkxOG8#Q$v?v}X)n>o&0_q%B=AscnU#ruF4?k-_kd zo=~-M_+r8kJ%`kg>Qh0+EGSrGHmC4GD9gs_%{40@+pJ>68=Ip~m=v*fO32Nm)~x+9 zrwOBJY4h`XbN|;sg@N@@O)3V4Z3!k}dqq2C+$RiCB2)DnH6yWg+X|ujL5s{(X(o7o%L$!rUqzE)7Z?rcU0?O?q9~9m zEDAh!Aa=i6-r20&<*V;3r7_teyKC1PctPj}o-dlm#x@Z?^!p^h%^v_7xd7-(u6CO5 z+S-Bc8hAeY%e$t{q46ej5=PgIWUbrd%4!g^Ryz;)9yJAW8j?Jx)_QQ8c%}Qv;MkXEfSp(%T!|2aL{09X1)4T5S&hg_T3oGXeT9#{of; z^18Jr58G}tN;&r14|y}_HjC~=0Av~me1Ao`b&W_6r~=y(Kl1A-lhK1%tRak-^FO;! zmdd7!Xo`$dEI1{Lg-sSz5^Sq$p(Z$P_BVm=!@s*^c9tOx3fmfs$yrTXUbQFzi z#X`WK=aKsk0=T+s>3M~dO0k=(r)t}(>stebg#nOI=K)H@o5_%pwd6^D7iUkLAdG4z zE?hGo8DcKyG$62RF3sM9AOKq0|h<{ zi<(NxgCUO(JgO~`R03}92MK-jlD9m?<#H`1bTu>%^7(wqUQ|URk472yWGTR6| z7i22;3V5&Ja9a70&jC!Bl!!Pu?O`$vL#4tg%zh=bqW^HlucPIJ}6YHcaiz?d;1(M;}(?_X|o>}xom^i~MVY!}k3E*eJlFERUyz(*Ok}G*~t29?B1YQe2_N+p< zN5Rggn|mOyV%+;^@q-?si%C*(HPMq>HL4j-$g91xn&o%hi_v85$to@E>3v-4*+u9N z{`Q{i^m?8j!G1Cf=M(xVj0Ug?B(FK3dPDBSHYPJ8gOm-$I2{6V1w8aUpX$y-MMYJj zjTSS~LpmHRPRk>PE#J$twyqZH+daHA`oMoTeh~XXE9_+zAz8%>qz(On7J{L~ElrK@ zJ@7rn1Jbr8R6W+b