【vue】推荐的风格指南(总结自官网)
创始人
2024-03-23 23:23:36

组件名为多个单词

组件名应该始终是多个单词的,根组件 App 以及 、 之类的 Vue 内置组件除外。

Vue.component('todo-item', {// ...
})
export default {name: 'TodoItem',// ...
}

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

Prop 定义应该尽量详细。

// 更好的做法!
props: {status: {type: String,required: true,validator: function (value) {return ['syncing','synced','version-conflict','error'].indexOf(value) !== -1}}
}

为 v-for 设置键值 总是用 key 配合 v-for。

    {{ todo.text }}

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

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

    {{ user.name }}

为组件样式设置作用域

这条规则只和单文件组件有关。



私有 property 名

使用模块作用域保持不允许外部访问的函数的私有性。如果无法做到这一点,就始终为插件、混入等不考虑作为对外公共 API 的自定义私有 property 使用 $_ 前缀。并附带一个命名空间以回避和其它作者的冲突 (比如 $yourPluginName)

// 甚至更好!
var myGreatMixin = {// ...methods: {publicMethod() {// ...myPrivateFunction()}}
}function myPrivateFunction() {// ...
}export default myGreatMixin

单文件组件文件名的大小写强烈推荐

单文件组件的文件名应该要么始终是单词大写开头 (PascalCase),要么始终是横线连接 (kebab-case)。

components/
|- MyComponent.vuecomponents/
|- my-component.vue

基础组件名强烈推荐

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

紧密耦合的组件名

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

components/
|- SearchSidebar.vue
|- SearchSidebarNavigation.vue

完整单词的组件名强烈推荐

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

components/
|- StudentDashboardSettings.vue
|- UserProfileOptions.vue

Prop 名大小写

在声明 prop 的时候,其命名应该始终使用 camelCase,而在模板和 JSX 中应该始终使用 kebab-case。

props: {greetingText: String
}

模板中简单的表达式强烈推荐

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


{{ normalizedFullName }}
// 复杂表达式已经移入一个计算属性
computed: {normalizedFullName: function () {return this.fullName.split(' ').map(function (word) {return word[0].toUpperCase() + word.slice(1)}).join(' ')}
}

相关内容

热门资讯

“小爱同学”不是想喊就能喊 (来源:法治日报)转自:法治日报□ 本报记者   罗莎莎  □ 本报通讯员 刘晓慧 张海陵  科技飞...
以文塑城 以旅兴城 (来源:衢州日报)转自:衢州日报  记者 赵凯怡  当人文温度融入城市治理的肌理,衢州将千年文脉转化...
中煤(宣威)新能源有限公司成立... 经济观察网 天眼查App显示,12月3日,中煤(宣威)新能源有限公司成立,法定代表人为杨航行,注册资...
深化普法长效机制,打造法治宣传... (来源:法治日报)转自:法治日报□ 周元卿  法治宣传教育是全面依法治国的长期基础性工作。党的二十届...
《雨中曲》等经典剧目岁末年初蓉... 转自:成都日报锦观《雨中曲》等经典剧目岁末年初蓉城上演 本报讯 (成都日报锦观新闻记者 余力)...