[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"$KiqIp5Qu8t":3,"vue-tips-\u002Fvue-tips\u002Fcomposable-to-define-keyboard-shortcuts":52,"blogToc-\u002Fvue-tips\u002Fcomposable-to-define-keyboard-shortcuts":357,"vue-tips-surrounding-\u002Fvue-tips\u002Fcomposable-to-define-keyboard-shortcuts":539},{"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":339,"cover":341,"date":342,"description":343,"extension":344,"lastUpdated":345,"meta":346,"navigation":11,"ogImage":345,"path":347,"readingTime":348,"robots":345,"schemaOrg":345,"seo":353,"sitemap":354,"stem":355,"tags":345,"__hash__":356},"vueTips\u002Fvue-tips\u002Fcomposable-to-define-keyboard-shortcuts\u002Findex.md","Vue Tip: Composable to Define Keyboard Shortcuts",{"type":56,"value":57,"toc":335},"minimark",[58,75,80,87,267,270,319,323,331],[59,60,61,62,69,70,74],"p",{},"I want to show you a handy Vue composable that allows you to define keyboard shortcuts in your app. I discovered it in ",[63,64,68],"a",{"href":65,"rel":66},"https:\u002F\u002Fui.nuxt.com\u002Fgetting-started\u002Fshortcuts#defineshortcuts",[67],"nofollow","Nuxt UI",", and it's called ",[71,72,73],"code",{},"defineShortcuts",".",[76,77,79],"h2",{"id":78},"how-to-use-it","How to Use It",[59,81,82,83,86],{},"Let me first demonstrate how to use it. You can define your shortcuts in a ",[71,84,85],{},"setup"," function like this:",[88,89,103],"pre",{"className":90,"code":91,"filename":92,"highlights":93,"language":101,"meta":102,"style":102},"language-vue shiki shiki-themes github-light poimandres poimandres","\u003Cscript setup lang=\"ts\">\nconst isActive = ref(false)\n\ndefineShortcuts({\n  meta_k: {\n    handler: () => {\n      isActive.value = !isActive.value\n    }\n  }\n})\n\u003C\u002Fscript>\n","App.vue",[94,95,96,97,98,99,100],4,5,6,7,8,9,10,"vue","",[71,104,105,142,170,176,185,198,215,239,245,251,257],{"__ignoreMap":102},[106,107,110,114,118,122,125,129,133,137,139],"span",{"class":108,"line":109},"line",1,[106,111,113],{"class":112},"sMzB8","\u003C",[106,115,117],{"class":116},"s8PnL","script",[106,119,121],{"class":120},"sppiw"," setup",[106,123,124],{"class":120}," lang",[106,126,128],{"class":127},"sygvE","=",[106,130,132],{"class":131},"srEIG","\"",[106,134,136],{"class":135},"skTdI","ts",[106,138,132],{"class":131},[106,140,141],{"class":112},">\n",[106,143,145,149,153,156,160,163,167],{"class":108,"line":144},2,[106,146,148],{"class":147},"slWGy","const",[106,150,152],{"class":151},"sGRIV"," isActive",[106,154,155],{"class":147}," =",[106,157,159],{"class":158},"sHQ3f"," ref",[106,161,162],{"class":127},"(",[106,164,166],{"class":165},"sQJmo","false",[106,168,169],{"class":127},")\n",[106,171,173],{"class":108,"line":172},3,[106,174,175],{"emptyLinePlaceholder":11},"\n",[106,177,180,182],{"class":178,"line":94},[108,179],"highlight",[106,181,73],{"class":158},[106,183,184],{"class":127},"({\n",[106,186,188,192,195],{"class":187,"line":95},[108,179],[106,189,191],{"class":190},"srga6","  meta_k",[106,193,194],{"class":127},":",[106,196,197],{"class":127}," {\n",[106,199,201,205,207,210,213],{"class":200,"line":96},[108,179],[106,202,204],{"class":203},"sBmmg","    handler",[106,206,194],{"class":127},[106,208,209],{"class":127}," ()",[106,211,212],{"class":147}," =>",[106,214,197],{"class":127},[106,216,218,221,223,226,228,231,234,236],{"class":217,"line":97},[108,179],[106,219,220],{"class":112},"      isActive",[106,222,74],{"class":127},[106,224,225],{"class":112},"value",[106,227,155],{"class":147},[106,229,230],{"class":147}," !",[106,232,233],{"class":112},"isActive",[106,235,74],{"class":127},[106,237,238],{"class":112},"value\n",[106,240,242],{"class":241,"line":98},[108,179],[106,243,244],{"class":127},"    }\n",[106,246,248],{"class":247,"line":99},[108,179],[106,249,250],{"class":127},"  }\n",[106,252,254],{"class":253,"line":100},[108,179],[106,255,256],{"class":127},"})\n",[106,258,260,263,265],{"class":108,"line":259},11,[106,261,262],{"class":112},"\u003C\u002F",[106,264,117],{"class":116},[106,266,141],{"class":112},[59,268,269],{},"I don't want to repeat the documentation, but let me highlight a few things:",[271,272,273,297,303],"ul",{},[274,275,276,277,280,281,284,285,288,289,292,293,296],"li",{},"Shortcuts can be combined with the ",[71,278,279],{},"_"," character. For example, ",[71,282,283],{},"meta_k"," is the meta key (",[71,286,287],{},"Command"," key on MacOS, ",[71,290,291],{},"Control"," on other OS) key and the ",[71,294,295],{},"k"," key.",[274,298,299,302],{},[71,300,301],{},"usingInput"," is a flag that tells the composable to only trigger the shortcut when the user is not typing in an input field.",[274,304,305,308,309,312,313,315,316,74],{},[71,306,307],{},"whenever"," is used to add constraints so that the shortcut is only triggered when the constraints are met. For example, you can use ",[71,310,311],{},"whenever: [isActive]"," to only trigger the shortcut when ",[71,314,233],{}," is ",[71,317,318],{},"true",[76,320,322],{"id":321},"source-code","Source Code",[59,324,325,326],{},"You can grab the source code from ",[63,327,330],{"href":328,"rel":329},"https:\u002F\u002Fgithub.com\u002Fnuxt\u002Fui\u002Fblob\u002F1f0f6181db7fa1ab45b8f7fec8df1cedccaec688\u002Fsrc\u002Fruntime\u002Fcomposables\u002FdefineShortcuts.ts",[67],"GitHub",[332,333,334],"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 .slWGy, html code.shiki .slWGy{--shiki-light:#D73A49;--shiki-default:#91B4D5;--shiki-dark:#91B4D5}html pre.shiki code .sGRIV, html code.shiki .sGRIV{--shiki-light:#005CC5;--shiki-default:#E4F0FB;--shiki-dark:#E4F0FB}html pre.shiki code .sHQ3f, html code.shiki .sHQ3f{--shiki-light:#6F42C1;--shiki-default:#E4F0FBD0;--shiki-dark:#E4F0FBD0}html pre.shiki code .sQJmo, html code.shiki .sQJmo{--shiki-light:#005CC5;--shiki-default:#D0679D;--shiki-dark:#D0679D}html pre.shiki code .srga6, html code.shiki .srga6{--shiki-light:#24292E;--shiki-default:#ADD7FF;--shiki-dark:#ADD7FF}html pre.shiki code .sBmmg, html code.shiki .sBmmg{--shiki-light:#6F42C1;--shiki-default:#ADD7FF;--shiki-dark:#ADD7FF}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":102,"searchDepth":144,"depth":144,"links":336},[337,338],{"id":78,"depth":144,"text":79},{"id":321,"depth":144,"text":322},[117,340],"composables","vue-tips\u002Fcomposable-to-define-keyboard-shortcuts\u002Fog.png","2023-12-07","I show you a handy Vue composable that allows you to define keyboard shortcuts in your app.","md",null,{},"\u002Fvue-tips\u002Fcomposable-to-define-keyboard-shortcuts",{"text":349,"minutes":350,"time":351,"words":352},"1 min read",0.825,49500,165,{"title":54,"description":343},{"loc":347,"lastmod":342},"vue-tips\u002Fcomposable-to-define-keyboard-shortcuts\u002Findex","WR7KGQyZ_ykuMSxaih6DOlmmLTb8Oc8-TwTU0EpLIko",{"id":358,"title":54,"body":359,"cover":341,"description":343,"extension":344,"meta":533,"navigation":11,"path":347,"robots":345,"seo":536,"sitemap":537,"stem":355,"__hash__":538},"content\u002Fvue-tips\u002Fcomposable-to-define-keyboard-shortcuts\u002Findex.md",{"type":56,"value":360,"toc":529},[361,368,370,374,490,492,520,522,527],[59,362,61,363,69,366,74],{},[63,364,68],{"href":65,"rel":365},[67],[71,367,73],{},[76,369,79],{"id":78},[59,371,82,372,86],{},[71,373,85],{},[88,375,377],{"className":90,"code":91,"filename":92,"highlights":376,"language":101,"meta":102,"style":102},[94,95,96,97,98,99,100],[71,378,379,399,415,419,426,435,448,467,472,477,482],{"__ignoreMap":102},[106,380,381,383,385,387,389,391,393,395,397],{"class":108,"line":109},[106,382,113],{"class":112},[106,384,117],{"class":116},[106,386,121],{"class":120},[106,388,124],{"class":120},[106,390,128],{"class":127},[106,392,132],{"class":131},[106,394,136],{"class":135},[106,396,132],{"class":131},[106,398,141],{"class":112},[106,400,401,403,405,407,409,411,413],{"class":108,"line":144},[106,402,148],{"class":147},[106,404,152],{"class":151},[106,406,155],{"class":147},[106,408,159],{"class":158},[106,410,162],{"class":127},[106,412,166],{"class":165},[106,414,169],{"class":127},[106,416,417],{"class":108,"line":172},[106,418,175],{"emptyLinePlaceholder":11},[106,420,422,424],{"class":421,"line":94},[108,179],[106,423,73],{"class":158},[106,425,184],{"class":127},[106,427,429,431,433],{"class":428,"line":95},[108,179],[106,430,191],{"class":190},[106,432,194],{"class":127},[106,434,197],{"class":127},[106,436,438,440,442,444,446],{"class":437,"line":96},[108,179],[106,439,204],{"class":203},[106,441,194],{"class":127},[106,443,209],{"class":127},[106,445,212],{"class":147},[106,447,197],{"class":127},[106,449,451,453,455,457,459,461,463,465],{"class":450,"line":97},[108,179],[106,452,220],{"class":112},[106,454,74],{"class":127},[106,456,225],{"class":112},[106,458,155],{"class":147},[106,460,230],{"class":147},[106,462,233],{"class":112},[106,464,74],{"class":127},[106,466,238],{"class":112},[106,468,470],{"class":469,"line":98},[108,179],[106,471,244],{"class":127},[106,473,475],{"class":474,"line":99},[108,179],[106,476,250],{"class":127},[106,478,480],{"class":479,"line":100},[108,179],[106,481,256],{"class":127},[106,483,484,486,488],{"class":108,"line":259},[106,485,262],{"class":112},[106,487,117],{"class":116},[106,489,141],{"class":112},[59,491,269],{},[271,493,494,506,510],{},[274,495,276,496,280,498,284,500,288,502,292,504,296],{},[71,497,279],{},[71,499,283],{},[71,501,287],{},[71,503,291],{},[71,505,295],{},[274,507,508,302],{},[71,509,301],{},[274,511,512,308,514,312,516,315,518,74],{},[71,513,307],{},[71,515,311],{},[71,517,233],{},[71,519,318],{},[76,521,322],{"id":321},[59,523,325,524],{},[63,525,330],{"href":328,"rel":526},[67],[332,528,334],{},{"title":102,"searchDepth":144,"depth":144,"links":530},[531,532],{"id":78,"depth":144,"text":79},{"id":321,"depth":144,"text":322},{"categories":534,"date":342,"readingTime":535},[117,340],{"text":349,"minutes":350,"time":351,"words":352},{"title":54,"description":343},{"loc":347,"lastmod":342},"RGYwUBQOk4jRuubDLfEQMwZBgoWhWzQHwAfVZ3pfyLc",[540,544],{"title":541,"path":542,"stem":543,"children":-1},"Vue Tip: Document Your Component Props Using JSDoc","\u002Fvue-tips\u002Fdocument-your-component-props-using-js-doc","vue-tips\u002Fdocument-your-component-props-using-js-doc\u002Findex",{"title":545,"path":546,"stem":547,"children":-1},"Vue Tip: Use a Head Manager","\u002Fvue-tips\u002Fuse-a-head-manager","vue-tips\u002Fuse-a-head-manager\u002Findex"]