docs: better example to clarify rule (#1984)

vuejs · Sep 20, 2022 · fdb67d1 · fdb67d1
1 parent a4e807c
commit fdb67d1
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/docs/rules/define-props-declaration.md b/docs/rules/define-props-declaration.md
@@ -21,12 +21,14 @@ This rule only works in setup script and `lang="ts"`.
 <script setup lang="ts">
 /* ✓ GOOD */
 const props = defineProps<{
-  kind: string
+  kind: string,
+  options: { title: string }
 }>()
 
 /* ✗ BAD */
 const props = defineProps({
-  kind: { type: String }
+  kind: { type: String },
+  options: { type: Object as PropType<{ title: string }> }
 })
 </script>
 ```
@@ -50,12 +52,14 @@ const props = defineProps({
 <script setup lang="ts">
 /* ✓ GOOD */
 const props = defineProps({
-  kind: { type: String }
+  kind: { type: String },
+  options: { type: Object as PropType<{ title: string }> }
 })
 
 /* ✗ BAD */
 const props = defineProps<{
-  kind: string
+  kind: string,
+  options: { title: string }
 }>()
 </script>
 ```