model

Author: ruojianll

docs/en/_sidebar.md

@@ -11,7 +11,7 @@
     - [Reference](/en/class-component/reference/reference.md)
     - [Watcher](/en/class-component/watcher/watcher.md)
     - [Injection](/en/class-component/injection/injection.md)
-    - [VModel](/en/class-component/v-model/v-model.md)
+    - [Model](/en/class-component/model/model.md)
 - Inheritance
     - [ECMAScript class](/en/inheritance/es-class/es-class.md)
     - [Component](/en/inheritance/component/component.md)

docs/en/class-component/v-model/code-option-name.ts renamed to docs/en/class-component/model/code-option-name.ts

@@ -1,7 +1,6 @@
-import { VModel, Component, Vue } from 'vue-facing-decorator'
+import { Model, Component, Vue } from 'vue-facing-decorator'
 
 /*
-
 Vue options API
 {
     props:{
@@ -27,7 +26,7 @@ In other components:
 
 @Component
 export default class MyComponent extends Vue {
-    @VModel({
+    @Model({
         name: 'value'
     })
     valueAgent!: string

docs/zh-cn/class-component/v-model/code-option-others.ts renamed to docs/en/class-component/model/code-option-others.ts

@@ -1,7 +1,6 @@
-import { VModel, Component, Vue } from 'vue-facing-decorator'
+import { Model, Component, Vue } from 'vue-facing-decorator'
 
 /*
-
 Vue options API
 {
     props:{
@@ -22,20 +21,16 @@ Vue options API
         }
     }
 }
-
 */
 
 /*
-
 In other components:
-
 <MyComponent v-model="foo"></MyComponent>
-
 */
 
 @Component
 export default class MyComponent extends Vue {
-    @VModel({
+    @Model({
         type: String,
         default: 'bar',
         //...

docs/en/class-component/v-model/code-usage.ts renamed to docs/en/class-component/model/code-usage.ts

@@ -1,7 +1,6 @@
-import { VModel, Component, Vue } from 'vue-facing-decorator'
+import { Model, Component, Vue } from 'vue-facing-decorator'
 
 /*
-
 Vue options API
 {
     props:{
@@ -18,19 +17,15 @@ Vue options API
         }
     }
 }
-
 */
 
 /*
-
 In other components:
-
 <MyComponent v-model="foo"></MyComponent>
-
 */
 
 @Component
 export default class MyComponent extends Vue {
-    @VModel
+    @Model
     valueAgent!: string
 }

docs/en/class-component/v-model/v-model.md renamed to docs/en/class-component/model/model.md

@@ -1,6 +1,8 @@
 ## Usage
 
-Use `VModel` decorator to define a model for vue `v-model` or `v-model:foo`. 
+Use `Model` decorator to define a model for vue `v-model` or `v-model:foo`. 
+
+> Alias of old `VModel` decorator. `VModel` will be supported in the future, but we recommend to update to `Model`.
 
 [](./code-usage.ts ':include :type=code typescript')
 

docs/zh-cn/_sidebar.md

@@ -11,7 +11,7 @@
     - [引用](/zh-cn/class-component/reference/reference.md)
     - [监视器](/zh-cn/class-component/watcher/watcher.md)
     - [注入](/zh-cn/class-component/injection/injection.md)
-    - [VModel](/zh-cn/class-component/v-model/v-model.md)
+    - [Model](/zh-cn/class-component/model/model.md)
 - 继承
     - [ECMAScript 类 继承](/zh-cn/inheritance/es-class/es-class.md)
     - [组件 继承](/zh-cn/inheritance/component/component.md)

docs/zh-cn/class-component/v-model/code-option-name.ts renamed to docs/zh-cn/class-component/model/code-option-name.ts

@@ -1,7 +1,6 @@
-import { VModel, Component, Vue } from 'vue-facing-decorator'
+import { Model, Component, Vue } from 'vue-facing-decorator'
 
 /*
-
 Vue options API
 {
     props:{
@@ -21,13 +20,13 @@ Vue options API
 */
 
 /*
-In other components:
+在另一个组件中:
 <MyComponent v-model:value="foo"></MyComponent>
 */
 
 @Component
 export default class MyComponent extends Vue {
-    @VModel({
+    @Model({
         name: 'value'
     })
     valueAgent!: string

docs/en/class-component/v-model/code-option-others.ts renamed to docs/zh-cn/class-component/model/code-option-others.ts

@@ -1,7 +1,6 @@
-import { VModel, Component, Vue } from 'vue-facing-decorator'
+import { Model, Component, Vue } from 'vue-facing-decorator'
 
 /*
-
 Vue options API
 {
     props:{
@@ -22,20 +21,16 @@ Vue options API
         }
     }
 }
-
 */
 
 /*
-
-In other components:
-
+在另一个组件中:
 <MyComponent v-model="foo"></MyComponent>
-
 */
 
 @Component
 export default class MyComponent extends Vue {
-    @VModel({
+    @Model({
         type: String,
         default: 'bar',
         //...

docs/zh-cn/class-component/v-model/code-usage.ts renamed to docs/zh-cn/class-component/model/code-usage.ts

@@ -1,7 +1,6 @@
-import { VModel, Component, Vue } from 'vue-facing-decorator'
+import { Model, Component, Vue } from 'vue-facing-decorator'
 
 /*
-
 Vue options API
 {
     props:{
@@ -18,19 +17,15 @@ Vue options API
         }
     }
 }
-
 */
 
 /*
-
 In other components:
-
 <MyComponent v-model="foo"></MyComponent>
-
 */
 
 @Component
 export default class MyComponent extends Vue {
-    @VModel
+    @Model
     valueAgent!: string
 }

docs/zh-cn/class-component/v-model/v-model.md renamed to docs/zh-cn/class-component/model/model.md

@@ -1,6 +1,8 @@
 ## 用法
 
-使用装饰器`VModel`去定义vue `v-model`或`v-model:foo`。
+使用装饰器`Model`去定义vue `v-model`或`v-model:foo`。
+
+> 这是`VModel`装饰器的别名。`VModel`在未来会被继续支持，但是我们建议升级到`Model`.
 
 [](./code-usage.ts ':include :type=code typescript')
 

src/index.ts

@@ -5,7 +5,7 @@ export { decorator as Watch } from './option/watch'
 export { decorator as Prop } from './option/props'
 export { decorator as Inject } from './option/inject'
 export { decorator as Emit } from './option/emit'
-export { decorator as VModel } from './option/vmodel'
+export { decorator as VModel, decorator as Model } from './option/vmodel'
 import type {
     ComponentPublicInstance
 } from 'vue'

test/option/vmodel.ts

@@ -1,15 +1,15 @@
 
 import { expect } from 'chai';
 import 'mocha';
-import { Component, VModel, Base } from '../../dist'
+import { Component, Model, Base } from '../../dist'
 
 @Component
 export class Comp extends Base {
 
-    @VModel
+    @Model
     defaultValueAgent!:string
 
-    @VModel({
+    @Model({
         name:'value',
         required:true
     })