Skip to content

Commit

Permalink
feat: add description for model modifiers
Browse files Browse the repository at this point in the history 
close #2405
  • Loading branch information
@johnsoncodehk
johnsoncodehk committed Feb 17, 2023
1 parent 4f09eec commit 775d3e9
Show file tree
Hide file tree
Showing 8 changed files with 580 additions and 13 deletions.
92 changes: 92 additions & 0 deletions packages/vue-language-service/data/model-modifiers/en.json
View file
@@ -0,0 +1,92 @@
{
"version": 1.1,
"globalAttributes": [
{
"name": "lazy",
"description": {
"kind": "markdown",
"value": "\nBy default, `v-model` syncs the input with the data after each `input` event (with the exception of IME composition as [stated above](#vmodel-ime-tip)). You can add the `lazy` modifier to instead sync after `change` events:\n\n```html\n<!-- synced after \"change\" instead of \"input\" -->\n<input v-model.lazy=\"msg\" />\n```\n"
},
"references": [
{
"name": "en",
"url": "https://vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "zh-cn",
"url": "https://cn.vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "ja",
"url": "https://ja.vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "ua",
"url": "https://ua.vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "fr",
"url": "https://fr.vuejs.org/guide/essentials/forms.html#lazy"
}
]
},
{
"name": "number",
"description": {
"kind": "markdown",
"value": "\nIf you want user input to be automatically typecast as a number, you can add the `number` modifier to your `v-model` managed inputs:\n\n```html\n<input v-model.number=\"age\" />\n```\n\nIf the value cannot be parsed with `parseFloat()`, then the original value is used instead.\n\nThe `number` modifier is applied automatically if the input has `type=\"number\"`.\n"
},
"references": [
{
"name": "en",
"url": "https://vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "zh-cn",
"url": "https://cn.vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "ja",
"url": "https://ja.vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "ua",
"url": "https://ua.vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "fr",
"url": "https://fr.vuejs.org/guide/essentials/forms.html#number"
}
]
},
{
"name": "trim",
"description": {
"kind": "markdown",
"value": "\nIf you want whitespace from user input to be trimmed automatically, you can add the `trim` modifier to your `v-model`-managed inputs:\n\n```html\n<input v-model.trim=\"msg\" />\n```\n"
},
"references": [
{
"name": "en",
"url": "https://vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "zh-cn",
"url": "https://cn.vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "ja",
"url": "https://ja.vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "ua",
"url": "https://ua.vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "fr",
"url": "https://fr.vuejs.org/guide/essentials/forms.html#trim"
}
]
}
]
}
92 changes: 92 additions & 0 deletions packages/vue-language-service/data/model-modifiers/fr.json
View file
@@ -0,0 +1,92 @@
{
"version": 1.1,
"globalAttributes": [
{
"name": "lazy",
"description": {
"kind": "markdown",
"value": "\nPar défaut, `v-model` synchronise l'entrée avec les données après chaque événement `input` (à l'exception de la composition IME comme [indiqué ci-dessus](#vmodel-ime-tip)). Vous pouvez ajouter le modificateur `lazy` pour enclencher la synchronisation après les événements `change` :\n\n```html\n<!-- synchronisé après \"change\" au lieu de \"input\" -->\n<input v-model.lazy=\"msg\" />\n```\n"
},
"references": [
{
"name": "en",
"url": "https://vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "zh-cn",
"url": "https://cn.vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "ja",
"url": "https://ja.vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "ua",
"url": "https://ua.vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "fr",
"url": "https://fr.vuejs.org/guide/essentials/forms.html#lazy"
}
]
},
{
"name": "number",
"description": {
"kind": "markdown",
"value": "\nSi vous voulez que l'entrée de l'utilisateur soit automatiquement typée comme un nombre, vous pouvez ajouter le modificateur `number` à vos entrées gérées par `v-model` :\n\n```html\n<input v-model.number=\"age\" />\n```\n\nSi la valeur ne peut pas être analysée avec `parseFloat()`, alors la valeur originale est utilisée à la place.\n\nLe modificateur `number` est appliqué automatiquement si l'entrée possède `type=\"number\"`.\n"
},
"references": [
{
"name": "en",
"url": "https://vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "zh-cn",
"url": "https://cn.vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "ja",
"url": "https://ja.vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "ua",
"url": "https://ua.vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "fr",
"url": "https://fr.vuejs.org/guide/essentials/forms.html#number"
}
]
},
{
"name": "trim",
"description": {
"kind": "markdown",
"value": "\nSi vous voulez que les espaces blancs des entrées utilisateur soient automatiquement supprimés, vous pouvez ajouter le modificateur `trim` à vos entrées gérées par `v-model` :\n\n```html\n<input v-model.trim=\"msg\" />\n```\n"
},
"references": [
{
"name": "en",
"url": "https://vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "zh-cn",
"url": "https://cn.vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "ja",
"url": "https://ja.vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "ua",
"url": "https://ua.vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "fr",
"url": "https://fr.vuejs.org/guide/essentials/forms.html#trim"
}
]
}
]
}
92 changes: 92 additions & 0 deletions packages/vue-language-service/data/model-modifiers/ja.json
View file
@@ -0,0 +1,92 @@
{
"version": 1.1,
"globalAttributes": [
{
"name": "lazy",
"description": {
"kind": "markdown",
"value": "\nデフォルトでは、 `v-model` は各 `input` イベントの後に、入力とデータを同期します ([上記](#vmodel-ime-tip) の IME による入力は例外とします)。 代わりに `change` イベント後に同期する `lazy` 修飾子を追加することができます。\n\n```html\n<!-- \"input\" の代わりに \"change\" イベント後に同期されます -->\n<input v-model.lazy=\"msg\" />\n```\n"
},
"references": [
{
"name": "en",
"url": "https://vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "zh-cn",
"url": "https://cn.vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "ja",
"url": "https://ja.vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "ua",
"url": "https://ua.vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "fr",
"url": "https://fr.vuejs.org/guide/essentials/forms.html#lazy"
}
]
},
{
"name": "number",
"description": {
"kind": "markdown",
"value": "\nユーザー入力を自動で数値として型変換したい場合、 `v-model` で管理している入力に `number` 修飾子を追加することができます。\n\n```html\n<input v-model.number=\"age\" />\n```\n\nもし値が `parseFloat()` で解析できない場合は、代わりに元の値が使用されます。\n\ninput が `type=\"number\"` を持つ場合は `number` 修飾子が自動で適用されます。\n"
},
"references": [
{
"name": "en",
"url": "https://vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "zh-cn",
"url": "https://cn.vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "ja",
"url": "https://ja.vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "ua",
"url": "https://ua.vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "fr",
"url": "https://fr.vuejs.org/guide/essentials/forms.html#number"
}
]
},
{
"name": "trim",
"description": {
"kind": "markdown",
"value": "\nユーザー入力から自動で空白を取り除きたい場合、 `v-model` で管理している入力に `trim` 修飾子を追加することができます。\n\n```html\n<input v-model.trim=\"msg\" />\n```\n"
},
"references": [
{
"name": "en",
"url": "https://vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "zh-cn",
"url": "https://cn.vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "ja",
"url": "https://ja.vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "ua",
"url": "https://ua.vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "fr",
"url": "https://fr.vuejs.org/guide/essentials/forms.html#trim"
}
]
}
]
}
92 changes: 92 additions & 0 deletions packages/vue-language-service/data/model-modifiers/zh-cn.json
View file
@@ -0,0 +1,92 @@
{
"version": 1.1,
"globalAttributes": [
{
"name": "lazy",
"description": {
"kind": "markdown",
"value": "\n默认情况下，`v-model` 会在每次 `input` 事件后更新数据 ([IME 拼字阶段的状态](#vmodel-ime-tip)例外)。你可以添加 `lazy` 修饰符来改为在每次 `change` 事件后更新数据：\n\n```html\n<!-- 在 \"change\" 事件后同步更新而不是 \"input\" -->\n<input v-model.lazy=\"msg\" />\n```\n"
},
"references": [
{
"name": "en",
"url": "https://vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "zh-cn",
"url": "https://cn.vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "ja",
"url": "https://ja.vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "ua",
"url": "https://ua.vuejs.org/guide/essentials/forms.html#lazy"
},
{
"name": "fr",
"url": "https://fr.vuejs.org/guide/essentials/forms.html#lazy"
}
]
},
{
"name": "number",
"description": {
"kind": "markdown",
"value": "\n如果你想让用户输入自动转换为数字，你可以在 `v-model` 后添加 `.number` 修饰符来管理输入：\n\n```html\n<input v-model.number=\"age\" />\n```\n\n如果该值无法被 `parseFloat()` 处理，那么将返回原始值。\n\n`number` 修饰符会在输入框有 `type=\"number\"` 时自动启用。\n"
},
"references": [
{
"name": "en",
"url": "https://vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "zh-cn",
"url": "https://cn.vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "ja",
"url": "https://ja.vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "ua",
"url": "https://ua.vuejs.org/guide/essentials/forms.html#number"
},
{
"name": "fr",
"url": "https://fr.vuejs.org/guide/essentials/forms.html#number"
}
]
},
{
"name": "trim",
"description": {
"kind": "markdown",
"value": "\n如果你想要默认自动去除用户输入内容中两端的空格，你可以在 `v-model` 后添加 `.trim` 修饰符：\n\n```html\n<input v-model.trim=\"msg\" />\n```\n"
},
"references": [
{
"name": "en",
"url": "https://vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "zh-cn",
"url": "https://cn.vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "ja",
"url": "https://ja.vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "ua",
"url": "https://ua.vuejs.org/guide/essentials/forms.html#trim"
},
{
"name": "fr",
"url": "https://fr.vuejs.org/guide/essentials/forms.html#trim"
}
]
}
]
}

0 comments on commit 775d3e9

Please sign in to comment.