https://www.electronjs.org/assets/js/6a1c58bb.78839181.js

1"use strict";(self.webpackChunkelectronjs=self.webpackChunkelectronjs||[]).push([["28508"],{30943(e,t,n){n.r(t),n.d(t,{metadata:()=>o,default:()=>u,frontMatter:()=>r,contentTitle:()=>a,toc:()=>f,assets:()=>c});var o=JSON.parse('{"id":"latest/api/structures/jump-list-category","title":"JumpListCategory Object","description":"","source":"@site/docs/latest/api/structures/jump-list-category.md","sourceDirName":"latest/api/structures","slug":"/latest/api/structures/jump-list-category","permalink":"/docs/latest/api/structures/jump-list-category","draft":false,"unlisted":false,"editUrl":"https://github.com/electron/electron/edit/main/docs/api/structures/jump-list-category.md","tags":[],"version":"current","frontMatter":{"title":"JumpListCategory Object","description":"","slug":"jump-list-category","hide_title":false},"sidebar":"api","previous":{"title":"IpcRendererEvent Object extends `Event`","permalink":"/docs/latest/api/structures/ipc-renderer-event"},"next":{"title":"JumpListItem Object","permalink":"/docs/latest/api/structures/jump-list-item"}}'),i=n(74848),l=n(28453),s=n(40329);let r={title:"JumpListCategory Object",description:"",slug:"jump-list-category",hide_title:!1},a="JumpListCategory Object",c={},f=[];function p(e){let t={admonition:"admonition",code:"code",h1:"h1",header:"header",li:"li",p:"p",ul:"ul",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"jumplistcategory-object",children:"JumpListCategory Object"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"type"})," string (optional) - One of the following:","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"tasks"})," - Items in this category will be placed into the standard ",(0,i.jsx)(t.code,{children:"Tasks"}),"\ncategory. There can be only one such category, and it will always be\ndisplayed at the bottom of the Jump List."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"frequent"})," - Displays a list of files frequently opened by the app, the\nname of the category and its items are set by Windows."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"recent"})," - Displays a list of files recently opened by the app, the name\nof the category and its items are set by Windows. Items may be added to\nthis category indirectly using ",(0,i.jsx)(t.code,{children:"app.addRecentDocument(path)"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"custom"})," - Displays tasks or file links, ",(0,i.jsx)(t.code,{children:"name"})," must be set by the app."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"name"})," string (optional) - Must be set if ",(0,i.jsx)(t.code,{children:"type"})," is ",(0,i.jsx)(t.code,{children:"custom"}),", otherwise it should be\nomitted."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"items"})," JumpListItem[] (optional) - Array of ",(0,i.jsx)(s.A,{url:"/docs/latest/api/structures/jump-list-item",title:"JumpListItem",content:'{"type":"root","children":[{"type":"element","tagName":"h1","properties":{},"children":[{"type":"text","value":"JumpListItem Object"}]},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":10,"column":3,"offset":118},"end":{"line":10,"column":9,"offset":124}}}],"position":{"start":{"line":10,"column":3,"offset":118},"end":{"line":10,"column":9,"offset":124}}},{"type":"text","value":" string (optional) - One of the following:","position":{"start":{"line":10,"column":9,"offset":124},"end":{"line":10,"column":51,"offset":166}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"task","position":{"start":{"line":11,"column":5,"offset":171},"end":{"line":11,"column":11,"offset":177}}}],"position":{"start":{"line":11,"column":5,"offset":171},"end":{"line":11,"column":11,"offset":177}}},{"type":"text","value":" - A task will launch an app with specific arguments.","position":{"start":{"line":11,"column":11,"offset":177},"end":{"line":11,"column":64,"offset":230}}}],"position":{"start":{"line":11,"column":3,"offset":169},"end":{"line":11,"column":64,"offset":230}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"separator","position":{"start":{"line":12,"column":5,"offset":235},"end":{"line":12,"column":16,"offset":246}}}],"position":{"start":{"line":12,"column":5,"offset":235},"end":{"line":12,"column":16,"offset":246}}},{"type":"text","value":" - Can be used to separate items in the standard ","position":{"start":{"line":12,"column":16,"offset":246},"end":{"line":12,"column":65,"offset":295}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"Tasks","position":{"start":{"line":12,"column":65,"offset":295},"end":{"line":12,"column":72,"offset":302}}}],"position":{"start":{"line":12,"column":65,"offset":295},"end":{"line":12,"column":72,"offset":302}}},{"type":"text","value":"\\ncategory.","position":{"start":{"line":12,"column":72,"offset":302},"end":{"line":13,"column":14,"offset":316}}}],"position":{"start":{"line":12,"column":3,"offset":233},"end":{"line":13,"column":14,"offset":316}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"file","position":{"start":{"line":14,"column":5,"offset":321},"end":{"line":14,"column":11,"offset":327}}}],"position":{"start":{"line":14,"column":5,"offset":321},"end":{"line":14,"column":11,"offset":327}}},{"type":"text","value":" - A file link will open a file using the app that created the\\nJump List, for this to work the app must be registered as a handler for\\nthe file type (though it doesn\'t have to be the default handler).","position":{"start":{"line":14,"column":11,"offset":327},"end":{"line":16,"column":70,"offset":535}}}],"position":{"start":{"line":14,"column":3,"offset":319},"end":{"line":16,"column":70,"offset":535}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":11,"column":3,"offset":169},"end":{"line":16,"column":70,"offset":535}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":116},"end":{"line":16,"column":70,"offset":535}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"path","position":{"start":{"line":17,"column":3,"offset":538},"end":{"line":17,"column":9,"offset":544}}}],"position":{"start":{"line":17,"column":3,"offset":538},"end":{"line":17,"column":9,"offset":544}}},{"type":"text","value":" string (optional) - Path of the file to open, should only be set if ","position":{"start":{"line":17,"column":9,"offset":544},"end":{"line":17,"column":78,"offset":613}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":17,"column":78,"offset":613},"end":{"line":17,"column":84,"offset":619}}}],"position":{"start":{"line":17,"column":78,"offset":613},"end":{"line":17,"column":84,"offset":619}}},{"type":"text","value":" is\\n","position":{"start":{"line":17,"column":84,"offset":619},"end":{"line":18,"column":1,"offset":623}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"file","position":{"start":{"line":18,"column":3,"offset":625},"end":{"line":18,"column":9,"offset":631}}}],"position":{"start":{"line":18,"column":3,"offset":625},"end":{"line":18,"column":9,"offset":631}}},{"type":"text","value":".","position":{"start":{"line":18,"column":9,"offset":631},"end":{"line":18,"column":10,"offset":632}}}],"position":{"start":{"line":17,"column":1,"offset":536},"end":{"line":18,"column":10,"offset":632}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"program","position":{"start":{"line":19,"column":3,"offset":635},"end":{"line":19,"column":12,"offset":644}}}],"position":{"start":{"line":19,"column":3,"offset":635},"end":{"line":19,"column":12,"offset":644}}},{"type":"text","value":" string (optional) - Path of the program to execute, usually you should\\nspecify ","position":{"start":{"line":19,"column":12,"offset":644},"end":{"line":20,"column":11,"offset":726}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"process.execPath","position":{"start":{"line":20,"column":11,"offset":726},"end":{"line":20,"column":29,"offset":744}}}],"position":{"start":{"line":20,"column":11,"offset":726},"end":{"line":20,"column":29,"offset":744}}},{"type":"text","value":" which opens the current program. Should only be\\nset if ","position":{"start":{"line":20,"column":29,"offset":744},"end":{"line":21,"column":10,"offset":802}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":21,"column":10,"offset":802},"end":{"line":21,"column":16,"offset":808}}}],"position":{"start":{"line":21,"column":10,"offset":802},"end":{"line":21,"column":16,"offset":808}}},{"type":"text","value":" is ","position":{"start":{"line":21,"column":16,"offset":808},"end":{"line":21,"column":20,"offset":812}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"task","position":{"start":{"line":21,"column":20,"offset":812},"end":{"line":21,"column":26,"offset":818}}}],"position":{"start":{"line":21,"column":20,"offset":812},"end":{"line":21,"column":26,"offset":818}}},{"type":"text","value":".","position":{"start":{"line":21,"column":26,"offset":818},"end":{"line":21,"column":27,"offset":819}}}],"position":{"start":{"line":19,"column":1,"offset":633},"end":{"line":21,"column":27,"offset":819}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"args","position":{"start":{"line":22,"column":3,"offset":822},"end":{"line":22,"column":9,"offset":828}}}],"position":{"start":{"line":22,"column":3,"offset":822},"end":{"line":22,"column":9,"offset":828}}},{"type":"text","value":" string (optional) - The command line arguments when ","position":{"start":{"line":22,"column":9,"offset":828},"end":{"line":22,"column":62,"offset":881}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"program","position":{"start":{"line":22,"column":62,"offset":881},"end":{"line":22,"column":71,"offset":890}}}],"position":{"start":{"line":22,"column":62,"offset":881},"end":{"line":22,"column":71,"offset":890}}},{"type":"text","value":" is executed. Should\\nonly be set if ","position":{"start":{"line":22,"column":71,"offset":890},"end":{"line":23,"column":18,"offset":928}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":23,"column":18,"offset":928},"end":{"line":23,"column":24,"offset":934}}}],"position":{"start":{"line":23,"column":18,"offset":928},"end":{"line":23,"column":24,"offset":934}}},{"type":"text","value":" is ","position":{"start":{"line":23,"column":24,"offset":934},"end":{"line":23,"column":28,"offset":938}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"task","position":{"start":{"line":23,"column":28,"offset":938},"end":{"line":23,"column":34,"offset":944}}}],"position":{"start":{"line":23,"column":28,"offset":938},"end":{"line":23,"column":34,"offset":944}}},{"type":"text","value":".","position":{"start":{"line":23,"column":34,"offset":944},"end":{"line":23,"column":35,"offset":945}}}],"position":{"start":{"line":22,"column":1,"offset":820},"end":{"line":23,"column":35,"offset":945}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"title","position":{"start":{"line":24,"column":3,"offset":948},"end":{"line":24,"column":10,"offset":955}}}],"position":{"start":{"line":24,"column":3,"offset":948},"end":{"line":24,"column":10,"offset":955}}},{"type":"text","value":" string (optional) - The text to be displayed for the item in the Jump List.\\nShould only be set if ","position":{"start":{"line":24,"column":10,"offset":955},"end":{"line":25,"column":25,"offset":1056}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":25,"column":25,"offset":1056},"end":{"line":25,"column":31,"offset":1062}}}],"position":{"start":{"line":25,"column":25,"offset":1056},"end":{"line":25,"column":31,"offset":1062}}},{"type":"text","value":" is ","position":{"start":{"line":25,"column":31,"offset":1062},"end":{"line":25,"column":35,"offset":1066}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"task","position":{"start":{"line":25,"column":35,"offset":1066},"end":{"line":25,"column":41,"offset":1072}}}],"position":{"start":{"line":25,"column":35,"offset":1066},"end":{"line":25,"column":41,"offset":1072}}},{"type":"text","value":".","position":{"start":{"line":25,"column":41,"offset":1072},"end":{"line":25,"column":42,"offset":1073}}}],"position":{"start":{"line":24,"column":1,"offset":946},"end":{"line":25,"column":42,"offset":1073}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"description","position":{"start":{"line":26,"column":3,"offset":1076},"end":{"line":26,"column":16,"offset":1089}}}],"position":{"start":{"line":26,"column":3,"offset":1076},"end":{"line":26,"column":16,"offset":1089}}},{"type":"text","value":" string (optional) - Description of the task (displayed in a tooltip).\\nShould only be set if ","position":{"start":{"line":26,"column":16,"offset":1089},"end":{"line":27,"column":25,"offset":1184}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type","position":{"start":{"line":27,"column":25,"offset":1184},"end":{"line":27,"column":31,"offset":1190}}}],"position":{"start":{"line":27,"column":25,"offset":1184},"end":{"line":27,"column":31,"offset":1190}}},{"type":"text","value":" is ","position":{"start":{"line":27,"column":31,"offset":1190},"end":{"line":27,"column":35,"offset":1194}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"task","position":{"start":{"line":27,"column":35,"offset":1194},"end":{"line":27,"column":41,"offset":1200}}}],"position":{"start":{"line":27,"column":35,"offset":1194},"end":{"line":27,"column":41,"offset":1200}}},{"type":"text","value":". Maximum length 260 characters.","position":{"start":{"line":27,"column":41,"offset":1200},"end":{"line":27,"column":73,"offset":1232}}}],"position":{"start":{"line":26,"column":1,"offset":1074},"end":{"line":27,"column":73,"offset":1232}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"iconPath","position":{"start":{"line":28,"column":3,"offset":1235},"end":{"line":28,"column":13,"offset":1245}}}],"position":{"start":{"line":28,"column":3,"offset":1235},"end":{"line":28,"column":13,"offset":1245}}},{"type":"text","value":" string (optional) - The absolute path to an icon to be displayed in a\\nJump List, which can be an arbitrary resource file that contains an icon\\n(e.g. ","position":{"start":{"line":28,"column":13,"offset":1245},"end":{"line":30,"column":9,"offset":1399}}},{"type":"element","tagName":"code","properties":{},"children":[{"type

1":"text","value":".ico","position":{"start":{"line":30,"column":9,"offset":1399},"end":{"line":30,"column":15,"offset":1405}}}],"position":{"start":{"line":30,"column":9,"offset":1399},"end":{"line":30,"column":15,"offset":1405}}},{"type":"text","value":", ","position":{"start":{"line":30,"column":15,"offset":1405},"end":{"line":30,"column":17,"offset":1407}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":".exe","position":{"start":{"line":30,"column":17,"offset":1407},"end":{"line":30,"column":23,"offset":1413}}}],"position":{"start":{"line":30,"column":17,"offset":1407},"end":{"line":30,"column":23,"offset":1413}}},{"type":"text","value":", ","position":{"start":{"line":30,"column":23,"offset":1413},"end":{"line":30,"column":25,"offset":1415}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":".dll","position":{"start":{"line":30,"column":25,"offset":1415},"end":{"line":30,"column":31,"offset":1421}}}],"position":{"start":{"line":30,"column":25,"offset":1415},"end":{"line":30,"column":31,"offset":1421}}},{"type":"text","value":"). You can usually specify ","position":{"start":{"line":30,"column":31,"offset":1421},"end":{"line":30,"column":58,"offset":1448}}},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"process.execPath","position":{"start":{"line":30,"column":58,"offset":1448},"end":{"line":30,"column":76,"offset":1466}}}],"position":{"start":{"line":30,"column":58,"offset":1448},"end":{"line":30,"column":76,"offset":1466}}},{"type":"text","value":" to\\nshow the program icon.","position":{"start":{"line":30,"column":76,"offset":1466},"end":{"line":31,"column":25,"offset":1494}}}],"position":{"start":{"line":28,"column":1,"offset":1233},"end":{"line":31,"column":25,"offset":1494}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"iconIndex","position":{"start":{"line":32,"column":3,"offset":1497},"end":{"line":32,"column":14,"offset":1508}}}],"position":{"start":{"line":32,"column":3,"offset":1497},"end":{"line":32,"column":14,"offset":1508}}},{"type":"text","value":" number (optional) - The index of the icon in the resource file. If a\\nresource file contains multiple icons this value can be used to specify the\\nzero-based index of the icon that should be displayed for this task. If a\\nresource file contains only one icon, this property should be set to zero.","position":{"start":{"line":32,"column":14,"offset":1508},"end":{"line":35,"column":77,"offset":1808}}}],"position":{"start":{"line":32,"column":1,"offset":1495},"end":{"line":35,"column":77,"offset":1808}}},{"type":"text","value":"\\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"workingDirectory","position":{"start":{"line":36,"column":3,"offset":1811},"end":{"line":36,"column":21,"offset":1829}}}],"position":{"start":{"line":36,"column":3,"offset":1811},"end":{"line":36,"column":21,"offset":1829}}},{"type":"text","value":" string (optional) - The working directory. Default is empty.","position":{"start":{"line":36,"column":21,"offset":1829},"end":{"line":36,"column":82,"offset":1890}}}],"position":{"start":{"line":36,"column":1,"offset":1809},"end":{"line":36,"column":82,"offset":1890}}},{"type":"text","value":"\\n"}],"position":{"start":{"line":10,"column":1,"offset":116},"end":{"line":36,"column":82,"offset":1890}}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":37,"column":1,"offset":1891}}}'})," objects if ",(0,i.jsx)(t.code,{children:"type"})," is ",(0,i.jsx)(t.code,{children:"tasks"})," or\n",(0,i.jsx)(t.code,{children:"custom"}),", otherwise it should be omitted."]}),"\n"]}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsxs)(t.p,{children:["If a ",(0,i.jsx)(t.code,{children:"JumpListCategory"})," object has neither the ",(0,i.jsx)(t.code,{children:"type"})," nor the ",(0,i.jsx)(t.code,{children:"name"}),"\nproperty set then its ",(0,i.jsx)(t.code,{children:"type"})," is assumed to be ",(0,i.jsx)(t.code,{children:"tasks"}),". If the ",(0,i.jsx)(t.code,{children:"name"})," property\nis set but the ",(0,i.jsx)(t.code,{children:"type"})," property is omitted then the ",(0,i.jsx)(t.code,{children:"type"})," is assumed to be\n",(0,i.jsx)(t.code,{children:"custom"}),"."]})}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsxs)(t.p,{children:["The maximum length of a Jump List item's ",(0,i.jsx)(t.code,{children:"description"})," property is\n260 characters. Beyond this limit, the item will not be added to the Jump\nList, nor will it be displayed."]})})]})}function u(e={}){let{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},40329(e,t,n){n.d(t,{A:()=>f});var o=n(74848),i=n(20053),l=n(96540),s=n(75392),r=n.n(s),a=n(83561);let c=e=>(0,o.jsx)("article",{ref:e.innerRef,id:"structures-tooltip",role:"tooltip",className:(0,i.A)("alert","alert--info","shadow--md","card_ZoSr"),style:e.position,children:(0,o.jsx)("div",{className:"card__body",dangerouslySetInnerHTML:{__html:(0,a.V)(JSON.parse(e.content))}})}),f=function(e){let{Portal:t}=r()(),n=(0,l.useRef)(null),i=(0,l.useRef)(null),[s,a]=(0,l.useState)(!1),[f,p]=(0,l.useState)(void 0);(0,l.useEffect)(()=>

1{if(s){let e={x:0,y:0},t=n.current.getBoundingClientRect(),o=window.innerHeight/2<t.y,l=window.innerWidth/2<t.x;o?e.y=i.current.clientHeight+-2:e.y=-t.height- -2,l?e.x=i.current.clientWidth:e.x=0,p({top:n.current.offsetTop-e.y,left:n.current.offsetLeft-e.x})}},[s]);let u=(0,l.useCallback)(()=>{a(!0)},[]),m=(0,l.useCallback)(()=>{a(!1)},[]);return(0,o.jsxs)("a",{"aria-describedby":"structures-tooltip",href:e.url,ref:n,className:"link_nCrB",onMouseEnter:u,onMouseLeave:m,children:[e.title,!!s&&(0,o.jsx)(t,{children:(0,o.jsx)(c,{innerRef:i,position:f,...e})})]})}}}]);