You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

152 lines
3.8 KiB

  1. ---
  2. layout : 'default'
  3. css : 'carousel'
  4. title : 'Carousel'
  5. description : 'A carousel alternates display between several pieces of content in sequence.'
  6. type : 'UI Module'
  7. ---
  8. <script src="/javascript/carousel.js"></script>
  9. <%- @partial('header') %>
  10. <div class="main container">
  11. <div class="peek">
  12. <div class="ui vertical pointing secondary menu">
  13. <a class="active item">Standard</a>
  14. <a class="item">Variations</a>
  15. <a class="item">Behavior</a>
  16. <a class="item">Examples</a>
  17. <a class="item">Usage</a>
  18. </div>
  19. </div>
  20. <h2 class="ui dividing header">Standard</h2>
  21. <div class="example">
  22. <h4 class="ui header">Carousel</h4>
  23. <p>A standard carousel</p>
  24. <div class="ui carousel">
  25. <i class="left arrow icon"></i>
  26. <i class="right arrow icon"></i>
  27. <div class="slides">
  28. <div class="slide">
  29. <img src="/images/demo/item1.jpg">
  30. </div>
  31. <div class="slide">
  32. <img src="/images/demo/item2.jpg">
  33. </div>
  34. <div class="slide">
  35. <img src="/images/demo/item3.jpg">
  36. </div>
  37. <div class="slide">
  38. <img src="/images/demo/item4.jpg">
  39. </div>
  40. <div class="slide">
  41. <img src="/images/demo/item5.jpg">
  42. </div>
  43. </div>
  44. <div class="menu">
  45. <i class="active circle icon item"></i>
  46. <i class="circle icon item"></i>
  47. <i class="circle icon item"></i>
  48. <i class="circle icon item"></i>
  49. </div>
  50. </div>
  51. </div>
  52. <h2 class="ui dividing header">Usage</h2>
  53. <h3>Initializing</h3>
  54. <h3 class="ui header">Initializing a carousel</h3>
  55. <div class="code">
  56. $('.ui.carousel')
  57. .carousel()
  58. ;
  59. </div>
  60. <h3 class="ui header">Settings</h3>
  61. <table class="ui red table segment">
  62. <thead>
  63. <th colspan="3">Carousel Settings</th>
  64. </thead>
  65. <tbody>
  66. <tr>
  67. <td>required</td>
  68. <td>auto</td>
  69. <td>Setting to true/false will determine whether an input will allow no selection. Auto will set disallow this behavior only for radio boxes</td>
  70. </tr>
  71. <tr>
  72. <td>context</td>
  73. <td>false</td>
  74. <td>A selector or jQuery object to use as a delegated event context</td>
  75. </tr>
  76. </tbody>
  77. </table>
  78. <table class="ui teal table segment">
  79. <thead>
  80. <th colspan="3">Callbacks</th>
  81. </thead>
  82. <tbody>
  83. <tr>
  84. <td>onChange</td>
  85. <td>None</td>
  86. <td>Callback after a carousel is either disabled or enabled.</td>
  87. </tr>
  88. <tr>
  89. <td>onEnable</td>
  90. <td>None</td>
  91. <td>Callback after a carousel is enabled.</td>
  92. </tr>
  93. <tr>
  94. <td>onDisable</td>
  95. <td>None</td>
  96. <td>Callback after a carousel is disabled.</td>
  97. </tr>
  98. </tbody>
  99. </table>
  100. <table class="ui blue table segment">
  101. <thead>
  102. <th colspan="3">UI Module Settings</th>
  103. </thead>
  104. <tbody>
  105. <tr>
  106. <td>Name</td>
  107. <td>Carousel</td>
  108. <td>Name used in debug logs</td>
  109. </tr>
  110. <tr>
  111. <td>debug</td>
  112. <td>True</td>
  113. <td>Provides standard debug output to console</td>
  114. </tr>
  115. <tr>
  116. <td>performance</td>
  117. <td>False</td>
  118. <td>Provides standard debug output to console</td>
  119. </tr>
  120. <tr>
  121. <td>verbose</td>
  122. <td>False</td>
  123. <td>Provides ancillary debug output to console</td>
  124. </tr>
  125. <tr>
  126. <td>namespace</td>
  127. <td>carousel</td>
  128. <td>Event namespace. Makes sure module teardown does not effect other events attached to an element.</td>
  129. </tr>
  130. <tr>
  131. <td>errors</td>
  132. <td colspan="2">
  133. <div class="code">
  134. errors : {
  135. method : 'The method you called is not defined.'
  136. }
  137. </div>
  138. </td>
  139. </tr>
  140. </tbody>
  141. </table>
  142. </div>