From 30b28889e15ecec3775aa1db73bdf5586186a3f7 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Fri, 25 Jan 2019 10:38:22 +0000 Subject: [PATCH] [ADF-3745] Added Confirm dialog docs (#4193) --- docs/README.md | 1 + docs/content-services/README.md | 1 + docs/content-services/confirm.dialog.md | 47 ++++++++++++++++++++++++ docs/docassets/images/ConfirmDialog.png | Bin 0 -> 6941 bytes tools/doc/doctool.config.json | 1 + 5 files changed, 50 insertions(+) create mode 100644 docs/content-services/confirm.dialog.md create mode 100644 docs/docassets/images/ConfirmDialog.png diff --git a/docs/README.md b/docs/README.md index b2bddf7645..c1fd47f006 100644 --- a/docs/README.md +++ b/docs/README.md @@ -260,6 +260,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | +| [Confirm dialog](content-services/confirm.dialog.md) | Requests a yes/no choice from the user. | [Source](../lib/content-services/dialogs/confirm.dialog.ts) | | [Library dialog](content-services/library.dialog.md) | Creates a new Content Services document library/site. | [Source](../lib/content-services/dialogs/library/library.dialog.ts) | ## Directives diff --git a/docs/content-services/README.md b/docs/content-services/README.md index 3297d94001..a16327b967 100644 --- a/docs/content-services/README.md +++ b/docs/content-services/README.md @@ -58,6 +58,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | +| [Confirm dialog](confirm.dialog.md) | Requests a yes/no choice from the user. | [Source](../../lib/content-services/dialogs/confirm.dialog.ts) | | [Library dialog](library.dialog.md) | Creates a new Content Services document library/site. | [Source](../../lib/content-services/dialogs/library/library.dialog.ts) | ## Directives diff --git a/docs/content-services/confirm.dialog.md b/docs/content-services/confirm.dialog.md new file mode 100644 index 0000000000..cbdff467f4 --- /dev/null +++ b/docs/content-services/confirm.dialog.md @@ -0,0 +1,47 @@ +--- +Title: Confirm dialog component +Added: v2.3.0 +Status: Active +Last reviewed: 2019-01-22 +--- + +# [Confirm dialog component](../../lib/content-services/dialogs/library/library.dialog.ts "Defined in library.dialog.ts") + +Requests a yes/no choice from the user. + +![Confirm dialog](../docassets/images/ConfirmDialog.png) + +## Basic Usage + +```ts +constructor(private dialog: MatDialog) {} + +... + +let files = [ + // Files defined here... +]; + +const dialogRef = this.dialog.open(ConfirmDialogComponent, { + data: { + title: 'Upload', + message: `Are you sure you want to upload ${files.length} file(s)?` + }, + minWidth: '250px' +}); + +dialogRef.afterClosed().subscribe((result) => { + if (result === true) { + event.resumeUpload(); + } +}); +``` + +## Details + +This component lets the user make a yes/no choice to confirm an action. Use the +Angular [`MatDialog`](https://material.angular.io/components/dialog/overview) +service to open the dialog, as shown in the example, and pass a `data` object +with properties for the `title` and `message` to show. The `afterClosed` event +of the [`MatDialog`](https://material.angular.io/components/dialog/overview) +gives you the user's choice via the `result` parameter. diff --git a/docs/docassets/images/ConfirmDialog.png b/docs/docassets/images/ConfirmDialog.png new file mode 100644 index 0000000000000000000000000000000000000000..2c7ae6bd6d31b0c25d1b51cf74f3692144fe5518 GIT binary patch literal 6941 zcmZu$1yoegx*ocvQ|XkD4(Sd>WRwO$8tD)Tm5!l9>1L2lk&^B%2@z0ALUL%N=I*)g z-u2#H?=BY1oU>2v|Nm+ep{=DxginVLfk22f)Rmt>AZV1}dj&2w_?r#c(E=aX7LV1G zAxP9uZfns8um{go-OvL9xzmmMMeBDdwgNkGUTZv2!C6D2B4%L}MeL_QAatb~$_hH( z^LszvYg3%x;2_TTvR&PaxZ>~?NL6^rGK!S!I9GdAzVvT{X2LQISCxqp807 zS9SD{S)4><X{JwJ29RN(cZLs8V8QdHJ%Xec_ik?o4rZGz4$h))kVcFfCd}d6ny` zmnVTw{kYoh1<}VdOyc0MVh3H`G47;##U8)Z`if95s}6wxShjO*p-jJ_vBIid>dlVB z3!)FP_AI26Qx3CVIOC_&rN_b^`c^u*Ev-nxRY=qnb7*t6ARvLr#w%U99T4+lfIU z8$@15ha!xa@lKXj|I@hQyY`NbJ*PY06LNB@Lc-Wh=JBa2cmgf($RV)kXk{xawgyS4 zc;VC^5?We3!(^zocJ7x)mC-LGy!|67@+RW0nl89|W({u# zbeRM?{_1k>94^7Fj;X)!)Sg~Qd0JRerJ}?2BTkT!_uRN6t&Q0w3G{q(_o88(0J2Tp zUh+a?*pD(l+qk5dk~VgXj38FA8;ZmyJsq)EsbEy$lfta~+~;RgHxvr<)jRHoKA3yT zDM6Pvd(E7mP0u^VAmwyBr_X6G_kb-wo098Hj^njX9j<*6jAxI7Wt%qh^i#16)xDcR z^*Xt+9&P6Bv^!#E(%{~ta+1tZyBtkIs{HJQYqvLn<)WQ4v@~4G z^T4v#BWyr-oO0CxtB!`YWU4o~-gFFf3 z+02V5w#AO(X=3_9NjEm80R~HTOa>vHNhdyu=HKS#U_^Jtm}F#Lc)oLU6I@+egPNEu znh(Dt`!+RIW8RG|A|~d}U*K$3Au&vtS7Ds_`LB}ln4h?0sv0MF0M6 zWzyT_2)k`IfVJ2gJ!qh*nW|=0gtw z=S7KqpB|e8p3$5!yMcIS#L>}bS~15tf$5o!85uD#F}cPMel~|QD}{A*cPr6yM6xIQ~w*!lRr~xX>Dz741+0(403S}m)e_Ru23uorxo!QkRjMy8F83*-Tn|Foa z8GL;q8mEo?KqdXK!+IIExU^QIsI`2v7+S*#M+3it^`lCl(AMZb3 zUSAJwY?MG2{+9in^;cMO6yu2_CnL-L^XOAi z(b{Tn)LgYW#%oD>IqQ5*$Khl?5==Bu?|d%qI4lM2TQu*J%#3K5B$-kuO!8xWS?h|= z@rL=Y7N6_iFiE^CKPo+L<(>^-N`ALnbE7OtNrN>d3k6VVoqK2bq-J? zqf$ct2M_uRpJYtT%?)V#(2dv#laZ4rBq#T=77)C8^{Vr5tsiP^yin=(0;;P^S?{tG zyFQ#^Ihe@qy_w~ut*bj@|8;fM0(3STJA3EU6nXp2o{Ll0CqB>#7hCW+oo=;c>+3xi zefZYUBirL!H`Y$v#%dKX;UV>~v;Rt6GS1=2LV*OT-Gy!K6C`M3}}XXn0p zr-ka5o#>cYSZEN?v1pJ~F(*19AtBe_1EeCNqUN*Zh6Z2kNR5n)5VuzcYcu+0D(dRE zrDbI`*27e6Y;3vy$lIZ}EpPVdz>H4Vl)q@Edh+Cn`s2slPyH{SZ@rfM{rfi) z4-di4Y=x4$yU^v?UKHS23jh=vap!xWZ{t%^aDqDnP-4QuqG)(qVcg()fiN#OZKZQ| zb{5t|6yAkNK8!39l0pbHNQ7E z;Vmuq^s7u&w6#fQtIUY``S~+kjtHn9Fo}v%5;I75fMV2G^x}Jad*_yx;zvY8H2NHK zbaizt9~{I11?lPQTiqDVP}kH{c5>oVjbkACFgR_`Sm#Htk?6WPMvsYuv!HqW!#2nK z>TC~Hw3Y5~W(_iFY3b@$Qydw8?CtG!&an)W-Tod~Yo?3fL0r#v4R;rt$RPsmztzhP zYS7Wp&;|wuCA)!l^)#J7Z7F4LTg~Xm`0`?ZmflL9K7kExr|KAP@)$ zP=Rgfvp2$<;dhkHi&W;PxF*-^FSBq19^F}NvC(!al?pzH9U>X0L9kYb2tQhdJDMQ!(K67o zOwb#M^K&(Od+xrNyWzmU!V3$rH8eDE2?<}ny28f7>a-Hd%g;xbm6aVBAMXe1dx zJa{n15g;QYV;pm}8pW^EfDFMSH~FRiz_bNshP?caI6dwCd%RiWvLp-UQE z+K0^law=z{*~{hK<)0!@hK}pM$8K8_%p>Wd1Z(|q{UCrKP_6`cA0i^6xmsId0P%41 z?yx-IOWOaAy6BiK*@;;6$I@S%wr-W? zC=WiEtFbJ-3Q~nDfM&WpKOlxr!T{P>1O-V=O-+j{E5l5y^t(_q<=bj%xWSq8E(qnx z-d~=W7n?M?qUGh~4RwkFA3{M%$;{3D=;55Sj0_s&;lqcG-iItlM@JuB>H{%wxbx5< z-C;yZdU{lJbadKAM)>~z{=gWlg4@%`_SZzPtPIWsC-y)F&DrVtB43i%7Yg`E6FFO zr$gSJ@2}vUt@V3oH=0s)RQp zcl0a*2GbsTYnV(*M+b_XJN0LIXNREn$71DpQ+2hr=T!rzPFHvL3fKvu5wyUJWt5Bk z`c*RHHadY-je9|ag#{hw&OLcu-K0@55gI~VVqzS~$CQ+A;1$PZ&hJ4w78Vw4{6EhE zq5`bA93%cq-q%-B_U~`T>*H2=h@N(Xqgva*s-WD5xiVFFXY=zlE;x`C92 z2DjDJrS`)c@z1>QrY6H1rU`qe^p};On84WflsqqD*lCrRrv^Ha)Su7AA}h-POja)- zRK%nj7EodV{GHyE znu^NGFn_zw9TCvbVPRoqGS1V$Blc!b~~FE4#Dv9T=xd(b>| zXLJ7fHMFmYr8*cQ)Sex_fQg#xlo#bWglTQy%beG zm&MuckGU2fVNDM5d^miv%B)@Q;1p=$#cu7mqiF+h5U|+TzU`SZFeDce9$u!0ItjS5 zxz@Mh!1=bzQ>cuj3SxkeX)n45_{D8wgcjIOwU7_k48l7i*3zL9g%Z=*r{rvn8 zXJ@K_mO#QqHL8n?%Z$?=&<#>n)n#CVK~4(hiUa^w17_~Ca4dL4ahG4p@7}e1gF3vb zm0I23kEJ$yM|#k59Q#DAV!jc$?U_B7_N>hJR6s}7wX{^t&6$DRA!>7OMm83FKqgBS zvc~`Ay+$Pc?t+BB1%aN-Z*~VtaX9Z##SCZ{l{kRflTc9=iV#!tn>tQGrQTg2^mZfx z%N7(CuEzOa!=K&UfY|JO?swp52GZQtR1q#3yP>~?_SB;BS~cDajj$jY`Ur91r$y-BOw=LYVmv$OL~#s#oAC^uEATbBLE!xjVu z0BVpG^0^dAFxQ*bYfg`yeN>!4Gm5$ViUwljRU(gy_nzAnX9r7hKWc4-wS9}BaMhKv zsy26TQe%*2K-HyGkQzn1#qY_|)6?VQ_XukDKb zkk<;#|IQL1k^J{8@t-*Zm0|uTb^I&5{QoWYtmKScquTq zIFg;GcoL2Asj{+ixXoW9@#8tNJUDcekp%*Xe%V(*2PS!zk-gKY&780Gf3goqNvN%H z8h$@GXTLYO#34S(Uu=QvQ?>5eCG4SgOvSZ;^3wp-cOqjRG>C7U@+u7Rr{v4#e;c}q z#?dU15X{l7>9Q8D15T0JA9$m7j%%gKBdNC1fE*Ea|LYM!2=5GH^|Fc2Od zj-wPhP$JveF(BHZe}EA<1$hr~Jtx$5znA)js2GWjxJ%ITuIo+PrIh>`5*_Y$%N6bH ze@Ex{n@ep_Sd`~$X>BFFcW=@D8s*D@bNLs};;m_$nwn4`)hjnZ11pIe#0k$?{RmI! z@l6&XsdNF0OXx})7#N%nvx{ob1>`U)elKDQ^h}#KUs+D(>FoCWjNbf z+N?q|B@IAgF4rC7rLtb~G_ih*`>V(EiJSq$dLU(?Z&(L-0?Nyhd?7+zOnRnqj zb;2*K)^=Pmkxf}eMWO1uM;W=N(&_0b2oh>QT$G_Y?j1=s@w2kpnMo4KhqmL{y}~_IJN4LkdohOtHGaaFq3uS& zaQ1{rfrM%J^C&VIlE9`x>rBs*eD`AsJ3|>oevxs_95q_0I7V%$#WZ@~VwJoXa+T}bHJ3a=VNIbLcd!fPum&p1JPpX$jwz`q(h$R+dRep&6^aAVUENv7Ql z*~)7bKWxIu4+oEH7+n}iVzro!!=r2Q2MV7-rD`o1vB4bGMfP428F|gt&+M*L$}egFUf literal 0 HcmV?d00001 diff --git a/tools/doc/doctool.config.json b/tools/doc/doctool.config.json index e17de082bb..23db08534f 100644 --- a/tools/doc/doctool.config.json +++ b/tools/doc/doctool.config.json @@ -33,6 +33,7 @@ "Blob": "https://developer.mozilla.org/en-US/docs/Web/API/Blob", "Promise": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises", "EventEmitter": "https://angular.io/api/core/EventEmitter", + "MatDialog": "https://material.angular.io/components/dialog/overview", "MatIconRegistry": "https://material.angular.io/components/icon/api", "MatSnackBarRef": "https://material.angular.io/components/snack-bar/overview", "TemplateRef": "https://angular.io/api/core/TemplateRef",