本文作者:qiaoqingyi

vue基础组件文件名符合规范的是(组件vue文件必须有的要素)

qiaoqingyi 2023-02-10 766

今天给各位分享vue基础组件文件名符合规范的是的知识,其中也会对组件vue文件必须有的要素进行解释,如果能碰巧解决你现在面临的问题,别忘了关注本站,现在开始吧!

本文目录一览:

Vue在前端开发中需要注意什么

基于Vue官方风格指南整理

一、强制

1. 组件名为多个单词

组件名应该始终是多个单词的,根组件 App 除外。

正例:

export default {

name: 'TodoItem',

// ...

}

反例:

export default {

name: 'Todo',

// ...

}

2. 组件数据

组件的 data 必须是一个函数。

当在组件中使用 data 属性的时候 (除了 new Vue 外的任何地方),它的值必须是返回一个对象的函数。

正例:

// In a .vue file

export default {

data () {

return {

foo: 'bar'

}

}

}

// 在一个 Vue 的根实例上直接使用对象是可以的,

// 因为只存在一个这样的实例。

new Vue({

data: {

foo: 'bar'

}

})

反例:

export default {

data: {

foo: 'bar'

}

}

3. Prop定义

Prop 定义应该尽量详细。

在你提交的代码中,prop 的定义应该尽量详细,至少需要指定其类型。

正例:

props: {

status: String

}

// 更好的做法!

props: {

status: {

type: String,

required: true,

validator: function (value) {

return [

'syncing',

'synced',

'version-conflict',

'error'

].indexOf(value) !== -1

}

}

}

反例:

// 这样做只有开发原型系统时可以接受

props: ['status']

4. 为v-for设置键值

总是用 key 配合 v-for。

在组件上_总是_必须用 key 配合 v-for,以便维护内部组件及其子树的状态。甚至在元素上维护可预测的行为,比如动画中的对象固化 (object constancy),也是一种好的做法。

正例:

ul

li

v-for="todo in todos"

:key="todo.id"

{{ todo.text }}

/li

/ul

反例:

ul

li v-for="todo in todos"

{{ todo.text }}

/li

/ul

5.避免 v-if 和 v-for 用在一起

永远不要把 v-if 和 v-for 同时用在同一个元素上。

一般我们在两种常见的情况下会倾向于这样做:

为了过滤一个列表中的项目 (比如 v-for="user in users" v-if="user.isActive")。在这种情形下,请将 users 替换为一个计算属性 (比如 activeUsers),让其返回过滤后的列表。

为了避免渲染本应该被隐藏的列表 (比如 v-for="user in users" v-if="shouldShowUsers")。这种情形下,请将 v-if 移动至容器元素上 (比如 ul, ol)。

正例:

ul v-if="shouldShowUsers"

li

v-for="user in users"

:key="user.id"

{{ user.name }}

/li

/ul

反例:

ul

li

v-for="user in users"

v-if="shouldShowUsers"

:key="user.id"

{{ user.name }}

/li

/ul

6. 为组件样式设置作用域

对于应用来说,顶级 App 组件和布局组件中的样式可以是全局的,但是其它所有组件都应该是有作用域的。

这条规则只和单文件组件有关。你不一定要使用 scoped 特性。设置作用域也可以通过 CSS Modules,那是一个基于 class 的类似 BEM 的策略,当然你也可以使用其它的库或约定。

不管怎样,对于组件库,我们应该更倾向于选用基于 class 的策略而不是 scoped 特性。

这让覆写内部样式更容易:使用了常人可理解的 class 名称且没有太高的选择器优先级,而且不太会导致冲突。

正例:

template

button class="c-Button c-Button--close"X/button

/template

!-- 使用 BEM 约定 --

style

.c-Button {

border: none;

border-radius: 2px;

}

.c-Button--close {

background-color: red;

}

/style

反例:

template

button class="btn btn-close"X/button

/template

style

.btn-close {

background-color: red;

}

/style

template

button class="button button-close"X/button

/template

!-- 使用 `scoped` 特性 --

style scoped

.button {

border: none;

border-radius: 2px;

}

.button-close {

background-color: red;

}

/style

二、强烈推荐(增强可读性)

1. 组件文件

只要有能够拼接文件的构建系统,就把每个组件单独分成文件。

当你需要编辑一个组件或查阅一个组件的用法时,可以更快速的找到它。

正例:

components/

|- TodoList.vue

|- TodoItem.vue

反例:

V

ue.component('TodoList', {

// ...

})

Vue.component('TodoItem', {

// ...

})

2. 单文件组件文件的大小写

单文件组件的文件名应该要么始终是单词大写开头 (PascalCase)

正例:

components/

|- MyComponent.vue

反例:

components/

|- myComponent.vue

|- mycomponent.vue

3. 基础组件名

应用特定样式和约定的基础组件 (也就是展示类的、无逻辑的或无状态的组件) 应该全部以一个特定的前缀开头,比如 Base、App 或 V。

正例:

components/

|- BaseButton.vue

|- BaseTable.vue

|- BaseIcon.vue

反例:

components/

|- MyButton.vue

|- VueTable.vue

|- Icon.vue

4. 单例组件名

只应该拥有单个活跃实例的组件应该以 The 前缀命名,以示其唯一性。

这不意味着组件只可用于一个单页面,而是每个页面只使用一次。这些组件永远不接受任何 prop,因为它们是为你的应用定制的,而不是它们在你的应用中的上下文。如果你发现有必要添加 prop,那就表明这实际上是一个可复用的组件,只是目前在每个页面里只使用一次。

正例:

components/

|- TheHeading.vue

|- TheSidebar.vue

反例:

components/

|- Heading.vue

|- MySidebar.vue

5. 紧密耦合的组件名

和父组件紧密耦合的子组件应该以父组件名作为前缀命名。

如果一个组件只在某个父组件的场景下有意义,这层关系应该体现在其名字上。因为编辑器通常会按字母顺序组织文件,所以这样做可以把相关联的文件排在一起。

正例:

components/

|- TodoList.vue

|- TodoListItem.vue

|- TodoListItemButton.vue

components/

|- SearchSidebar.vue

|- SearchSidebarNavigation.vue

反例:

components/

|- SearchSidebar.vue

|- NavigationForSearchSidebar.vue

6. 组件名中的单词顺序

组件名应该以高级别的 (通常是一般化描述的) 单词开头,以描述性的修饰词结尾。

正例:

components/

|- SearchButtonClear.vue

|- SearchButtonRun.vue

|- SearchInputQuery.vue

|- SearchInputExcludeGlob.vue

|- SettingsCheckboxTerms.vue

|- SettingsCheckboxLaunchOnStartup.vue

反例:

components/

|- ClearSearchButton.vue

|- ExcludeFromSearchInput.vue

|- LaunchOnStartupCheckbox.vue

|- RunSearchButton.vue

|- SearchInput.vue

|- TermsCheckbox.vue

7. 模板中的组件名大小写

总是 PascalCase 的

正例:

!-- 在单文件组件和字符串模板中 --

MyComponent/

反例:

!-- 在单文件组件和字符串模板中 --

mycomponent/

!-- 在单文件组件和字符串模板中 --

myComponent/

8. 完整单词的组件名

组件名应该倾向于完整单词而不是缩写。

正例:

components/

|- StudentDashboardSettings.vue

|- UserProfileOptions.vue

反例:

components/

|- SdSettings.vue

|- UProfOpts.vue

9. 多个特性的元素

多个特性的元素应该分多行撰写,每个特性一行。

正例:

img

src="htorg/images/logo.png"

alt="Vue Logo"

MyComponent

foo="a"

bar="b"

baz="c"

/

反例:

img src="h/logo.png" alt="Vue Logo"

MyComponent foo="a" bar="b" baz="c"/

10. 模板中简单的表达式

组件模板应该只包含简单的表达式,复杂的表达式则应该重构为计算属性或方法。

复杂表达式会让你的模板变得不那么声明式。我们应该尽量描述应该出现的是什么,而非如何计算那个值。而且计算属性和方法使得代码可以重用。

vue基础组件文件名符合规范的是(组件vue文件必须有的要素)

Vue 单文件组件 (SFC) 规范

模板

脚本

样式

简介

.vue 文件是一个 自定义的文件类型 ,用类 HTML 语法描述一个 Vue 组件。

每个 .vue 文件包含三种类型的顶级语言块 template、script 和 style,还允许添加可选的 自定义块 。

Vue项目中的文件/文件夹命名规范

展开node_modules中的项目依赖,会发现,几乎所有的项目文件夹命名都是 kebab-case 命名的, 使用 kebab-case 命名的文件夹比 camelCase 命名的文件夹看起来更清晰

vue的官方的风格指南 中关于组件文件名的推荐:

index.js 中导出组件方式如下:

关于vue基础组件文件名符合规范的是和组件vue文件必须有的要素的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站。

阅读
分享