forked from vuejs-kr/kr.vuejs.org
-
Notifications
You must be signed in to change notification settings - Fork 7
/
index.md
2060 lines (1561 loc) · 52.4 KB
/
index.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
title: Style Guide
type: style-guide
---
# 스타일 가이드
이 문서는 Vue 코드에 대한 공식 스타일 가이드입니다. 만약 현재 Vue를 사용하여 프로젝트를 진행중이라면 이 문서는 에러와 바이크쉐딩(bikeshedding), 안티패턴을 피하는 좋은 참조가 될것 입니다. 그러나 이 문서에서 제시하는 스타일 가이드가 당신의 프로젝트에 무조건 적합한 것은 아닙니다. 그러므로 당신의 경험과 기술스택, 개인적 통찰력을 바탕으로 이 스타일 가이드가 적용되는 것을 권장해드립니다.
대부분의 경우 우리는 HTML과 자바스크립트에 대한 제안은 일반적으로 피합니다. 우리는 당신이 세미콜론이나 쉼표(trailing commas)에 대한 사용여부는 신경쓰지 않습니다. 우리는 당신이 HTML의 속성값을 위해 작음따옴표를 사용하지는 큰따옴표를 사용하는지 신경쓰지 않습니다. 그러나 특정 패턴이 뷰 컨텍스트에서 유용하다고 발견된 경우 예외가 존재합니다.
> **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.
마지막으로, 우리는 규칙을 4가지 범주로 분류하였습니다.
## 규칙 분류
### 우선순위 A: 필수
이 규칙은 오류를 예방하는데 도움을 주기 때문에 모든 비용을 통해서 학습하고 준수하여야 합니다. 예외상황이 존재하겠지만 매우 드물며 자바스크립트와 뷰에 대한 전문 지식이 있어야 만들 수 있습니다.
### 우선순위 B: 매우 추천함
이 규칙은 대부분의 프로젝트에서 가독성 그리고 개발자경험을 향상시키는 것으로 발견되었습니다. 해당 규칙을 위반해도 코드는 여전히 실행되지만 위반은 드물고 정당합니다.
### 우선순위 C: 추천함
동일하게 좋은 여러가지 옵션이 존재하는 경우, 일관성을 보장하기 위해 임의의 선택을 할 수 있습니다. 이 규칙은 각각의 수용가능한 옵션을 설명하고 기본 선택을 제안합니다. 즉, 일관성 있고 좋은 이유가 있으면 당신의 코드베이스에서 자유롭게 다른 선택을 할 수 있습니다. 좋은 이유가 있어야 합니다! 커뮤니티 표준에 적응되기 위해서 당신은 다음과 같이 해야합니다.
1. 당신이 마주하는 대부분의 커뮤니티 코드를 더 쉽게 분석할 수 있도록 훈련하세요
2. 커뮤니티 코드 예제를 수정하기 한고 복사 그리고 붙혀넣기 할 수 있어야 합니다
3. 적어도 뷰에 있어서는 당신이 선호하는 코딩 스타일을 수용하는 새로운 직원을 자주 찾을 것입니다
### 우선순위 D: 주의요함
뷰의 몇 가지 은 특성은 드문 엣지 케이스 또는 레거시 코드로의 부터 마이크레이션을 위해 존재합니다. 그러나 그것들을 남용하면 당신의 코드를 유지보수하기 어렵게만들거나 버그를 발생시키는 원인이 될 수 있습니다. 이 규칙은 잠재적 위험요소를 인식시켜주고 언제 그리고 왜 피해야되는지 설명해 줍니다.
## 우선순위 A 규칙: 필수 (에러 방지)
### 컴포넌트 이름에 합성어 사용 <sup data-p="a">필수</sup>
**root 컴포넌트인 `App` 과 `<transition>`, `<component>`등 Vue에서 제공되는 빌트인 컴포넌트를 제외하고 컴포넌트의 이름은 항상 합성어를 사용해야한다.**
모든 HTML 엘리먼트의 이름은 한 단어이기 때문에 합성어를 사용하는 것은 기존 그리고 향후 HTML엘리먼트와의 [충돌을 방지해줍니다](http://w3c.github.io/webcomponents/spec/custom/#valid-custom-element-name).
{% raw %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
Vue.component('todo', {
// ...
})
```
``` js
export default {
name: 'Todo',
// ...
}
```
{% raw %}</div>{% endraw %}
{% raw %}<div class="style-example example-good">{% endraw %}
#### 좋음
``` js
Vue.component('todo-item', {
// ...
})
```
``` js
export default {
name: 'TodoItem',
// ...
}
```
{% raw %}</div>{% endraw %}
### 컴포넌트 데이터 <sup data-p="a">필수</sup>
**컴포넌트의 `data` 는 반드시 함수여야 합니다.**
컴포넌트(i.e. `new Vue`를 제외한 모든곳)의 `data` 프로퍼티의 값은 반드시 객체(object)를 반환하는 함수여야 한다.
{% raw %}
<details>
<summary>
<h4>자세한 설명</h4>
</summary>
{% endraw %}
`data` 의 값이 오브젝트일 경우, 컴포넌트의 모든 인스턴스가 공유한다. 예를 들어, 다음 data 를 가진 `TodoList` 컴포넌트를 상상해보자.
``` js
data: {
listTitle: '',
todos: []
}
```
이 컴포넌트는 재사용하여 사용자가 여러 목록(e.g. 쇼핑, 소원, 오늘 할일 등)을 유지할 수 있도록 해야 할 수 있다. 컴포넌트의 모든 인스턴스가 동일한 data 객체를 참조하므로, 하나의 목록의 타이틀을 변경할 때 다른 모든 리스트의 타이틀도 변경될 것이다. Todo를 추가/수정/삭제하는 경우에도 마찬가지다.
대신 우리는 각 컴포넌트의 인스턴스 자체 data만을 관리하기를 원한다. 이렇게 하려면 각 인스턴스는 고유한 data 객체를 생성해야 한다. JavaScript에서는 함수안에서 객체를 반환하는 방법으로 해결할 수 있다:
``` js
data: function () {
return {
listTitle: '',
todos: []
}
}
```
{% raw %}</details>{% endraw %}
{% raw %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
``` js
Vue.component('some-comp', {
data: {
foo: 'bar'
}
})
```
``` js
export default {
data: {
foo: 'bar'
}
}
```
{% raw %}</div>{% endraw %}
{% raw %}<div class="style-example example-good">{% endraw %}
#### 좋음
``` 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 %}</div>{% endraw %}
### Props 정의 <sup data-p="a">필수</sup>
**Prop은 가능한 상세하게 정의되어야 합니다.**
커밋 된 코드에서, prop 정의는 적어도 타입은 명시되도록 가능한 상세하게 정의되어야 합니다.
{% raw %}
<details>
<summary>
<h4>자세한 설명</h4>
</summary>
{% endraw %}
자세한 [prop definitions](https://vuejs.org/v2/guide/components.html#Prop-Validation) 두 가지 이점을 갖는다:
- 이 API는 컴포넌트의 API를 문서화하므로 컴포넌트의 사용 방법을 쉽게 알 수 있다.
- 개발 중에, Vue는 컴포넌트의 타입이 잘못 지정된 props를 전달하면 경고 메시지를 표시하여 오류의 잠재적 원인을 파악할 수 있도록 도와준다.
{% raw %}</details>{% endraw %}
{% raw %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
``` js
// This is only OK when prototyping
props: ['status']
```
{% raw %}</div>{% endraw %}
{% raw %}<div class="style-example example-good">{% endraw %}
#### 좋음
``` js
props: {
status: String
}
```
``` js
// Even better!
props: {
status: {
type: String,
required: true,
validator: function (value) {
return [
'syncing',
'synced',
'version-conflict',
'error'
].indexOf(value) !== -1
}
}
}
```
{% raw %}</div>{% endraw %}
### `v-for` 에 `key` 지정 <sup data-p="a">필수</sup>
**`v-for`는 `key`와 항상 함께 사용합니다.**
서브트리의 내부 컴포넌트 상태를 유지하기 위해 `v-for`는 _항상_ `key`와 함께 요구됩니다. 비록 엘리먼트이긴 하지만 에니메이션의 [객체 불변성](https://bost.ocks.org/mike/constancy/)과 같이 예측 가능한 행동을 유지하는것은 좋은 습관입니다.
{% raw %}
<details>
<summary>
<h4>자세한 설명</h4>
</summary>
{% endraw %}
할일 목록이 있다고 가정 해보자:
``` js
data: function () {
return {
todos: [
{
id: 1,
text: 'Learn to use v-for'
},
{
id: 2,
text: 'Learn to use key'
}
]
}
}
```
그 다음 알파벳순으로 정렬한다. DOM 이 업데이트될 때, Vue는 가능한 적은 DOM 전이(mutations)를 수행하기 위해 렌더링을 최적화한다. 즉, 첫번째 할일 엘리먼트를 지우고, 리스트의 마지막에 다시 추가한다.
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 `<transition-group>` to animate list sorting, or maintain focus if the rendered element is an `<input>`. 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 %}</details>{% endraw %}
{% raw %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
``` html
<ul>
<li v-for="todo in todos">
{{ todo.text }}
</li>
</ul>
```
{% raw %}</div>{% endraw %}
{% raw %}<div class="style-example example-good">{% endraw %}
#### 좋음
``` html
<ul>
<li
v-for="todo in todos"
:key="todo.id"
>
{{ todo.text }}
</li>
</ul>
```
{% raw %}</div>{% endraw %}
### `v-if`와 `v-for`를 동시에 사용하지 마세요 <sup data-p="a">필수</sup>
**`v-for`가 사용된 엘리먼트에 절대 `v-if`를 사용하지 마세요.**
사용 가능해 보이는 두 가지 일반적인 경우가 있습니다:
- 리스트 목록을 필터링하기 위해서 입니다 (e.g. `v-for="user in users" v-if="user.isActive"`). 이 경우 users을 새로운 computed 속성으로 필더링된 목록으로 대체하십시오(e.g. `activeUsers`).
- 숨기기 위해 리스트의 랜더링을 피할 때 입니다 (e.g. `v-for="user in users" v-if="shouldShowUsers"`). 이 경우 `v-if`를 컨테이너 엘리먼트로 옮기세요 (e.g. `ul`, `ol`).
{% raw %}
<details>
<summary>
<h4>자세한 설명</h4>
</summary>
{% endraw %}
When Vue processes directives, `v-for` has a higher priority than `v-if`, so that this template:
``` html
<ul>
<li
v-for="user in users"
v-if="user.isActive"
:key="user.id"
>
{{ user.name }}
</li>
</ul>
```
Will be evaluated similar to:
``` js
this.users.map(function (user) {
if (user.isActive) {
return user.name
}
})
```
So even if we only render elements for a small fraction of users, we have to iterate over the entire list every time we re-render, whether or not the set of active users has changed.
By iterating over a computed property instead, like this:
``` js
computed: {
activeUsers: function () {
return this.users.filter(function (user) {
return user.isActive
})
}
}
```
``` html
<ul>
<li
v-for="user in activeUsers"
:key="user.id"
>
{{ user.name }}
</li>
</ul>
```
다음과 같은 이점을 얻을 수 있다:
- The filtered list will _only_ be re-evaluated if there are relevant changes to the `users` array, making filtering much more efficient.
- Using `v-for="user in activeUsers"`, we _only_ iterate over active users during render, making rendering much more efficient.
- Logic is now decoupled from the presentation layer, making maintenance (change/extension of logic) much easier.
We get similar benefits from updating:
``` html
<ul>
<li
v-for="user in users"
v-if="shouldShowUsers"
:key="user.id"
>
{{ user.name }}
</li>
</ul>
```
to:
``` html
<ul v-if="shouldShowUsers">
<li
v-for="user in users"
:key="user.id"
>
{{ user.name }}
</li>
</ul>
```
By moving the `v-if` to a container element, we're no longer checking `shouldShowUsers` for _every_ user in the list. Instead, we check it once and don't even evaluate the `v-for` if `shouldShowUsers` is false.
{% raw %}</details>{% endraw %}
{% raw %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
``` html
<ul>
<li
v-for="user in users"
v-if="user.isActive"
:key="user.id"
>
{{ user.name }}
</li>
</ul>
```
``` html
<ul>
<li
v-for="user in users"
v-if="shouldShowUsers"
:key="user.id"
>
{{ user.name }}
</li>
</ul>
```
{% raw %}</div>{% endraw %}
{% raw %}<div class="style-example example-good">{% endraw %}
#### 좋음
``` html
<ul>
<li
v-for="user in activeUsers"
:key="user.id"
>
{{ user.name }}
</li>
</ul>
```
``` html
<ul v-if="shouldShowUsers">
<li
v-for="user in users"
:key="user.id"
>
{{ user.name }}
</li>
</ul>
```
{% raw %}</div>{% endraw %}
### 컴포넌트 스타일 스코프 <sup data-p="a">필수</sup>
**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](../guide/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 %}
<details>
<summary>
<h4>자세한 설명</h4>
</summary>
{% 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 %}</details>{% endraw %}
{% raw %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
``` html
<template>
<button class="btn btn-close">X</button>
</template>
<style>
.btn-close {
background-color: red;
}
</style>
```
{% raw %}</div>{% endraw %}
{% raw %}<div class="style-example example-good">{% endraw %}
#### 좋음
``` html
<template>
<button class="button button-close">X</button>
</template>
<!-- Using the `scoped` attribute -->
<style scoped>
.button {
border: none;
border-radius: 2px;
}
.button-close {
background-color: red;
}
</style>
```
``` html
<template>
<button :class="[$style.button, $style.buttonClose]">X</button>
</template>
<!-- Using CSS modules -->
<style module>
.button {
border: none;
border-radius: 2px;
}
.buttonClose {
background-color: red;
}
</style>
```
``` html
<template>
<button class="c-Button c-Button--close">X</button>
</template>
<!-- Using the BEM convention -->
<style>
.c-Button {
border: none;
border-radius: 2px;
}
.c-Button--close {
background-color: red;
}
</style>
```
{% raw %}</div>{% endraw %}
### Private 속성 이름 <sup data-p="a">필수</sup>
**플러그인, mixin 등에서 커스텀 사용자 private 프로터피에는 항상 접두사 `$_`를 사용하라. 그 다음 다른 사람의 코드와 충돌을 피하려면 named scope를 포함하라. (e.g. `$_yourPluginName_`).**
{% raw %}
<details>
<summary>
<h4>자세한 설명</h4>
</summary>
{% 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, its 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 %}</details>{% endraw %}
{% raw %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
``` 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 %}</div>{% endraw %}
{% raw %}<div class="style-example example-good">{% endraw %}
#### 좋음
``` js
var myGreatMixin = {
// ...
methods: {
$_myGreatMixin_update: function () {
// ...
}
}
}
```
``` js
// Even better!
var myGreatMixin = {
// ...
methods: {
publicMethod() {
// ...
myPrivateFunction()
}
}
}
function myPrivateFunction() {
// ...
}
export default myGreatMixin
```
{% raw %}</div>{% endraw %}
## 우선순위 B 규칙: 매우 추천함 (가독성 향상을 위함)
### 컴포넌트 파일 <sup data-p="b">매우 추천함</sup>
**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 %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
``` js
Vue.component('TodoList', {
// ...
})
Vue.component('TodoItem', {
// ...
})
```
{% raw %}</div>{% endraw %}
{% raw %}<div class="style-example example-good">{% endraw %}
#### 좋음
```
components/
|- TodoList.js
|- TodoItem.js
```
```
components/
|- TodoList.vue
|- TodoItem.vue
```
{% raw %}</div>{% endraw %}
### 싱글 파일 컴포넌트 이름 규칙 지정(casing) <sup data-p="b">매우 추천함</sup>
**Filenames of [single-file components](../guide/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 file systems, which is why kebab-case is also perfectly acceptable.
{% raw %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
```
components/
|- mycomponent.vue
```
```
components/
|- myComponent.vue
```
{% raw %}</div>{% endraw %}
{% raw %}<div class="style-example example-good">{% endraw %}
#### 좋음
```
components/
|- MyComponent.vue
```
```
components/
|- my-component.vue
```
{% raw %}</div>{% endraw %}
### 베이스 컴포넌트 이름 <sup data-p="b">매우 추천함</sup>
**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 %}
<details>
<summary>
<h4>자세한 설명</h4>
</summary>
{% endraw %}
These components lay the foundation for consistent styling and behavior in your application. They may **only** contain:
- HTML elements,
- other base 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 %}</details>{% endraw %}
{% raw %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
```
components/
|- MyButton.vue
|- VueTable.vue
|- Icon.vue
```
{% raw %}</div>{% endraw %}
{% raw %}<div class="style-example example-good">{% endraw %}
#### 좋음
```
components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue
```
```
components/
|- AppButton.vue
|- AppTable.vue
|- AppIcon.vue
```
```
components/
|- VButton.vue
|- VTable.vue
|- VIcon.vue
```
{% raw %}</div>{% endraw %}
### 싱글 인스턴스 컴포넌트 이름 <sup data-p="b">매우 추천함</sup>
**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 %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
```
components/
|- Heading.vue
|- MySidebar.vue
```
{% raw %}</div>{% endraw %}
{% raw %}<div class="style-example example-good">{% endraw %}
#### 좋음
```
components/
|- TheHeading.vue
|- TheSidebar.vue
```
{% raw %}</div>{% endraw %}
### 강한 연관성을 가진 컴포넌트 이름 <sup data-p="b">매우 추천함</sup>
**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 %}
<details>
<summary>
<h4>자세한 설명</h4>
</summary>
{% endraw %}
You might be tempted to solve this problem by nesting child components in directories named after their parent. For example:
```
components/
|- TodoList/
|- Item/
|- index.vue
|- Button.vue
|- index.vue
```
or:
```
components/
|- TodoList/
|- Item/
|- Button.vue
|- Item.vue
|- TodoList.vue
```
This isn't recommended, as it results in:
- Many files with similar names, making rapid file switching in code editors more difficult.
- Many nested sub-directories, which increases the time it takes to browse components in an editor's sidebar.
{% raw %}</details>{% endraw %}
{% raw %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
```
components/
|- TodoList.vue
|- TodoItem.vue
|- TodoButton.vue
```
```
components/
|- SearchSidebar.vue
|- NavigationForSearchSidebar.vue
```
{% raw %}</div>{% endraw %}
{% raw %}<div class="style-example example-good">{% endraw %}
#### 좋음
```
components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue
```
```
components/
|- SearchSidebar.vue
|- SearchSidebarNavigation.vue
```
{% raw %}</div>{% endraw %}
### 컴포넌트 이름의 단어 순서 정렬 <sup data-p="b">매우 추천함</sup>
**Component names should start with the highest-level (often most general) words and end with descriptive modifying words.**
{% raw %}
<details>
<summary>
<h4>자세한 설명</h4>
</summary>
{% 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 %}</details>{% endraw %}
{% raw %}<div class="style-example example-bad">{% endraw %}
#### 나쁨
```
components/
|- ClearSearchButton.vue
|- ExcludeFromSearchInput.vue