uni-app组件

140 阅读8分钟

开启掘金成长之旅!这是我参与「掘金日新计划 · 12 月更文挑战」的第32天,点击查看活动详情

组件概述

组件使用的入门教程

  • 组件是视图层的基本组成单元。
  • 组件是一个单独且可复用的功能模块的封装。

每个组件,包括如下几个部分:以组件名称为标记的开始标签和结束标签、组件内容、组件属性、组件属性值。

  • 组件名称由尖括号包裹,称为标签,它有开始标签和结束标签。结束标签的<后面用/来表示结束。结束标签也称为闭合标签。如下面示例的<component-name>是开始标签,</component-name>是结束标签。
  • 在开始标签和结束标签之间,称为组件内容。如下面示例的content
  • 开始标签上可以写属性,属性可以有多个,多个属性之间用空格分割。如下面示例的property1property2。注意闭合标签上不能写属性。
  • 每个属性通过=赋值。如下面的示例中,属性property1的值被设为字符串value

注意:所有组件与属性名都是小写,单词之间以连字符-连接。

image.png 下面是一个基本组件的实例,在一个vue页面的根<view>组件下插入一个<button>组件。给这个组件的内容区写上文字“按钮”,同时给这个组件设置了一个属性“size”,并且“size”属性的值设为了“mini”。

注:按照[vue单文件组件规范],每个vue文件的根节点必须为 <template>,且这个 <template> 下只能且必须有一个根 <view> 组件。

image.png

组件的属性类型

组件的属性,有多种类型

image.png 下面的例子演示了组件的属性设置boolean值和数字的例子。注意false作为一个js变量,在组件的属性中使用时,属性前面需增加:冒号前缀,属性值仍使用引号包裹,但引号里不是字符串,而是js。

image.png

公共属性列表

每个组件都有各自定义的属性,但所有uni-app的组件,都有如下属性:

image.png 除了上述公共属性,还有一类特殊属性以v-开头,称之为vue指令,如v-if、v-else、v-for、v-model。详见[vue指令]

在组件中使用js变量

组件中可以使用script的data中定义的js变量,但组件的属性中使用和内容区使用的用法不一样。

  • 在内容区使用时,使用两个花括号来包裹,如下面的buttonText
  • 在属性值中使用时,属性名的前面要加冒号前缀(指令)

下面的button组件示例,等价于上一个的示例。只不过静态内容改成动态js。

image.png

组件的事件

每个组件都有“事件”。事件就是在指定的条件下触发某个js方法。

比如button组件,有点击事件,也就是当手机用户点击这个button组件时,会触发这个事件。

事件也是组件的属性,只不过这类属性以@为前缀。

事件的属性值,指向一个在script的methods里定义过的js方法,还可以给方法传参数。

下面是组件事件的示例:

  • click是button组件的点击事件,在用户点击这个button时触发
  • click指向了methods中定义的goto方法,并且传递了一个参数'/pages/about/about'

image.png

基础组件

uni-app的组件,分为基础组件(内置组件)和扩展组件。

基础组件在uni-app框架中已经内置,无需将内置组件的文件导入项目,也无需注册内置组件,随时可以直接使用,比如<view>组件。

除了基础组件,都称为扩展组件。扩展组件需要将组件导入项目中才可以使用。

uni-app为开发者提供了一系列基础组件,类似HTML里的基础标签元素。

但uni-app的组件与HTML不同,而是与小程序相同,可更好的满足手机端的使用习惯。

虽然不推荐使用HTML标签,但实际上如果开发者写了div等标签,在编译到非H5平台时也会被编译器转换为view标签,类似的还有spantextanavigator等,包括css里的元素选择器也会转。但为了管理方便、策略统一,新写代码时仍然建议使用view等组件。

开发者可以通过组合这些基础组件进行快速开发。在需要复用的情况下可封装成扩展组件。

uni-app 基础组件规范,与小程序规范相近。如果了解小程序开发的话,uni-app的基础组件会感觉很熟悉。但需要注意组件上的事件绑定,需要以 vue 的事件绑定语法来绑定,如 bindchange="eventName" 事件,需要写成 @change="eventName"

image.png

基础组件列表

基础组件分为以下十几大类:

视图容器(View Container):

image.png 基础内容(Basic Content):

image.png 表单组件(Form):

image.png 路由与页面跳转(Navigation):

image.png 媒体组件(Media):

image.png 地图(Map):

image.png 画布(Canvas):

image.png webview(Web-view):

image.png 广告

image.png 页面属性配置

image.png uniCloud

image.png 各平台专有组件

在小程序平台和nvue平台,还有一些专有组件,比如open-data,详见左侧导航

扩展组件的意义

虽然所有的业务需求都可以通过基础组件满足,但仅有基础组件是低效的,实际开发中会有很多封装的组件。

比如我们需要一个五角星点击评分的组件,在DCloud的插件市场里可以获取到:ext.dcloud.net.cn/plugin?id=3…

把这个uni-rate组件导入到你的uni-app项目下,在需要的vue页面里引用它,就可以在指定的地方显示出这个五角星组件。

image.png 封装扩展组件的优势:

  • 可以将组件进行任意次数的复用。
  • 合理的划分组件,有助于提高应用性能。
  • 代码更加方便组织和管理,并且扩展性也更强,便于多人协同开发。
  • 组件化开发能大幅度提高应用开发效率、测试性、复用性等。

组件的类别

uni-app支持的组件分为vue组件和小程序自定义组件 日常开发来讲,推荐使用vue组件。uni-app支持小程序组件主要是为了兼容更多生态资源。 如果扩展组件符合uni-app的easycom组件规范,则可以免注册,直接使用。比如uni-ui扩展组件就符合easycom组件规范。

如果组件不符合easycom规范,则需要在代码里手动import和注册组件,然后才能使用 除了easycom规范外,扩展组件还有很多概念,比如uni_moduledatacom原生组件uniCloud组件

easycom组件规范

HBuilderX 2.5.5起支持

传统vue组件,需要安装、引用、注册,三个步骤后才能使用组件。easycom将其精简为一步。

只要组件安装在项目的components目录下或uni_modules目录下,并符合components/组件名称/组件名称.vue目录结构。就可以不用引用、注册,直接在页面中使用。

比如前述举例的[uni-rate组件],它导入到uni-app项目后,存放在了目录/components/uni-rate/uni-rate.vue

同时它的组件名称也叫uni-rate,所以这样的组件,不用在script里注册和引用。 如下:

image.png 不管components目录下安装了多少组件,easycom打包后会自动剔除没有使用的组件,对组件库的使用尤为友好。

组件库批量安装,随意使用,自动按需打包。以官方的uni-ui为例,在HBuilderX新建项目界面选择uni-ui项目模板,只需在页面中敲u(快捷键),拉出大量组件代码块,直接选择,即可使用。大幅提升开发效率,降低使用门槛。

在[DCloud插件市场]下载符合components/组件名称/组件名称.vue目录结构的组件,均可直接使用。

easycom是自动开启的,不需要手动开启。 如果你的组件名称或路径不符合easycom的默认规范,可以在pages.jsoneasycom节点进行个性化设置,自定义匹配组件的策略。 如果不使用easycom,手动引用和注册vue组件,则需要分3步写如下代码:

  1. import导入组件
  2. components里注册组件
  3. template中使用组件

image.png

uni_module规范

uni_module其实不止服务于组件,它可以服务于组件、js库、页面、项目等所有DCloud插件市场所支持的种类。

符合uni_module规范的组件都在项目的uni_modules目录下,以插件id为目录存放。(项目模板不放在uni_modules目录下)

在HBuilderX中点右键可方便的更新插件,插件作者也可以方便的上传插件。

uni_module还支持云端一体的插件。

uni_module有详细的专项文档,请另行查阅[uni_module规范]。
可以右击选择一键更新所有插件

image.png

uniCloud组件

uniCloud是DCloud提供的、配套uni-app的云开发服务。

uni-app的基础组件中,有一个特殊基础组件是:<unicloud-db>组件。

它可以在前端直接获取和操作uniCloud的云端数据库。

相关文档详见:[unicloud-db组件]

除了内置的数据库组件,在uni-ui扩展库里还有uniCloud的文件选择和上传组件,参考:[uni-file-picker]

原生组件和原生插件

基础组件里的原生组件

uni-app的基础组件里,有一批原生组件,如video、map...

这些组件如果用于vue页面,也就是webview渲染时,会造成层级高于普通前端组件的情况。

它们的层级需要使用cover-view等特殊组件才能覆盖,同时在使用中有些需要注意的事情。

在app-nvue里没有这些问题