-
-
Notifications
You must be signed in to change notification settings - Fork 679
Require key for conditionally rendered repeated components #2280
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
ota-meshi
merged 30 commits into
vuejs:master
from
felipemelendez:require-key-for-conditionally-rendered-repeated-components
Nov 30, 2023
Merged
Changes from 20 commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
76ae5c7
create rule
felipemelendez 11769be
create tests
felipemelendez 7899246
add docs
felipemelendez a02a577
fix spacing
felipemelendez b7a7cbb
slots are abstract outlets and can possibly expand into multiple elem…
felipemelendez 17323fa
add test for slot exclusion
felipemelendez a5d7879
use more efficient Set rather than Array
felipemelendez 308e2a1
change vue 3 to vue 2
felipemelendez 0daeb91
target custom components
felipemelendez c4871c6
rename
felipemelendez 4aac97a
Merge branch 'master' into require-key-for-conditionally-rendered-rep…
felipemelendez 88d57d4
proper name updating
felipemelendez 4515954
Merge remote-tracking branch 'origin/require-key-for-conditionally-re…
felipemelendez c659339
removed references to html container elements
felipemelendez c89efd8
added test
felipemelendez 1f81ded
Merge branch 'master' into require-key-for-conditionally-rendered-rep…
felipemelendez d1b5039
add valid test case
felipemelendez fdd59a5
add Related rule link to require-v-for-key and vice-versa
felipemelendez 92bdc2f
remove md extension from brackets
felipemelendez 3212653
turned off formatting settings so I can submit this - changing the th…
felipemelendez 1206bbd
make if attribute required and finetune docstrings
felipemelendez 8da18db
fix type
felipemelendez a8709d7
fix condition
felipemelendez f039fb7
use double quotes
felipemelendez 2ff3a5f
fix conditional family completeness logic and add test
felipemelendez 608b4b9
reform helper function - exists only to ease code readability
felipemelendez 42500ce
inline logic for conditional family formation
felipemelendez 51cef47
match test file name with rule name
felipemelendez e6d5c92
move conditionalFamilies map into create function
felipemelendez ceab4c3
Merge branch 'master' into require-key-for-conditionally-rendered-rep…
felipemelendez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
pageClass: rule-details | ||
sidebarDepth: 0 | ||
title: vue/v-if-else-key | ||
description: require key attribute for conditionally rendered repeated components | ||
--- | ||
|
||
# vue/v-if-else-key | ||
|
||
> require key attribute for conditionally rendered repeated components | ||
|
||
- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> ***This rule has not been released yet.*** </badge> | ||
- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. | ||
|
||
## :book: Rule Details | ||
|
||
This rule checks for components that are both repeated and conditionally rendered within the same scope. If such a component is found, the rule then checks for the presence of a 'key' directive. If the 'key' directive is missing, the rule issues a warning and offers a fix. | ||
|
||
This rule is not required in Vue 3, as the key is automatically assigned to the elements. | ||
|
||
<eslint-code-block fix :rules="{'vue/v-if-else-key': ['error']}"> | ||
|
||
```vue | ||
<template> | ||
<!-- ✓ GOOD --> | ||
<my-component v-if="condition1" :key="one" /> | ||
<my-component v-else-if="condition2" :key="two" /> | ||
<my-component v-else :key="three" /> | ||
|
||
<!-- ✗ BAD --> | ||
<my-component v-if="condition1" /> | ||
<my-component v-else-if="condition2" /> | ||
<my-component v-else /> | ||
</template> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
## :wrench: Options | ||
|
||
Nothing. | ||
|
||
## :couple: Related Rules | ||
|
||
- [vue/require-v-for-key] | ||
|
||
[vue/require-v-for-key]: ./require-v-for-key.md | ||
|
||
## :books: Further Reading | ||
|
||
- [Guide (for v2) - v-if without key](https://v2.vuejs.org/v2/style-guide/#v-if-v-else-if-v-else-without-key-use-with-caution) | ||
|
||
## :mag: Implementation | ||
|
||
- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/v-if-else-key.js) | ||
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/v-if-else-key.js) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.