u-sticky.vue 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  1. <template>
  2. <view
  3. class="u-sticky"
  4. :id="elId"
  5. :style="[style]"
  6. >
  7. <view
  8. :style="[stickyContent]"
  9. class="u-sticky__content"
  10. >
  11. <slot />
  12. </view>
  13. </view>
  14. </template>
  15. <script>
  16. import props from './props.js';
  17. import mpMixin from '../../libs/mixin/mpMixin.js';
  18. import mixin from '../../libs/mixin/mixin.js';
  19. /**
  20. * sticky 吸顶
  21. * @description 该组件与CSS中position: sticky属性实现的效果一致,当组件达到预设的到顶部距离时, 就会固定在指定位置,组件位置大于预设的顶部距离时,会重新按照正常的布局排列。
  22. * @tutorial https://ijry.github.io/uview-plus/components/sticky.html
  23. * @property {String | Number} offsetTop 吸顶时与顶部的距离,单位px(默认 0 )
  24. * @property {String | Number} customNavHeight 自定义导航栏的高度 (h5 默认44 其他默认 0 )
  25. * @property {Boolean} disabled 是否开启吸顶功能 (默认 false )
  26. * @property {String} bgColor 组件背景颜色(默认 '#ffffff' )
  27. * @property {String | Number} zIndex 吸顶时的z-index值
  28. * @property {String | Number} index 自定义标识,用于区分是哪一个组件
  29. * @property {Object} customStyle 组件的样式,对象形式
  30. * @event {Function} fixed 组件吸顶时触发
  31. * @event {Function} unfixed 组件取消吸顶时触发
  32. * @example <u-sticky offsetTop="200"><view>塞下秋来风景异,衡阳雁去无留意</view></u-sticky>
  33. */
  34. export default {
  35. name: 'u-sticky',
  36. mixins: [mpMixin, mixin, props],
  37. data() {
  38. return {
  39. cssSticky: false, // 是否使用css的sticky实现
  40. stickyTop: 0, // 吸顶的top值,因为可能受自定义导航栏影响,最终的吸顶值非offsetTop值
  41. elId: uni.$u.guid(),
  42. left: 0, // js模式时,吸顶的内容因为处于postition: fixed模式,为了和原来保持一致的样式,需要记录并重新设置它的left,height,width属性
  43. width: 'auto',
  44. height: 'auto',
  45. fixed: false, // js模式时,是否处于吸顶模式
  46. }
  47. },
  48. computed: {
  49. style() {
  50. const style = {}
  51. if(!this.disabled) {
  52. if (this.cssSticky) {
  53. style.position = 'sticky'
  54. style.zIndex = this.uZindex
  55. style.top = uni.$u.addUnit(this.stickyTop)
  56. } else {
  57. style.height = this.fixed ? this.height + 'px' : 'auto'
  58. }
  59. } else {
  60. // 无需吸顶时,设置会默认的relative(nvue)和非nvue的static静态模式即可
  61. // #ifdef APP-NVUE
  62. style.position = 'relative'
  63. // #endif
  64. // #ifndef APP-NVUE
  65. style.position = 'static'
  66. // #endif
  67. }
  68. style.backgroundColor = this.bgColor
  69. return uni.$u.deepMerge(uni.$u.addStyle(this.customStyle), style)
  70. },
  71. // 吸顶内容的样式
  72. stickyContent() {
  73. const style = {}
  74. if (!this.cssSticky) {
  75. style.position = this.fixed ? 'fixed' : 'static'
  76. style.top = this.stickyTop + 'px'
  77. style.left = this.left + 'px'
  78. style.width = this.width == 'auto' ? 'auto' : this.width + 'px'
  79. style.zIndex = this.uZindex
  80. }
  81. return style
  82. },
  83. uZindex() {
  84. return this.zIndex ? this.zIndex : uni.$u.zIndex.sticky
  85. }
  86. },
  87. mounted() {
  88. this.init()
  89. },
  90. methods: {
  91. init() {
  92. this.getStickyTop()
  93. // 判断使用的模式
  94. this.checkSupportCssSticky()
  95. // 如果不支持css sticky,则使用js方案,此方案性能比不上css方案
  96. if (!this.cssSticky) {
  97. !this.disabled && this.initObserveContent()
  98. }
  99. },
  100. initObserveContent() {
  101. // 获取吸顶内容的高度,用于在js吸顶模式时,给父元素一个填充高度,防止"塌陷"
  102. this.$uGetRect('#' + this.elId).then((res) => {
  103. this.height = res.height
  104. this.left = res.left
  105. this.width = res.width
  106. this.$nextTick(() => {
  107. this.observeContent()
  108. })
  109. })
  110. },
  111. observeContent() {
  112. // 先断掉之前的观察
  113. this.disconnectObserver('contentObserver')
  114. const contentObserver = uni.createIntersectionObserver({
  115. // 检测的区间范围
  116. thresholds: [0.95, 0.98, 1]
  117. })
  118. // 到屏幕顶部的高度时触发
  119. contentObserver.relativeToViewport({
  120. top: -this.stickyTop
  121. })
  122. // 绑定观察的元素
  123. contentObserver.observe(`#${this.elId}`, res => {
  124. this.setFixed(res.boundingClientRect.top)
  125. })
  126. this.contentObserver = contentObserver
  127. },
  128. setFixed(top) {
  129. // 判断是否出于吸顶条件范围
  130. const fixed = top <= this.stickyTop
  131. this.fixed = fixed
  132. },
  133. disconnectObserver(observerName) {
  134. // 断掉观察,释放资源
  135. const observer = this[observerName]
  136. observer && observer.disconnect()
  137. },
  138. getStickyTop() {
  139. this.stickyTop = uni.$u.getPx(this.offsetTop) + uni.$u.getPx(this.customNavHeight)
  140. },
  141. async checkSupportCssSticky() {
  142. // #ifdef H5
  143. // H5,一般都是现代浏览器,是支持css sticky的,这里使用创建元素嗅探的形式判断
  144. if (this.checkCssStickyForH5()) {
  145. this.cssSticky = true
  146. }
  147. // #endif
  148. // 如果安卓版本高于8.0,依然认为是支持css sticky的(因为安卓7在某些机型,可能不支持sticky)
  149. if (uni.$u.os() === 'android' && Number(uni.$u.sys().system) > 8) {
  150. this.cssSticky = true
  151. }
  152. // APP-Vue和微信平台,通过computedStyle判断是否支持css sticky
  153. // #ifdef APP-VUE || MP-WEIXIN || MP-TOUTIAO
  154. this.cssSticky = await this.checkComputedStyle()
  155. // #endif
  156. // ios上,从ios6开始,都是支持css sticky的
  157. if (uni.$u.os() === 'ios') {
  158. this.cssSticky = true
  159. }
  160. // nvue,是支持css sticky的
  161. // #ifdef APP-NVUE
  162. this.cssSticky = true
  163. // #endif
  164. },
  165. // 在APP和微信小程序上,通过uni.createSelectorQuery可以判断是否支持css sticky
  166. checkComputedStyle() {
  167. // 方法内进行判断,避免在其他平台生成无用代码
  168. // #ifdef APP-VUE || MP-WEIXIN || MP-TOUTIAO
  169. return new Promise(resolve => {
  170. uni.createSelectorQuery().in(this).select('.u-sticky').fields({
  171. computedStyle: ["position"]
  172. }).exec(e => {
  173. resolve('sticky' === e[0].position)
  174. })
  175. })
  176. // #endif
  177. },
  178. // H5通过创建元素的形式嗅探是否支持css sticky
  179. // 判断浏览器是否支持sticky属性
  180. checkCssStickyForH5() {
  181. // 方法内进行判断,避免在其他平台生成无用代码
  182. // #ifdef H5
  183. const vendorList = ['', '-webkit-', '-ms-', '-moz-', '-o-'],
  184. vendorListLength = vendorList.length,
  185. stickyElement = document.createElement('div')
  186. for (let i = 0; i < vendorListLength; i++) {
  187. stickyElement.style.position = vendorList[i] + 'sticky'
  188. if (stickyElement.style.position !== '') {
  189. return true
  190. }
  191. }
  192. return false;
  193. // #endif
  194. }
  195. },
  196. beforeDestroy() {
  197. this.disconnectObserver('contentObserver')
  198. }
  199. }
  200. </script>
  201. <style lang="scss" scoped>
  202. .u-sticky {
  203. /* #ifdef APP-VUE || MP-WEIXIN || MP-TOUTIAO */
  204. // 此处默认写sticky属性,是为了给微信和APP通过uni.createSelectorQuery查询是否支持css sticky使用
  205. position: sticky;
  206. /* #endif */
  207. }
  208. </style>