[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"$KiqIp5Qu8t":3,"vue-tips-\u002Fvue-tips\u002Fdocument-your-component-props-using-js-doc":52,"blogToc-\u002Fvue-tips\u002Fdocument-your-component-props-using-js-doc":316,"vue-tips-surrounding-\u002Fvue-tips\u002Fdocument-your-component-props-using-js-doc":498},{"id":4,"extension":5,"items":6,"meta":49,"stem":50,"__hash__":51},"menu\u002Fmenu.json","json",[7,12,16,20,24,28,32,36,41,45],{"i18nId":8,"to":9,"ariaLabel":10,"mainNavigation":11},"components.menu.home","\u002F","Home",true,{"i18nId":13,"to":14,"ariaLabel":15,"mainNavigation":11},"components.menu.about","\u002Fhire-me","About",{"i18nId":17,"to":18,"ariaLabel":19,"mainNavigation":11},"components.menu.testimonials","\u002Ftestimonials","Testimonials",{"i18nId":21,"to":22,"ariaLabel":23},"components.menu.contact","\u002Fcontact","Contact",{"i18nId":25,"to":26,"ariaLabel":27,"mainNavigation":11},"components.menu.blog","\u002Fblog","Blog",{"i18nId":29,"to":30,"ariaLabel":31,"mainNavigation":11},"components.menu.tips","\u002Fvue-tips","Vue Tips",{"i18nId":33,"to":34,"ariaLabel":35,"mainNavigation":11},"components.menu.projects","\u002Fprojects","Projects",{"i18nId":37,"to":38,"ariaLabel":39,"mainNavigation":40},"components.menu.stats","\u002Fstats","stats",false,{"i18nId":42,"to":43,"ariaLabel":44,"mainNavigation":40},"components.menu.businessCard","\u002Fbusiness-card","Business Card",{"i18nId":46,"to":47,"ariaLabel":48,"mainNavigation":40},"components.menu.publications","\u002Fpublications","Publications",{},"menu","njLT1QoRt2Dv8QWoVmH8xdTAiDywSj0bxBQdmoyWUE0",{"id":53,"title":54,"body":55,"categories":297,"cover":298,"date":299,"description":300,"extension":301,"lastUpdated":302,"meta":303,"navigation":11,"ogImage":302,"path":304,"readingTime":305,"robots":302,"schemaOrg":302,"seo":310,"sitemap":311,"stem":314,"tags":302,"__hash__":315},"vueTips\u002Fvue-tips\u002Fdocument-your-component-props-using-js-doc\u002Findex.md","Vue Tip: Document Your Component Props Using JSDoc",{"type":56,"value":57,"toc":295},"minimark",[58,67,204,209,281,284,291],[59,60,61,62,66],"p",{},"It can be useful to document your component props so that they show up when you hover over the component in your IDE. You can do this using JSDoc in the TypeScript interface that you pass to the ",[63,64,65],"code",{},"defineProps"," function:",[68,69,78],"pre",{"className":70,"code":71,"filename":72,"highlights":73,"language":76,"meta":77,"style":77},"language-vue shiki shiki-themes github-light poimandres poimandres","\u003Cscript setup lang=\"ts\">\nexport interface Props {\n  \u002F** The name of the user. *\u002F\n  name: string\n  \u002F** The age of the user. *\u002F\n  age: number\n}\ndefineProps\u003CProps>()\n\u003C\u002Fscript>\n","MyComponent.vue",[74,75],3,5,"vue","",[63,79,80,117,135,143,157,163,174,180,194],{"__ignoreMap":77},[81,82,85,89,93,97,100,104,108,112,114],"span",{"class":83,"line":84},"line",1,[81,86,88],{"class":87},"sMzB8","\u003C",[81,90,92],{"class":91},"s8PnL","script",[81,94,96],{"class":95},"sppiw"," setup",[81,98,99],{"class":95}," lang",[81,101,103],{"class":102},"sygvE","=",[81,105,107],{"class":106},"srEIG","\"",[81,109,111],{"class":110},"skTdI","ts",[81,113,107],{"class":106},[81,115,116],{"class":87},">\n",[81,118,120,124,128,132],{"class":83,"line":119},2,[81,121,123],{"class":122},"sRZEA","export",[81,125,127],{"class":126},"slWGy"," interface",[81,129,131],{"class":130},"s4XUm"," Props",[81,133,134],{"class":102}," {\n",[81,136,139],{"class":137,"line":74},[83,138],"highlight",[81,140,142],{"class":141},"s1MN7","  \u002F** The name of the user. *\u002F\n",[81,144,146,150,153],{"class":83,"line":145},4,[81,147,149],{"class":148},"sPC-1","  name",[81,151,152],{"class":126},":",[81,154,156],{"class":155},"svhIC"," string\n",[81,158,160],{"class":159,"line":75},[83,138],[81,161,162],{"class":141},"  \u002F** The age of the user. *\u002F\n",[81,164,166,169,171],{"class":83,"line":165},6,[81,167,168],{"class":148},"  age",[81,170,152],{"class":126},[81,172,173],{"class":155}," number\n",[81,175,177],{"class":83,"line":176},7,[81,178,179],{"class":102},"}\n",[81,181,183,186,188,191],{"class":83,"line":182},8,[81,184,65],{"class":185},"sHQ3f",[81,187,88],{"class":102},[81,189,190],{"class":130},"Props",[81,192,193],{"class":102},">()\n",[81,195,197,200,202],{"class":83,"line":196},9,[81,198,199],{"class":87},"\u003C\u002F",[81,201,92],{"class":91},[81,203,116],{"class":87},[59,205,206,207,66],{},"It's also possible to document the props in the ",[63,208,65],{},[68,210,213],{"className":70,"code":211,"filename":72,"highlights":212,"language":76,"meta":77,"style":77},"\u003Cscript setup lang=\"ts\">\ndefineProps\u003C{\n  \u002F** The name of the user. *\u002F\n  name: string\n  \u002F** The age of the user. *\u002F\n  age: number\n}>()\n\u003C\u002Fscript>\n",[74,75],[63,214,215,235,242,247,255,260,268,273],{"__ignoreMap":77},[81,216,217,219,221,223,225,227,229,231,233],{"class":83,"line":84},[81,218,88],{"class":87},[81,220,92],{"class":91},[81,222,96],{"class":95},[81,224,99],{"class":95},[81,226,103],{"class":102},[81,228,107],{"class":106},[81,230,111],{"class":110},[81,232,107],{"class":106},[81,234,116],{"class":87},[81,236,237,239],{"class":83,"line":119},[81,238,65],{"class":185},[81,240,241],{"class":102},"\u003C{\n",[81,243,245],{"class":244,"line":74},[83,138],[81,246,142],{"class":141},[81,248,249,251,253],{"class":83,"line":145},[81,250,149],{"class":148},[81,252,152],{"class":126},[81,254,156],{"class":155},[81,256,258],{"class":257,"line":75},[83,138],[81,259,162],{"class":141},[81,261,262,264,266],{"class":83,"line":165},[81,263,168],{"class":148},[81,265,152],{"class":126},[81,267,173],{"class":155},[81,269,270],{"class":83,"line":176},[81,271,272],{"class":102},"}>()\n",[81,274,275,277,279],{"class":83,"line":182},[81,276,199],{"class":87},[81,278,92],{"class":91},[81,280,116],{"class":87},[59,282,283],{},"If you hover over the prop name in your IDE, you should see the documentation:",[59,285,286],{},[287,288],"img",{"alt":289,"src":290},"Screenshot of the prop documentation in VS Code","\u002Fvue-tips\u002Fdocument-your-component-props-using-js-doc\u002Fvs-code.png",[292,293,294],"style",{},"html pre.shiki code .sMzB8, html code.shiki .sMzB8{--shiki-light:#24292E;--shiki-default:#E4F0FB;--shiki-dark:#E4F0FB}html pre.shiki code .s8PnL, html code.shiki .s8PnL{--shiki-light:#22863A;--shiki-default:#5DE4C7;--shiki-dark:#5DE4C7}html pre.shiki code .sppiw, html code.shiki .sppiw{--shiki-light:#6F42C1;--shiki-light-font-style:inherit;--shiki-default:#91B4D5;--shiki-default-font-style:italic;--shiki-dark:#91B4D5;--shiki-dark-font-style:italic}html pre.shiki code .sygvE, html code.shiki .sygvE{--shiki-light:#24292E;--shiki-default:#A6ACCD;--shiki-dark:#A6ACCD}html pre.shiki code .srEIG, html code.shiki .srEIG{--shiki-light:#032F62;--shiki-default:#A6ACCD;--shiki-dark:#A6ACCD}html pre.shiki code .skTdI, html code.shiki .skTdI{--shiki-light:#032F62;--shiki-default:#5DE4C7;--shiki-dark:#5DE4C7}html pre.shiki code .sRZEA, html code.shiki .sRZEA{--shiki-light:#D73A49;--shiki-default:#5DE4C7;--shiki-dark:#5DE4C7}html pre.shiki code .slWGy, html code.shiki .slWGy{--shiki-light:#D73A49;--shiki-default:#91B4D5;--shiki-dark:#91B4D5}html pre.shiki code .s4XUm, html code.shiki .s4XUm{--shiki-light:#6F42C1;--shiki-default:#A6ACCDC0;--shiki-dark:#A6ACCDC0}html pre.shiki code .s1MN7, html code.shiki .s1MN7{--shiki-light:#6A737D;--shiki-light-font-style:inherit;--shiki-default:#767C9DB0;--shiki-default-font-style:italic;--shiki-dark:#767C9DB0;--shiki-dark-font-style:italic}html pre.shiki code .sPC-1, html code.shiki .sPC-1{--shiki-light:#E36209;--shiki-default:#A6ACCD;--shiki-dark:#A6ACCD}html pre.shiki code .svhIC, html code.shiki .svhIC{--shiki-light:#005CC5;--shiki-default:#A6ACCDC0;--shiki-dark:#A6ACCDC0}html pre.shiki code .sHQ3f, html code.shiki .sHQ3f{--shiki-light:#6F42C1;--shiki-default:#E4F0FBD0;--shiki-dark:#E4F0FBD0}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":77,"searchDepth":119,"depth":119,"links":296},[],[92],"vue-tips\u002Fdocument-your-component-props-using-js-doc\u002Fog.png","2023-12-14","You can use JSDoc to document your component props so that they show up when you hover over the component in your IDE.","md",null,{},"\u002Fvue-tips\u002Fdocument-your-component-props-using-js-doc",{"text":306,"minutes":307,"time":308,"words":309},"1 min read",0.56,33600,112,{"title":54,"description":300},{"loc":304,"images":312,"lastmod":299},[313],{"loc":290},"vue-tips\u002Fdocument-your-component-props-using-js-doc\u002Findex","hkYHkd3zQ3Du0Qmtc_KyO1Sr5tTRW7JJfjnm2e_krP8",{"id":317,"title":54,"body":318,"cover":298,"description":300,"extension":301,"meta":490,"navigation":11,"path":304,"robots":302,"seo":493,"sitemap":494,"stem":314,"__hash__":497},"content\u002Fvue-tips\u002Fdocument-your-component-props-using-js-doc\u002Findex.md",{"type":56,"value":319,"toc":488},[320,324,407,411,480,482,486],[59,321,61,322,66],{},[63,323,65],{},[68,325,327],{"className":70,"code":71,"filename":72,"highlights":326,"language":76,"meta":77,"style":77},[74,75],[63,328,329,349,359,364,372,377,385,389,399],{"__ignoreMap":77},[81,330,331,333,335,337,339,341,343,345,347],{"class":83,"line":84},[81,332,88],{"class":87},[81,334,92],{"class":91},[81,336,96],{"class":95},[81,338,99],{"class":95},[81,340,103],{"class":102},[81,342,107],{"class":106},[81,344,111],{"class":110},[81,346,107],{"class":106},[81,348,116],{"class":87},[81,350,351,353,355,357],{"class":83,"line":119},[81,352,123],{"class":122},[81,354,127],{"class":126},[81,356,131],{"class":130},[81,358,134],{"class":102},[81,360,362],{"class":361,"line":74},[83,138],[81,363,142],{"class":141},[81,365,366,368,370],{"class":83,"line":145},[81,367,149],{"class":148},[81,369,152],{"class":126},[81,371,156],{"class":155},[81,373,375],{"class":374,"line":75},[83,138],[81,376,162],{"class":141},[81,378,379,381,383],{"class":83,"line":165},[81,380,168],{"class":148},[81,382,152],{"class":126},[81,384,173],{"class":155},[81,386,387],{"class":83,"line":176},[81,388,179],{"class":102},[81,390,391,393,395,397],{"class":83,"line":182},[81,392,65],{"class":185},[81,394,88],{"class":102},[81,396,190],{"class":130},[81,398,193],{"class":102},[81,400,401,403,405],{"class":83,"line":196},[81,402,199],{"class":87},[81,404,92],{"class":91},[81,406,116],{"class":87},[59,408,206,409,66],{},[63,410,65],{},[68,412,414],{"className":70,"code":211,"filename":72,"highlights":413,"language":76,"meta":77,"style":77},[74,75],[63,415,416,436,442,447,455,460,468,472],{"__ignoreMap":77},[81,417,418,420,422,424,426,428,430,432,434],{"class":83,"line":84},[81,419,88],{"class":87},[81,421,92],{"class":91},[81,423,96],{"class":95},[81,425,99],{"class":95},[81,427,103],{"class":102},[81,429,107],{"class":106},[81,431,111],{"class":110},[81,433,107],{"class":106},[81,435,116],{"class":87},[81,437,438,440],{"class":83,"line":119},[81,439,65],{"class":185},[81,441,241],{"class":102},[81,443,445],{"class":444,"line":74},[83,138],[81,446,142],{"class":141},[81,448,449,451,453],{"class":83,"line":145},[81,450,149],{"class":148},[81,452,152],{"class":126},[81,454,156],{"class":155},[81,456,458],{"class":457,"line":75},[83,138],[81,459,162],{"class":141},[81,461,462,464,466],{"class":83,"line":165},[81,463,168],{"class":148},[81,465,152],{"class":126},[81,467,173],{"class":155},[81,469,470],{"class":83,"line":176},[81,471,272],{"class":102},[81,473,474,476,478],{"class":83,"line":182},[81,475,199],{"class":87},[81,477,92],{"class":91},[81,479,116],{"class":87},[59,481,283],{},[59,483,484],{},[287,485],{"alt":289,"src":290},[292,487,294],{},{"title":77,"searchDepth":119,"depth":119,"links":489},[],{"categories":491,"date":299,"readingTime":492},[92],{"text":306,"minutes":307,"time":308,"words":309},{"title":54,"description":300},{"loc":304,"images":495,"lastmod":299},[496],{"loc":290},"qE4c6N2mLY1635FQ3ewD9bYncpuZ33e-WIwRPzydX7A",[499,503],{"title":500,"path":501,"stem":502,"children":-1},"Vue Tip: Best Way to Force Re-Render Vue Component","\u002Fvue-tips\u002Fbest-way-to-force-re-render-vue-component","vue-tips\u002Fbest-way-to-force-re-render-vue-component\u002Findex",{"title":504,"path":505,"stem":506,"children":-1},"Vue Tip: Composable to Define Keyboard Shortcuts","\u002Fvue-tips\u002Fcomposable-to-define-keyboard-shortcuts","vue-tips\u002Fcomposable-to-define-keyboard-shortcuts\u002Findex"]