diff --git a/src/v2/style-guide/index.md b/src/v2/style-guide/index.md new file mode 100644 index 0000000000..55b57e376b --- /dev/null +++ b/src/v2/style-guide/index.md @@ -0,0 +1,1802 @@ +--- +type: style-guide +--- + +# Style Guide beta + +This is the official style guide for Vue-specific code. If you use Vue in a project, it's a great reference to avoid errors, bikeshedding, and anti-patterns. However, we don't believe that any style guide is ideal for all teams or projects, so mindful deviations are encouraged based on past experience, the surrounding tech stack, and personal values. + +For the most part, we also avoid suggestions about JavaScript or HTML in general. We don't mind whether you use semicolons or trailing commas. We don't mind whether your HTML uses single-quotes or double-quotes for attribute values. Some exceptions will exist however, where we've found that a particular pattern is helpful in the context of Vue. + +> **Soon, we'll also provide tips for enforcement.** Sometimes you'll simply have to be disciplined, but wherever possible, we'll try to show you how to use ESLint and other automated processes to make enforcement simpler. + +Finally, we've split rules into four categories: + + + +## Rule Categories + +### Priority A: Essential + +These rules help prevent errors, so learn and abide by them at all costs. Exceptions may exist, but should be very rare and only be made by those with expert knowledge of both JavaScript and Vue. + +### Priority B: Strongly Recommended + +These rules have been found to vastly improve readability in most projects. If you violate them, your code will still run, but other developers may give you the evil eye [at conferences](https://github.com/vuejs/roadmap#events). + +[![Fry from Futurama glaring](https://i.imgur.com/PcOnLxn.jpg)](http://futurama.wikia.com/wiki/Template:FOX_Image) + +### Priority C: Recommended + +Where multiple, equally good options exist, an arbitrary choice can be made to ensure consistency. In these rules, we describe each acceptable option and suggest a default choice. That means you can feel free to make a different choice in your own codebase, as long as you're consistent and have a good reason. Please do have a good reason though! By adapting to the community standard, you will: + +1. train your brain to more easily parse most of the community code you encounter +2. be able to copy and paste most community code examples without modification +2. often find new hires are already accustomed to your preferred coding style, at least in regards to Vue + +### Priority D: Use with Caution + +Some features of Vue exist to accommodate rare edge cases or smoother migrations from a legacy code base. When overused however, they can make your code more difficult to maintain or even become a source of bugs. These rules shine a light on potentially risky features, describing when and why they should be avoided. + +[![goto from xkcd.com](https://imgs.xkcd.com/comics/goto.png)](https://xkcd.com/292/) + + + +## Priority A Rules: Essential (Error Prevention) + + + +### Multi-word component names essential + +**Component names should always be multi-word, except for root `App` components.** + +This [prevents conflicts](http://w3c.github.io/webcomponents/spec/custom/#valid-custom-element-name) with existing and future HTML elements, since all HTML elements are a single word. + +{% raw %}
{% endraw %} +#### Bad + +``` js +Vue.component('todo', { + // ... +}) +``` + +``` js +export default { + name: 'Todo', + // ... +} +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` js +Vue.component('todo-item', { + // ... +}) +``` + +``` js +export default { + name: 'TodoItem', + // ... +} +``` +{% raw %}
{% endraw %} + + + +### Component data essential + +**Component `data` must be a function.** + +When using the `data` property on a component (i.e. anywhere except on `new Vue`), the value must be a function that returns an object. + +{% raw %} +
+ +

Detailed Explanation

+
+{% endraw %} + +When the value of `data` is an object, it's shared across all instances of a component. Imagine, for example, a `TodoList` component with this data: + +``` js +data: { + listTitle: '', + todos: [] +} +``` + +We might want to reuse this component, allowing users to maintain multiple lists (e.g. for shopping, wishlists, daily chores, etc). There's a problem though. Since every instance of the component references the same data object, changing the title of one list will also change the title of every other list. The same is true for adding/editing/deleting a todo. + +Instead, we want each component instance to only manage its own data. For that to happen, each instance must generate a unique data object. In JavaScript, this can be accomplished by returning the object in a function: + +``` js +data: function () { + return { + listTitle: '', + todos: [] + } +} +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Bad + +``` js +Vue.component('some-comp', { + data: { + foo: 'bar' + } +}) +``` + +``` js +export default { + data: { + foo: 'bar' + } +} +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good +``` js +Vue.component('some-comp', { + data: function () { + return { + foo: 'bar' + } + } +}) +``` + +``` js +// In a .vue file +export default { + data () { + return { + foo: 'bar' + } + } +} +``` + +``` js +// It's OK to use an object directly in a root +// Vue instance, since only a single instance +// will ever exist. +new Vue({ + data: { + foo: 'bar' + } +}) +``` +{% raw %}
{% endraw %} + + + +### Prop definitions essential + +**Prop definitions should be as detailed as possible.** + +In committed code, prop definitions should always be as detailed as possible, specifying at least type(s). + +{% raw %} +
+ +

Detailed Explanation

+
+{% endraw %} + +Detailed [prop definitions](https://vuejs.org/v2/guide/components.html#Prop-Validation) have two advantages: + +- They document the API of the component, so that it's easy to see how the component is meant to be used. +- In development, Vue will warn you if a component is ever provided incorrectly formatted props, helping you catch potential sources of error. + +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Bad + +``` js +// This is only OK when prototyping +props: ['status'] +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` js +props: { + status: String +} +``` + +``` js +// Even better! +props: { + status: { + type: String, + required: true, + validate: function (value) { + return [ + 'syncing', + 'synced', + 'version-conflict', + 'error' + ].indexOf(value) !== -1 + } + } +} +``` +{% raw %}
{% endraw %} + + + +### Keyed `v-for` essential + +**Always use `key` with `v-for`.** + +`key` with `v-for` is _always_ required on components, in order to maintain internal component state down the subtree. Even for elements though, it's a good practice to maintain predictable behavior, such as [object constancy](https://bost.ocks.org/mike/constancy/) in animations. + +{% raw %} +
+ +

Detailed Explanation

+
+{% endraw %} + +Let's say you have a list of todos: + +``` js +data: function () { + return { + todos: [ + { + id: 1, + text: 'Learn to use v-for' + }, + { + id: 2, + text: 'Learn to use key' + } + ] + } +} +``` + +Then you sort them alphabetically. When updating the DOM, Vue will optimize rendering to perform the cheapest DOM mutations possible. That might mean deleting the first todo element, then adding it again at the end of the list. + +The problem is, there are cases where it's important not to delete elements that will remain in the DOM. For example, you may want to use `` to animate list sorting, or maintain focus if the rendered element is an ``. In these cases, adding a unique key for each item (e.g. `:key="todo.id"`) will tell Vue how to behave more predictably. + +In our experience, it's better to _always_ add a unique key, so that you and your team simply never have to worry about these edge cases. Then in the rare, performance-critical scenarios where object constancy isn't necessary, you can make a conscious exception. + +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Bad + +``` html + +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` html + +``` +{% raw %}
{% endraw %} + + + +### Component style scoping essential + +**For applications, styles in a top-level `App` component and in layout components may be global, but all other components should always be scoped.** + +This is only relevant for [single-file components](single-file-components.html). It does _not_ require that the [`scoped` attribute](https://vue-loader.vuejs.org/en/features/scoped-css.html) be used. Scoping could be through [CSS modules](https://vue-loader.vuejs.org/en/features/css-modules.html), a class-based strategy such as [BEM](http://getbem.com/), or another library/convention. + +**Component libraries, however, should prefer a class-based strategy instead of using the `scoped` attribute.** + +This makes overriding internal styles easier, with human-readable class names that don't have too high specificity, but are still very unlikely to result in a conflict. + +{% raw %} +
+ +

Detailed Explanation

+
+{% endraw %} + +If you are developing a large project, working with other developers, or sometimes include 3rd-party HTML/CSS (e.g. from Auth0), consistent scoping will ensure that your styles only apply to the components they are meant for. + +Beyond the `scoped` attribute, using unique class names can help ensure that 3rd-party CSS does not apply to your own HTML. For example, many projects use the `button`, `btn`, or `icon` class names, so even if not using a strategy such as BEM, adding an app-specific and/or component-specific prefix (e.g. `ButtonClose-icon`) can provide some protection. + +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Bad + +``` html + + + +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` html + + + + +``` + +``` html + + + + +``` + +``` html + + + + +``` +{% raw %}
{% endraw %} + + + +### Private property names essential + +**Always use the `$_` prefix for custom private properties in a plugin, mixin, etc. Then to avoid conflicts with code by other authors, also include a named scope (e.g. `$_yourPluginName_`).** + +{% raw %} +
+ +

Detailed Explanation

+
+{% endraw %} + +Vue uses the `_` prefix to define its own private properties, so using the same prefix (e.g. `_update`) risks overwriting an instance property. Even if you check and Vue is not currently using a particular property name, there is no guarantee a conflict won't arise in a later version. + +As for the `$` prefix, it's purpose within the Vue ecosystem is special instance properties that are exposed to the user, so using it for _private_ properties would not be appropriate. + +Instead, we recommend combining the two prefixes into `$_`, as a convention for user-defined private properties that guarantee no conflicts with Vue. + +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Bad + +``` js +var myGreatMixin = { + // ... + methods: { + update: function () { + // ... + } + } +} +``` + +``` js +var myGreatMixin = { + // ... + methods: { + _update: function () { + // ... + } + } +} +``` + +``` js +var myGreatMixin = { + // ... + methods: { + $update: function () { + // ... + } + } +} +``` + +``` js +var myGreatMixin = { + // ... + methods: { + $_update: function () { + // ... + } + } +} +``` + +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` js +var myGreatMixin = { + // ... + methods: { + $_myGreatMixin_update: function () { + // ... + } + } +} +``` +{% raw %}
{% endraw %} + + + +## Priority B Rules: Strongly Recommended (Improving Readability) + + + +### Component files strongly recommended + +**Whenever a build system is available to concatenate files, each component should be in its own file.** + +This helps you to more quickly find a component when you need to edit it or review how to use it. + +{% raw %}
{% endraw %} +#### Bad + +``` js +Vue.component('TodoList', { + // ... +}) + +Vue.component('TodoItem', { + // ... +}) +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` +components/ +|- TodoList.js +|- TodoItem.js +``` + +``` +components/ +|- TodoList.vue +|- TodoItem.vue +``` +{% raw %}
{% endraw %} + + + +### Single-file component filename casing strongly recommended + +**Filenames of [single-file components](single-file-components.html) should either be always PascalCase or always kebab-case.** + +PascalCase works best with autocompletion in code editors, as it's consistent with how we reference components in JS(X) and templates, wherever possible. However, mixed case filenames can sometimes create issues on case-insensitive filesystems, which is why kebab-case is also perfectly acceptable. + +{% raw %}
{% endraw %} +#### Bad + +``` +components/ +|- mycomponent.vue +``` + +``` +components/ +|- myComponent.vue +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` +components/ +|- MyComponent.vue +``` + +``` +components/ +|- my-component.vue +``` +{% raw %}
{% endraw %} + + + +### Base component names strongly recommended + +**Base components (a.k.a. presentational, dumb, or pure components) that apply app-specific styling and conventions should all begin with a specific prefix, such as `Base`, `App`, or `V`.** + +{% raw %} +
+ +

Detailed Explanation

+
+{% endraw %} + +These components lay the foundation for consistent styling and behavior in your application. They may **only** contain: + +- HTML elements, +- other `Base`-prefixed components, and +- 3rd-party UI components. + +But they'll **never** contain global state (e.g. from a Vuex store). + +Their names often include the name of an element they wrap (e.g. `BaseButton`, `BaseTable`), unless no element exists for their specific purpose (e.g. `BaseIcon`). If you build similar components for a more specific context, they will almost always consume these components (e.g. `BaseButton` may be used in `ButtonSubmit`). + +Some advantages of this convention: + +- When organized alphabetically in editors, your app's base components are all listed together, making them easier to identify. + +- Since component names should always be multi-word, this convention prevents you from having to choose an arbitrary prefix for simple component wrappers (e.g. `MyButton`, `VueButton`). + +- Since these components are so frequently used, you may want to simply make them global instead of importing them everywhere. A prefix makes this possible with Webpack: + + ``` js + var requireComponent = require.context("./src", true, /^Base[A-Z]/) + requireComponent.keys().forEach(function (fileName) { + var baseComponentConfig = requireComponent(fileName) + baseComponentConfig = baseComponentConfig.default || baseComponentConfig + var baseComponentName = baseComponentConfig.name || ( + fileName + .replace(/^.+\//, '') + .replace(/\.\w+$/, '') + ) + Vue.component(baseComponentName, baseComponentConfig) + }) + ``` + +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Bad + +``` +components/ +|- MyButton.vue +|- VueTable.vue +|- Icon.vue +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` +components/ +|- BaseButton.vue +|- BaseTable.vue +|- BaseIcon.vue +``` + +``` +components/ +|- AppButton.vue +|- AppTable.vue +|- AppIcon.vue +``` + +``` +components/ +|- VButton.vue +|- VTable.vue +|- VIcon.vue +``` +{% raw %}
{% endraw %} + + + +### Single-instance component names strongly recommended + +**Components that should only ever have a single active instance should begin with the `The` prefix, to denote that there can be only one.** + +This does not mean the component is only used in a single page, but it will only be used once _per page_. These components never accept any props, since they are specific to your app, not their context within your app. If you find the need to add props, it's a good indication that this is actually a reusable component that is only used once per page _for now_. + +{% raw %}
{% endraw %} +#### Bad + +``` +components/ +|- Heading.vue +|- MySidebar.vue +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` +components/ +|- TheHeading.vue +|- TheSidebar.vue +``` +{% raw %}
{% endraw %} + + + +### Tightly coupled component names strongly recommended + +**Child components that are tightly coupled with their parent should include the parent component name as a prefix.** + +If a component only makes sense in the context of a single parent component, that relationship should be evident in its name. Since editors typically organize files alphabetically, this also keeps these related files next to each other. + +{% raw %}
{% endraw %} +#### Bad + +``` +components/ +|- TodoList.vue +|- TodoItem.vue +|- TodoButton.vue +``` + +``` +components/ +|- SearchSidebar.vue +|- NavigationForSearchSidebar.vue +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` +components/ +|- TodoList.vue +|- TodoListItem.vue +|- TodoListItemButton.vue +``` + +``` +components/ +|- SearchSidebar.vue +|- SearchSidebarNavigation.vue +``` +{% raw %}
{% endraw %} + + + +### Order of words in component names strongly recommended + +**Component names should start with the highest-level (often most general) words and end with descriptive modifying words.** + +{% raw %} +
+ +

Detailed Explanation

+
+{% endraw %} + +You may be wondering: + +> "Why would we force component names to use less natural language?" + +In natural English, adjectives and other descriptors do typically appear before the nouns, while exceptions require connector words. For example: + +- Coffee _with_ milk +- Soup _of the_ day +- Visitor _to the_ museum + +You can definitely include these connector words in component names if you'd like, but the order is still important. + +Also note that **what's considered "highest-level" will be contextual to your app**. For example, imagine an app with a search form. It may include components like this one: + +``` +components/ +|- ClearSearchButton.vue +|- ExcludeFromSearchInput.vue +|- LaunchOnStartupCheckbox.vue +|- RunSearchButton.vue +|- SearchInput.vue +|- TermsCheckbox.vue +``` + +As you might notice, it's quite difficult to see which components are specific to the search. Now let's rename the components according to the rule: + +``` +components/ +|- SearchButtonClear.vue +|- SearchButtonRun.vue +|- SearchInputExcludeGlob.vue +|- SearchInputQuery.vue +|- SettingsCheckboxLaunchOnStartup.vue +|- SettingsCheckboxTerms.vue +``` + +Since editors typically organize files alphabetically, all the important relationships between components are now evident at a glance. + +You might be tempted to solve this problem differently, nesting all the search components under a "search" directory, then all the settings components under a "settings" directory. We only recommend considering this approach in very large apps (e.g. 100+ components), for these reasons: + +- It generally takes more time to navigate through nested sub-directories, than scrolling through a single `components` directory. +- Name conflicts (e.g. multiple `ButtonDelete.vue` components) make it more difficult to quickly navigate to a specific component in a code editor. +- Refactoring becomes more difficult, because find-and-replace often isn't sufficient to update relative references to a moved component. + +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Bad + +``` +components/ +|- ClearSearchButton.vue +|- ExcludeFromSearchInput.vue +|- LaunchOnStartupCheckbox.vue +|- RunSearchButton.vue +|- SearchInput.vue +|- TermsCheckbox.vue +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` +components/ +|- SearchButtonClear.vue +|- SearchButtonRun.vue +|- SearchInputQuery.vue +|- SearchInputExcludeGlob.vue +|- SettingsCheckboxTerms.vue +|- SettingsCheckboxLaunchOnStartup.vue +``` +{% raw %}
{% endraw %} + + + +### Self-closing components strongly recommended + +**Components with no content should be self-closing in [single-file components](single-file-components.html), string templates, and [JSX](render-function.html#JSX) - but never in DOM templates.** + +Components that self-close communicate that they not only have no content, but are **meant** to have no content. It's the difference between a blank page in a book and one labeled "This page intentionally left blank." Your code is also cleaner without the unnecessary closing tag. + +Unfortunately, HTML doesn't allow custom elements to be self-closing - only [official "void" elements](https://www.w3.org/TR/html/syntax.html#void-elements). That's why the strategy is only possible when Vue's template compiler can reach the template before the DOM, then serve the DOM spec-compliant HTML. + +{% raw %}
{% endraw %} +#### Bad + +``` html + + +``` + +``` html + + +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` html + + +``` + +``` html + + +``` +{% raw %}
{% endraw %} + + + +### Component name casing in templates strongly recommended + +**Component names should always be PascalCase in [single-file components](single-file-components.html) and string templates - but kebab-case in DOM templates.** + +PascalCase in templates improves readability, because it's easier to tell at a glance what's an element and what's a component. Unfortunately, PascalCase is invalid for a custom element in HTML, so a DOM template must still use kebab-case. + +{% raw %}
{% endraw %} +#### Bad + +``` html + + +``` + +``` html + + +``` + +``` html + + +``` + +``` html + + +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` html + + +``` + +``` html + + +``` +{% raw %}
{% endraw %} + + + +### Component name casing in JS/JSX strongly recommended + +**Component names in JS/[JSX](render-function.html#JSX) should always be PascalCase, though may be kebab-case inside strings for simpler applications that only use global component registration through `Vue.component`.** + +{% raw %} +
+ +

Detailed Explanation

+
+{% endraw %} + +In JavaScript, PascalCase is the convention for classes and prototype constructors - essentially, anything that can have distinct instances. Vue components also have instances, so it makes sense to also use PascalCase. As an added benefit, using PascalCase within JSX (and templates) allows readers of the code to more easily distinguish between components and HTML elements. + +However, for applications that use **only** global component definitions via `Vue.component`, we recommend kebab-case instead. The reasons are: + +- It's rare that global components are ever referenced in JavaScript, so following a convention for JavaScript makes less sense. +- These applications always include many in-DOM components, where kebab-case [**must** be used](#Component-name-casing-in-templates). +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Bad + +``` js +Vue.component('myComponent', { + // ... +}) +``` + +``` js +import myComponent from './MyComponent.vue' +``` + +``` js +export default { + name: 'myComponent', + // ... +} +``` + +``` js +export default { + name: 'my-component', + // ... +} +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` js +Vue.component('MyComponent', { + // ... +}) +``` + +``` js +Vue.component('my-component', { + // ... +}) +``` + +``` js +import MyComponent from './MyComponent.vue' +``` + +``` js +export default { + name: 'MyComponent', + // ... +} +``` +{% raw %}
{% endraw %} + + + +### Abbreviations in component names strongly recommended + +**Component names should prefer full words over abbreviations.** + +The autocompletion in editors make the cost of writing longer names very low, while the clarity they provide is invaluable. Uncommon abbreviations, in particular, should always be avoided. + +{% raw %}
{% endraw %} +#### Bad + +``` +components/ +|- SdSettings.vue +|- UProfOpts.vue +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` +components/ +|- StudentDashboardSettings.vue +|- UserProfileOptions.vue +``` +{% raw %}
{% endraw %} + + + +### Prop name casing strongly recommended + +**Prop names should always use camelCase during declaration, but kebab-case in templates and [JSX](render-function.html#JSX).** + +We're simply following the conventions of each language. Within JavaScript, camelCase is more natural. Within HTML, kebab-case is. + +{% raw %}
{% endraw %} +#### Bad + +``` js +props: { + 'greeting-text': String +} +``` + +``` html + +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` js +props: { + greetingText: String +} +``` + +``` html + +``` +{% raw %}
{% endraw %} + + + +### Multi-attribute elements strongly recommended + +**Elements with multiple attributes should span multiple lines, with one attribute per line.** + +In JavaScript, splitting objects with multiple properties over multiple lines is widely considered a good convention, because it's much easier to read. Our templates and [JSX](render-function.html#JSX) deserve the same consideration. + +{% raw %}
{% endraw %} +#### Bad + +``` html +Vue Logo +``` + +``` html + +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` html +Vue Logo +``` + +``` html + +``` +{% raw %}
{% endraw %} + + + +### Complex expressions in templates strongly recommended + +**Component templates should only include simple expressions, with more complex expressions refactored into computed properties or methods.** + +Complex expressions in your templates make them less declarative. We should strive to describe _what_ should appear, not _how_ we're computing that value. Computed properties and methods also allow the code to be reused. + +{% raw %}
{% endraw %} +#### Bad + +``` html +{{ + fullName.split(' ').map(function (word) { + return word[0].toUpperCase() + word.slice(1) + }).join(' ') +}} +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` html + +{{ normalizedFullName }} +``` + +``` js +// The complex expression has been moved to a computed property +computed: { + normalizedFullName: function () { + return this.fullName.split(' ').map(function (word) { + return word[0].toUpperCase() + word.slice(1) + }).join(' ') + } +} +``` +{% raw %}
{% endraw %} + + + +### Complex computed properties strongly recommended + +**Complex computed properties should be split into as many simpler properties as possible.** + +{% raw %} +
+ +

Detailed Explanation

+
+{% endraw %} + +Simpler, well-named computed properties are: + +- __Easier to test__ + + When each computed property contains only a very simple expression, with very few dependencies, it's much easier to write tests confirming that it works correctly. + +- __Easier to read__ + + Simplifying computed properties forces you to give each value a descriptive name, even if it's not reused. This makes it much easier for other developers (and future you) to focus in on the code they care about and figure out what's going on. + +- __More adaptable to changing requirements__ + + Any value that can be named might be useful to the view. For example, we might decide to display a message telling the user how much money they saved. We might also decide to calculate sales tax, but perhaps display it separately, rather than as part of the final price. + + Small, focused computed properties make fewer assumptions about how information will be used, so require less refactoring as requirements change. + +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Bad + +``` js +computed: { + price: function () { + var basePrice = this.manufactureCost / (1 - this.profitMargin) + return ( + basePrice - + basePrice * (this.discountPercent || 0) + ) + } +} +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` js +computed: { + basePrice: function () { + return this.manufactureCost / (1 - this.profitMargin) + }, + discount: function () { + return this.basePrice * (this.discountPercent || 0) + }, + finalPrice: function () { + return this.basePrice - this.discount + } +} +``` +{% raw %}
{% endraw %} + + + +### Quoted attribute values strongly recommended + +**Non-empty HTML attribute values should always be inside quotes (single or double, whichever is not used in JS).** + +While attribute values without any spaces are not required to have quotes in HTML, this practice often leads to _avoiding_ spaces, making attribute values less readable. + +{% raw %}
{% endraw %} +#### Bad + +``` html + +``` + +``` html + +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` html + +``` + +``` html + +``` +{% raw %}
{% endraw %} + + + +### Directive shorthands strongly recommended + +**Directive shorthands (`:` for `v-bind:` and `@` for `v-on:`) should be used always or never.** + +{% raw %}
{% endraw %} +#### Bad + +``` html + +``` + +``` html + +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` html + +``` + +``` html + +``` + +``` html + +``` + +``` html + +``` +{% raw %}
{% endraw %} + + + +## Priority C Rules: Recommended (Minimizing Arbitrary Choices and Cognitive Overhead) + + + +### Component/instance options order recommended + +**Component/instance options should be ordered consistently.** + +This is the default order we recommend for component options. They're split into categories, so you'll know where to add new properties from plugins. + +1. **Side Effects** (triggers effects outside the component) + - `el` + +2. **Global Awareness** (requires knowledge beyond the component) + - `name` + - `parent` + +3. **Component Type** (changes the type of the component) + - `functional` + +4. **Template Modifiers** (changes the way templates are compiled) + - `delimiters` + - `comments` + +5. **Template Dependencies** (assets used in the template) + - `components` + - `directives` + - `filters` + +6. **Composition** (merges properties into the options) + - `extends` + - `mixins` + +7. **Interface** (the interface to the component) + - `inheritAttrs` + - `model` + - `props`/`propsData` + +8. **Local State** (local reactive properties) + - `data` + - `computed` + +9. **Events** (callbacks triggered by reactive events) + - `watch` + - Lifecycle Events (in the order they are called) + +10. **Non-Reactive Properties** (instance properties independent of the reactivity system) + - `methods` + +11. **Rendering** (the declarative description of the component output) + - `template`/`render` + - `renderError` + + + +### Element attribute order recommended + +**The attributes of elements (including components) should be ordered consistently.** + +This is the default order we recommend for component options. They're split into categories, so you'll know where to add custom attributes and directives. + +1. **Definition** (provides the component options) + - `is` + +2. **List Rendering** (creates multiple variations of the same element) + - `v-for` + +2. **Conditionals** (whether the element is rendered/shown) + - `v-if` + - `v-else-if` + - `v-else` + - `v-show` + - `v-cloak` + +3. **Render Modifiers** (changes the way the element renders) + - `v-pre` + - `v-once` + +4. **Global Awareness** (requires knowledge beyond the component) + - `id` + +5. **Unique Attributes** (attributes that require unique values) + - `ref` + - `key` + - `slot` + +6. **Two-Way Binding** (combining binding and events) + - `v-model` + +7. **Other Attributes** (all unspecified bound & unbound attributes) + +8. **Events** (component event listeners) + - `v-on` + +9. **Content** (overrides the content of the element) + - `v-html` + - `v-text` + + + +### Empty lines in component/instance options recommended + +**You may want to add one empty line between multi-line properties, particularly if the options can no longer fit on your screen without scrolling.** + +When components begin to feel cramped or difficult to read, adding spaces between multi-line properties can make them easier to skim again. In some editors, such as Vim, formatting options like this can also make them easier to navigate with the keyboard. + +{% raw %}
{% endraw %} +#### Good + +``` js +props: { + value: { + type: String, + required: true + }, + + focused: { + type: Boolean, + default: false + }, + + label: String, + icon: String +}, + +computed: { + formattedValue: function () { + // ... + }, + + inputClasses: function () { + // ... + } +} +``` + +``` js +// No spaces are also fine, as long as the component +// is still easy to read and navigate. +props: { + value: { + type: String, + required: true + }, + focused: { + type: Boolean, + default: false + }, + label: String, + icon: String +}, +computed: { + formattedValue: function () { + // ... + }, + inputClasses: function () { + // ... + } +} +``` +{% raw %}
{% endraw %} + + + +### Single-file component top-level element order recommended + +**[Single-file components](single-file-components.html) should always order `template`, `script`, and `style` tags consistently, with ` + + +``` + +``` html + + + + + + + + + +``` +{% raw %}{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` html + + + + + + + + + +``` + +``` html + + + + + + + + + +``` +{% raw %}
{% endraw %} + + + +## Priority D Rules: Use with Caution (Potentially Dangerous Patterns) + + + +### `v-if`/`v-if-else`/`v-else` without `key` use with caution + +**It's usually best to use `key` with `v-if` + `v-else`, if they are the same element type (e.g. both `
` elements).** + +By default, Vue updates the DOM as efficiently as possible. That means when switching between elements of the same type, it simply patches the existing element, rather than removing it and adding a new one in its place. This can have [unintended side effects](https://jsfiddle.net/chrisvfritz/bh8fLeds/) if these elements should not actually be considered the same. + +{% raw %}
{% endraw %} +#### Bad + +``` html +
+ Error: {{ error }} +
+
+ {{ results }} +
+``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` html +
+ Error: {{ error }} +
+
+ {{ results }} +
+``` + +``` html +

+ Error: {{ error }} +

+
+ {{ results }} +
+``` +{% raw %}
{% endraw %} + + + +### Element selectors with `scoped` use with caution + +**Element selectors should be avoided with `scoped`.** + +Prefer class selectors over element selectors in `scoped` styles, because large numbers of element selectors are slow. + +{% raw %} +
+ +

Detailed Explanation

+
+{% endraw %} + +To scope styles, Vue adds a unique attribute to component elements, such as `data-v-f3f3eg9`. Then selectors are modified so that only matching elements with this attribute are selected (e.g. `button[data-v-f3f3eg9]`). + +The problem is that large numbers of [element-attribute selectors](http://stevesouders.com/efws/css-selectors/csscreate.php?n=1000&sel=a%5Bhref%5D&body=background%3A+%23CFD&ne=1000) (e.g. `button[data-v-f3f3eg9]`) will be considerably slower than [class-attribute selectors](http://stevesouders.com/efws/css-selectors/csscreate.php?n=1000&sel=.class%5Bhref%5D&body=background%3A+%23CFD&ne=1000) (e.g. `.btn-close[data-v-f3f3eg9]`), so class selectors should be preferred whenever possible. + +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Bad + +``` html + + + +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` html + + + +``` +{% raw %}
{% endraw %} + + + +### Parent-child communication use with caution + +**Props and events should be preferred for parent-child component communication, instead of `this.$parent` or mutating props.** + +An ideal Vue application is props down, events up. Sticking to this convention makes your components much easier to understand. However, there are edge cases where prop mutation or `this.$parent` can simplify two components that are already deeply coupled. + +The problem is, there are also many _simple_ cases where these patterns may offer convenience. Beware: do not be seduced into trading simplicity (being able to understand the flow of your state) for short-term convenience (writing less code). + +{% raw %}
{% endraw %} +#### Bad + +``` js +Vue.component('TodoItem', { + props: { + todo: { + type: Object, + required: true + } + }, + template: '' +}) +``` + +``` js +Vue.component('TodoItem', { + props: { + todo: { + type: Object, + required: true + } + }, + methods: { + removeTodo () { + var vm = this + vm.$parent.todos = vm.$parent.todos.filter(function (todo) { + return todo.id !== vm.todo.id + }) + } + }, + template: ` + + {{ todo.text }} + + + ` +}) +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` js +Vue.component('TodoItem', { + props: { + todo: { + type: Object, + required: true + } + }, + template: ` + + ` +}) +``` + +``` js +Vue.component('TodoItem', { + props: { + todo: { + type: Object, + required: true + } + }, + template: ` + + {{ todo.text }} + + + ` +}) +``` +{% raw %}
{% endraw %} + + + +### Global state management use with caution + +**[Vuex](https://github.com/vuejs/vuex) should be preferred for global state management, instead of `this.$root` or a global event bus.** + +Managing state on `this.$root` and/or using a [global event bus](https://vuejs.org/v2/guide/migration.html#dispatch-and-broadcast-replaced) can be convenient for very simple cases, but are not appropriate for most applications. Vuex offers not only a central place to manage state, but also tools for organizing, tracking, and debugging state changes. + +{% raw %}{% endraw %} + +{% raw %}
{% endraw %} +#### Bad + +``` js +// main.js +new Vue({ + data: { + todos: [] + }, + created: function () { + this.$on('remove-todo', this.removeTodo) + }, + methods: { + removeTodo: function (todo) { + var todoIdToRemove = todo.id + this.todos = this.todos.filter(function (todo) { + return todo.id !== todoIdToRemove + }) + } + } +}) +``` +{% raw %}
{% endraw %} + +{% raw %}
{% endraw %} +#### Good + +``` js +// store/modules/todos.js +export default { + state: { + list: [] + }, + mutations: { + REMOVE_TODO (state, todoId) { + state.list = state.list.filter(todo => todo.id !== todoId) + } + }, + actions: { + removeTodo ({ commit, state }, todo) { + commit('REMOVE_TODO', todo.id) + } + } +} +``` + +``` html + + + + +``` +{% raw %}
{% endraw %} + + + +{% raw %} + +{% endraw %} diff --git a/themes/vue/layout/layout.ejs b/themes/vue/layout/layout.ejs index ff8eae43d8..e86cea6759 100644 --- a/themes/vue/layout/layout.ejs +++ b/themes/vue/layout/layout.ejs @@ -1,4 +1,5 @@ <% var isIndex = page.path === 'index.html' %> + diff --git a/themes/vue/layout/partials/learn_dropdown.ejs b/themes/vue/layout/partials/learn_dropdown.ejs index ad19fcabac..445fe7e96f 100644 --- a/themes/vue/layout/partials/learn_dropdown.ejs +++ b/themes/vue/layout/partials/learn_dropdown.ejs @@ -1,10 +1,11 @@ diff --git a/themes/vue/layout/partials/sidebar.ejs b/themes/vue/layout/partials/sidebar.ejs index 6906e81ccc..09ac641a08 100644 --- a/themes/vue/layout/partials/sidebar.ejs +++ b/themes/vue/layout/partials/sidebar.ejs @@ -14,8 +14,14 @@ Become a Sponsor

- <%- type === 'api' ? 'API' : (type.charAt(0).toUpperCase() + type.slice(1)) %> - <% if (type !== 'cookbook') { %> + <%- + type === 'api' + ? 'API' + : type === 'style-guide' + ? 'Style Guidebeta' + : (type.charAt(0).toUpperCase() + type.slice(1)) + %> + <% if (['cookbook', 'style-guide'].indexOf(type) === -1) { %>