江西小程序管理端
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.

212 lines
6.8 KiB

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