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.

142 lines
3.5 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. <h2 class="ui dividing header">Standard</h2>
  12. <div class="example">
  13. <h4 class="ui header">Carousel</h4>
  14. <p>A standard carousel</p>
  15. <div class="ui carousel">
  16. <i class="left arrow icon"></i>
  17. <i class="right arrow icon"></i>
  18. <div class="slides">
  19. <div class="slide">
  20. <img src="/images/demo/item1.jpg">
  21. </div>
  22. <div class="slide">
  23. <img src="/images/demo/item2.jpg">
  24. </div>
  25. <div class="slide">
  26. <img src="/images/demo/item3.jpg">
  27. </div>
  28. <div class="slide">
  29. <img src="/images/demo/item4.jpg">
  30. </div>
  31. <div class="slide">
  32. <img src="/images/demo/item5.jpg">
  33. </div>
  34. </div>
  35. <div class="menu">
  36. <i class="active circle icon item"></i>
  37. <i class="circle icon item"></i>
  38. <i class="circle icon item"></i>
  39. <i class="circle icon item"></i>
  40. </div>
  41. </div>
  42. </div>
  43. <h2 class="ui dividing header">Usage</h2>
  44. <h3>Initializing</h3>
  45. <h3 class="ui header">Initializing a carousel</h3>
  46. <div class="code">
  47. $('.ui.carousel')
  48. .carousel()
  49. ;
  50. </div>
  51. <h3 class="ui header">Settings</h3>
  52. <table class="ui red table segment">
  53. <thead>
  54. <th colspan="3">Carousel Settings</th>
  55. </thead>
  56. <tbody>
  57. <tr>
  58. <td>required</td>
  59. <td>auto</td>
  60. <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>
  61. </tr>
  62. <tr>
  63. <td>context</td>
  64. <td>false</td>
  65. <td>A selector or jQuery object to use as a delegated event context</td>
  66. </tr>
  67. </tbody>
  68. </table>
  69. <table class="ui teal table segment">
  70. <thead>
  71. <th colspan="3">Callbacks</th>
  72. </thead>
  73. <tbody>
  74. <tr>
  75. <td>onChange</td>
  76. <td>None</td>
  77. <td>Callback after a carousel is either disabled or enabled.</td>
  78. </tr>
  79. <tr>
  80. <td>onEnable</td>
  81. <td>None</td>
  82. <td>Callback after a carousel is enabled.</td>
  83. </tr>
  84. <tr>
  85. <td>onDisable</td>
  86. <td>None</td>
  87. <td>Callback after a carousel is disabled.</td>
  88. </tr>
  89. </tbody>
  90. </table>
  91. <table class="ui blue table segment">
  92. <thead>
  93. <th colspan="3">UI Module Settings</th>
  94. </thead>
  95. <tbody>
  96. <tr>
  97. <td>Name</td>
  98. <td>Carousel</td>
  99. <td>Name used in debug logs</td>
  100. </tr>
  101. <tr>
  102. <td>debug</td>
  103. <td>True</td>
  104. <td>Provides standard debug output to console</td>
  105. </tr>
  106. <tr>
  107. <td>performance</td>
  108. <td>False</td>
  109. <td>Provides standard debug output to console</td>
  110. </tr>
  111. <tr>
  112. <td>verbose</td>
  113. <td>False</td>
  114. <td>Provides ancillary debug output to console</td>
  115. </tr>
  116. <tr>
  117. <td>namespace</td>
  118. <td>carousel</td>
  119. <td>Event namespace. Makes sure module teardown does not effect other events attached to an element.</td>
  120. </tr>
  121. <tr>
  122. <td>errors</td>
  123. <td colspan="2">
  124. <div class="code">
  125. errors : {
  126. method : 'The method you called is not defined.'
  127. }
  128. </div>
  129. </td>
  130. </tr>
  131. </tbody>
  132. </table>
  133. </div>