【Vue3】vue3 + ts 封装城市选择组件

已于 2023-10-30 09:16:20 修改
阅读量7.7k 收藏 27
点赞数 3
分类专栏： 封装组件 Vue3 Typescript系列 文章标签： vue.js 前端 typescript
于 2023-02-28 08:30:00 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_46862327/article/details/129252653
版权

城市选择-基本功能

能够封装城市选择组件，并且完成基础的显示隐藏的交互功能

（1）封装通用组件src/components/city/index.vue

<script lang="ts" setup name="City"></script>
<template>
  <div class="city">
    <div class="select">
      <span class="placeholder">请选择配送地址</span>
      <span class="value"></span>
      <i class="iconfont icon-angle-down"></i>
    </div>
    <div class="option">
      <span class="ellipsis" v-for="i in 24" :key="i">北京市</span>
    </div>
  </div>
</template>

<style scoped lang="less">
.city {
  display: inline-block;
  position: relative;
  z-index: 400;
  .select {
    border: 1px solid #e4e4e4;
    height: 30px;
    padding: 0 5px;
    line-height: 28px;
    cursor: pointer;
    &.active {
      background: #fff;
    }
    .placeholder {
      color: #999;
    }
    .value {
      color: #666;
      font-size: 12px;
    }
    i {
      font-size: 12px;
      margin-left: 5px;
    }
  }
  .option {
    width: 542px;
    border: 1px solid #e4e4e4;
    position: absolute;
    left: 0;
    top: 29px;
    background: #fff;
    min-height: 30px;
    line-height: 30px;
    display: flex;
    flex-wrap: wrap;
    padding: 10px;
    > span {
      width: 130px;
      text-align: center;
      cursor: pointer;
      border-radius: 4px;
      padding: 0 3px;
      &:hover {
        background: #f5f5f5;
      }
    }
  }
}
</style>

全局注册

import XtxCity from '@/components/city/index.vue'
export default {
  install(app: App) {
    app.component('City', City)
  },
}

提供类型 src/global.d.ts

import XtxCity from '@/components/city/index.vue'
declare module 'vue' {
    City: typeof City
  }
}

（2）在商品详情组件中渲染city组件 src/views/goods/components/goods-name.vue

<dl>
  <dt>配送</dt>
  <dd>至 <City></City></dd>
</dl>

（3）控制城市的显示和隐藏

  1. 点击的时候切换省市区的样式
  2. 切换城市弹层的显示或隐藏
<script lang="ts" setup name="City">
+ import { ref } from 'vue'
+const active = ref(false)
+const toggle = () => {
+  active.value = !active.value
+}
</script>


<template>
  <div class="city">
+    <div class="select" @click="toggle" :class="{ active: active }">
      <span class="placeholder">请选择配送地址</span>
      <span class="value"></span>
      <i class="iconfont icon-angle-down"></i>
    </div>
+    <div class="option" v-show="active">
      <span class="ellipsis" v-for="i in 24" :key="i">北京市</span>
    </div>
  </div>
</template>

（4）点击弹层外部，关闭弹层

<script lang="ts" setup>
import { ref } from 'vue'
+import { onClickOutside } from '@vueuse/core'
const active = ref(false)
const toggle = () => {
  active.value = !active.value
}
// 点击外面，关闭弹窗
const target = ref(null)
onClickOutside(target, () => {
// 参数1：监听哪个元素,target是通过ref绑定给我们监听盒子的
// 参数2：点击了该元素外其他地方触发的函数
  active.value = false
})
</script>
<template>
  <div class="city" ref="target">
    <div class="select" @click="toggle" :class="{ active: active }">
      <span class="placeholder">请选择配送地址</span>
      <span class="value"></span>
      <i class="iconfont icon-angle-down"></i>
    </div>
    <div class="option" v-if="active">
      <span class="ellipsis" v-for="i in 24" :key="i">北京市</span>
    </div>
  </div>
</template>

城市选择-动态渲染

需求：完成城市数据的获取以及渲染

注意

城市数据并不是直接从接口服务器中获取的，而是从阿里云服务器上获取的数据，所以不能使用封装好的request发送请求，直接使用 原生的axios 发送请求即可。https://yjy-oss-files.oss-cn-zhangjiakou.aliyuncs.com/tuxian/area.jsonopen in new window

（1）定义数据类型

// 城市列表类型
export type AreaList = {
  code: string
  level: number
  name: string
  areaList: AreaList[]
}

（2）获取数据src/components/city/index.vue

需求: 从接口获取城市数据，赋值给本地数据

  1. 定义列表数据变量 const cityList = ref<AreaList[]>([])
  2. 封装调接口的方法
  3. 方法内部调用接口，把获取到的结果赋值给cityList
  4. 调用方法
<script lang="ts" setup name="City">
import { ref } from 'vue'
import { onClickOutside } from '@vueuse/core'
import type { AreaList } from '@/types/goods'
import axios from 'axios'
// 控制弹层的显示隐藏
const active = ref(false)
const toggle = () => {
  active.value = !active.value
}
const target = ref(null)
onClickOutside(target, (e) => {
  // console.log(e)
  // 当点击target元素的外面的时候，就会触发
  active.value = false
})

const cityList = ref<AreaList[]>([])
const getCityList = async () => {
  const res = await axios.get<AreaList[]>(
    'https://yjy-oss-files.oss-cn-zhangjiakou.aliyuncs.com/tuxian/area.json'
  )
  cityList.value = res.data
}
getCityList()
</script>

（3）渲染数据src/components/City/index.vue

<template>
  <div class="city" ref="target">
    <div class="select" :class="{ active: active }" @click="toggle">
      <span class="placeholder">请选择配送地址</span>
      <span class="value"></span>
      <i class="iconfont icon-angle-down"></i>
    </div>
    <div class="option" v-show="active">
      <span class="ellipsis" v-for="item in cityList" :key="item.code">
        {{ item.name }}
      </span>
    </div>
  </div>
</template>

（4）点击弹层外部，关闭弹层

<script lang="ts" setup>
import { ref } from 'vue'
+import { onClickOutside } from '@vueuse/core'
const active = ref(false)
const toggle = () => {
  active.value = !active.value
}
// 点击外面，关闭弹窗
const target = ref(null)
onClickOutside(target, () => {
// 参数1：监听哪个元素,target是通过ref绑定给我们监听盒子的
// 参数2：点击了该元素外其他地方触发的函数
  active.value = false
})
</script>
<template>
  <div class="city" ref="target">
    <div class="select" @click="toggle" :class="{ active: active }">
      <span class="placeholder">请选择配送地址</span>
      <span class="value"></span>
      <i class="iconfont icon-angle-down"></i>
    </div>
    <div class="option" v-if="active">
      <span class="ellipsis" v-for="i in 24" :key="i">北京市</span>
    </div>
  </div>
</template>

城市选择-交互逻辑

在这里插入图片描述

需求： 点击选择省市区的时候能够把省市区数据存储起来

  1. 根据点击的每一个节点的level决定他应该存储到省/城/区的哪个下面
  2. 点击的时候，需要把当前弹层城市信息替换为当前点击节点的子节点的城市信息（点击省显示市，点击市显示县）
  3. 如果点击的是区的节点，则需要关弹层
  4. 如果中途点击了关闭弹层，则需要重置城市数据

点击某个省，显示省下面的市。点击市，显示市下面的县。

根据level判断级别。

（1）给城市注册点击事件

<div class="option" v-if="active">
  <span
    class="ellipsis"
    v-for="item in cityList"
    :key="item.code"
+    @click="selectCity(item)"
  >
    {{ item.name }}
  </span>
</div>

（2）城市切换逻辑

// 选择城市
const changeResult = ref({
  provinceCode: '',
  provinceName: '',
  cityCode: '',
  cityName: '',
  countyCode: '',
  countyName: ''
})

const selectCity = (city: AreaList) => {
  if (city.level === 0) {
    // 省
    changeResult.value.provinceName = city.name
    changeResult.value.provinceCode = city.code
    cityList.value = city.areaList
  }
  if (city.level === 1) {
    // 市
    changeResult.value.cityName = city.name
    changeResult.value.cityCode = city.code
    cityList.value = city.areaList
  }
  if (city.level === 2) {
    // 县（区）
    changeResult.value.countyName = city.name
    changeResult.value.countyCode = city.code
    // 关闭弹窗
    active.value = false
  }
}

（3）关闭时恢复城市数据

const cityList = ref<AreaList[]>([])
const cacheList = ref<AreaList[]>([])

const getCityData = async () => {
  const {data:res} = await axios.get<AreaListObj[]>('https://yjy-oss-files.oss-cn-zhangjiakou.aliyuncs.com/tuxian/area.json')
  cityList.value = res
  cacheList.value = res
}
getCityData()

// 监听关闭弹窗的处理，恢复数据
watch(active, (value) => {
  // 当关闭active的时候，需要回复数据
  if (!value) {
    cityList.value = cacheList.value
  }
})

城市选择-完整地址处理

需求描述

  1. 默认展示的配送地址需要从父组件传递过来(登录的用户可以拿到当前用户的默认配送地址)
  2. 子组件选择完省市区需要传递给父组件，由父组件组织数据传给子组件进行展示（默认展示配送地址的数据源在父组件）

注意：完整地址需要父组件传递给子组件，将来如果登录的用户，父组件可以获取到完整的地址。

（1）父组件将城市数据传递给子组件

<script lang="ts" setup>
const userAddress = ref('江西省 九江市 不知道县')
</script>

 <City :userAddress="userAddress"></City></dd>

（2）子组件接收，并且进行展示

注意点:具体的地址和请选择配送同时只展示一个

defineProps<{
  userAddress?: string
}>()

<div class="select" @click="toggle" :class="{ active }">
  <span class="value" v-if="userAddress">{{ userAddress }}</span>
  <span class="placeholder" v-else>请选择配送地址</span>
  <i class="iconfont icon-angle-down"></i>
</div>

（3）子组件选择完城市，需要将数据传递给父组件

// 选择的城市结果类型
export type CityResult = {
  provinceCode: string
  provinceName: string
  cityCode: string
  cityName: string
  countyCode: string
  countyName: string
}

const changeResult = ref<Partial<CityResult>>({})


const emit = defineEmits<{
  (e: 'changeCity', value: CityResult): void
}>()


const selectCity = (city: AreaList) => {
  if (city.level === 0) {
    // 省
    changeResult.value.provinceName = city.name
    changeResult.value.provinceCode = city.code
    cityList.value = city.areaList
  }
  if (city.level === 1) {
    // 市
    changeResult.value.cityName = city.name
    changeResult.value.cityCode = city.code
    cityList.value = city.areaList
  }
  if (city.level === 2) {
    // 县（区）
    changeResult.value.countyName = city.name
    changeResult.value.countyCode = city.code
    // 关闭弹窗
    active.value = false
    // 子传父
    emit('changeCity', changeResult.value)
  }
}

优化代码（可选）

const changeResult = ref<Partial<CityResult>>({})
// record接受两个泛型参数，第一个为对象key的类型，第二个为对象值的类型
const cityMap: Record<number, 'province' | 'city' | 'county'> = {
  0: 'province',
  1: 'city',
  2: 'county'
}
const selectedCity = (city: AreaList) => {
  changeResult.value[`${cityMap[city["level"]]}Name`] = city.name
  changeResult.value[`${cityMap[city["level"]]}Code`] = city.code
  if (city.level === 2) {
    setIsShowCity(false)
    emits('changeCity', changeResult.value)
  } else {
    cityList.value = city.areaList
  }
}

（4）父组件接受数据并且处理

<dl>
  <dt>配送</dt>
  <dd>
    至
    <XtxCity
      @changeCity="changeCity"
      :fullPath="fullPath"
    ></XtxCity>
  </dd>
</dl>

const userAddress = ref('江西省 九江市 不知道县')
const changeCity = (changeResult: CityResult) => {
  userAddress.value =
    changeResult.provinceName +
    ' ' +
    changeResult.cityName +
    ' ' +
    changeResult.countyName
}
', changeResult.value)
  } else {
    cityList.value = city.areaList
  }
}

（4）父组件接受数据并且处理

<dl>
  <dt>配送</dt>
  <dd>
    至
    <XtxCity
      @changeCity="changeCity"
      :fullPath="fullPath"
    ></XtxCity>
  </dd>
</dl>

const userAddress = ref('江西省 九江市 不知道县')
const changeCity = (changeResult: CityResult) => {
  userAddress.value =
    changeResult.provinceName +
    ' ' +
    changeResult.cityName +
    ' ' +
    changeResult.countyName
}
itpeilibo
关注
  • 3
    点赞
  • 踩
  • 27
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
vue+ts下对axios的封装实现
11-20
虽然vue中axios的使用已经十分方便,但是实际我们的日常操作中可能为了接口的规则一致,来创建一个统一管理的全局方法达到简化操作.而且在实际接口对接中,我们大多都需要对请求和响应进行拦截来进行token以及回调状态码的处理.那么我基于自己的需求简单分装了一下.(之前很少接触vue,主要用的ng和react,这次新项目想用vue来弄,熟悉一下vue的一些新特性和方法,有啥不对的,欢迎大家批评指正) 前提: 熟悉前端ts, node等等. 1. 安装axios npm install axios -D 2. 拦截器及全局方法编写 一个http.ts文件进行自己http逻辑的封装,为了代码
vue省市区组件，mint-ui封装的省市区组件
07-03
vue-cli项目中使用mint-ui封装的省市区三级联动组件，使用简单
循序渐进VUE+Element 前端应用开发(21）--- 省市区县联动处理的组件使用
最新发布
2401_83915664的博客
03-30 784
面试题千万不要死记，一定要自己理解，用自己的方式表达出来，在这里预祝各位成功拿下自己心仪的offer。需要完整面试题的朋友可以点击蓝色字体即可获取！！！由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！如果你觉得这些内容对你有帮助，可以扫码获取！！（资料价值较高，非无偿）面试题千万不要死记，一定要自己理解，用自己的方式表达出来，在这里预祝各位成功拿下自己心仪的offer。需要完整面试题的朋友可以点击蓝色字体即可获取！！！
vue3+ts+vite+router+vuex+api请求封装
12-29
后台管理系统脚手架
cron定时任务表达式组件（vue3+ts+naiveUI）
09-30
vue3+ts+naive UI,有执行时间的中文解析，还有10次执行时间（需要后端写接口）. 1.将文件放在你想放的项目文件夹下，引入import vue3CronComponent from "xxxx";如果需要中文解析功能，同理引入即可。 3.需要传的值，maxHeight="450px"//最大高， @changeCron="changeCron"//方法，:cronValue="cronValue"//cron表达式， :showCronModal="showCronModal"//打开弹框，style="flex: 0.25"//样式 4.// cron子组件传的方法 const changeCron = (val: string) => { showCronModal.value = false; if (val) { //赋值更新 } }
vue3+TS+axios+route+element plus 可二次开发的模板，包括请求使用方法，完美封装 上手即用
08-19
vue3+TS+axios+route+element plus 可二次开发的模板，包括请求使用方法，完美封装 上手即用
vue城市选择组件
08-10
vue城市选择组件
vue3 封装选择城市组件
m0_68702564的博客
07-24 966
vue组件封装
vue，城市选择组件
四月
03-12 1082
功能： 有搜索功能 当前城市展示 热门城市 可以点击右侧字母，也可以滚动字母方便选择城市 图示 完整代码： 文件目录： City.vue文件 <template> <div> <city-header></city-header> <city-search :cities="cities"></city-search> <city-list :cities=".
一个城市选择组件
08-12
一个城市选择组件
CitySelector:基于vue的移动端城市选择组件
05-13
CitySelector 基于vue的移动端城市选择组件 手机扫这里看demo 针对移动端的城市选择组件 可以使用拼音或关键字进行检索，也可以在右侧检索栏快速滑动 本地构建方法：clone后npm install->npm run dev 欢迎大家提issues呀 如有需要可e-mail: 版本管理 pub+数字 6.1 去掉了rem，改为px， 分支pub1 tips: master分支在开发，需要clone的话找pub版本
vue.js实现城市选择页面
12-27
web端h5+vue.js实现城市选择页面和选择城市功能，完美流畅侧滑效果
vue实现城市列表选择功能
10-18
主要介绍了vue实现城市列表选择功能，本文通过实例代码给大家介绍的非常详细，具有一定的参考借鉴价值,需要的朋友可以参考下
vue适用于pc端的城市选择组件按城市首字母排序
08-12
vue适用于pc端的城市选择组件（按城市首字母排序）
vue3+ts+echarts实现echarts封装
08-01
vue3+ts+echarts实现echarts封装
VUE城市地区三级划分组件，轻轻松松上手
weixin_42512282的博客
06-09 581
主入口挂载 main.js 页面引用 定义标签 第二阶段 方法的引入-控制台输出 选择触发方法 选择框样式
手把手教学：VUE3+TS组件库开发与发布
热门推荐
tglsaturn的专栏
10-19 1万+
前言 当市面上主流的组件库不能满足我们业务需求的时候，那么我们就有必要开发一套属于自己团队的组件库。 以下用一个简单的组件来讲述基于Vue3.0 + TS的组件从开发到发布npm仓库的全过程（参考element-plus） 环境版本 这里列出本文所使用的环境版本 vue 3.0 vue/cli 4.5.9 nodeJs 14.15.1 npm 6.14.8 > vue --version @vue/cli 4.5.9 > npm -v 6.14.
vue3 + ts + elementplus 封装表单提交组件
08-24
你可以尝试以下步骤来封装一个Vue 3和TypeScript下使用Element Plus的表单提交组件： 1. 安装必要的依赖： - Vue 3：`npm install vue@next` - TypeScript：`npm install -D typescript` - Element Plus：`npm install element-plus` 2. 创建一个新的Vue组件，并为其选择一个合适的名称，例如`FormSubmit.vue`。 3. 在`FormSubmit.vue`文件中，导入必要的模块和样式： ```vue <template> <!-- 表单内容 --> </template> <script lang="ts"> import { defineComponent } from 'vue'; import { ElButton, ElForm, ElFormItem } from 'element-plus'; export default defineComponent({ components: { ElButton, ElForm, ElFormItem, }, }); </script> <style scoped> /* Element Plus 样式 */ @import 'element-plus/packages/theme-chalk/src/index.scss'; /* 自定义样式 */ /* ... */ </style> ``` 4. 在模板中编写表单内容，并使用Element Plus的组件来构建表单： ```vue <template> <el-form ref="form" :model="formData" label-width="120px"> <el-form-item label="姓名" prop="name"> <el-input v-model="formData.name"></el-input> </el-form-item> <!-- 更多表单项 --> <el-form-item> <el-button type="primary" @click="submitForm">提交</el-button> </el-form-item> </el-form> </template> <script lang="ts"> // ... export default defineComponent({ // ... data() { return { formData: { name: '', // 更多表单字段 } }; }, methods: { submitForm() { // 表单提交逻辑 if (this.$refs.form.validate()) { // 表单验证通过，执行提交操作 // ... } } } }); </script> ``` 这样，你就可以使用封装好的表单提交组件来方便地处理表单提交了。你可以根据实际需求添加更多的表单项，并在`submitForm`方法中实现你的提交逻辑。希望这可以帮到你！

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

itpeilibo

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值