vue3自定义导航栏(Taro+navBar+ts)

背景

因项目是vue3,小程序简单的封装了一个自定义导航栏,(菜鸟一名有不对的地方勿喷欢迎留言指正)

<template>
  <scroll-view
    v-bind="$attrs"
    :scroll-with-animation="true"
    :scroll-y="true"
    :upper-threshold="state.upperThreshold"
    :class="[classes()]"
    :style="scrollStyle"
    @scroll="scroll"
    @scrolltoupper="scrolltoupper"
    @refresherrefresh="refresh"
    :refresherTriggered="refresherTriggered"
    :scrollTop="scrollY"
  >
    <image :class="classes('bg--image')" v-if="props.bgImage" style="width: 100%" :src="props.bgImage" />
    <view :class="classes('bar')" :style="style">
      <slot name="bar">
        <view v-if="props.showNavBar" :class="classes('bar--wrp')">
          <view :class="classes('bar--icon')" @tap.stop="goBack">
            <RectLeft />
          </view>
          <view :class="classes('bar--title')">{{ props.title }}</view>
        </view>
      </slot>
    </view>
    <view :class="classes('body')" :style="bodyStyle">
      <slot></slot>
    </view>
  </scroll-view>
</template>

<script setup>
import { computed, ref, defineEmits, reactive } from 'vue';
import { useSystemInfoStore } from '@/store';
import { useClass, useCreateSelectorQuery } from '@/utils';
import * as Taro from '@tarojs/taro';
import { RectLeft } from '@nutui/icons-vue-taro';//这里需要引入京东的框架

const { system, tabBarHeight, navBarHeight, rectInfo } = useSystemInfoStore();
const { classes } = useClass('mx-nav-bar-container');//这个在公共文件里
const refresherTriggered = ref(false);
const emit = defineEmits(['scroll', 'scrolltoupper']);

const props = defineProps({
  scrollY: {
    type: Number,
  },
  refresh: {
    //下拉刷新回调方法
    type: Function,
    defualt: () => {},
  },
  bgImage: {
    //背景图
    type: String,
  },
  isTabBar: {
    //是否在tabBar页面
    type: Boolean,
  },
  isNavBarFixed: {
    //滑动时NavBar是否fixed布局
    type: Boolean,
    default: true,
  },
  navBarColor: {
    //navBar背景色
    type: String,
  },
  activeNavBarColor: {
    //激活时navBar背景色
    type: String,
  },
  title: {
    type: String,
    default: '标题',
  },
  navBarTextColor: {
    //navBar字体色
    type: String,
    default: '#ffffff',
  },
  activeNavBarTextColor: {
    //激活时布局时navBar字体色
    type: String,
  },
  showNavBar: {
    //是否需要navBar
    type: Boolean,
    default: true,
  },
  goBack: {
    //自定义后退方法
    type: Function,
    default: () => {
      const pages = Taro.getCurrentPages();
      if (pages.length > 1) {
        Taro.navigateBack();
      } else {
        Taro.switchTab({
          url: '/pages/index/index',
        });
      }
    },
  },
  node: String, //滑动时需要计算的节点id,不穿默认一滑动就激活navBar
  bodyExceed: {
    //body内容超出
    type: Boolean,
    default: false,
  },
});

const state = reactive({
  scrollTop: false,
  upperThreshold: 20,
});

const bodyStyle = computed(() => {
  return {
    minHeight: `${system.screenHeight}px`,
    paddingTop: props.bodyExceed ? '0px' : `${navBarHeight}px`,
  };
});

const style = computed(() => {
  const paddingRight = system.windowWidth - rectInfo.right;
  const opts = {};
  if (state.scrollTop) {
    opts.background = props.activeNavBarColor;
    opts.color = props.activeNavBarTextColor;
  } else {
    opts.background = props.navBarColor;
    opts.color = props.navBarTextColor;
  }
  return {
    height: `${navBarHeight}px`,
    padding: `${system.statusBarHeight}px ${paddingRight}px 0 ${paddingRight}px`,
    ...opts,
  };
});

const scrollStyle = computed(() => {
  const tabHeight = props.isTabBar ? tabBarHeight : 0;
  return {
    height: `${system.screenHeight - tabHeight}px`,
  };
});

const goBack = () => {
  props.goBack();
};

const scroll = async e => {
  emit('scroll', e);
  if (state.scrollStops) {
    return;
  }
  if (props.node) {
    const { selectorQueryElemet } = useCreateSelectorQuery(props.node);
    const { top } = await selectorQueryElemet();
    const scrollTop = top - navBarHeight;
    state.scrollTop = scrollTop < 0 ? true : false;
  } else {
    const { scrollTop } = e.detail;
    if (scrollTop <= state.upperThreshold) {
      return;
    }
    state.scrollTop = true;
  }
};

const scrolltoupper = e => {
  emit('scrolltoupper', e);
  if (!props.node) {
    state.scrollTop = false;
  }
};

const refresh = () => {
  refresherTriggered.value = true;
  props.refresh(() => {
    refresherTriggered.value = false;
  });
};
</script>

<style lang="scss">
.mx-nav-bar-container {
  box-sizing: border-box;
  position: relative;
  &__bg--image {
    position: absolute;
    top: 0;
    left: 0;
  }
  &__bar {
    position: fixed;
    width: 100%;
    padding-left: 16px;
    padding-right: 16px;
    z-index: 2;
    transition: all 0.8s;
    &--wrp {
      position: relative;
      width: 100%;
      height: 100%;
    }
    box-sizing: border-box;
    &--title {
      display: flex;
      justify-content: center;
      align-items: center;
      font-size: 16px;
      font-weight: bold;
      height: 100%;
    }
    &--icon {
      position: absolute;
      top: 50%;
      font-size: 24px;
      transform: translateY(-50%);
      padding-right: 10px;
    }
  }

  &__body {
    position: relative;
    box-sizing: border-box;
    padding-bottom: calc(constant(safe-area-inset-bottom));
    padding-bottom: calc(env(safe-area-inset-bottom));
    z-index: 1;
  }
}
</style>

使用

<template>
  <view class="buyPage">
    <NavBarContainer :bodyExceed="true" :title="data.title" activeNavBarColor="#ffffff">
      <!-- 页面代码 -->
    </NavBarContainer>
  </view>
</template>

<script setup>
/*具体路由根据实际路径写*/
import Taro, { useRouter, useLoad, useDidShow, useReady, useUnload } from '@tarojs/taro';
import { reactive } from 'vue';
import NavBarContainer from '@/components/NavBarContainer';

const data = reactive({
  title: '标题',
});

useLoad(() => {
  console.log('--0-');
});
useDidShow(() => {
  console.log('--1-');
});
useReady(() => {
  console.log('--2-');
});
useUnload(() => {
  console.log('--3-');
});
</script>

公共文件

const { classes } = useClass('mx-nav-bar-container');//这个在公共文件里

/**
 *
 * @param {*} name
 * @returns
 */
export const useClass = (name = '') => {
  return {
    classes: function (fix) {
      return fix ? `${name}__${fix}` : name;
    },
  };
};

README

API

Props

参数 说明 类型 默认值
refresh 下拉刷新回调方法,通过Callback形式处理下拉刷新 Function > ()=>{}
bgImage 背景图 String -
isTabBar 是否TabBar页面 Boolean false
isNavBarFixed 滑动时顶部NavBar是否浮动布局 Boolean true
navBarColor 顶部NavBar背景色 String -
activeNavBarColor 顶部NavBar浮动布局时背景色 String -
title 顶部NavBar标题 String 标题
navBarTextColor 顶部NavBar标题颜色 String #ffffff
activeNavBarTextColor 顶部NavBar标题浮动时颜色 String -
showNavBar 是否展示顶部NavBar Boolean true
goBack 自定义顶部后退方法 Function ()=>{}
node 滑动到某个节点id后改变NavBar颜色 String -
bodyExceed body内容超出布局 Boolean false
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349

推荐阅读更多精彩内容