Vue 组件细则
.vue
文件是一个自定义的文件类型,用类 HTML 语法描述一个 Vue 组件。每个 .vue
文件包含三种类型的顶级语言块 <template>
、<script>
和 <style>
,还允许添加可选的自定义块:
<template>
<div class="example">{{ msg }}</div>
</template>
<script>
export default {
data () {
return {
msg: 'Hello world!'
}
}
}
</script>
<style>
.example {
color: red;
}
</style>
<custom1>
This could be e.g. documentation for the component.
</custom1>
vue-loader
会解析文件,提取每个语言块,如有必要会通过其它 loader 处理,最后将他们组装成一个 CommonJS 模块,module.exports
出一个 Vue.js 组件对象。
vue-loader
支持使用非默认语言,比如 CSS 预处理器,预编译的 HTML 模版语言,通过设置语言块的 lang
属性。例如,你可以像下面这样使用 Sass 语法编写样式:
<style lang="sass">
/* write Sass! */
</style>
更多细节可以在预处理器中找到。
语言块
<template>
默认语言:
html
。
每个
.vue
文件最多包含一个<template>
块。
内容将被提取为字符串,将编译并用作 Vue 组件的
template
选项。
<script>
默认语言:
js
(在检测到babel-loader
或buble-loader
配置时自动支持ES2015)。
每个
.vue
文件最多包含一个<script>
块。
该脚本在类 CommonJS 环境中执行 (就像通过 webpack 打包的正常 js 模块),这意味着你可以
require()
其它依赖。在 ES2015 支持下,你也可以使用import
和export
语法。
脚本必须导出 Vue.js 组件对象。也可以导出由
Vue.extend()
创建的扩展对象,但是普通对象是更好的选择。
<style>
默认语言:
css
。
一个
.vue
文件可以包含多个<style>
标签。
<style>
标签可以有scoped
或者module
属性 (查看 CSS 作用域和 CSS Modules) 以帮助你将样式封装到当前组件。具有不同封装模式的多个<style>
标签可以在同一个组件中混合使用。
默认情况下,将会使用
style-loader
提取内容,并通过<style>
标签动态加入文档的<head>
中,也可以配置 webpack 将所有 styles 提取到单个 CSS 文件中。
自定义块
只在 vue-loader 10.2.0+ 中支持
可以在 .vue
文件中添加额外的自定义块来实现项目的特定需求,例如 <docs>
块。vue-loader
将会使用标签名来查找对应的 webpack loader 来应用在对应的块上。webpack loader 需要在 vue-loader
的选项 loaders
中指定。
更多细节,查看自定义块。
Src 导入
如果你喜欢分隔你的 .vue
文件到多个文件中,你可以通过 src
属性导入外部文件:
<template src="./template.html"></template>
<style src="./style.css"></style>
<script src="./script.js"></script>
需要注意的是 src
导入遵循和 require()
一样的规则,这意味着你相对路径需要以 ./
开始,你还可以从 NPM 包中直接导入资源,例如:
<!-- import a file from the installed "todomvc-app-css" npm package -->
<style src="todomvc-app-css/index.css">
在自定义块上同样支持 src
导入,例如:
<unit-test src="./unit-test.js">
</unit-test>
语法高亮
目前语法高亮支持 Sublime Text、Atom、Vim、Emacs、Visual Studio Code、Brackets 和 JetBrains products (WebStorm、PhpStorm 等)。非常感谢其他编辑器/IDE 所做的贡献!如果在 Vue 组件中没有使用任何预处理器,你可以把 .vue
文件当作 HTML 对待。
注释
在语言块中使用该语言块对应的注释语法 (HTML、CSS、JavaScript、Jade 等)。顶层注释使用 HTML 注释语法:<!— comment contents here —>