api.html 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>镜像站@layer弹层组件移动版</title>
  6. <meta name="description" content="">
  7. <meta http-equiv="X-UA-Compatible" content="chrome=1">
  8. <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=0">
  9. <meta name="apple-mobile-web-app-status-bar-style" content="black">
  10. <meta name="apple-mobile-web-app-capable" content="yes">
  11. <meta name="format-detection" content="telephone=no">
  12. <link href="demo.css" tppabs="http://www.layui.com/layer/mobile/demo.css" type="text/css" rel="stylesheet">
  13. <script src="../../../res.layui.com/layui/release/layer/dist/mobile/layer.js" tppabs="http://res.layui.com/layui/release/layer/dist/mobile/layer.js"></script>
  14. </head>
  15. <body>
  16. <header>
  17. <div class="main">
  18. <h1>Layer For Mobile<code><script>document.write(layer.v)</script></code></h1>
  19. <nav>
  20. <a href="http://www.layui.com/mobile/">首页</a>
  21. <a href="../../index.html" tppabs="http://www.layui.com/">PC 版</a>
  22. </nav>
  23. </div>
  24. </header>
  25. <div class="main">
  26. <p>和 layer PC 版不同的是,我们只提供一个核心调用方法,即:layer.open(options)。各类型的层你可以借助下面高度灵活的参数接口对 layer.open 进行二次封装。</p>
  27. </div>
  28. <div class="main api">
  29. <h2 style="padding:10px 0 5px;">参数</h2>
  30. <p>即核心接口:<strong>layer.open(options)</strong> 中的options:</p>
  31. <div style="margin-top: 20px;">
  32. <p><strong>type</strong> - 设置弹层的类型</p>
  33. <p>类型:Number</p>
  34. <p>默认:0 (0表示信息框,1表示页面层,2表示加载层)</p>
  35. </div>
  36. <div>
  37. <p><strong>content</strong> - 设置弹层内容</p>
  38. <p>类型:String</p>
  39. <p>必选参数</p>
  40. </div>
  41. <div>
  42. <p><strong>title</strong> - 设置弹层标题</p>
  43. <p>类型:String或Array</p>
  44. <p>默认:空,值可以为字符串或者数组。,为空则不显示</p>
  45. <pre>
  46. title: '标题'
  47. //或者
  48. title: ['标题', 'background-color: #eee;'] //第二个参数可以自定义标题的样式
  49. </pre>
  50. </div>
  51. <div>
  52. <p><strong>time</strong> - 控制自动关闭层所需秒数</p>
  53. <p>类型:Number</p>
  54. <p>默认不开启,支持整数和浮点数</p>
  55. </div>
  56. <div>
  57. <p><strong>style</strong> - 自定义层的样式</p>
  58. <p>类型:String</p>
  59. <p>非常实用,如</p>
  60. <pre>
  61. <span id="demo3">layer.open({
  62. style: 'border:none; background-color:#78BA32; color:#fff;',
  63. content:'内容'
  64. })</span>
  65. <a href="javascript:;" class="button" onclick="new Function(demo3.innerHTML)();">运行</a>
  66. </pre>
  67. </div>
  68. <div>
  69. <p><strong>skin</strong> - 设定弹层显示风格</p>
  70. <p>类型:String</p>
  71. <p>目前支持配置 footer(即底部对话框风格)、msg(普通提示) 两种风格。</p>
  72. </div>
  73. <div>
  74. <p><strong>className</strong> - 自定义一个css类</p>
  75. <p>类型:String</p>
  76. <p>用于自定义样式。如</p>
  77. <pre>
  78. <span>layer.open({
  79. className: 'popuo-login', //这样你就可以在css里面控制该弹层的风格了
  80. content:'内容'
  81. })</span>
  82. </pre>
  83. </div>
  84. <div>
  85. <p><strong>btn</strong> - 按钮</p>
  86. <p>类型:String/Array</p>
  87. <p>不设置则不显示按钮。如果只需要一个按钮,则btn: '按钮',如果有两个,则:btn: ['按钮一', '按钮二']。</p>
  88. </div>
  89. <div>
  90. <p><strong>anim</strong> - 动画类型</p>
  91. <p>类型:String/Boolean</p>
  92. <p>可支持的支持动画配置:scale(默认)、up(从下往上弹出),如果不开启动画,设置false即可</p>
  93. </div>
  94. <div>
  95. <p><strong>shade</strong> - 控制遮罩展现</p>
  96. <p>类型:String/Boolean</p>
  97. <p>默认:true,该参数可允许你是否显示遮罩,并且定义遮罩风格</p>
  98. <pre>
  99. shade: false //不显示遮罩
  100. 或者
  101. shade: 'background-color: rgba(0,0,0,.3)' //自定义遮罩的透明度
  102. </pre>
  103. </div>
  104. <div>
  105. <p><strong>shadeClose</strong></p>
  106. <p>类型:Boolean</p>
  107. <p>默认:true,是否点击遮罩时关闭层</p>
  108. </div>
  109. <div>
  110. <p><strong>fixed</strong> - 是否固定层的位置</p>
  111. <p>类型:Boolean</p>
  112. <p>默认:true</p>
  113. </div>
  114. <div>
  115. <p><strong>top</strong> - 控制层的纵坐标</p>
  116. <p>类型:Number</p>
  117. <p>默认:无,一般情况下不需要设置,因为层会始终垂直水平居中,只有当fixed: false时top才有效。</p>
  118. </div>
  119. <div>
  120. <p><strong>success</strong> - 层成功弹出层的回调</p>
  121. <p>类型:Function</p>
  122. <p>该回调参数返回一个参数为当前层元素对象</p>
  123. <pre>
  124. success: function(elem){
  125. console.log(elem);
  126. }
  127. </pre>
  128. </div>
  129. <div>
  130. <p><strong>yes</strong></p>
  131. <p>类型:Function</p>
  132. <p>点确定按钮触发的回调函数,返回一个参数为当前层的索引</p>
  133. <pre>
  134. yes: function(index){
  135. alert('点击了是')
  136. layer.close(index)
  137. }
  138. </pre>
  139. </div>
  140. <div>
  141. <p><strong>no</strong></p>
  142. <p>类型:Function</p>
  143. <p>点取消按钮触发的回调函数</p>
  144. </div>
  145. <div>
  146. <p><strong>end</strong></p>
  147. <p>类型:Function</p>
  148. <p>层彻底销毁后的回调函数</p>
  149. </div>
  150. <h2 style="line-height: 50px; padding:10px 0 5px; border-bottom:1px solid #ccc;">其它内置方法/属性</h2>
  151. <div>
  152. <p><strong>layer.v</strong></p>
  153. <p>返回当前使用的layer mobile版本号</p>
  154. </div>
  155. <div>
  156. <p><strong>layer.close(index)</strong></p>
  157. <p>用于关闭特定层,index为该特定层的索引</p>
  158. </div>
  159. <div>
  160. <p><strong>layer.closeAll()</strong></p>
  161. <p>关闭页面所有layer的层</p>
  162. </div>
  163. <p style="padding:50px 0; text-align:center; color:#999;">layui 开源组件</p>
  164. </div>
  165. <script src="demo.js" tppabs="http://www.layui.com/layer/mobile/demo.js"></script>
  166. </body>
  167. </html>