widget_file.xsd 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3. /**
  4. * Copyright © Magento, Inc. All rights reserved.
  5. * See COPYING.txt for license details.
  6. */
  7. -->
  8. <xs:schema elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  9. <xs:include schemaLocation="urn:magento:module:Magento_Widget:etc/types.xsd"/>
  10. <xs:annotation>
  11. <xs:documentation>Contains widgets.</xs:documentation>
  12. </xs:annotation>
  13. <xs:element name="widgets">
  14. <xs:annotation>
  15. <xs:documentation>A list of widgets.</xs:documentation>
  16. </xs:annotation>
  17. <xs:complexType>
  18. <xs:sequence maxOccurs="unbounded" minOccurs="0">
  19. <xs:element name="widget" type="widgetType" />
  20. </xs:sequence>
  21. </xs:complexType>
  22. </xs:element>
  23. <xs:complexType name="widgetType">
  24. <xs:annotation>
  25. <xs:documentation>Definition of a widget.</xs:documentation>
  26. </xs:annotation>
  27. <xs:all>
  28. <xs:element name="label" type="translatableType" maxOccurs="1" minOccurs="0" />
  29. <xs:element name="description" type="translatableType" maxOccurs="1" minOccurs="0" />
  30. <xs:element name="parameters" type="parametersType" minOccurs="0"/>
  31. <xs:element name="containers" type="containersType" minOccurs="0"/>
  32. </xs:all>
  33. <xs:attribute name="id" type="xs:ID" use="required" />
  34. <xs:attribute name="class" type="xs:string" />
  35. <xs:attribute name="is_email_compatible" type="xs:boolean" />
  36. <xs:attribute name="placeholder_image" type="xs:string" />
  37. <xs:attribute name="ttl" type="xs:int" />
  38. </xs:complexType>
  39. <xs:complexType name="parametersType">
  40. <xs:sequence>
  41. <xs:element name="parameter" type="parameterType" maxOccurs="unbounded" minOccurs="1" />
  42. </xs:sequence>
  43. </xs:complexType>
  44. <xs:complexType name="containersType">
  45. <xs:sequence>
  46. <xs:element name="container" type="containerType" maxOccurs="unbounded" minOccurs="1" />
  47. </xs:sequence>
  48. </xs:complexType>
  49. <xs:complexType name="translatableType">
  50. <xs:simpleContent>
  51. <xs:extension base="xs:string">
  52. <xs:attribute name="translate" use="optional" fixed="true" type="xs:boolean"/>
  53. </xs:extension>
  54. </xs:simpleContent>
  55. </xs:complexType>
  56. <xs:complexType name="parameterType" abstract="true">
  57. <xs:annotation>
  58. <xs:documentation>
  59. Abstract type which is parent of all parameters. Contains attributes
  60. and elements common across all parameter types.
  61. </xs:documentation>
  62. </xs:annotation>
  63. <xs:sequence>
  64. <xs:element name="label" type="translatableType" minOccurs="0" maxOccurs="1" />
  65. <xs:element name="description" type="translatableType" minOccurs="0" maxOccurs="1" />
  66. <xs:element name="depends" type="dependsType" minOccurs="0" maxOccurs="1" />
  67. </xs:sequence>
  68. <xs:attribute name="name" type="xs:NMTOKEN" use="required" />
  69. <xs:attribute name="visible" type="xs:boolean" />
  70. <xs:attribute name="sort_order" type="xs:int" />
  71. <xs:attribute name="required" type="xs:string" />
  72. </xs:complexType>
  73. <xs:complexType name="dependsParameterType">
  74. <xs:annotation>
  75. <xs:documentation>
  76. The parameter name and the value it must be to satisfy this dependency.
  77. </xs:documentation>
  78. </xs:annotation>
  79. <xs:attribute name="name" type="xs:NMTOKEN" use="required" />
  80. <xs:attribute name="value" type="xs:string" use="required" />
  81. </xs:complexType>
  82. <xs:complexType name="block">
  83. <xs:annotation>
  84. <xs:documentation>Parameter type which supplies a renderer.</xs:documentation>
  85. </xs:annotation>
  86. <xs:complexContent>
  87. <xs:extension base="parameterType">
  88. <xs:sequence>
  89. <xs:element name="block" type="blockType" />
  90. </xs:sequence>
  91. </xs:extension>
  92. </xs:complexContent>
  93. </xs:complexType>
  94. <xs:complexType name="conditions">
  95. <xs:annotation>
  96. <xs:documentation>Parameter type which provide conditions functionality.</xs:documentation>
  97. </xs:annotation>
  98. <xs:complexContent>
  99. <xs:extension base="parameterType">
  100. <xs:attribute name="class" type="xs:string" use="required" />
  101. </xs:extension>
  102. </xs:complexContent>
  103. </xs:complexType>
  104. <xs:complexType name="dataType">
  105. <xs:annotation>
  106. <xs:documentation>Data for the renderer.</xs:documentation>
  107. </xs:annotation>
  108. <xs:sequence>
  109. <xs:element name="item" type="namedType" minOccurs="0" maxOccurs="unbounded"/>
  110. </xs:sequence>
  111. </xs:complexType>
  112. <xs:complexType name="blockType">
  113. <xs:annotation>
  114. <xs:documentation>Class and data needed to render the parameter.</xs:documentation>
  115. </xs:annotation>
  116. <xs:all>
  117. <xs:element name="data" minOccurs="0" type="dataType" />
  118. </xs:all>
  119. <xs:attribute name="class" type="xs:string" />
  120. </xs:complexType>
  121. <xs:complexType name="text">
  122. <xs:annotation>
  123. <xs:documentation>Parameter type which is text</xs:documentation>
  124. </xs:annotation>
  125. <xs:complexContent>
  126. <xs:extension base="parameterType">
  127. <xs:sequence>
  128. <xs:element name="value" type="translatableType" minOccurs="0" maxOccurs="1" />
  129. </xs:sequence>
  130. </xs:extension>
  131. </xs:complexContent>
  132. </xs:complexType>
  133. <xs:complexType name="select">
  134. <xs:annotation>
  135. <xs:documentation>Parameter type which has a list of options.</xs:documentation>
  136. </xs:annotation>
  137. <xs:complexContent>
  138. <xs:extension base="parameterType">
  139. <xs:sequence>
  140. <xs:element name="options" type="optionsType" minOccurs="0"/>
  141. </xs:sequence>
  142. <xs:attribute name="source_model" type="xs:string" />
  143. </xs:extension>
  144. </xs:complexContent>
  145. </xs:complexType>
  146. <xs:complexType name="multiselect">
  147. <xs:annotation>
  148. <xs:documentation>Display a parameter with a multi-select box.</xs:documentation>
  149. </xs:annotation>
  150. <xs:complexContent>
  151. <xs:extension base="parameterType">
  152. <xs:sequence>
  153. <xs:element name="options" type="optionsType" minOccurs="0"/>
  154. </xs:sequence>
  155. <xs:attribute name="source_model" type="xs:string" />
  156. </xs:extension>
  157. </xs:complexContent>
  158. </xs:complexType>
  159. <xs:complexType name="optionsType">
  160. <xs:sequence>
  161. <xs:element name="option" type="optionType" maxOccurs="unbounded" minOccurs="1" />
  162. </xs:sequence>
  163. </xs:complexType>
  164. <xs:complexType name="optionType">
  165. <xs:annotation>
  166. <xs:documentation>An option of a select parameter.</xs:documentation>
  167. </xs:annotation>
  168. <xs:all>
  169. <xs:element name="label" type="translatableType" />
  170. </xs:all>
  171. <xs:attribute name="name" type="xs:NMTOKEN" use="required" />
  172. <xs:attribute name="value" type="xs:string" />
  173. <xs:attribute name="selected" type="xs:boolean" />
  174. </xs:complexType>
  175. <xs:complexType name="containerType">
  176. <xs:annotation>
  177. <xs:documentation>Specifies the widget's sections and templates.</xs:documentation>
  178. </xs:annotation>
  179. <xs:sequence>
  180. <xs:element name="template" type="templateType" minOccurs="0" maxOccurs="unbounded" />
  181. </xs:sequence>
  182. <xs:attribute name="name" type="xs:NMTOKEN" use="required" />
  183. </xs:complexType>
  184. <xs:complexType name="templateType">
  185. <xs:annotation>
  186. <xs:documentation>Name and value of template</xs:documentation>
  187. </xs:annotation>
  188. <xs:attribute name="name" type="xs:NMTOKEN" use="required" />
  189. <xs:attribute name="value" type="xs:string" use="required"/>
  190. </xs:complexType>
  191. <xs:complexType name="dependsType">
  192. <xs:annotation>
  193. <xs:documentation>List of parameters this parameter depends on.</xs:documentation>
  194. </xs:annotation>
  195. <xs:sequence maxOccurs="unbounded">
  196. <xs:element name="parameter" type="dependsParameterType" />
  197. </xs:sequence>
  198. </xs:complexType>
  199. </xs:schema>