class.tmpl.partial 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
  1. {{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
  2. {{>partials/uref/class.header}}
  3. {{#children}}
  4. <h3 id="{{id}}">{{>partials/classSubtitle}}</h3>
  5. {{#children}}
  6. {{^_disableContribution}}
  7. {{#docurl}}
  8. <span class="small pull-right mobile-hide">
  9. <span class="divider">|</span>
  10. <a href="{{docurl}}">{{__global.improveThisDoc}}</a>
  11. </span>{{/docurl}}
  12. {{#sourceurl}}
  13. <span class="small pull-right mobile-hide">
  14. <a href="{{sourceurl}}">{{__global.viewSource}}</a>
  15. </span>{{/sourceurl}}
  16. {{/_disableContribution}}
  17. {{#overload}}
  18. <a id="{{id}}" data-uid="{{uid}}"></a>
  19. {{/overload}}
  20. <h4 id="{{id}}" data-uid="{{uid}}">{{name.0.value}}</h4>
  21. <div class="markdown level1 summary">{{{summary}}}</div>
  22. <div class="markdown level1 conceptual">{{{conceptual}}}</div>
  23. <h5 class="decalaration">{{__global.declaration}}</h5>
  24. {{#syntax}}
  25. <div class="codewrapper">
  26. <pre><code class="lang-{{syntax.content.0.lang}} hljs">{{syntax.content.0.value}}</code></pre>
  27. </div>
  28. {{#parameters.0}}
  29. <h5 class="parameters">{{__global.parameters}}</h5>
  30. <table class="table table-bordered table-striped table-condensed">
  31. <thead>
  32. <tr>
  33. <th>{{__global.type}}</th>
  34. <th>{{__global.name}}</th>
  35. <th>{{__global.description}}</th>
  36. </tr>
  37. </thead>
  38. <tbody>
  39. {{/parameters.0}}
  40. {{#parameters}}
  41. <tr>
  42. <td>{{{type.specName.0.value}}}</td>
  43. <td><em>{{{id}}}</em></td>
  44. <td>
  45. {{{description}}}
  46. {{>partials/uref/parameters}}
  47. </td>
  48. </tr>
  49. {{/parameters}}
  50. {{#parameters.0}}
  51. </tbody>
  52. </table>
  53. {{/parameters.0}}
  54. {{#return}}
  55. <h5 class="returns">{{__global.returns}}</h5>
  56. <table class="table table-bordered table-striped table-condensed">
  57. <thead>
  58. <tr>
  59. <th>{{__global.type}}</th>
  60. <th>{{__global.description}}</th>
  61. </tr>
  62. </thead>
  63. <tbody>
  64. <tr>
  65. <td>{{{value.type.0.specName.0.value}}}</td>
  66. <td>{{{value.description}}}</td>
  67. </tr>
  68. </tbody>
  69. </table>
  70. {{/return}}
  71. {{#typeParameters.0}}
  72. <h5 class="typeParameters">{{__global.typeParameters}}</h5>
  73. <table class="table table-bordered table-striped table-condensed">
  74. <thead>
  75. <tr>
  76. <th>{{__global.name}}</th>
  77. <th>{{__global.description}}</th>
  78. </tr>
  79. </thead>
  80. <tbody>
  81. {{/typeParameters.0}}
  82. {{#typeParameters}}
  83. <tr>
  84. <td><em>{{{id}}}</em></td>
  85. <td>{{{description}}}</td>
  86. </tr>
  87. {{/typeParameters}}
  88. {{#typeParameters.0}}
  89. </tbody>
  90. </table>
  91. {{/typeParameters.0}}
  92. {{#fieldValue}}
  93. <h5 class="fieldValue">{{__global.fieldValue}}</h5>
  94. <table class="table table-bordered table-striped table-condensed">
  95. <thead>
  96. <tr>
  97. <th>{{__global.type}}</th>
  98. <th>{{__global.description}}</th>
  99. </tr>
  100. </thead>
  101. <tbody>
  102. <tr>
  103. <td>{{{value.type.0.specName.0.value}}}</td>
  104. <td>{{{value.description}}}</td>
  105. </tr>
  106. </tbody>
  107. </table>
  108. {{/fieldValue}}
  109. {{#propertyValue}}
  110. <h5 class="propertyValue">{{__global.propertyValue}}</h5>
  111. <table class="table table-bordered table-striped table-condensed">
  112. <thead>
  113. <tr>
  114. <th>{{__global.type}}</th>
  115. <th>{{__global.description}}</th>
  116. </tr>
  117. </thead>
  118. <tbody>
  119. <tr>
  120. <td>{{{value.type.0.specName.0.value}}}</td>
  121. <td>{{{value.description}}}</td>
  122. </tr>
  123. </tbody>
  124. </table>
  125. {{/propertyValue}}
  126. {{#eventType}}
  127. <h5 class="eventType">{{__global.eventType}}</h5>
  128. <table class="table table-bordered table-striped table-condensed">
  129. <thead>
  130. <tr>
  131. <th>{{__global.type}}</th>
  132. <th>{{__global.description}}</th>
  133. </tr>
  134. </thead>
  135. <tbody>
  136. <tr>
  137. <td>{{{type.specName.0.value}}}</td>
  138. <td>{{{description}}}</td>
  139. </tr>
  140. </tbody>
  141. </table>
  142. {{/eventType}}
  143. {{#variableValue}}
  144. <h5 class="variableValue">{{__global.variableValue}}</h5>
  145. <table class="table table-bordered table-striped table-condensed">
  146. <thead>
  147. <tr>
  148. <th>{{__global.type}}</th>
  149. <th>{{__global.description}}</th>
  150. </tr>
  151. </thead>
  152. <tbody>
  153. <tr>
  154. <td>{{{value.type.0.specName.0.value}}}</td>
  155. <td>{{{value.description}}}</td>
  156. </tr>
  157. </tbody>
  158. </table>
  159. {{/variableValue}}
  160. {{#typeAliasType}}
  161. <h5 class="typeAliasType">{{__global.typeAliasType}}</h5>
  162. <table class="table table-bordered table-striped table-condensed">
  163. <thead>
  164. <tr>
  165. <th>{{__global.type}}</th>
  166. <th>{{__global.description}}</th>
  167. </tr>
  168. </thead>
  169. <tbody>
  170. <tr>
  171. <td>{{{value.type.0.specName.0.value}}}</td>
  172. <td>{{{value.description}}}</td>
  173. </tr>
  174. </tbody>
  175. </table>
  176. {{/typeAliasType}}
  177. {{/syntax}}
  178. {{#overridden}}
  179. <h5 class="overrides">{{__global.overrides}}</h5>
  180. <div><xref href="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
  181. {{/overridden}}
  182. {{#implements.0}}
  183. <h5 class="implements">{{__global.implements}}</h5>
  184. {{/implements.0}}
  185. {{#implements}}
  186. {{#definition}}
  187. <div><xref href="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/></div>
  188. {{/definition}}
  189. {{^definition}}
  190. <div><xref href="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
  191. {{/definition}}
  192. {{/implements}}
  193. {{#remarks}}
  194. <h5 id="{{id}}_remarks">{{__global.remarks}}</h5>
  195. <div class="markdown level1 remarks">{{{remarks}}}</div>
  196. {{/remarks}}
  197. {{#example.0}}
  198. <h5 id="{{id}}_examples">{{__global.examples}}</h5>
  199. {{/example.0}}
  200. {{#example}}
  201. {{{.}}}
  202. {{/example}}
  203. {{#exceptions.0}}
  204. <h5 class="exceptions">{{__global.exceptions}}</h5>
  205. <table class="table table-bordered table-striped table-condensed">
  206. <thead>
  207. <tr>
  208. <th>{{__global.type}}</th>
  209. <th>{{__global.condition}}</th>
  210. </tr>
  211. </thead>
  212. <tbody>
  213. {{/exceptions.0}}
  214. {{#exceptions.0.value}}
  215. <tr>
  216. <td>{{{type.specName.0.value}}}</td>
  217. <td>{{{description}}}</td>
  218. </tr>
  219. {{/exceptions.0.value}}
  220. {{#exceptions.0}}
  221. </tbody>
  222. </table>
  223. {{/exceptions.0}}
  224. {{#seealso.0}}
  225. <h5 id="{{id}}_seealso">{{__global.seealso}}</h5>
  226. <div class="seealso">
  227. {{/seealso.0}}
  228. {{#seealso}}
  229. {{#isCref}}
  230. <div>{{{type.specName.0.value}}}</div>
  231. {{/isCref}}
  232. {{^isCref}}
  233. <div>{{{url}}}</div>
  234. {{/isCref}}
  235. {{/seealso}}
  236. {{#seealso.0}}
  237. </div>
  238. {{/seealso.0}}
  239. {{/children}}
  240. {{/children}}
  241. {{#extensionMethods.0}}
  242. <h3 id="extensionmethods">{{__global.extensionMethods}}</h3>
  243. {{/extensionMethods.0}}
  244. {{#extensionMethods}}
  245. <div>
  246. {{#definition}}
  247. <xref href="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/>
  248. {{/definition}}
  249. {{^definition}}
  250. <xref href="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/>
  251. {{/definition}}
  252. </div>
  253. {{/extensionMethods}}
  254. {{#seealso.0}}
  255. <h3 id="seealso">{{__global.seealso}}</h3>
  256. <div class="seealso">
  257. {{/seealso.0}}
  258. {{#seealso}}
  259. {{#isCref}}
  260. <div>{{{type.specName.0.value}}}</div>
  261. {{/isCref}}
  262. {{^isCref}}
  263. <div>{{{url}}}</div>
  264. {{/isCref}}
  265. {{/seealso}}
  266. {{#seealso.0}}
  267. </div>
  268. {{/seealso.0}}