From b1317107af98eb914e040a963a739ade7a138a03 Mon Sep 17 00:00:00 2001 From: jlp-craigmorten Date: Wed, 10 Jan 2024 08:53:52 +0000 Subject: [PATCH] Deploy website - based on c70163d6e6b2ace299a4c3559c9b461aac6dc4ee --- 404.html | 4 ++-- assets/js/{74692c7f.5d1c8609.js => 74692c7f.63bbf048.js} | 2 +- assets/js/ab93d54b.07524266.js | 1 + assets/js/ab93d54b.c048b667.js | 1 - assets/js/{main.3087a5c3.js => main.a872d147.js} | 4 ++-- ...87a5c3.js.LICENSE.txt => main.a872d147.js.LICENSE.txt} | 0 ...{runtime~main.1ba263f0.js => runtime~main.f78be0a3.js} | 2 +- docs/api/class-click-options.html | 6 +++--- docs/api/class-command-options.html | 4 ++-- docs/api/class-guidepup-virtual-screen-reader.html | 4 ++-- docs/api/class-guidepup.html | 4 ++-- docs/api/class-key-code-command.html | 4 ++-- docs/api/class-keyboard-command.html | 4 ++-- docs/api/class-keyboard-options.html | 4 ++-- docs/api/class-keystroke-command.html | 4 ++-- docs/api/class-macos-activate.html | 4 ++-- docs/api/class-macos-applications.html | 4 ++-- docs/api/class-macos-key-code-command.html | 4 ++-- docs/api/class-macos-key-codes.html | 4 ++-- docs/api/class-macos-keyboard-command.html | 4 ++-- docs/api/class-macos-keystroke-command.html | 4 ++-- docs/api/class-macos-modifiers.html | 4 ++-- docs/api/class-macos-quit.html | 4 ++-- docs/api/class-macos-record.html | 4 ++-- docs/api/class-nvda-key-code-commands.html | 4 ++-- docs/api/class-nvda.html | 4 ++-- docs/api/class-screenreader.html | 4 ++-- docs/api/class-start-options.html | 4 ++-- docs/api/class-virtual-commands.html | 4 ++-- docs/api/class-virtual.html | 8 ++++---- docs/api/class-voiceover-commander-commands.html | 4 ++-- docs/api/class-voiceover-key-code-commands.html | 4 ++-- docs/api/class-voiceover.html | 4 ++-- docs/api/class-windows-activate.html | 4 ++-- docs/api/class-windows-key-code-command.html | 4 ++-- docs/api/class-windows-key-codes.html | 4 ++-- docs/api/class-windows-keystroke-command.html | 4 ++-- docs/api/class-windows-modifiers.html | 4 ++-- docs/api/class-windows-quit.html | 4 ++-- docs/api/class-windows-record.html | 4 ++-- docs/example.html | 4 ++-- docs/guides/automated-environment-setup.html | 4 ++-- docs/guides/manual-voiceover-setup.html | 4 ++-- docs/intro.html | 4 ++-- docs/release.html | 4 ++-- docs/support.html | 4 ++-- docs/virtual.html | 4 ++-- index.html | 4 ++-- 48 files changed, 92 insertions(+), 92 deletions(-) rename assets/js/{74692c7f.5d1c8609.js => 74692c7f.63bbf048.js} (55%) create mode 100644 assets/js/ab93d54b.07524266.js delete mode 100644 assets/js/ab93d54b.c048b667.js rename assets/js/{main.3087a5c3.js => main.a872d147.js} (99%) rename assets/js/{main.3087a5c3.js.LICENSE.txt => main.a872d147.js.LICENSE.txt} (100%) rename assets/js/{runtime~main.1ba263f0.js => runtime~main.f78be0a3.js} (97%) diff --git a/404.html b/404.html index 20d54ca..933ad2b 100644 --- a/404.html +++ b/404.html @@ -4,8 +4,8 @@ Page Not Found | Guidepup - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

diff --git a/assets/js/74692c7f.5d1c8609.js b/assets/js/74692c7f.63bbf048.js similarity index 55% rename from assets/js/74692c7f.5d1c8609.js rename to assets/js/74692c7f.63bbf048.js index 4966b3c..9be5293 100644 --- a/assets/js/74692c7f.5d1c8609.js +++ b/assets/js/74692c7f.63bbf048.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_guidepup_guidepup_dev=self.webpackChunk_guidepup_guidepup_dev||[]).push([[1040],{1368:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>a,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var t=i(5893),c=i(1151);const o={title:"ClickOptions"},s=void 0,l={id:"api/class-click-options",title:"ClickOptions",description:"Extends: [CommandOptions]",source:"@site/docs/api/class-click-options.md",sourceDirName:"api",slug:"/api/class-click-options",permalink:"/docs/api/class-click-options",draft:!1,unlisted:!1,editUrl:"https://github.com/guidepup/guidepup.dev/tree/main/docs/api/class-click-options.md",tags:[],version:"current",frontMatter:{title:"ClickOptions"},sidebar:"api",previous:{title:"Guidepup Library",permalink:"/docs/api/class-guidepup"},next:{title:"CommandOptions",permalink:"/docs/api/class-command-options"}},r={},p=[{value:"clickOptions.button",id:"click-options-button",level:2},{value:"clickOptions.clickCount",id:"click-options-click-count",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Extends:"})," ",(0,t.jsx)(n.a,{href:"./class-command-options",title:"CommandOptions",children:"CommandOptions"})]}),"\n",(0,t.jsx)(n.p,{children:"Options for click operations."}),"\n",(0,t.jsx)(n.p,{children:"For example, use with the VoiceOver mouse cursor:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'import { voiceOver } from "@guidepup/guidepup";\n\n(async () => {\n // Start VoiceOver.\n await voiceOver.start();\n\n // Left-click the mouse.\n await voiceOver.click();\n\n // Left-click the mouse using specific options.\n await voiceOver.click({ button: "left", clickCount: 1 });\n\n // Double-right-click the mouse.\n await voiceOver.click({ button: "right", clickCount: 2 });\n\n // Stop VoiceOver.\n await voiceOver.stop();\n})();\n'})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Contents:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"./class-click-options#click-options-button",children:"clickOptions.button"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"./class-click-options#click-options-lick-count",children:"clickOptions.clickCount"})}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"click-options-button",children:"clickOptions.button"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Optional:"})," Mouse button to click. One of: ",(0,t.jsx)(n.code,{children:'"left"'}),", ",(0,t.jsx)(n.code,{children:'"right"'}),". Defaults to ",(0,t.jsx)(n.code,{children:'"left"'})," if not provided."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Type:"})," ",(0,t.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"})]}),"\n",(0,t.jsx)(n.h2,{id:"click-options-click-count",children:"clickOptions.clickCount"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Optional:"})," Number of times to click the mouse. One of: ",(0,t.jsx)(n.code,{children:"1"}),", ",(0,t.jsx)(n.code,{children:"2"}),", ",(0,t.jsx)(n.code,{children:"3"}),". Defaults to ",(0,t.jsx)(n.code,{children:"1"})," if not provided."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Type:"})," ",(0,t.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",title:"number",children:"number"})]})]})}function a(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},1151:(e,n,i)=>{i.d(n,{Z:()=>l,a:()=>s});var t=i(7294);const c={},o=t.createContext(c);function s(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_guidepup_guidepup_dev=self.webpackChunk_guidepup_guidepup_dev||[]).push([[1040],{1368:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>a,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var t=i(5893),c=i(1151);const o={title:"ClickOptions"},s=void 0,l={id:"api/class-click-options",title:"ClickOptions",description:"Extends: [CommandOptions]",source:"@site/docs/api/class-click-options.md",sourceDirName:"api",slug:"/api/class-click-options",permalink:"/docs/api/class-click-options",draft:!1,unlisted:!1,editUrl:"https://github.com/guidepup/guidepup.dev/tree/main/docs/api/class-click-options.md",tags:[],version:"current",frontMatter:{title:"ClickOptions"},sidebar:"api",previous:{title:"Guidepup Library",permalink:"/docs/api/class-guidepup"},next:{title:"CommandOptions",permalink:"/docs/api/class-command-options"}},r={},p=[{value:"clickOptions.button",id:"click-options-button",level:2},{value:"clickOptions.clickCount",id:"click-options-click-count",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Extends:"})," ",(0,t.jsx)(n.a,{href:"./class-command-options",title:"CommandOptions",children:"CommandOptions"})]}),"\n",(0,t.jsx)(n.p,{children:"Options for click operations."}),"\n",(0,t.jsx)(n.p,{children:"For example, use with the VoiceOver mouse cursor:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'import { voiceOver } from "@guidepup/guidepup";\n\n(async () => {\n // Start VoiceOver.\n await voiceOver.start();\n\n // Left-click the mouse.\n await voiceOver.click();\n\n // Left-click the mouse using specific options.\n await voiceOver.click({ button: "left", clickCount: 1 });\n\n // Double-right-click the mouse.\n await voiceOver.click({ button: "right", clickCount: 2 });\n\n // Stop VoiceOver.\n await voiceOver.stop();\n})();\n'})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Contents:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"./class-click-options#click-options-button",children:"clickOptions.button"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"./class-click-options#click-options-click-count",children:"clickOptions.clickCount"})}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"click-options-button",children:"clickOptions.button"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Optional:"})," Mouse button to click. One of: ",(0,t.jsx)(n.code,{children:'"left"'}),", ",(0,t.jsx)(n.code,{children:'"right"'}),". Defaults to ",(0,t.jsx)(n.code,{children:'"left"'})," if not provided."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Type:"})," ",(0,t.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"})]}),"\n",(0,t.jsx)(n.h2,{id:"click-options-click-count",children:"clickOptions.clickCount"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Optional:"})," Number of times to click the mouse. One of: ",(0,t.jsx)(n.code,{children:"1"}),", ",(0,t.jsx)(n.code,{children:"2"}),", ",(0,t.jsx)(n.code,{children:"3"}),". Defaults to ",(0,t.jsx)(n.code,{children:"1"})," if not provided."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Type:"})," ",(0,t.jsx)(n.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",title:"number",children:"number"})]})]})}function a(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},1151:(e,n,i)=>{i.d(n,{Z:()=>l,a:()=>s});var t=i(7294);const c={},o=t.createContext(c);function s(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ab93d54b.07524266.js b/assets/js/ab93d54b.07524266.js new file mode 100644 index 0000000..ac75f76 --- /dev/null +++ b/assets/js/ab93d54b.07524266.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_guidepup_guidepup_dev=self.webpackChunk_guidepup_guidepup_dev||[]).push([[4443],{8053:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var n=t(5893),i=t(1151);const a={title:"Virtual"},l=void 0,s={id:"api/class-virtual",title:"Virtual",description:"Implements: [ScreenReader]",source:"@site/docs/api/class-virtual.md",sourceDirName:"api",slug:"/api/class-virtual",permalink:"/docs/api/class-virtual",draft:!1,unlisted:!1,editUrl:"https://github.com/guidepup/guidepup.dev/tree/main/docs/api/class-virtual.md",tags:[],version:"current",frontMatter:{title:"Virtual"},sidebar:"api",previous:{title:"VirtualCommands",permalink:"/docs/api/class-virtual-commands"},next:{title:"StartOptions",permalink:"/docs/api/class-start-options"}},o={},c=[{value:"virtual.activeNode",id:"virtual-active-node",level:2},{value:"virtual.commands",id:"virtual-commands",level:2},{value:"virtual.act()",id:"virtual-act",level:2},{value:"virtual.clearItemTextLog()",id:"virtual-clear-item-text-log",level:2},{value:"virtual.clearSpokenPhraseLog()",id:"virtual-clear-spoken-phrase-log",level:2},{value:"virtual.click([options])",id:"virtual-click",level:2},{value:"virtual.default()",id:"virtual-default",level:2},{value:"virtual.detect()",id:"virtual-detect",level:2},{value:"virtual.interact()",id:"virtual-interact",level:2},{value:"virtual.itemText()",id:"virtual-item-text",level:2},{value:"virtual.itemTextLog()",id:"virtual-item-text-log",level:2},{value:"virtual.lastSpokenPhrase()",id:"virtual-last-spoken-phrase",level:2},{value:"virtual.next()",id:"virtual-next",level:2},{value:"virtual.perform(command[, options])",id:"virtual-perform",level:2},{value:"virtual.press(key)",id:"virtual-press",level:2},{value:"virtual.previous()",id:"virtual-previous",level:2},{value:"virtual.spokenPhraseLog()",id:"virtual-spoken-phrase-log",level:2},{value:"virtual.start([options])",id:"virtual-start",level:2},{value:"virtual.stop()",id:"virtual-stop",level:2},{value:"virtual.stopInteracting()",id:"virtual-stop-interacting",level:2},{value:"virtual.type(text)",id:"virtual-type",level:2}];function d(e){const r={a:"a",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Implements:"})," ",(0,n.jsx)(r.a,{href:"./class-screenreader",title:"ScreenReader",children:"ScreenReader"})]}),"\n",(0,n.jsxs)(r.p,{children:["A Virtual Screen Reader instance can be used to launch and control a headless JavaScript screen reader which is compatible with any specification compliant ",(0,n.jsx)(r.a,{href:"https://dom.spec.whatwg.org/",children:"DOM"})," implementation, e.g. ",(0,n.jsx)(r.a,{href:"https://github.com/jsdom/jsdom",children:"jsdom"}),", ",(0,n.jsx)(r.a,{href:"https://jestjs.io/",children:"Jest"}),", or any modern browser."]}),"\n",(0,n.jsxs)(r.p,{children:["Here's a typical example using a ",(0,n.jsx)(r.a,{href:"./class-virtual",title:"virtual",children:"Virtual"})," instance:"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\nfunction setupBasicPage() {\n document.body.innerHTML = `\n \n
\n

Section Heading

\n

Section Text

\n
\n
\n

Article Header Heading

\n

Article Header Text

\n
\n

Article Text

\n
\n
\n \n `;\n}\n\ndescribe("Screen Reader Tests", () => {\n test("should traverse the page announcing the expected roles and content", async () => {\n // Setup a page using a framework and testing library of your choice\n setupBasicPage();\n\n // Start your Virtual Screen Reader instance\n await virtual.start({ container: document.body });\n\n // Navigate your environment with the Virtual Screen Reader just as your users would\n while ((await virtual.lastSpokenPhrase()) !== "end of document") {\n await virtual.next();\n }\n\n // Assert on what your users would really see and hear when using screen readers\n expect(await virtual.spokenPhraseLog()).toEqual([\n "document",\n "navigation",\n "Nav Text",\n "end of navigation",\n "region",\n "heading, Section Heading, level 1",\n "Section Text",\n "article",\n "banner",\n "heading, Article Header Heading, level 1",\n "Article Header Text",\n "end of banner",\n "Article Text",\n "end of article",\n "end of region",\n "contentinfo",\n "Footer",\n "end of contentinfo",\n "end of document",\n ]);\n\n // Stop your Virtual Screen Reader instance\n await virtual.stop();\n });\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Contents:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-active-node",children:"virtual.activeNode"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-commands",children:"virtual.commands"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-act",children:"virtual.act()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-clear-item-text-log",children:"virtual.clearItemTextLog()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-clear-spoken-phrase-log",children:"virtual.clearSpokenPhraseLog()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-click",children:"virtual.click()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-default",children:"virtual.default()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-detect",children:"virtual.detect()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-interact",children:"virtual.interact()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-item-text",children:"virtual.itemText()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-item-text-log",children:"virtual.itemTextLog()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-last-spoken-phrase",children:"virtual.lastSpokenPhrase()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-next",children:"virtual.next()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-perform",children:"virtual.perform(command[, options])"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-press",children:"virtual.press(key)"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-previous",children:"virtual.previous()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-spoken-phrase-log",children:"virtual.spokenPhraseLog()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-start",children:"virtual.start([options])"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-stop",children:"virtual.stop()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-stop-interacting",children:"virtual.stopInteracting()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-type",children:"virtual.type(text)"})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-active-node",children:"virtual.activeNode"}),"\n",(0,n.jsx)(r.p,{children:"Getter for the active node under the Virtual Screen Reader cursor."}),"\n",(0,n.jsx)(r.p,{children:"Note that this is not always the same as the currently focused node."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the next element.\n await virtual.next();\n\n // Log the currently focused node.\n console.log(virtual.activeNode);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/Node",title:"Node",children:"Node"})," | ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/null",title:"null",children:"null"})]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-commands",children:"virtual.commands"}),"\n",(0,n.jsx)(r.p,{children:"Getter for all Virtual Screen Reader commands."}),"\n",(0,n.jsxs)(r.p,{children:["Use with the ",(0,n.jsx)(r.code,{children:"perform"})," command to invoke an action:"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Perform action to move to the next landmark.\n await virtual.perform(virtual.commands.moveToNextLandmark);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:"See also:"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-perform",children:"virtual.perform(command[, options])"})}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"./class-virtual-commands",title:"VirtualCommands",children:"VirtualCommands"})]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-act",children:"virtual.act()"}),"\n",(0,n.jsx)(r.p,{children:"Perform the default action for the item in the Virtual Screen Reader cursor."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the next item.\n await virtual.next();\n\n // Perform the default action for the item.\n await virtual.act();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-clear-item-text-log",children:"virtual.clearItemTextLog()"}),"\n",(0,n.jsx)(r.p,{children:"Clear the log of all visited item text for this Virtual Screen Reader instance."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // ... perform some commands.\n\n // Clear the item text log.\n await virtual.clearItemTextLog();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-clear-spoken-phrase-log",children:"virtual.clearSpokenPhraseLog()"}),"\n",(0,n.jsx)(r.p,{children:"Clear the log of all spoken phrases for this Virtual Screen Reader instance."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // ... perform some commands.\n\n // Clear the spoken phrase log.\n await virtual.clearSpokenPhraseLog();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-click",children:"virtual.click([options])"}),"\n",(0,n.jsx)(r.p,{children:"Click the mouse."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Left-click the mouse.\n await virtual.click();\n\n // Left-click the mouse using specific options.\n await virtual.click({ button: "left", clickCount: 1 });\n\n // Double-right-click the mouse.\n await virtual.click({ button: "right", clickCount: 2 });\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Parameters:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.strong,{children:"Optional:"})," ",(0,n.jsx)(r.code,{children:"options"})," ",(0,n.jsx)(r.a,{href:"./class-click-options",title:"ClickOptions",children:"ClickOptions"})," Click options."]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-default",children:"virtual.default()"}),"\n",(0,n.jsx)(r.p,{children:"Detect whether Virtual is the default screen reader for the current OS:"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"false"})," for all OS"]}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n const isVirtualDefaultScreenReader = await virtual.default();\n\n console.log(isVirtualDefaultScreenReader);\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean",title:"boolean",children:"boolean"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-detect",children:"virtual.detect()"}),"\n",(0,n.jsx)(r.p,{children:"Detect whether Virtual is supported for the current OS:"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"true"})," for all OS"]}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n const isVirtualSupportedScreenReader = await virtual.detect();\n\n console.log(isVirtualSupportedScreenReader);\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean",title:"boolean",children:"boolean"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-interact",children:"virtual.interact()"}),"\n",(0,n.jsx)(r.p,{children:"No-op to provide same API across screen readers."}),"\n",(0,n.jsx)(r.p,{children:"The Virtual Screen Reader does not require users to perform an additional command to interact with the item in the Virtual Screen Reader cursor."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the next item.\n await virtual.next();\n\n // Interact with the item - does nothing with the Virtual Screen Reader.\n await virtual.interact();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-item-text",children:"virtual.itemText()"}),"\n",(0,n.jsx)(r.p,{children:"Get the text of the item in the Virtual Screen Reader cursor."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the next item.\n await virtual.next();\n\n // Get the text (if any) for the item currently in focus by the Virtual\n // screen reader cursor.\n const itemText = await virtual.itemText();\n console.log(itemText);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"}),"> The item's text."]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-item-text-log",children:"virtual.itemTextLog()"}),"\n",(0,n.jsx)(r.p,{children:"Get the log of all visited item text for this Virtual Screen Reader instance."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move through several items.\n for (let i = 0; i < 10; i++) {\n await virtual.next();\n }\n\n // Get the text (if any) for all the items visited by the Virtual screen\n // reader cursor.\n const itemTextLog = await virtual.itemTextLog();\n console.log(itemTextLog);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array",title:"Array",children:"Array"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"}),">> The item text log."]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-last-spoken-phrase",children:"virtual.lastSpokenPhrase()"}),"\n",(0,n.jsx)(r.p,{children:"Get the last spoken phrase."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the next item.\n await virtual.next();\n\n // Get the phrase spoken by Virtual Screen Reader from moving to the next item above.\n const lastSpokenPhrase = await virtual.lastSpokenPhrase();\n console.log(lastSpokenPhrase);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"}),"> The last spoken phrase."]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-next",children:"virtual.next()"}),"\n",(0,n.jsx)(r.p,{children:"Move the Virtual cursor to the next location."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the next item.\n await virtual.next();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Parameters:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.strong,{children:"Optional:"})," ",(0,n.jsx)(r.code,{children:"options"})," ",(0,n.jsx)(r.a,{href:"./class-command-options",title:"CommandOptions",children:"CommandOptions"})," Additional options."]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-perform",children:"virtual.perform(command[, options])"}),"\n",(0,n.jsx)(r.p,{children:"Perform a Virtual Screen Reader command."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Perform action to move to the next landmark.\n await virtual.perform(virtual.commands.moveToNextLandmark);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:"See also:"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-commands",children:"virtual.commands"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual-commands",title:"VirtualCommands",children:"VirtualCommands"})}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Parameters:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"command"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"})," Virtual Screen Reader command to execute. See ",(0,n.jsx)(r.a,{href:"./class-virtual-commands",title:"VirtualCommands",children:"VirtualCommands"})," for valid commands."]}),"\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.strong,{children:"Optional:"})," ",(0,n.jsx)(r.code,{children:"options"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",title:"object",children:"object"})," Additional options."]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-press",children:"virtual.press(key)"}),"\n",(0,n.jsx)(r.p,{children:"Press a key on the focused item."}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"key"})," can specify the intended ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key",children:(0,n.jsx)(r.code,{children:"keyboardEvent.key"})}),"\nvalue or a single character to generate the text for. A superset of the ",(0,n.jsx)(r.code,{children:"key"})," values can be found ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values",children:"on the MDN key values page"}),". Examples of the keys are:"]}),"\n",(0,n.jsxs)("p",{children:[(0,n.jsx)("kbd",{children:"F1"})," - ",(0,n.jsx)("kbd",{children:"F20"}),", ",(0,n.jsx)("kbd",{children:"Digit0"})," - ",(0,n.jsx)("kbd",{children:"Digit9"}),", ",(0,n.jsx)("kbd",{children:"KeyA"})," - ",(0,n.jsx)("kbd",{children:"KeyZ"}),", ",(0,n.jsx)("kbd",{children:"Backquote"}),", ",(0,n.jsx)("kbd",{children:"Minus"}),", ",(0,n.jsx)("kbd",{children:"Equal"}),", ",(0,n.jsx)("kbd",{children:"Backslash"}),", ",(0,n.jsx)("kbd",{children:"Backspace"}),", ",(0,n.jsx)("kbd",{children:"Tab"}),",\n",(0,n.jsx)("kbd",{children:"Delete"}),", ",(0,n.jsx)("kbd",{children:"Escape"}),", ",(0,n.jsx)("kbd",{children:"ArrowDown"}),", ",(0,n.jsx)("kbd",{children:"End"}),", ",(0,n.jsx)("kbd",{children:"Enter"}),", ",(0,n.jsx)("kbd",{children:"Home"}),", ",(0,n.jsx)("kbd",{children:"Insert"}),", ",(0,n.jsx)("kbd",{children:"PageDown"}),", ",(0,n.jsx)("kbd",{children:"PageUp"}),", ",(0,n.jsx)("kbd",{children:"ArrowRight"}),", ",(0,n.jsx)("kbd",{children:"ArrowUp"}),", etc."]}),"\n",(0,n.jsxs)(r.p,{children:["Following modification shortcuts are also supported: ",(0,n.jsx)("kbd",{children:"Shift"}),", ",(0,n.jsx)("kbd",{children:"Control"}),", ",(0,n.jsx)("kbd",{children:"Alt"}),", ",(0,n.jsx)("kbd",{children:"Meta"}),", ",(0,n.jsx)("kbd",{children:"Command"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:["Holding down ",(0,n.jsx)("kbd",{children:"Shift"})," will type the text that corresponds to the ",(0,n.jsx)(r.code,{children:"key"})," in the upper case."]}),"\n",(0,n.jsxs)(r.p,{children:["If ",(0,n.jsx)(r.code,{children:"key"})," is a single character, it is case-sensitive, so the values ",(0,n.jsx)("kbd",{children:"a"})," and ",(0,n.jsx)("kbd",{children:"A"})," will generate different respective texts."]}),"\n",(0,n.jsxs)(r.p,{children:["Shortcuts such as ",(0,n.jsx)(r.code,{children:'key: "Command+f"'})," or ",(0,n.jsx)(r.code,{children:'key: "Command+Shift+f"'})," are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed."]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Open a find text modal.\n await virtual.press("Command+f");\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Parameters:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"key"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"})," Name of the key to press or a character to generate, such as ",(0,n.jsx)("kbd",{children:"ArrowLeft"})," or ",(0,n.jsx)("kbd",{children:"a"}),"."]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-previous",children:"virtual.previous()"}),"\n",(0,n.jsx)(r.p,{children:"Move the Virtual cursor to the previous location."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the previous item.\n await virtual.previous();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-spoken-phrase-log",children:"virtual.spokenPhraseLog()"}),"\n",(0,n.jsx)(r.p,{children:"Get the log of all spoken phrases for this Virtual Screen Reader instance."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move through several items.\n for (let i = 0; i < 10; i++) {\n await virtual.next();\n }\n\n // Get the phrase spoken by the Virtual Screen Reader from moving through the\n // items above.\n const spokenPhraseLog = await virtual.spokenPhraseLog();\n console.log(spokenPhraseLog);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array",title:"Array",children:"Array"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"}),">> The spoken phrase log."]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-start",children:"virtual.start([options])"}),"\n",(0,n.jsx)(r.p,{children:"Turn the Virtual Screen Reader on."}),"\n",(0,n.jsx)(r.p,{children:"This must be called before any other Virtual Screen Reader command can be issued."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader on the entire page.\n await virtual.start({ container: document.body });\n\n // ... perform some commands.\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Parameters:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.strong,{children:"Optional:"})," ",(0,n.jsx)(r.code,{children:"options"})," ",(0,n.jsx)(r.a,{href:"./class-start-options",title:"StartOptions",children:"StartOptions"})," Start options."]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-stop",children:"virtual.stop()"}),"\n",(0,n.jsx)(r.p,{children:"Turn the Virtual Screen Reader off."}),"\n",(0,n.jsx)(r.p,{children:"Calling this method will clear any item text or spoken phrases collected by the Virtual Screen Reader."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // ... perform some commands.\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-stop-interacting",children:"virtual.stopInteracting()"}),"\n",(0,n.jsx)(r.p,{children:"No-op to provide same API across screen readers."}),"\n",(0,n.jsx)(r.p,{children:"The Virtual Screen Reader does not require users to perform an additional command to interact with the item in the Virtual Screen Reader cursor."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Interact with the item - does nothing with the Virtual Screen Reader.\n await virtual.interact();\n\n // ... perform some commands.\n\n // Stop interacting with the item - does nothing with Virtual.\n await virtual.stopInteracting();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-type",children:"virtual.type(text)"}),"\n",(0,n.jsx)(r.p,{children:"Type text into the focused item."}),"\n",(0,n.jsxs)(r.p,{children:["To press a special key, like ",(0,n.jsx)("kbd",{children:"Control"})," or ",(0,n.jsx)("kbd",{children:"ArrowDown"}),", use ",(0,n.jsx)(r.a,{href:"./class-virtual#virtual-press",children:(0,n.jsx)(r.code,{children:"virtual.press(key)"})}),"."]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Type a username and key Enter.\n await virtual.type("my-username");\n await virtual.press("Enter");\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Parameters:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"text"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"})," Text to type into the focused item."]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]})]})}function h(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},1151:(e,r,t)=>{t.d(r,{Z:()=>s,a:()=>l});var n=t(7294);const i={},a=n.createContext(i);function l(e){const r=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function s(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ab93d54b.c048b667.js b/assets/js/ab93d54b.c048b667.js deleted file mode 100644 index 4947322..0000000 --- a/assets/js/ab93d54b.c048b667.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_guidepup_guidepup_dev=self.webpackChunk_guidepup_guidepup_dev||[]).push([[4443],{8053:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var n=t(5893),i=t(1151);const a={title:"Virtual"},l=void 0,s={id:"api/class-virtual",title:"Virtual",description:"Implements: [ScreenReader]",source:"@site/docs/api/class-virtual.md",sourceDirName:"api",slug:"/api/class-virtual",permalink:"/docs/api/class-virtual",draft:!1,unlisted:!1,editUrl:"https://github.com/guidepup/guidepup.dev/tree/main/docs/api/class-virtual.md",tags:[],version:"current",frontMatter:{title:"Virtual"},sidebar:"api",previous:{title:"VirtualCommands",permalink:"/docs/api/class-virtual-commands"},next:{title:"StartOptions",permalink:"/docs/api/class-start-options"}},o={},c=[{value:"virtual.activeNode",id:"virtual-activeNode",level:2},{value:"virtual.commands",id:"virtual-commands",level:2},{value:"virtual.act()",id:"virtual-act",level:2},{value:"virtual.clearItemTextLog()",id:"virtual-clear-item-text-log",level:2},{value:"virtual.clearSpokenPhraseLog()",id:"virtual-clear-spoken-phrase-log",level:2},{value:"virtual.click([options])",id:"virtual-click",level:2},{value:"virtual.default()",id:"virtual-default",level:2},{value:"virtual.detect()",id:"virtual-detect",level:2},{value:"virtual.interact()",id:"virtual-interact",level:2},{value:"virtual.itemText()",id:"virtual-item-text",level:2},{value:"virtual.itemTextLog()",id:"virtual-item-text-log",level:2},{value:"virtual.lastSpokenPhrase()",id:"virtual-last-spoken-phrase",level:2},{value:"virtual.next()",id:"virtual-next",level:2},{value:"virtual.perform(command[, options])",id:"virtual-perform",level:2},{value:"virtual.press(key)",id:"virtual-press",level:2},{value:"virtual.previous()",id:"virtual-previous",level:2},{value:"virtual.spokenPhraseLog()",id:"virtual-spoken-phrase-log",level:2},{value:"virtual.start([options])",id:"virtual-start",level:2},{value:"virtual.stop()",id:"virtual-stop",level:2},{value:"virtual.stopInteracting()",id:"virtual-stop-interacting",level:2},{value:"virtual.type(text)",id:"virtual-type",level:2}];function d(e){const r={a:"a",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Implements:"})," ",(0,n.jsx)(r.a,{href:"./class-screenreader",title:"ScreenReader",children:"ScreenReader"})]}),"\n",(0,n.jsxs)(r.p,{children:["A Virtual Screen Reader instance can be used to launch and control a headless JavaScript screen reader which is compatible with any specification compliant ",(0,n.jsx)(r.a,{href:"https://dom.spec.whatwg.org/",children:"DOM"})," implementation, e.g. ",(0,n.jsx)(r.a,{href:"https://github.com/jsdom/jsdom",children:"jsdom"}),", ",(0,n.jsx)(r.a,{href:"https://jestjs.io/",children:"Jest"}),", or any modern browser."]}),"\n",(0,n.jsxs)(r.p,{children:["Here's a typical example using a ",(0,n.jsx)(r.a,{href:"./class-virtual",title:"virtual",children:"Virtual"})," instance:"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\nfunction setupBasicPage() {\n document.body.innerHTML = `\n \n
\n

Section Heading

\n

Section Text

\n
\n
\n

Article Header Heading

\n

Article Header Text

\n
\n

Article Text

\n
\n
\n \n `;\n}\n\ndescribe("Screen Reader Tests", () => {\n test("should traverse the page announcing the expected roles and content", async () => {\n // Setup a page using a framework and testing library of your choice\n setupBasicPage();\n\n // Start your Virtual Screen Reader instance\n await virtual.start({ container: document.body });\n\n // Navigate your environment with the Virtual Screen Reader just as your users would\n while ((await virtual.lastSpokenPhrase()) !== "end of document") {\n await virtual.next();\n }\n\n // Assert on what your users would really see and hear when using screen readers\n expect(await virtual.spokenPhraseLog()).toEqual([\n "document",\n "navigation",\n "Nav Text",\n "end of navigation",\n "region",\n "heading, Section Heading, level 1",\n "Section Text",\n "article",\n "banner",\n "heading, Article Header Heading, level 1",\n "Article Header Text",\n "end of banner",\n "Article Text",\n "end of article",\n "end of region",\n "contentinfo",\n "Footer",\n "end of contentinfo",\n "end of document",\n ]);\n\n // Stop your Virtual Screen Reader instance\n await virtual.stop();\n });\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Contents:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-active-node",children:"virtual.activeNode"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-commands",children:"virtual.commands"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-act",children:"virtual.act()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-clear-item-text-log",children:"virtual.clearItemTextLog()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-clear-spoken-phrase-log",children:"virtual.clearSpokenPhraseLog()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-click",children:"virtual.click()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-default",children:"virtual.default()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-detect",children:"virtual.detect()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-interact",children:"virtual.interact()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-item-text",children:"virtual.itemText()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-item-text-log",children:"virtual.itemTextLog()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-last-spoken-phrase",children:"virtual.lastSpokenPhrase()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-next",children:"virtual.next()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-perform",children:"virtual.perform(command[, options])"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-press",children:"virtual.press(key)"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-previous",children:"virtual.previous()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-spoken-phrase-log",children:"virtual.spokenPhraseLog()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-start",children:"virtual.start([options])"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-stop",children:"virtual.stop()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-stop-interacting",children:"virtual.stopInteracting()"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-type",children:"virtual.type(text)"})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-activeNode",children:"virtual.activeNode"}),"\n",(0,n.jsx)(r.p,{children:"Getter for the active node under the Virtual Screen Reader cursor."}),"\n",(0,n.jsx)(r.p,{children:"Note that this is not always the same as the currently focused node."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the next element.\n await virtual.next();\n\n // Log the currently focused node.\n console.log(virtual.activeNode);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/Node",title:"Node",children:"Node"})," | ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/null",title:"null",children:"null"})]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-commands",children:"virtual.commands"}),"\n",(0,n.jsx)(r.p,{children:"Getter for all Virtual Screen Reader commands."}),"\n",(0,n.jsxs)(r.p,{children:["Use with the ",(0,n.jsx)(r.code,{children:"perform"})," command to invoke an action:"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Perform action to move to the next landmark.\n await virtual.perform(virtual.commands.moveToNextLandmark);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:"See also:"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-perform",children:"virtual.perform(command[, options])"})}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"./class-virtual-commands",title:"VirtualCommands",children:"VirtualCommands"})]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-act",children:"virtual.act()"}),"\n",(0,n.jsx)(r.p,{children:"Perform the default action for the item in the Virtual Screen Reader cursor."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the next item.\n await virtual.next();\n\n // Perform the default action for the item.\n await virtual.act();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-clear-item-text-log",children:"virtual.clearItemTextLog()"}),"\n",(0,n.jsx)(r.p,{children:"Clear the log of all visited item text for this Virtual Screen Reader instance."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // ... perform some commands.\n\n // Clear the item text log.\n await virtual.clearItemTextLog();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-clear-spoken-phrase-log",children:"virtual.clearSpokenPhraseLog()"}),"\n",(0,n.jsx)(r.p,{children:"Clear the log of all spoken phrases for this Virtual Screen Reader instance."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // ... perform some commands.\n\n // Clear the spoken phrase log.\n await virtual.clearSpokenPhraseLog();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-click",children:"virtual.click([options])"}),"\n",(0,n.jsx)(r.p,{children:"Click the mouse."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Left-click the mouse.\n await virtual.click();\n\n // Left-click the mouse using specific options.\n await virtual.click({ button: "left", clickCount: 1 });\n\n // Double-right-click the mouse.\n await virtual.click({ button: "right", clickCount: 2 });\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Parameters:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.strong,{children:"Optional:"})," ",(0,n.jsx)(r.code,{children:"options"})," ",(0,n.jsx)(r.a,{href:"./class-click-options",title:"ClickOptions",children:"ClickOptions"})," Click options."]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-default",children:"virtual.default()"}),"\n",(0,n.jsx)(r.p,{children:"Detect whether Virtual is the default screen reader for the current OS:"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"false"})," for all OS"]}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n const isVirtualDefaultScreenReader = await virtual.default();\n\n console.log(isVirtualDefaultScreenReader);\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean",title:"boolean",children:"boolean"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-detect",children:"virtual.detect()"}),"\n",(0,n.jsx)(r.p,{children:"Detect whether Virtual is supported for the current OS:"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"true"})," for all OS"]}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n const isVirtualSupportedScreenReader = await virtual.detect();\n\n console.log(isVirtualSupportedScreenReader);\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean",title:"boolean",children:"boolean"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-interact",children:"virtual.interact()"}),"\n",(0,n.jsx)(r.p,{children:"No-op to provide same API across screen readers."}),"\n",(0,n.jsx)(r.p,{children:"The Virtual Screen Reader does not require users to perform an additional command to interact with the item in the Virtual Screen Reader cursor."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the next item.\n await virtual.next();\n\n // Interact with the item - does nothing with the Virtual Screen Reader.\n await virtual.interact();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-item-text",children:"virtual.itemText()"}),"\n",(0,n.jsx)(r.p,{children:"Get the text of the item in the Virtual Screen Reader cursor."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the next item.\n await virtual.next();\n\n // Get the text (if any) for the item currently in focus by the Virtual\n // screen reader cursor.\n const itemText = await virtual.itemText();\n console.log(itemText);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"}),"> The item's text."]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-item-text-log",children:"virtual.itemTextLog()"}),"\n",(0,n.jsx)(r.p,{children:"Get the log of all visited item text for this Virtual Screen Reader instance."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move through several items.\n for (let i = 0; i < 10; i++) {\n await virtual.next();\n }\n\n // Get the text (if any) for all the items visited by the Virtual screen\n // reader cursor.\n const itemTextLog = await virtual.itemTextLog();\n console.log(itemTextLog);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array",title:"Array",children:"Array"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"}),">> The item text log."]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-last-spoken-phrase",children:"virtual.lastSpokenPhrase()"}),"\n",(0,n.jsx)(r.p,{children:"Get the last spoken phrase."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the next item.\n await virtual.next();\n\n // Get the phrase spoken by Virtual Screen Reader from moving to the next item above.\n const lastSpokenPhrase = await virtual.lastSpokenPhrase();\n console.log(lastSpokenPhrase);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"}),"> The last spoken phrase."]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-next",children:"virtual.next()"}),"\n",(0,n.jsx)(r.p,{children:"Move the Virtual cursor to the next location."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the next item.\n await virtual.next();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Parameters:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.strong,{children:"Optional:"})," ",(0,n.jsx)(r.code,{children:"options"})," ",(0,n.jsx)(r.a,{href:"./class-command-options",title:"CommandOptions",children:"CommandOptions"})," Additional options."]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-perform",children:"virtual.perform(command[, options])"}),"\n",(0,n.jsx)(r.p,{children:"Perform a Virtual Screen Reader command."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Perform action to move to the next landmark.\n await virtual.perform(virtual.commands.moveToNextLandmark);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:"See also:"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual#virtual-commands",children:"virtual.commands"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"./class-virtual-commands",title:"VirtualCommands",children:"VirtualCommands"})}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Parameters:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"command"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"})," Virtual Screen Reader command to execute. See ",(0,n.jsx)(r.a,{href:"./class-virtual-commands",title:"VirtualCommands",children:"VirtualCommands"})," for valid commands."]}),"\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.strong,{children:"Optional:"})," ",(0,n.jsx)(r.code,{children:"options"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",title:"object",children:"object"})," Additional options."]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-press",children:"virtual.press(key)"}),"\n",(0,n.jsx)(r.p,{children:"Press a key on the focused item."}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"key"})," can specify the intended ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key",children:(0,n.jsx)(r.code,{children:"keyboardEvent.key"})}),"\nvalue or a single character to generate the text for. A superset of the ",(0,n.jsx)(r.code,{children:"key"})," values can be found ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values",children:"on the MDN key values page"}),". Examples of the keys are:"]}),"\n",(0,n.jsxs)("p",{children:[(0,n.jsx)("kbd",{children:"F1"})," - ",(0,n.jsx)("kbd",{children:"F20"}),", ",(0,n.jsx)("kbd",{children:"Digit0"})," - ",(0,n.jsx)("kbd",{children:"Digit9"}),", ",(0,n.jsx)("kbd",{children:"KeyA"})," - ",(0,n.jsx)("kbd",{children:"KeyZ"}),", ",(0,n.jsx)("kbd",{children:"Backquote"}),", ",(0,n.jsx)("kbd",{children:"Minus"}),", ",(0,n.jsx)("kbd",{children:"Equal"}),", ",(0,n.jsx)("kbd",{children:"Backslash"}),", ",(0,n.jsx)("kbd",{children:"Backspace"}),", ",(0,n.jsx)("kbd",{children:"Tab"}),",\n",(0,n.jsx)("kbd",{children:"Delete"}),", ",(0,n.jsx)("kbd",{children:"Escape"}),", ",(0,n.jsx)("kbd",{children:"ArrowDown"}),", ",(0,n.jsx)("kbd",{children:"End"}),", ",(0,n.jsx)("kbd",{children:"Enter"}),", ",(0,n.jsx)("kbd",{children:"Home"}),", ",(0,n.jsx)("kbd",{children:"Insert"}),", ",(0,n.jsx)("kbd",{children:"PageDown"}),", ",(0,n.jsx)("kbd",{children:"PageUp"}),", ",(0,n.jsx)("kbd",{children:"ArrowRight"}),", ",(0,n.jsx)("kbd",{children:"ArrowUp"}),", etc."]}),"\n",(0,n.jsxs)(r.p,{children:["Following modification shortcuts are also supported: ",(0,n.jsx)("kbd",{children:"Shift"}),", ",(0,n.jsx)("kbd",{children:"Control"}),", ",(0,n.jsx)("kbd",{children:"Alt"}),", ",(0,n.jsx)("kbd",{children:"Meta"}),", ",(0,n.jsx)("kbd",{children:"Command"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:["Holding down ",(0,n.jsx)("kbd",{children:"Shift"})," will type the text that corresponds to the ",(0,n.jsx)(r.code,{children:"key"})," in the upper case."]}),"\n",(0,n.jsxs)(r.p,{children:["If ",(0,n.jsx)(r.code,{children:"key"})," is a single character, it is case-sensitive, so the values ",(0,n.jsx)("kbd",{children:"a"})," and ",(0,n.jsx)("kbd",{children:"A"})," will generate different respective texts."]}),"\n",(0,n.jsxs)(r.p,{children:["Shortcuts such as ",(0,n.jsx)(r.code,{children:'key: "Command+f"'})," or ",(0,n.jsx)(r.code,{children:'key: "Command+Shift+f"'})," are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed."]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Open a find text modal.\n await virtual.press("Command+f");\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Parameters:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"key"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"})," Name of the key to press or a character to generate, such as ",(0,n.jsx)("kbd",{children:"ArrowLeft"})," or ",(0,n.jsx)("kbd",{children:"a"}),"."]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-previous",children:"virtual.previous()"}),"\n",(0,n.jsx)(r.p,{children:"Move the Virtual cursor to the previous location."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move to the previous item.\n await virtual.previous();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-spoken-phrase-log",children:"virtual.spokenPhraseLog()"}),"\n",(0,n.jsx)(r.p,{children:"Get the log of all spoken phrases for this Virtual Screen Reader instance."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Move through several items.\n for (let i = 0; i < 10; i++) {\n await virtual.next();\n }\n\n // Get the phrase spoken by the Virtual Screen Reader from moving through the\n // items above.\n const spokenPhraseLog = await virtual.spokenPhraseLog();\n console.log(spokenPhraseLog);\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array",title:"Array",children:"Array"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"}),">> The spoken phrase log."]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-start",children:"virtual.start([options])"}),"\n",(0,n.jsx)(r.p,{children:"Turn the Virtual Screen Reader on."}),"\n",(0,n.jsx)(r.p,{children:"This must be called before any other Virtual Screen Reader command can be issued."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader on the entire page.\n await virtual.start({ container: document.body });\n\n // ... perform some commands.\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Parameters:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.strong,{children:"Optional:"})," ",(0,n.jsx)(r.code,{children:"options"})," ",(0,n.jsx)(r.a,{href:"./class-start-options",title:"StartOptions",children:"StartOptions"})," Start options."]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-stop",children:"virtual.stop()"}),"\n",(0,n.jsx)(r.p,{children:"Turn the Virtual Screen Reader off."}),"\n",(0,n.jsx)(r.p,{children:"Calling this method will clear any item text or spoken phrases collected by the Virtual Screen Reader."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // ... perform some commands.\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-stop-interacting",children:"virtual.stopInteracting()"}),"\n",(0,n.jsx)(r.p,{children:"No-op to provide same API across screen readers."}),"\n",(0,n.jsx)(r.p,{children:"The Virtual Screen Reader does not require users to perform an additional command to interact with the item in the Virtual Screen Reader cursor."}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Interact with the item - does nothing with the Virtual Screen Reader.\n await virtual.interact();\n\n // ... perform some commands.\n\n // Stop interacting with the item - does nothing with Virtual.\n await virtual.stopInteracting();\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]}),"\n",(0,n.jsx)(r.h2,{id:"virtual-type",children:"virtual.type(text)"}),"\n",(0,n.jsx)(r.p,{children:"Type text into the focused item."}),"\n",(0,n.jsxs)(r.p,{children:["To press a special key, like ",(0,n.jsx)("kbd",{children:"Control"})," or ",(0,n.jsx)("kbd",{children:"ArrowDown"}),", use ",(0,n.jsx)(r.a,{href:"./class-virtual#virtual-press",children:(0,n.jsx)(r.code,{children:"virtual.press(key)"})}),"."]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:'import { virtual } from "@guidepup/virtual-screen-reader";\n\ntest("example test", async () => {\n // Start the Virtual Screen Reader.\n await virtual.start({ container: document.body });\n\n // Type a username and key Enter.\n await virtual.type("my-username");\n await virtual.press("Enter");\n\n // Stop the Virtual Screen Reader.\n await virtual.stop();\n});\n'})}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Parameters:"})}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"text"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",title:"string",children:"string"})," Text to type into the focused item."]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"Returns:"})," ",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",title:"Promise",children:"Promise"}),"<",(0,n.jsx)(r.a,{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined",title:"void",children:"void"}),">"]})]})}function h(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},1151:(e,r,t)=>{t.d(r,{Z:()=>s,a:()=>l});var n=t(7294);const i={},a=n.createContext(i);function l(e){const r=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function s(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/main.3087a5c3.js b/assets/js/main.a872d147.js similarity index 99% rename from assets/js/main.3087a5c3.js rename to assets/js/main.a872d147.js index 1733a7f..f18afcb 100644 --- a/assets/js/main.3087a5c3.js +++ b/assets/js/main.a872d147.js @@ -1,2 +1,2 @@ -/*! For license information please see main.3087a5c3.js.LICENSE.txt */ -(self.webpackChunk_guidepup_guidepup_dev=self.webpackChunk_guidepup_guidepup_dev||[]).push([[179],{723:(e,t,n)=>{"use strict";n.d(t,{Z:()=>p});n(7294);var r=n(8356),a=n.n(r),o=n(6887);const i={"02de0776":[()=>n.e(5793).then(n.t.bind(n,3769,19)),"/Users/j84556224/git/guidepup/guidepup.dev/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",3769],"05a474a1":[()=>n.e(4073).then(n.bind(n,732)),"@site/docs/release.md",732],"0e0d6754":[()=>n.e(4437).then(n.bind(n,3262)),"@site/docs/api/class-windows-keystroke-command.md",3262],"0e384e19":[()=>Promise.all([n.e(532),n.e(9671)]).then(n.bind(n,7876)),"@site/docs/intro.md",7876],"1001bb42":[()=>n.e(3104).then(n.bind(n,1416)),"@site/docs/api/class-windows-key-codes.md",1416],"17284fae":[()=>Promise.all([n.e(532),n.e(7402)]).then(n.bind(n,6444)),"@site/docs/example.md",6444],17896441:[()=>Promise.all([n.e(532),n.e(7918)]).then(n.bind(n,1777)),"@theme/DocItem",1777],"1ddd1148":[()=>n.e(4193).then(n.bind(n,8730)),"@site/docs/api/class-keyboard-command.md",8730],"23ee349a":[()=>n.e(4925).then(n.bind(n,5475)),"@site/docs/api/class-voiceover-commander-commands.md",5475],27135732:[()=>n.e(3841).then(n.bind(n,6643)),"@site/docs/api/class-virtual-commands.md",6643],"3023e2ff":[()=>n.e(1230).then(n.bind(n,4813)),"@site/docs/api/class-macos-keyboard-command.md",4813],"30bcac6a":[()=>n.e(6981).then(n.bind(n,9456)),"@site/docs/api/class-key-code-command.md",9456],"3100a497":[()=>n.e(4283).then(n.bind(n,4914)),"@site/docs/api/class-windows-quit.md",4914],40431842:[()=>n.e(7614).then(n.bind(n,6745)),"@site/docs/api/class-macos-key-codes.md",6745],"437a1d55":[()=>n.e(7228).then(n.bind(n,3214)),"@site/docs/api/class-macos-quit.md",3214],"46f05416":[()=>n.e(7401).then(n.bind(n,4994)),"@site/docs/api/class-voiceover-key-code-commands.md",4994],"4d62c3a4":[()=>n.e(6982).then(n.t.bind(n,5745,19)),"/Users/j84556224/git/guidepup/guidepup.dev/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json",5745],"58e27507":[()=>n.e(9733).then(n.bind(n,8498)),"@site/docs/api/class-guidepup.md",8498],"5d27f971":[()=>n.e(0).then(n.bind(n,7758)),"@site/docs/api/class-macos-modifiers.md",7758],"5e95c892":[()=>n.e(9661).then(n.bind(n,1892)),"@theme/DocsRoot",1892],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,6809)),"@generated/docusaurus.config",6809],"627ef86e":[()=>Promise.all([n.e(532),n.e(6642)]).then(n.bind(n,3562)),"@site/docs/virtual.md",3562],"64e23cd3":[()=>n.e(6844).then(n.bind(n,7905)),"@site/docs/api/class-windows-record.md",7905],"74692c7f":[()=>n.e(1040).then(n.bind(n,1368)),"@site/docs/api/class-click-options.md",1368],"78c4c67d":[()=>n.e(7396).then(n.bind(n,7894)),"@site/docs/api/class-macos-applications.md",7894],"78f5257a":[()=>n.e(2745).then(n.bind(n,8831)),"@site/docs/api/class-start-options.md",8831],"80590a21":[()=>n.e(7613).then(n.bind(n,1264)),"@site/docs/api/class-nvda.md",1264],"8ca033d0":[()=>n.e(7810).then(n.bind(n,5711)),"@site/docs/api/class-keyboard-options.md",5711],"935f2afb":[()=>n.e(53).then(n.t.bind(n,1109,19)),"~docs/default/version-current-metadata-prop-751.json",1109],"94a77198":[()=>Promise.all([n.e(532),n.e(6820)]).then(n.bind(n,2262)),"@site/docs/guides/manual-voiceover-setup.md",2262],"9e5e3ee8":[()=>n.e(1535).then(n.bind(n,6259)),"@site/docs/api/class-windows-modifiers.md",6259],"9fb37905":[()=>n.e(4451).then(n.bind(n,8413)),"@site/docs/api/class-windows-key-code-command.md",8413],a7bd4aaa:[()=>n.e(8518).then(n.bind(n,8564)),"@theme/DocVersionRoot",8564],a94703ab:[()=>Promise.all([n.e(532),n.e(4368)]).then(n.bind(n,2674)),"@theme/DocRoot",2674],ab93d54b:[()=>n.e(4443).then(n.bind(n,8053)),"@site/docs/api/class-virtual.md",8053],ac60b277:[()=>n.e(4638).then(n.bind(n,6975)),"@site/docs/api/class-guidepup-virtual-screen-reader.md",6975],b0c5d6a1:[()=>n.e(1058).then(n.bind(n,4629)),"@site/docs/api/class-macos-key-code-command.md",4629],b455fa6b:[()=>n.e(8514).then(n.bind(n,8081)),"@site/docs/api/class-command-options.md",8081],c4f5d8e4:[()=>Promise.all([n.e(532),n.e(4195)]).then(n.bind(n,9831)),"@site/src/pages/index.js",9831],cb813de9:[()=>n.e(2781).then(n.bind(n,6137)),"@site/docs/api/class-macos-keystroke-command.md",6137],d77f44dc:[()=>n.e(5235).then(n.bind(n,3025)),"@site/docs/api/class-nvda-key-code-commands.md",3025],d9e16301:[()=>n.e(6217).then(n.bind(n,3514)),"@site/docs/support.md",3514],e08633c3:[()=>n.e(4292).then(n.bind(n,2117)),"@site/docs/api/class-voiceover.md",2117],e33aac28:[()=>n.e(7494).then(n.bind(n,5924)),"@site/docs/api/class-macos-record.md",5924],e489fc55:[()=>n.e(2128).then(n.bind(n,4019)),"@site/docs/api/class-windows-activate.md",4019],f002572d:[()=>n.e(5469).then(n.bind(n,4165)),"@site/docs/api/class-macos-activate.md",4165],f07a834a:[()=>n.e(1987).then(n.bind(n,3004)),"@site/docs/api/class-keystroke-command.md",3004],f392299e:[()=>Promise.all([n.e(532),n.e(8006)]).then(n.bind(n,4383)),"@site/docs/guides/automated-environment-setup.md",4383],f67253e1:[()=>n.e(2092).then(n.bind(n,7462)),"@site/docs/api/class-screenreader.md",7462]};var l=n(5893);function s(e){let{error:t,retry:n,pastDelay:r}=e;return t?(0,l.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,l.jsx)("p",{children:String(t)}),(0,l.jsx)("div",{children:(0,l.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):r?(0,l.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,l.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,l.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,l.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var c=n(9670),u=n(226);function d(e,t){if("*"===e)return a()({loading:s,loader:()=>n.e(1772).then(n.bind(n,1772)),modules:["@theme/NotFound"],webpack:()=>[1772],render(e,t){const n=e.default;return(0,l.jsx)(u.z,{value:{plugin:{name:"native",id:"default"}},children:(0,l.jsx)(n,{...t})})}});const r=o[`${e}-${t}`],d={},p=[],f=[],m=(0,c.Z)(r);return Object.entries(m).forEach((e=>{let[t,n]=e;const r=i[n];r&&(d[t]=r[0],p.push(r[1]),f.push(r[2]))})),a().Map({loading:s,loader:d,modules:p,webpack:()=>f,render(t,n){const a=JSON.parse(JSON.stringify(r));Object.entries(t).forEach((t=>{let[n,r]=t;const o=r.default;if(!o)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof o&&"function"!=typeof o||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{o[e]=r[e]}));let i=a;const l=n.split(".");l.slice(0,-1).forEach((e=>{i=i[e]})),i[l[l.length-1]]=o}));const o=a.__comp;delete a.__comp;const i=a.__context;return delete a.__context,(0,l.jsx)(u.z,{value:i,children:(0,l.jsx)(o,{...a,...n})})}})}const p=[{path:"/docs",component:d("/docs","e23"),routes:[{path:"/docs",component:d("/docs","fb2"),routes:[{path:"/docs",component:d("/docs","118"),routes:[{path:"/docs/api/class-click-options",component:d("/docs/api/class-click-options","c49"),exact:!0,sidebar:"api"},{path:"/docs/api/class-command-options",component:d("/docs/api/class-command-options","ed5"),exact:!0,sidebar:"api"},{path:"/docs/api/class-guidepup",component:d("/docs/api/class-guidepup","ba6"),exact:!0,sidebar:"api"},{path:"/docs/api/class-guidepup-virtual-screen-reader",component:d("/docs/api/class-guidepup-virtual-screen-reader","92d"),exact:!0,sidebar:"api"},{path:"/docs/api/class-key-code-command",component:d("/docs/api/class-key-code-command","cfb"),exact:!0,sidebar:"api"},{path:"/docs/api/class-keyboard-command",component:d("/docs/api/class-keyboard-command","61a"),exact:!0,sidebar:"api"},{path:"/docs/api/class-keyboard-options",component:d("/docs/api/class-keyboard-options","4aa"),exact:!0,sidebar:"api"},{path:"/docs/api/class-keystroke-command",component:d("/docs/api/class-keystroke-command","1db"),exact:!0,sidebar:"api"},{path:"/docs/api/class-macos-activate",component:d("/docs/api/class-macos-activate","346"),exact:!0,sidebar:"api"},{path:"/docs/api/class-macos-applications",component:d("/docs/api/class-macos-applications","8e9"),exact:!0,sidebar:"api"},{path:"/docs/api/class-macos-key-code-command",component:d("/docs/api/class-macos-key-code-command","962"),exact:!0,sidebar:"api"},{path:"/docs/api/class-macos-key-codes",component:d("/docs/api/class-macos-key-codes","9e4"),exact:!0,sidebar:"api"},{path:"/docs/api/class-macos-keyboard-command",component:d("/docs/api/class-macos-keyboard-command","44e"),exact:!0,sidebar:"api"},{path:"/docs/api/class-macos-keystroke-command",component:d("/docs/api/class-macos-keystroke-command","a27"),exact:!0,sidebar:"api"},{path:"/docs/api/class-macos-modifiers",component:d("/docs/api/class-macos-modifiers","526"),exact:!0,sidebar:"api"},{path:"/docs/api/class-macos-quit",component:d("/docs/api/class-macos-quit","c92"),exact:!0,sidebar:"api"},{path:"/docs/api/class-macos-record",component:d("/docs/api/class-macos-record","eb2"),exact:!0,sidebar:"api"},{path:"/docs/api/class-nvda",component:d("/docs/api/class-nvda","8a3"),exact:!0,sidebar:"api"},{path:"/docs/api/class-nvda-key-code-commands",component:d("/docs/api/class-nvda-key-code-commands","b80"),exact:!0,sidebar:"api"},{path:"/docs/api/class-screenreader",component:d("/docs/api/class-screenreader","9b8"),exact:!0,sidebar:"api"},{path:"/docs/api/class-start-options",component:d("/docs/api/class-start-options","e65"),exact:!0,sidebar:"api"},{path:"/docs/api/class-virtual",component:d("/docs/api/class-virtual","ffb"),exact:!0,sidebar:"api"},{path:"/docs/api/class-virtual-commands",component:d("/docs/api/class-virtual-commands","1fd"),exact:!0,sidebar:"api"},{path:"/docs/api/class-voiceover",component:d("/docs/api/class-voiceover","205"),exact:!0,sidebar:"api"},{path:"/docs/api/class-voiceover-commander-commands",component:d("/docs/api/class-voiceover-commander-commands","40a"),exact:!0,sidebar:"api"},{path:"/docs/api/class-voiceover-key-code-commands",component:d("/docs/api/class-voiceover-key-code-commands","671"),exact:!0,sidebar:"api"},{path:"/docs/api/class-windows-activate",component:d("/docs/api/class-windows-activate","02b"),exact:!0,sidebar:"api"},{path:"/docs/api/class-windows-key-code-command",component:d("/docs/api/class-windows-key-code-command","994"),exact:!0,sidebar:"api"},{path:"/docs/api/class-windows-key-codes",component:d("/docs/api/class-windows-key-codes","34a"),exact:!0,sidebar:"api"},{path:"/docs/api/class-windows-keystroke-command",component:d("/docs/api/class-windows-keystroke-command","c96"),exact:!0,sidebar:"api"},{path:"/docs/api/class-windows-modifiers",component:d("/docs/api/class-windows-modifiers","fea"),exact:!0,sidebar:"api"},{path:"/docs/api/class-windows-quit",component:d("/docs/api/class-windows-quit","0d2"),exact:!0,sidebar:"api"},{path:"/docs/api/class-windows-record",component:d("/docs/api/class-windows-record","d4b"),exact:!0,sidebar:"api"},{path:"/docs/example",component:d("/docs/example","d4a"),exact:!0,sidebar:"docs"},{path:"/docs/guides/automated-environment-setup",component:d("/docs/guides/automated-environment-setup","820"),exact:!0,sidebar:"docs"},{path:"/docs/guides/manual-voiceover-setup",component:d("/docs/guides/manual-voiceover-setup","169"),exact:!0,sidebar:"docs"},{path:"/docs/intro",component:d("/docs/intro","6e9"),exact:!0,sidebar:"docs"},{path:"/docs/release",component:d("/docs/release","fe7"),exact:!0,sidebar:"docs"},{path:"/docs/support",component:d("/docs/support","73c"),exact:!0,sidebar:"docs"},{path:"/docs/virtual",component:d("/docs/virtual","a20"),exact:!0,sidebar:"docs"}]}]}]},{path:"/",component:d("/","c25"),exact:!0},{path:"*",component:d("*")}]},8934:(e,t,n)=>{"use strict";n.d(t,{_:()=>o,t:()=>i});var r=n(7294),a=n(5893);const o=r.createContext(!1);function i(e){let{children:t}=e;const[n,i]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{i(!0)}),[]),(0,a.jsx)(o.Provider,{value:n,children:t})}},7221:(e,t,n)=>{"use strict";var r=n(7294),a=n(745),o=n(3727),i=n(405),l=n(412);const s=[n(2497),n(3310),n(8320),n(2295)];var c=n(723),u=n(6550),d=n(8790),p=n(5893);function f(e){let{children:t}=e;return(0,p.jsx)(p.Fragment,{children:t})}var m=n(5742),h=n(2263),g=n(4996),y=n(6668),b=n(1944),v=n(4711),w=n(9727),k=n(3320),x=n(8780),S=n(197);function E(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,h.Z)(),r=(0,v.l)(),a=n[e].htmlLang,o=e=>e.replace("-","_");return(0,p.jsxs)(m.Z,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,p.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,p.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,p.jsx)("meta",{property:"og:locale",content:o(a)}),Object.values(n).filter((e=>a!==e.htmlLang)).map((e=>(0,p.jsx)("meta",{property:"og:locale:alternate",content:o(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function C(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,h.Z)(),r=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,h.Z)(),{pathname:r}=(0,u.TH)();return e+(0,x.applyTrailingSlash)((0,g.Z)(r),{trailingSlash:n,baseUrl:t})}(),a=t?`${n}${t}`:r;return(0,p.jsxs)(m.Z,{children:[(0,p.jsx)("meta",{property:"og:url",content:a}),(0,p.jsx)("link",{rel:"canonical",href:a})]})}function _(){const{i18n:{currentLocale:e}}=(0,h.Z)(),{metadata:t,image:n}=(0,y.L)();return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsxs)(m.Z,{children:[(0,p.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,p.jsx)("body",{className:w.h})]}),n&&(0,p.jsx)(b.d,{image:n}),(0,p.jsx)(C,{}),(0,p.jsx)(E,{}),(0,p.jsx)(S.Z,{tag:k.HX,locale:e}),(0,p.jsx)(m.Z,{children:t.map(((e,t)=>(0,p.jsx)("meta",{...e},t)))})]})}const T=new Map;function j(e){if(T.has(e.pathname))return{...e,pathname:T.get(e.pathname)};if((0,d.f)(c.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return T.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return T.set(e.pathname,t),{...e,pathname:t}}var A=n(8934),L=n(8940),N=n(469);function R(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r{const r=t.default?.[e]??t[e];return r?.(...n)}));return()=>a.forEach((e=>e?.()))}const P=function(e){let{children:t,location:n,previousLocation:r}=e;return(0,N.Z)((()=>{r!==n&&(!function(e){let{location:t,previousLocation:n}=e;if(!n)return;const r=t.pathname===n.pathname,a=t.hash===n.hash,o=t.search===n.search;if(r&&a&&!o)return;const{hash:i}=t;if(i){const e=decodeURIComponent(i.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:n,previousLocation:r}),R("onRouteDidUpdate",{previousLocation:r,location:n}))}),[r,n]),t};function O(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,d.f)(c.Z,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class D extends r.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=l.Z.canUseDOM?R("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=R("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),O(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return(0,p.jsx)(P,{previousLocation:this.previousLocation,location:t,children:(0,p.jsx)(u.AW,{location:t,render:()=>e})})}}const I=D,F="__docusaurus-base-url-issue-banner-container",M="__docusaurus-base-url-issue-banner",z="__docusaurus-base-url-issue-banner-suggestion-container";function B(e){return`\ndocument.addEventListener('DOMContentLoaded', function maybeInsertBanner() {\n var shouldInsert = typeof window['docusaurus'] === 'undefined';\n shouldInsert && insertBanner();\n});\n\nfunction insertBanner() {\n var bannerContainer = document.createElement('div');\n bannerContainer.id = '${F}';\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/{if("undefined"==typeof document)return void n();const r=document.createElement("link");r.setAttribute("rel","prefetch"),r.setAttribute("href",e),r.onload=()=>t(),r.onerror=()=>n();const a=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;a?.appendChild(r)}))}:function(e){return new Promise(((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)}))};var Y=n(9670);const K=new Set,X=new Set,J=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,ee={prefetch(e){if(!(e=>!J()&&!X.has(e)&&!K.has(e))(e))return!1;K.add(e);const t=(0,d.f)(c.Z,e).flatMap((e=>{return t=e.route.path,Object.entries(W).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,Y.Z)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?Q(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!J()&&!X.has(e))(e)&&(X.add(e),O(e))},te=Object.freeze(ee),ne=Boolean(!0);if(l.Z.canUseDOM){window.docusaurus=te;const e=document.getElementById("__docusaurus"),t=(0,p.jsx)(i.B6,{children:(0,p.jsx)(o.VK,{children:(0,p.jsx)(V,{})})}),n=(e,t)=>{console.error("Docusaurus React Root onRecoverableError:",e,t)},l=()=>{if(ne)r.startTransition((()=>{a.hydrateRoot(e,t,{onRecoverableError:n})}));else{const o=a.createRoot(e,{onRecoverableError:n});r.startTransition((()=>{o.render(t)}))}};O(window.location.pathname).then(l)}},8940:(e,t,n)=>{"use strict";n.d(t,{_:()=>d,M:()=>p});var r=n(7294),a=n(6809);const o=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/docs","versions":[{"name":"current","label":"Next","isLast":true,"path":"/docs","mainDocId":"intro","docs":[{"id":"api/class-click-options","path":"/docs/api/class-click-options","sidebar":"api"},{"id":"api/class-command-options","path":"/docs/api/class-command-options","sidebar":"api"},{"id":"api/class-guidepup","path":"/docs/api/class-guidepup","sidebar":"api"},{"id":"api/class-guidepup-virtual-screen-reader","path":"/docs/api/class-guidepup-virtual-screen-reader","sidebar":"api"},{"id":"api/class-key-code-command","path":"/docs/api/class-key-code-command","sidebar":"api"},{"id":"api/class-keyboard-command","path":"/docs/api/class-keyboard-command","sidebar":"api"},{"id":"api/class-keyboard-options","path":"/docs/api/class-keyboard-options","sidebar":"api"},{"id":"api/class-keystroke-command","path":"/docs/api/class-keystroke-command","sidebar":"api"},{"id":"api/class-macos-activate","path":"/docs/api/class-macos-activate","sidebar":"api"},{"id":"api/class-macos-applications","path":"/docs/api/class-macos-applications","sidebar":"api"},{"id":"api/class-macos-key-code-command","path":"/docs/api/class-macos-key-code-command","sidebar":"api"},{"id":"api/class-macos-key-codes","path":"/docs/api/class-macos-key-codes","sidebar":"api"},{"id":"api/class-macos-keyboard-command","path":"/docs/api/class-macos-keyboard-command","sidebar":"api"},{"id":"api/class-macos-keystroke-command","path":"/docs/api/class-macos-keystroke-command","sidebar":"api"},{"id":"api/class-macos-modifiers","path":"/docs/api/class-macos-modifiers","sidebar":"api"},{"id":"api/class-macos-quit","path":"/docs/api/class-macos-quit","sidebar":"api"},{"id":"api/class-macos-record","path":"/docs/api/class-macos-record","sidebar":"api"},{"id":"api/class-nvda","path":"/docs/api/class-nvda","sidebar":"api"},{"id":"api/class-nvda-key-code-commands","path":"/docs/api/class-nvda-key-code-commands","sidebar":"api"},{"id":"api/class-screenreader","path":"/docs/api/class-screenreader","sidebar":"api"},{"id":"api/class-start-options","path":"/docs/api/class-start-options","sidebar":"api"},{"id":"api/class-virtual","path":"/docs/api/class-virtual","sidebar":"api"},{"id":"api/class-virtual-commands","path":"/docs/api/class-virtual-commands","sidebar":"api"},{"id":"api/class-voiceover","path":"/docs/api/class-voiceover","sidebar":"api"},{"id":"api/class-voiceover-commander-commands","path":"/docs/api/class-voiceover-commander-commands","sidebar":"api"},{"id":"api/class-voiceover-key-code-commands","path":"/docs/api/class-voiceover-key-code-commands","sidebar":"api"},{"id":"api/class-windows-activate","path":"/docs/api/class-windows-activate","sidebar":"api"},{"id":"api/class-windows-key-code-command","path":"/docs/api/class-windows-key-code-command","sidebar":"api"},{"id":"api/class-windows-key-codes","path":"/docs/api/class-windows-key-codes","sidebar":"api"},{"id":"api/class-windows-keystroke-command","path":"/docs/api/class-windows-keystroke-command","sidebar":"api"},{"id":"api/class-windows-modifiers","path":"/docs/api/class-windows-modifiers","sidebar":"api"},{"id":"api/class-windows-quit","path":"/docs/api/class-windows-quit","sidebar":"api"},{"id":"api/class-windows-record","path":"/docs/api/class-windows-record","sidebar":"api"},{"id":"example","path":"/docs/example","sidebar":"docs"},{"id":"guides/automated-environment-setup","path":"/docs/guides/automated-environment-setup","sidebar":"docs"},{"id":"guides/manual-voiceover-setup","path":"/docs/guides/manual-voiceover-setup","sidebar":"docs"},{"id":"intro","path":"/docs/intro","sidebar":"docs"},{"id":"release","path":"/docs/release","sidebar":"docs"},{"id":"support","path":"/docs/support","sidebar":"docs"},{"id":"virtual","path":"/docs/virtual","sidebar":"docs"}],"draftIds":[],"sidebars":{"docs":{"link":{"path":"/docs/intro","label":"intro"}},"api":{"link":{"path":"/docs/api/class-guidepup","label":"api/class-guidepup"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var l=n(7529);const s=JSON.parse('{"docusaurusVersion":"3.1.0","siteVersion":"0.20.1","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.1.0"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"3.1.0"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"3.1.0"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.1.0"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.1.0"}}}');var c=n(5893);const u={siteConfig:a.default,siteMetadata:s,globalData:o,i18n:i,codeTranslations:l},d=r.createContext(u);function p(e){let{children:t}=e;return(0,c.jsx)(d.Provider,{value:u,children:t})}},4763:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(7294),a=n(412),o=n(5742),i=n(8780),l=n(6040),s=n(5893);function c(e){let{error:t,tryAgain:n}=e;return(0,s.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,s.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,s.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,s.jsx)(u,{error:t})]})}function u(e){let{error:t}=e;const n=(0,i.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,s.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function d(e){let{error:t,tryAgain:n}=e;return(0,s.jsxs)(f,{fallback:()=>(0,s.jsx)(c,{error:t,tryAgain:n}),children:[(0,s.jsx)(o.Z,{children:(0,s.jsx)("title",{children:"Page Error"})}),(0,s.jsx)(l.Z,{children:(0,s.jsx)(c,{error:t,tryAgain:n})})]})}const p=e=>(0,s.jsx)(d,{...e});class f extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){a.Z.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??p)(e)}return e??null}}},412:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,a={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},5742:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(7294);var r=n(405),a=n(5893);function o(e){return(0,a.jsx)(r.ql,{...e})}},3692:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(7294),a=n(3727),o=n(8780),i=n(2263),l=n(3919),s=n(412),c=n(8138),u=n(4996),d=n(5893);function p(e,t){let{isNavLink:n,to:p,href:f,activeClassName:m,isActive:h,"data-noBrokenLinkCheck":g,autoAddBaseUrl:y=!0,...b}=e;const{siteConfig:{trailingSlash:v,baseUrl:w}}=(0,i.Z)(),{withBaseUrl:k}=(0,u.C)(),x=(0,c.Z)(),S=(0,r.useRef)(null);(0,r.useImperativeHandle)(t,(()=>S.current));const E=p||f;const C=(0,l.Z)(E),_=E?.replace("pathname://","");let T=void 0!==_?(j=_,y&&(e=>e.startsWith("/"))(j)?k(j):j):void 0;var j;T&&C&&(T=(0,o.applyTrailingSlash)(T,{trailingSlash:v,baseUrl:w}));const A=(0,r.useRef)(!1),L=n?a.OL:a.rU,N=s.Z.canUseIntersectionObserver,R=(0,r.useRef)(),P=()=>{A.current||null==T||(window.docusaurus.preload(T),A.current=!0)};(0,r.useEffect)((()=>(!N&&C&&null!=T&&window.docusaurus.prefetch(T),()=>{N&&R.current&&R.current.disconnect()})),[R,T,N,C]);const O=T?.startsWith("#")??!1,D=!T||!C||O;return D||g||x.collectLink(T),D?(0,d.jsx)("a",{ref:S,href:T,...E&&!C&&{target:"_blank",rel:"noopener noreferrer"},...b}):(0,d.jsx)(L,{...b,onMouseEnter:P,onTouchStart:P,innerRef:e=>{S.current=e,N&&e&&C&&(R.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(R.current.unobserve(e),R.current.disconnect(),null!=T&&window.docusaurus.prefetch(T))}))})),R.current.observe(e))},to:T,...n&&{isActive:h,activeClassName:m}})}const f=r.forwardRef(p)},1875:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});const r=()=>null},5999:(e,t,n)=>{"use strict";n.d(t,{Z:()=>c,I:()=>s});var r=n(7294),a=n(5893);function o(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,r.isValidElement)(e)))?n.map(((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var i=n(7529);function l(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return i[t??n]??n??t}function s(e,t){let{message:n,id:r}=e;return o(l({message:n,id:r}),t)}function c(e){let{children:t,id:n,values:r}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const i=l({message:t,id:n});return(0,a.jsx)(a.Fragment,{children:o(i,r)})}},9935:(e,t,n)=>{"use strict";n.d(t,{m:()=>r});const r="default"},3919:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function a(e){return void 0!==e&&!r(e)}n.d(t,{Z:()=>a,b:()=>r})},4996:(e,t,n)=>{"use strict";n.d(t,{C:()=>i,Z:()=>l});var r=n(7294),a=n(2263),o=n(3919);function i(){const{siteConfig:{baseUrl:e,url:t}}=(0,a.Z)(),n=(0,r.useCallback)(((n,r)=>function(e,t,n,r){let{forcePrependBaseUrl:a=!1,absolute:i=!1}=void 0===r?{}:r;if(!n||n.startsWith("#")||(0,o.b)(n))return n;if(a)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const l=n.startsWith(t)?n:t+n.replace(/^\//,"");return i?e+l:l}(t,e,n,r)),[t,e]);return{withBaseUrl:n}}function l(e,t){void 0===t&&(t={});const{withBaseUrl:n}=i();return n(e,t)}},8138:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i});var r=n(7294);n(5893);const a=r.createContext({collectAnchor:()=>{},collectLink:()=>{}}),o=()=>(0,r.useContext)(a);function i(){return o()}},2263:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(8940);function o(){return(0,r.useContext)(a._)}},2389:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(8934);function o(){return(0,r.useContext)(a._)}},469:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});var r=n(7294);const a=n(412).Z.canUseDOM?r.useLayoutEffect:r.useEffect},9670:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const r=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function a(e){const t={};return function e(n,a){Object.entries(n).forEach((n=>{let[o,i]=n;const l=a?`${a}.${o}`:o;r(i)?e(i,l):t[l]=i}))}(e),t}},226:(e,t,n)=>{"use strict";n.d(t,{_:()=>o,z:()=>i});var r=n(7294),a=n(5893);const o=r.createContext(null);function i(e){let{children:t,value:n}=e;const i=r.useContext(o),l=(0,r.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const r={...t.data,...n?.data};return{plugin:t.plugin,data:r}}({parent:i,value:n})),[i,n]);return(0,a.jsx)(o.Provider,{value:l,children:t})}},143:(e,t,n)=>{"use strict";n.d(t,{Iw:()=>h,gA:()=>p,_r:()=>u,Jo:()=>g,zh:()=>d,yW:()=>m,gB:()=>f});var r=n(6550),a=n(2263),o=n(9935);function i(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,a.Z)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}const l=e=>e.versions.find((e=>e.isLast));function s(e,t){const n=function(e,t){const n=l(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,r.LX)(t,{path:e.path,exact:!1,strict:!1})))}(e,t),a=n?.docs.find((e=>!!(0,r.LX)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:a,alternateDocVersions:a?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(a.id):{}}}const c={},u=()=>i("docusaurus-plugin-content-docs")??c,d=e=>function(e,t,n){void 0===t&&(t=o.m),void 0===n&&(n={});const r=i(e),a=r?.[t];if(!a&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return a}("docusaurus-plugin-content-docs",e,{failfast:!0});function p(e){void 0===e&&(e={});const t=u(),{pathname:n}=(0,r.TH)();return function(e,t,n){void 0===n&&(n={});const a=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,r.LX)(t,{path:n.path,exact:!1,strict:!1})})),o=a?{pluginId:a[0],pluginData:a[1]}:void 0;if(!o&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return o}(t,n,e)}function f(e){return d(e).versions}function m(e){const t=d(e);return l(t)}function h(e){const t=d(e),{pathname:n}=(0,r.TH)();return s(t,n)}function g(e){const t=d(e),{pathname:n}=(0,r.TH)();return function(e,t){const n=l(e);return{latestDocSuggestion:s(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},8320:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>o});var r=n(4865),a=n.n(r);a().configure({showSpinner:!1});const o={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{a().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){a().done()}}},3310:(e,t,n)=>{"use strict";n.r(t);var r=n(2573),a=n(6809);!function(e){const{themeConfig:{prism:t}}=a.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{"php"===e&&n(6854),n(6726)(`./prism-${e}`)})),delete globalThis.Prism}(r.p1)},2503:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});n(7294);var r=n(512),a=n(5999),o=n(6668),i=n(3692),l=n(8138);const s={anchorWithStickyNavbar:"anchorWithStickyNavbar_LWe7",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_WYt5"};var c=n(5893);function u(e){let{as:t,id:n,...u}=e;const d=(0,l.Z)(),{navbar:{hideOnScroll:p}}=(0,o.L)();if("h1"===t||!n)return(0,c.jsx)(t,{...u,id:void 0});d.collectAnchor(n);const f=(0,a.I)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof u.children?u.children:n});return(0,c.jsxs)(t,{...u,className:(0,r.Z)("anchor",p?s.anchorWithHideOnScrollNavbar:s.anchorWithStickyNavbar,u.className),id:n,children:[u.children,(0,c.jsx)(i.Z,{className:"hash-link",to:`#${n}`,"aria-label":f,title:f,children:"\u200b"})]})}},9471:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(7294);const r={iconExternalLink:"iconExternalLink_nPIU"};var a=n(5893);function o(e){let{width:t=13.5,height:n=13.5}=e;return(0,a.jsx)("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:r.iconExternalLink,children:(0,a.jsx)("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"})})}},6040:(e,t,n)=>{"use strict";n.d(t,{Z:()=>ft});var r=n(7294),a=n(512),o=n(4763),i=n(1944),l=n(6550),s=n(5999),c=n(5936),u=n(5893);const d="__docusaurus_skipToContent_fallback";function p(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function f(){const e=(0,r.useRef)(null),{action:t}=(0,l.k6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&p(t)}),[]);return(0,c.S)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}const m=(0,s.I)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function h(e){const t=e.children??m,{containerRef:n,onClick:r}=f();return(0,u.jsx)("div",{ref:n,role:"region","aria-label":m,children:(0,u.jsx)("a",{...e,href:`#${d}`,onClick:r,children:t})})}var g=n(5281),y=n(9727);const b={skipToContent:"skipToContent_fXgn"};function v(){return(0,u.jsx)(h,{className:b.skipToContent})}var w=n(6668),k=n(9689);function x(e){let{width:t=21,height:n=21,color:r="currentColor",strokeWidth:a=1.2,className:o,...i}=e;return(0,u.jsx)("svg",{viewBox:"0 0 15 15",width:t,height:n,...i,children:(0,u.jsx)("g",{stroke:r,strokeWidth:a,children:(0,u.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const S={closeButton:"closeButton_CVFx"};function E(e){return(0,u.jsx)("button",{type:"button","aria-label":(0,s.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,a.Z)("clean-btn close",S.closeButton,e.className),children:(0,u.jsx)(x,{width:14,height:14,strokeWidth:3.1})})}const C={content:"content_knG7"};function _(e){const{announcementBar:t}=(0,w.L)(),{content:n}=t;return(0,u.jsx)("div",{...e,className:(0,a.Z)(C.content,e.className),dangerouslySetInnerHTML:{__html:n}})}const T={announcementBar:"announcementBar_mb4j",announcementBarPlaceholder:"announcementBarPlaceholder_vyr4",announcementBarClose:"announcementBarClose_gvF7",announcementBarContent:"announcementBarContent_xLdY"};function j(){const{announcementBar:e}=(0,w.L)(),{isActive:t,close:n}=(0,k.nT)();if(!t)return null;const{backgroundColor:r,textColor:a,isCloseable:o}=e;return(0,u.jsxs)("div",{className:T.announcementBar,style:{backgroundColor:r,color:a},role:"banner",children:[o&&(0,u.jsx)("div",{className:T.announcementBarPlaceholder}),(0,u.jsx)(_,{className:T.announcementBarContent}),o&&(0,u.jsx)(E,{onClick:n,className:T.announcementBarClose})]})}var A=n(3163),L=n(2466);var N=n(902),R=n(3102);const P=r.createContext(null);function O(e){let{children:t}=e;const n=function(){const e=(0,A.e)(),t=(0,R.HY)(),[n,a]=(0,r.useState)(!1),o=null!==t.component,i=(0,N.D9)(o);return(0,r.useEffect)((()=>{o&&!i&&a(!0)}),[o,i]),(0,r.useEffect)((()=>{o?e.shown||a(!0):a(!1)}),[e.shown,o]),(0,r.useMemo)((()=>[n,a]),[n])}();return(0,u.jsx)(P.Provider,{value:n,children:t})}function D(e){if(e.component){const t=e.component;return(0,u.jsx)(t,{...e.props})}}function I(){const e=(0,r.useContext)(P);if(!e)throw new N.i6("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,a=(0,r.useCallback)((()=>n(!1)),[n]),o=(0,R.HY)();return(0,r.useMemo)((()=>({shown:t,hide:a,content:D(o)})),[a,o,t])}function F(e){let{header:t,primaryMenu:n,secondaryMenu:r}=e;const{shown:o}=I();return(0,u.jsxs)("div",{className:"navbar-sidebar",children:[t,(0,u.jsxs)("div",{className:(0,a.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":o}),children:[(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:n}),(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:r})]})]})}var M=n(2949),z=n(2389);function B(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.jsx)("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"})})}function $(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.jsx)("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"})})}const U={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function q(e){let{className:t,buttonClassName:n,value:r,onChange:o}=e;const i=(0,z.Z)(),l=(0,s.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===r?(0,s.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,s.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return(0,u.jsx)("div",{className:(0,a.Z)(U.toggle,t),children:(0,u.jsxs)("button",{className:(0,a.Z)("clean-btn",U.toggleButton,!i&&U.toggleButtonDisabled,n),type:"button",onClick:()=>o("dark"===r?"light":"dark"),disabled:!i,title:l,"aria-label":l,"aria-live":"polite",children:[(0,u.jsx)(B,{className:(0,a.Z)(U.toggleIcon,U.lightToggleIcon)}),(0,u.jsx)($,{className:(0,a.Z)(U.toggleIcon,U.darkToggleIcon)})]})})}const H=r.memo(q),Z={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_X3D1"};function G(e){let{className:t}=e;const n=(0,w.L)().navbar.style,r=(0,w.L)().colorMode.disableSwitch,{colorMode:a,setColorMode:o}=(0,M.I)();return r?null:(0,u.jsx)(H,{className:t,buttonClassName:"dark"===n?Z.darkNavbarColorModeToggle:void 0,value:a,onChange:o})}var V=n(1327);function W(){return(0,u.jsx)(V.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function Q(){const e=(0,A.e)();return(0,u.jsx)("button",{type:"button","aria-label":(0,s.I)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle(),children:(0,u.jsx)(x,{color:"var(--ifm-color-emphasis-600)"})})}function Y(){return(0,u.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,u.jsx)(W,{}),(0,u.jsx)(G,{className:"margin-right--md"}),(0,u.jsx)(Q,{})]})}var K=n(3692),X=n(4996),J=n(3919);function ee(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var te=n(9471);function ne(e){let{activeBasePath:t,activeBaseRegex:n,to:r,href:a,label:o,html:i,isDropdownLink:l,prependBaseUrlToHref:s,...c}=e;const d=(0,X.Z)(r),p=(0,X.Z)(t),f=(0,X.Z)(a,{forcePrependBaseUrl:!0}),m=o&&a&&!(0,J.Z)(a),h=i?{dangerouslySetInnerHTML:{__html:i}}:{children:(0,u.jsxs)(u.Fragment,{children:[o,m&&(0,u.jsx)(te.Z,{...l&&{width:12,height:12}})]})};return a?(0,u.jsx)(K.Z,{href:s?f:a,...c,...h}):(0,u.jsx)(K.Z,{to:d,isNavLink:!0,...(t||n)&&{isActive:(e,t)=>n?ee(n,t.pathname):t.pathname.startsWith(p)},...c,...h})}function re(e){let{className:t,isDropdownItem:n=!1,...r}=e;const o=(0,u.jsx)(ne,{className:(0,a.Z)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n,...r});return n?(0,u.jsx)("li",{children:o}):o}function ae(e){let{className:t,isDropdownItem:n,...r}=e;return(0,u.jsx)("li",{className:"menu__list-item",children:(0,u.jsx)(ne,{className:(0,a.Z)("menu__link",t),...r})})}function oe(e){let{mobile:t=!1,position:n,...r}=e;const a=t?ae:re;return(0,u.jsx)(a,{...r,activeClassName:r.activeClassName??(t?"menu__link--active":"navbar__link--active")})}var ie=n(6043),le=n(8596),se=n(2263);const ce={dropdownNavbarItemMobile:"dropdownNavbarItemMobile_S0Fm"};function ue(e,t){return e.some((e=>function(e,t){return!!(0,le.Mg)(e.to,t)||!!ee(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function de(e){let{items:t,position:n,className:o,onClick:i,...l}=e;const s=(0,r.useRef)(null),[c,d]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{s.current&&!s.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[s]),(0,u.jsxs)("div",{ref:s,className:(0,a.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":c}),children:[(0,u.jsx)(ne,{"aria-haspopup":"true","aria-expanded":c,role:"button",href:l.to?void 0:"#",className:(0,a.Z)("navbar__link",o),...l,onClick:l.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!c))},children:l.children??l.label}),(0,u.jsx)("ul",{className:"dropdown__menu",children:t.map(((e,t)=>(0,r.createElement)(Ce,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t})))})]})}function pe(e){let{items:t,className:n,position:o,onClick:i,...s}=e;const c=function(){const{siteConfig:{baseUrl:e}}=(0,se.Z)(),{pathname:t}=(0,l.TH)();return t.replace(e,"/")}(),d=ue(t,c),{collapsed:p,toggleCollapsed:f,setCollapsed:m}=(0,ie.u)({initialState:()=>!d});return(0,r.useEffect)((()=>{d&&m(!d)}),[c,d,m]),(0,u.jsxs)("li",{className:(0,a.Z)("menu__list-item",{"menu__list-item--collapsed":p}),children:[(0,u.jsx)(ne,{role:"button",className:(0,a.Z)(ce.dropdownNavbarItemMobile,"menu__link menu__link--sublist menu__link--sublist-caret",n),...s,onClick:e=>{e.preventDefault(),f()},children:s.children??s.label}),(0,u.jsx)(ie.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:p,children:t.map(((e,t)=>(0,r.createElement)(Ce,{mobile:!0,isDropdownItem:!0,onClick:i,activeClassName:"menu__link--active",...e,key:t})))})]})}function fe(e){let{mobile:t=!1,...n}=e;const r=t?pe:de;return(0,u.jsx)(r,{...n})}var me=n(4711);function he(e){let{width:t=20,height:n=20,...r}=e;return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0,...r,children:(0,u.jsx)("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"})})}const ge="iconLanguage_nlXk";var ye=n(1875);const be={navbarSearchContainer:"navbarSearchContainer_Bca1"};function ve(e){let{children:t,className:n}=e;return(0,u.jsx)("div",{className:(0,a.Z)(n,be.navbarSearchContainer),children:t})}var we=n(143),ke=n(3438);var xe=n(373);const Se=e=>e.docs.find((t=>t.id===e.mainDocId));const Ee={default:oe,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:r,queryString:a="",...o}=e;const{i18n:{currentLocale:i,locales:c,localeConfigs:d}}=(0,se.Z)(),p=(0,me.l)(),{search:f,hash:m}=(0,l.TH)(),h=[...n,...c.map((e=>{const n=`${`pathname://${p.createUrl({locale:e,fullyQualified:!1})}`}${f}${m}${a}`;return{label:d[e].label,lang:d[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...r],g=t?(0,s.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[i].label;return(0,u.jsx)(fe,{...o,mobile:t,label:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(he,{className:ge}),g]}),items:h})},search:function(e){let{mobile:t,className:n}=e;return t?null:(0,u.jsx)(ve,{className:n,children:(0,u.jsx)(ye.Z,{})})},dropdown:fe,html:function(e){let{value:t,className:n,mobile:r=!1,isDropdownItem:o=!1}=e;const i=o?"li":"div";return(0,u.jsx)(i,{className:(0,a.Z)({navbar__item:!r&&!o,"menu__list-item":r},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:r,...a}=e;const{activeDoc:o}=(0,we.Iw)(r),i=(0,ke.vY)(t,r),l=o?.path===i?.path;return null===i||i.unlisted&&!l?null:(0,u.jsx)(oe,{exact:!0,...a,isActive:()=>l||!!o?.sidebar&&o.sidebar===i.sidebar,label:n??i.id,to:i.path})},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:r,...a}=e;const{activeDoc:o}=(0,we.Iw)(r),i=(0,ke.oz)(t,r).link;if(!i)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return(0,u.jsx)(oe,{exact:!0,...a,isActive:()=>o?.sidebar===t,label:n??i.label,to:i.path})},docsVersion:function(e){let{label:t,to:n,docsPluginId:r,...a}=e;const o=(0,ke.lO)(r)[0],i=t??o.label,l=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(o).path;return(0,u.jsx)(oe,{...a,label:i,to:l})},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:r,dropdownItemsBefore:a,dropdownItemsAfter:o,...i}=e;const{search:c,hash:d}=(0,l.TH)(),p=(0,we.Iw)(n),f=(0,we.gB)(n),{savePreferredVersionName:m}=(0,xe.J)(n),h=[...a,...f.map((e=>{const t=p.alternateDocVersions[e.name]??Se(e);return{label:e.label,to:`${t.path}${c}${d}`,isActive:()=>e===p.activeVersion,onClick:()=>m(e.name)}})),...o],g=(0,ke.lO)(n)[0],y=t&&h.length>1?(0,s.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):g.label,b=t&&h.length>1?void 0:Se(g).path;return h.length<=1?(0,u.jsx)(oe,{...i,mobile:t,label:y,to:b,isActive:r?()=>!1:void 0}):(0,u.jsx)(fe,{...i,mobile:t,label:y,to:b,items:h,isActive:r?()=>!1:void 0})}};function Ce(e){let{type:t,...n}=e;const r=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),a=Ee[r];if(!a)throw new Error(`No NavbarItem component found for type "${t}".`);return(0,u.jsx)(a,{...n})}function _e(){const e=(0,A.e)(),t=(0,w.L)().navbar.items;return(0,u.jsx)("ul",{className:"menu__list",children:t.map(((t,n)=>(0,r.createElement)(Ce,{mobile:!0,...t,onClick:()=>e.toggle(),key:n})))})}function Te(e){return(0,u.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,u.jsx)(s.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)",children:"\u2190 Back to main menu"})})}function je(){const e=0===(0,w.L)().navbar.items.length,t=I();return(0,u.jsxs)(u.Fragment,{children:[!e&&(0,u.jsx)(Te,{onClick:()=>t.hide()}),t.content]})}function Ae(){const e=(0,A.e)();var t;return void 0===(t=e.shown)&&(t=!0),(0,r.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?(0,u.jsx)(F,{header:(0,u.jsx)(Y,{}),primaryMenu:(0,u.jsx)(_e,{}),secondaryMenu:(0,u.jsx)(je,{})}):null}const Le={navbarHideable:"navbarHideable_m1mJ",navbarHidden:"navbarHidden_jGov"};function Ne(e){return(0,u.jsx)("div",{role:"presentation",...e,className:(0,a.Z)("navbar-sidebar__backdrop",e.className)})}function Re(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:o}}=(0,w.L)(),i=(0,A.e)(),{navbarRef:l,isNavbarVisible:d}=function(e){const[t,n]=(0,r.useState)(e),a=(0,r.useRef)(!1),o=(0,r.useRef)(0),i=(0,r.useCallback)((e=>{null!==e&&(o.current=e.getBoundingClientRect().height)}),[]);return(0,L.RF)(((t,r)=>{let{scrollY:i}=t;if(!e)return;if(i=l?n(!1):i+c{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return a.current=!0,void n(!1);n(!0)})),{navbarRef:i,isNavbarVisible:t}}(n);return(0,u.jsxs)("nav",{ref:l,"aria-label":(0,s.I)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,a.Z)("navbar","navbar--fixed-top",n&&[Le.navbarHideable,!d&&Le.navbarHidden],{"navbar--dark":"dark"===o,"navbar--primary":"primary"===o,"navbar-sidebar--show":i.shown}),children:[t,(0,u.jsx)(Ne,{onClick:i.toggle}),(0,u.jsx)(Ae,{})]})}var Pe=n(8780);const Oe={errorBoundaryError:"errorBoundaryError_a6uf",errorBoundaryFallback:"errorBoundaryFallback_VBag"};function De(e){return(0,u.jsx)("button",{type:"button",...e,children:(0,u.jsx)(s.Z,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function Ie(e){let{error:t}=e;const n=(0,Pe.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,u.jsx)("p",{className:Oe.errorBoundaryError,children:n})}class Fe extends r.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}const Me="right";function ze(e){let{width:t=30,height:n=30,className:r,...a}=e;return(0,u.jsx)("svg",{className:r,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true",...a,children:(0,u.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function Be(){const{toggle:e,shown:t}=(0,A.e)();return(0,u.jsx)("button",{onClick:e,"aria-label":(0,s.I)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button",children:(0,u.jsx)(ze,{})})}const $e={colorModeToggle:"colorModeToggle_DEke"};function Ue(e){let{items:t}=e;return(0,u.jsx)(u.Fragment,{children:t.map(((e,t)=>(0,u.jsx)(Fe,{onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t}),children:(0,u.jsx)(Ce,{...e})},t)))})}function qe(e){let{left:t,right:n}=e;return(0,u.jsxs)("div",{className:"navbar__inner",children:[(0,u.jsx)("div",{className:"navbar__items",children:t}),(0,u.jsx)("div",{className:"navbar__items navbar__items--right",children:n})]})}function He(){const e=(0,A.e)(),t=(0,w.L)().navbar.items,[n,r]=function(e){function t(e){return"left"===(e.position??Me)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),a=t.find((e=>"search"===e.type));return(0,u.jsx)(qe,{left:(0,u.jsxs)(u.Fragment,{children:[!e.disabled&&(0,u.jsx)(Be,{}),(0,u.jsx)(W,{}),(0,u.jsx)(Ue,{items:n})]}),right:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(Ue,{items:r}),(0,u.jsx)(G,{className:$e.colorModeToggle}),!a&&(0,u.jsx)(ve,{children:(0,u.jsx)(ye.Z,{})})]})})}function Ze(){return(0,u.jsx)(Re,{children:(0,u.jsx)(He,{})})}function Ge(e){let{item:t}=e;const{to:n,href:r,label:a,prependBaseUrlToHref:o,...i}=t,l=(0,X.Z)(n),s=(0,X.Z)(r,{forcePrependBaseUrl:!0});return(0,u.jsxs)(K.Z,{className:"footer__link-item",...r?{href:o?s:r}:{to:l},...i,children:[a,r&&!(0,J.Z)(r)&&(0,u.jsx)(te.Z,{})]})}function Ve(e){let{item:t}=e;return t.html?(0,u.jsx)("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)("li",{className:"footer__item",children:(0,u.jsx)(Ge,{item:t})},t.href??t.to)}function We(e){let{column:t}=e;return(0,u.jsxs)("div",{className:"col footer__col",children:[(0,u.jsx)("div",{className:"footer__title",children:t.title}),(0,u.jsx)("ul",{className:"footer__items clean-list",children:t.items.map(((e,t)=>(0,u.jsx)(Ve,{item:e},t)))})]})}function Qe(e){let{columns:t}=e;return(0,u.jsx)("div",{className:"row footer__links",children:t.map(((e,t)=>(0,u.jsx)(We,{column:e},t)))})}function Ye(){return(0,u.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function Ke(e){let{item:t}=e;return t.html?(0,u.jsx)("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)(Ge,{item:t})}function Xe(e){let{links:t}=e;return(0,u.jsx)("div",{className:"footer__links text--center",children:(0,u.jsx)("div",{className:"footer__links",children:t.map(((e,n)=>(0,u.jsxs)(r.Fragment,{children:[(0,u.jsx)(Ke,{item:e}),t.length!==n+1&&(0,u.jsx)(Ye,{})]},n)))})})}function Je(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?(0,u.jsx)(Qe,{columns:t}):(0,u.jsx)(Xe,{links:t})}var et=n(9965);const tt={footerLogoLink:"footerLogoLink_BH7S"};function nt(e){let{logo:t}=e;const{withBaseUrl:n}=(0,X.C)(),r={light:n(t.src),dark:n(t.srcDark??t.src)};return(0,u.jsx)(et.Z,{className:(0,a.Z)("footer__logo",t.className),alt:t.alt,sources:r,width:t.width,height:t.height,style:t.style})}function rt(e){let{logo:t}=e;return t.href?(0,u.jsx)(K.Z,{href:t.href,className:tt.footerLogoLink,target:t.target,children:(0,u.jsx)(nt,{logo:t})}):(0,u.jsx)(nt,{logo:t})}function at(e){let{copyright:t}=e;return(0,u.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function ot(e){let{style:t,links:n,logo:r,copyright:o}=e;return(0,u.jsx)("footer",{className:(0,a.Z)("footer",{"footer--dark":"dark"===t}),children:(0,u.jsxs)("div",{className:"container container-fluid",children:[n,(r||o)&&(0,u.jsxs)("div",{className:"footer__bottom text--center",children:[r&&(0,u.jsx)("div",{className:"margin-bottom--sm",children:r}),o]})]})})}function it(){const{footer:e}=(0,w.L)();if(!e)return null;const{copyright:t,links:n,logo:r,style:a}=e;return(0,u.jsx)(ot,{style:a,links:n&&n.length>0&&(0,u.jsx)(Je,{links:n}),logo:r&&(0,u.jsx)(rt,{logo:r}),copyright:t&&(0,u.jsx)(at,{copyright:t})})}const lt=r.memo(it),st=(0,N.Qc)([M.S,k.pl,L.OC,xe.L5,i.VC,function(e){let{children:t}=e;return(0,u.jsx)(R.n2,{children:(0,u.jsx)(A.M,{children:(0,u.jsx)(O,{children:t})})})}]);function ct(e){let{children:t}=e;return(0,u.jsx)(st,{children:t})}var ut=n(2503);function dt(e){let{error:t,tryAgain:n}=e;return(0,u.jsx)("main",{className:"container margin-vert--xl",children:(0,u.jsx)("div",{className:"row",children:(0,u.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,u.jsx)(ut.Z,{as:"h1",className:"hero__title",children:(0,u.jsx)(s.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,u.jsx)("div",{className:"margin-vert--lg",children:(0,u.jsx)(De,{onClick:n,className:"button button--primary shadow--lw"})}),(0,u.jsx)("hr",{}),(0,u.jsx)("div",{className:"margin-vert--md",children:(0,u.jsx)(Ie,{error:t})})]})})})}const pt={mainWrapper:"mainWrapper_z2l0"};function ft(e){const{children:t,noFooter:n,wrapperClassName:r,title:l,description:s}=e;return(0,y.t)(),(0,u.jsxs)(ct,{children:[(0,u.jsx)(i.d,{title:l,description:s}),(0,u.jsx)(v,{}),(0,u.jsx)(j,{}),(0,u.jsx)(Ze,{}),(0,u.jsx)("div",{id:d,className:(0,a.Z)(g.k.wrapper.main,pt.mainWrapper,r),children:(0,u.jsx)(o.Z,{fallback:e=>(0,u.jsx)(dt,{...e}),children:t})}),!n&&(0,u.jsx)(lt,{})]})}},1327:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});n(7294);var r=n(3692),a=n(4996),o=n(2263),i=n(6668),l=n(9965),s=n(5893);function c(e){let{logo:t,alt:n,imageClassName:r}=e;const o={light:(0,a.Z)(t.src),dark:(0,a.Z)(t.srcDark||t.src)},i=(0,s.jsx)(l.Z,{className:t.className,sources:o,height:t.height,width:t.width,alt:n,style:t.style});return r?(0,s.jsx)("div",{className:r,children:i}):i}function u(e){const{siteConfig:{title:t}}=(0,o.Z)(),{navbar:{title:n,logo:l}}=(0,i.L)(),{imageClassName:u,titleClassName:d,...p}=e,f=(0,a.Z)(l?.href||"/"),m=n?"":t,h=l?.alt??m;return(0,s.jsxs)(r.Z,{to:f,...p,...l?.target&&{target:l.target},children:[l&&(0,s.jsx)(c,{logo:l,alt:h,imageClassName:u}),null!=n&&(0,s.jsx)("b",{className:d,children:n})]})}},197:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(7294);var r=n(5742),a=n(5893);function o(e){let{locale:t,version:n,tag:o}=e;const i=t;return(0,a.jsxs)(r.Z,{children:[t&&(0,a.jsx)("meta",{name:"docusaurus_locale",content:t}),n&&(0,a.jsx)("meta",{name:"docusaurus_version",content:n}),o&&(0,a.jsx)("meta",{name:"docusaurus_tag",content:o}),i&&(0,a.jsx)("meta",{name:"docsearch:language",content:i}),n&&(0,a.jsx)("meta",{name:"docsearch:version",content:n}),o&&(0,a.jsx)("meta",{name:"docsearch:docusaurus_tag",content:o})]})}},9965:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});var r=n(7294),a=n(512),o=n(2389),i=n(2949);const l={themedComponent:"themedComponent_mlkZ","themedComponent--light":"themedComponent--light_NVdE","themedComponent--dark":"themedComponent--dark_xIcU"};var s=n(5893);function c(e){let{className:t,children:n}=e;const c=(0,o.Z)(),{colorMode:u}=(0,i.I)();return(0,s.jsx)(s.Fragment,{children:(c?"dark"===u?["dark"]:["light"]:["light","dark"]).map((e=>{const o=n({theme:e,className:(0,a.Z)(t,l.themedComponent,l[`themedComponent--${e}`])});return(0,s.jsx)(r.Fragment,{children:o},e)}))})}function u(e){const{sources:t,className:n,alt:r,...a}=e;return(0,s.jsx)(c,{className:n,children:e=>{let{theme:n,className:o}=e;return(0,s.jsx)("img",{src:t[n],alt:r,className:o,...a})}})}},6043:(e,t,n)=>{"use strict";n.d(t,{u:()=>c,z:()=>y});var r=n(7294),a=n(412),o=n(469),i=n(1442),l=n(5893);const s="ease-in-out";function c(e){let{initialState:t}=e;const[n,a]=(0,r.useState)(t??!1),o=(0,r.useCallback)((()=>{a((e=>!e))}),[]);return{collapsed:n,setCollapsed:a,toggleCollapsed:o}}const u={display:"none",overflow:"hidden",height:"0px"},d={display:"block",overflow:"visible",height:"auto"};function p(e,t){const n=t?u:d;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function f(e){let{collapsibleRef:t,collapsed:n,animation:a}=e;const o=(0,r.useRef)(!1);(0,r.useEffect)((()=>{const e=t.current;function r(){const t=e.scrollHeight,n=a?.duration??function(e){if((0,i.n)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${a?.easing??s}`,height:`${t}px`}}function l(){const t=r();e.style.transition=t.transition,e.style.height=t.height}if(!o.current)return p(e,n),void(o.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(l(),requestAnimationFrame((()=>{e.style.height=u.height,e.style.overflow=u.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{l()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,a])}function m(e){if(!a.Z.canUseDOM)return e?u:d}function h(e){let{as:t="div",collapsed:n,children:a,animation:o,onCollapseTransitionEnd:i,className:s,disableSSRStyle:c}=e;const u=(0,r.useRef)(null);return f({collapsibleRef:u,collapsed:n,animation:o}),(0,l.jsx)(t,{ref:u,style:c?void 0:m(n),onTransitionEnd:e=>{"height"===e.propertyName&&(p(u.current,n),i?.(n))},className:s,children:a})}function g(e){let{collapsed:t,...n}=e;const[a,i]=(0,r.useState)(!t),[s,c]=(0,r.useState)(t);return(0,o.Z)((()=>{t||i(!0)}),[t]),(0,o.Z)((()=>{a&&c(t)}),[a,t]),a?(0,l.jsx)(h,{...n,collapsed:s}):null}function y(e){let{lazy:t,...n}=e;const r=t?g:h;return(0,l.jsx)(r,{...n})}},9689:(e,t,n)=>{"use strict";n.d(t,{nT:()=>h,pl:()=>m});var r=n(7294),a=n(2389),o=n(12),i=n(902),l=n(6668),s=n(5893);const c=(0,o.WA)("docusaurus.announcement.dismiss"),u=(0,o.WA)("docusaurus.announcement.id"),d=()=>"true"===c.get(),p=e=>c.set(String(e)),f=r.createContext(null);function m(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,l.L)(),t=(0,a.Z)(),[n,o]=(0,r.useState)((()=>!!t&&d()));(0,r.useEffect)((()=>{o(d())}),[]);const i=(0,r.useCallback)((()=>{p(!0),o(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=u.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;u.set(t),r&&p(!1),!r&&d()||o(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return(0,s.jsx)(f.Provider,{value:n,children:t})}function h(){const e=(0,r.useContext)(f);if(!e)throw new i.i6("AnnouncementBarProvider");return e}},2949:(e,t,n)=>{"use strict";n.d(t,{I:()=>y,S:()=>g});var r=n(7294),a=n(412),o=n(902),i=n(12),l=n(6668),s=n(5893);const c=r.createContext(void 0),u="theme",d=(0,i.WA)(u),p={light:"light",dark:"dark"},f=e=>e===p.dark?p.dark:p.light,m=e=>a.Z.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e),h=e=>{d.set(f(e))};function g(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,l.L)(),[a,o]=(0,r.useState)(m(e));(0,r.useEffect)((()=>{t&&d.del()}),[t]);const i=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:a=!0}=r;t?(o(t),a&&h(t)):(o(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p.dark:p.light:e),d.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(a))}),[a]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==u)return;const t=d.get();null!==t&&i(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,i]);const s=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||s.current?s.current=window.matchMedia("print").matches:i(null)};return e.addListener(r),()=>e.removeListener(r)}),[i,t,n]),(0,r.useMemo)((()=>({colorMode:a,setColorMode:i,get isDarkTheme(){return a===p.dark},setLightTheme(){i(p.light)},setDarkTheme(){i(p.dark)}})),[a,i])}();return(0,s.jsx)(c.Provider,{value:n,children:t})}function y(){const e=(0,r.useContext)(c);if(null==e)throw new o.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},373:(e,t,n)=>{"use strict";n.d(t,{J:()=>v,L5:()=>y});var r=n(7294),a=n(143),o=n(9935),i=n(6668),l=n(3438),s=n(902),c=n(12),u=n(5893);const d=e=>`docs-preferred-version-${e}`,p={save:(e,t,n)=>{(0,c.WA)(d(e),{persistence:t}).set(n)},read:(e,t)=>(0,c.WA)(d(e),{persistence:t}).get(),clear:(e,t)=>{(0,c.WA)(d(e),{persistence:t}).del()}},f=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const m=r.createContext(null);function h(){const e=(0,a._r)(),t=(0,i.L)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[o,l]=(0,r.useState)((()=>f(n)));(0,r.useEffect)((()=>{l(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function a(e){const t=p.read(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(p.clear(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,a(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[o,(0,r.useMemo)((()=>({savePreferredVersion:function(e,n){p.save(e,t,n),l((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function g(e){let{children:t}=e;const n=h();return(0,u.jsx)(m.Provider,{value:n,children:t})}function y(e){let{children:t}=e;return l.cE?(0,u.jsx)(g,{children:t}):(0,u.jsx)(u.Fragment,{children:t})}function b(){const e=(0,r.useContext)(m);if(!e)throw new s.i6("DocsPreferredVersionContextProvider");return e}function v(e){void 0===e&&(e=o.m);const t=(0,a.zh)(e),[n,i]=b(),{preferredVersionName:l}=n[e];return{preferredVersion:t.versions.find((e=>e.name===l))??null,savePreferredVersionName:(0,r.useCallback)((t=>{i.savePreferredVersion(e,t)}),[i,e])}}},1116:(e,t,n)=>{"use strict";n.d(t,{V:()=>c,b:()=>s});var r=n(7294),a=n(902),o=n(5893);const i=Symbol("EmptyContext"),l=r.createContext(i);function s(e){let{children:t,name:n,items:a}=e;const i=(0,r.useMemo)((()=>n&&a?{name:n,items:a}:null),[n,a]);return(0,o.jsx)(l.Provider,{value:i,children:t})}function c(){const e=(0,r.useContext)(l);if(e===i)throw new a.i6("DocsSidebarProvider");return e}},4477:(e,t,n)=>{"use strict";n.d(t,{E:()=>s,q:()=>l});var r=n(7294),a=n(902),o=n(5893);const i=r.createContext(null);function l(e){let{children:t,version:n}=e;return(0,o.jsx)(i.Provider,{value:n,children:t})}function s(){const e=(0,r.useContext)(i);if(null===e)throw new a.i6("DocsVersionProvider");return e}},3163:(e,t,n)=>{"use strict";n.d(t,{M:()=>p,e:()=>f});var r=n(7294),a=n(3102),o=n(7524),i=n(1980),l=n(6668),s=n(902),c=n(5893);const u=r.createContext(void 0);function d(){const e=function(){const e=(0,a.HY)(),{items:t}=(0,l.L)().navbar;return 0===t.length&&!e.component}(),t=(0,o.i)(),n=!e&&"mobile"===t,[s,c]=(0,r.useState)(!1);(0,i.Rb)((()=>{if(s)return c(!1),!1}));const u=(0,r.useCallback)((()=>{c((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&c(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:s})),[e,n,u,s])}function p(e){let{children:t}=e;const n=d();return(0,c.jsx)(u.Provider,{value:n,children:t})}function f(){const e=r.useContext(u);if(void 0===e)throw new s.i6("NavbarMobileSidebarProvider");return e}},3102:(e,t,n)=>{"use strict";n.d(t,{HY:()=>s,Zo:()=>c,n2:()=>l});var r=n(7294),a=n(902),o=n(5893);const i=r.createContext(null);function l(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return(0,o.jsx)(i.Provider,{value:n,children:t})}function s(){const e=(0,r.useContext)(i);if(!e)throw new a.i6("NavbarSecondaryMenuContentProvider");return e[0]}function c(e){let{component:t,props:n}=e;const o=(0,r.useContext)(i);if(!o)throw new a.i6("NavbarSecondaryMenuContentProvider");const[,l]=o,s=(0,a.Ql)(n);return(0,r.useEffect)((()=>{l({component:t,props:s})}),[l,t,s]),(0,r.useEffect)((()=>()=>l({component:null,props:null})),[l]),null}},9727:(e,t,n)=>{"use strict";n.d(t,{h:()=>a,t:()=>o});var r=n(7294);const a="navigation-with-keyboard";function o(){(0,r.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(a),"mousedown"===e.type&&document.body.classList.remove(a)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(a),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},7524:(e,t,n)=>{"use strict";n.d(t,{i:()=>l});var r=n(7294),a=n(412);const o={desktop:"desktop",mobile:"mobile",ssr:"ssr"},i=996;function l(e){let{desktopBreakpoint:t=i}=void 0===e?{}:e;const[n,l]=(0,r.useState)((()=>"ssr"));return(0,r.useEffect)((()=>{function e(){l(function(e){if(!a.Z.canUseDOM)throw new Error("getWindowSize() should only be called after React hydration");return window.innerWidth>e?o.desktop:o.mobile}(t))}return e(),window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[t]),n}},5281:(e,t,n)=>{"use strict";n.d(t,{k:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{}}},1442:(e,t,n)=>{"use strict";function r(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{n:()=>r})},3438:(e,t,n)=>{"use strict";n.d(t,{LM:()=>f,SN:()=>E,_F:()=>g,cE:()=>p,f:()=>b,lO:()=>k,oz:()=>x,s1:()=>w,vY:()=>S});var r=n(7294),a=n(6550),o=n(8790),i=n(143),l=n(373),s=n(4477),c=n(1116),u=n(7392),d=n(8596);const p=!!i._r;function f(e){return"link"!==e.type||e.unlisted?"category"===e.type?function(e){if(e.href&&!e.linkUnlisted)return e.href;for(const t of e.items){const e=f(t);if(e)return e}}(e):void 0:e.href}const m=(e,t)=>void 0!==e&&(0,d.Mg)(e,t),h=(e,t)=>e.some((e=>g(e,t)));function g(e,t){return"link"===e.type?m(e.href,t):"category"===e.type&&(m(e.href,t)||h(e.items,t))}function y(e,t){switch(e.type){case"category":return g(e,t)||e.items.some((e=>y(e,t)));case"link":return!e.unlisted||g(e,t);default:return!0}}function b(e,t){return(0,r.useMemo)((()=>e.filter((e=>y(e,t)))),[e,t])}function v(e){let{sidebarItems:t,pathname:n,onlyCategories:r=!1}=e;const a=[];return function e(t){for(const o of t)if("category"===o.type&&((0,d.Mg)(o.href,n)||e(o.items))||"link"===o.type&&(0,d.Mg)(o.href,n)){return r&&"category"!==o.type||a.unshift(o),!0}return!1}(t),a}function w(){const e=(0,c.V)(),{pathname:t}=(0,a.TH)(),n=(0,i.gA)()?.pluginData.breadcrumbs;return!1!==n&&e?v({sidebarItems:e.items,pathname:t}):null}function k(e){const{activeVersion:t}=(0,i.Iw)(e),{preferredVersion:n}=(0,l.J)(e),a=(0,i.yW)(e);return(0,r.useMemo)((()=>(0,u.j)([t,n,a].filter(Boolean))),[t,n,a])}function x(e,t){const n=k(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),r=t.find((t=>t[0]===e));if(!r)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return r[1]}),[e,n])}function S(e,t){const n=k(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),r=t.find((t=>t.id===e));if(!r){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`Couldn't find any doc with id "${e}" in version${n.length>1?"s":""} "${n.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${(0,u.j)(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function E(e){let{route:t}=e;const n=(0,a.TH)(),r=(0,s.E)(),i=t.routes,l=i.find((e=>(0,a.LX)(n.pathname,e)));if(!l)return null;const c=l.sidebar,u=c?r.docsSidebars[c]:void 0;return{docElement:(0,o.H)(i),sidebarName:c,sidebarItems:u}}},1980:(e,t,n)=>{"use strict";n.d(t,{Rb:()=>i,_X:()=>l});var r=n(7294),a=n(6550),o=n(902);function i(e){!function(e){const t=(0,a.k6)(),n=(0,o.zX)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}function l(e){return function(e){const t=(0,a.k6)();return(0,r.useSyncExternalStore)(t.listen,(()=>e(t)),(()=>e(t)))}((t=>null===e?null:new URLSearchParams(t.location.search).get(e)))}},7392:(e,t,n)=>{"use strict";function r(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((n,r)=>e.findIndex((e=>t(e,n)))!==r))}function a(e){return Array.from(new Set(e))}n.d(t,{j:()=>a,l:()=>r})},1944:(e,t,n)=>{"use strict";n.d(t,{FG:()=>f,d:()=>d,VC:()=>m});var r=n(7294),a=n(512),o=n(5742),i=n(226);function l(){const e=r.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var s=n(4996),c=n(2263);var u=n(5893);function d(e){let{title:t,description:n,keywords:r,image:a,children:i}=e;const l=function(e){const{siteConfig:t}=(0,c.Z)(),{title:n,titleDelimiter:r}=t;return e?.trim().length?`${e.trim()} ${r} ${n}`:n}(t),{withBaseUrl:d}=(0,s.C)(),p=a?d(a,{absolute:!0}):void 0;return(0,u.jsxs)(o.Z,{children:[t&&(0,u.jsx)("title",{children:l}),t&&(0,u.jsx)("meta",{property:"og:title",content:l}),n&&(0,u.jsx)("meta",{name:"description",content:n}),n&&(0,u.jsx)("meta",{property:"og:description",content:n}),r&&(0,u.jsx)("meta",{name:"keywords",content:Array.isArray(r)?r.join(","):r}),p&&(0,u.jsx)("meta",{property:"og:image",content:p}),p&&(0,u.jsx)("meta",{name:"twitter:image",content:p}),i]})}const p=r.createContext(void 0);function f(e){let{className:t,children:n}=e;const i=r.useContext(p),l=(0,a.Z)(i,t);return(0,u.jsxs)(p.Provider,{value:l,children:[(0,u.jsx)(o.Z,{children:(0,u.jsx)("html",{className:l})}),n]})}function m(e){let{children:t}=e;const n=l(),r=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const o=`plugin-id-${n.plugin.id}`;return(0,u.jsx)(f,{className:(0,a.Z)(r,o),children:t})}},902:(e,t,n)=>{"use strict";n.d(t,{D9:()=>l,Qc:()=>u,Ql:()=>c,i6:()=>s,zX:()=>i});var r=n(7294),a=n(469),o=n(5893);function i(e){const t=(0,r.useRef)(e);return(0,a.Z)((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function l(e){const t=(0,r.useRef)();return(0,a.Z)((()=>{t.current=e})),t.current}class s extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function c(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function u(e){return t=>{let{children:n}=t;return(0,o.jsx)(o.Fragment,{children:e.reduceRight(((e,t)=>(0,o.jsx)(t,{children:e})),n)})}}},8596:(e,t,n)=>{"use strict";n.d(t,{Mg:()=>i,Ns:()=>l});var r=n(7294),a=n(723),o=n(2263);function i(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function l(){const{baseUrl:e}=(0,o.Z)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function a(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(a).flatMap((e=>e.routes??[])))}(n)}({routes:a.Z,baseUrl:e})),[e])}},2466:(e,t,n)=>{"use strict";n.d(t,{Ct:()=>h,OC:()=>u,RF:()=>f,o5:()=>m});var r=n(7294),a=n(412),o=n(2389),i=n(469),l=n(902),s=n(5893);const c=r.createContext(void 0);function u(e){let{children:t}=e;const n=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return(0,s.jsx)(c.Provider,{value:n,children:t})}function d(){const e=(0,r.useContext)(c);if(null==e)throw new l.i6("ScrollControllerProvider");return e}const p=()=>a.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function f(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=d(),a=(0,r.useRef)(p()),o=(0,l.zX)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=p();o(e,a.current),a.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[o,n,...t])}function m(){const e=d(),t=function(){const e=(0,r.useRef)({elem:null,top:0}),t=(0,r.useCallback)((t=>{e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),n=(0,r.useCallback)((()=>{const{current:{elem:t,top:n}}=e;if(!t)return{restored:!1};const r=t.getBoundingClientRect().top-n;return r&&window.scrollBy({left:0,top:r}),e.current={elem:null,top:0},{restored:0!==r}}),[]);return(0,r.useMemo)((()=>({save:t,restore:n})),[n,t])}(),n=(0,r.useRef)(void 0),a=(0,r.useCallback)((r=>{t.save(r),e.disableScrollEvents(),n.current=()=>{const{restored:r}=t.restore();if(n.current=void 0,r){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}}),[e,t]);return(0,i.Z)((()=>{queueMicrotask((()=>n.current?.()))})),{blockElementScrollPositionUntilNextRender:a}}function h(){const e=(0,r.useRef)(null),t=(0,o.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const a=document.documentElement.scrollTop;(n&&a>e||!n&&at&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},3320:(e,t,n)=>{"use strict";n.d(t,{HX:()=>r,os:()=>a});n(2263);const r="default";function a(e,t){return`docs-${e}-${t}`}},12:(e,t,n)=>{"use strict";n.d(t,{Nk:()=>u,WA:()=>c});var r=n(7294);const a="localStorage";function o(e){let{key:t,oldValue:n,newValue:r,storage:a}=e;if(n===r)return;const o=document.createEvent("StorageEvent");o.initStorageEvent("storage",!1,!1,t,n,r,window.location.href,a),window.dispatchEvent(o)}function i(e){if(void 0===e&&(e=a),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,l||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),l=!0),null}var t}let l=!1;const s={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function c(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(e);const n=i(t?.persistence);return null===n?s:{get:()=>{try{return n.getItem(e)}catch(t){return console.error(`Docusaurus storage error, can't get key=${e}`,t),null}},set:t=>{try{const r=n.getItem(e);n.setItem(e,t),o({key:e,oldValue:r,newValue:t,storage:n})}catch(r){console.error(`Docusaurus storage error, can't set ${e}=${t}`,r)}},del:()=>{try{const t=n.getItem(e);n.removeItem(e),o({key:e,oldValue:t,newValue:null,storage:n})}catch(t){console.error(`Docusaurus storage error, can't delete key=${e}`,t)}},listen:t=>{try{const r=r=>{r.storageArea===n&&r.key===e&&t(r)};return window.addEventListener("storage",r),()=>window.removeEventListener("storage",r)}catch(r){return console.error(`Docusaurus storage error, can't listen for changes of key=${e}`,r),()=>{}}}}}function u(e,t){const n=(0,r.useRef)((()=>null===e?s:c(e,t))).current(),a=(0,r.useCallback)((e=>"undefined"==typeof window?()=>{}:n.listen(e)),[n]);return[(0,r.useSyncExternalStore)(a,(()=>"undefined"==typeof window?null:n.get()),(()=>null)),n]}},4711:(e,t,n)=>{"use strict";n.d(t,{l:()=>i});var r=n(2263),a=n(6550),o=n(8780);function i(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:n},i18n:{defaultLocale:i,currentLocale:l}}=(0,r.Z)(),{pathname:s}=(0,a.TH)(),c=(0,o.applyTrailingSlash)(s,{trailingSlash:n,baseUrl:e}),u=l===i?e:e.replace(`/${l}/`,"/"),d=c.replace(e,"");return{createUrl:function(e){let{locale:n,fullyQualified:r}=e;return`${r?t:""}${function(e){return e===i?`${u}`:`${u}${e}/`}(n)}${d}`}}}},5936:(e,t,n)=>{"use strict";n.d(t,{S:()=>i});var r=n(7294),a=n(6550),o=n(902);function i(e){const t=(0,a.TH)(),n=(0,o.D9)(t),i=(0,o.zX)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},6668:(e,t,n)=>{"use strict";n.d(t,{L:()=>a});var r=n(2263);function a(){return(0,r.Z)().siteConfig.themeConfig}},8802:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[a]=e.split(/[#?]/),o="/"===a||a===r?a:(i=a,n?function(e){return e.endsWith("/")?e:`${e}/`}(i):function(e){return e.endsWith("/")?e.slice(0,-1):e}(i));var i;return e.replace(a,o)}},4143:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=void 0,t.getErrorCausalChain=function e(t){return t.cause?[t,...e(t.cause)]:[t]}},8780:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="__blog-post-container";var a=n(8802);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return r(a).default}});var o=n(4143);Object.defineProperty(t,"getErrorCausalChain",{enumerable:!0,get:function(){return o.getErrorCausalChain}})},9318:(e,t,n)=>{"use strict";n.d(t,{lX:()=>w,q_:()=>_,ob:()=>f,PP:()=>j,Ep:()=>p});var r=n(3117);function a(e){return"/"===e.charAt(0)}function o(e,t){for(var n=t,r=n+1,a=e.length;r=0;p--){var f=i[p];"."===f?o(i,p):".."===f?(o(i,p),d++):d&&(o(i,p),d--)}if(!c)for(;d--;d)i.unshift("..");!c||""===i[0]||i[0]&&a(i[0])||i.unshift("");var m=i.join("/");return n&&"/"!==m.substr(-1)&&(m+="/"),m};var l=n(2177);function s(e){return"/"===e.charAt(0)?e:"/"+e}function c(e){return"/"===e.charAt(0)?e.substr(1):e}function u(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function p(e){var t=e.pathname,n=e.search,r=e.hash,a=t||"/";return n&&"?"!==n&&(a+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(a+="#"===r.charAt(0)?r:"#"+r),a}function f(e,t,n,a){var o;"string"==typeof e?(o=function(e){var t=e||"/",n="",r="",a=t.indexOf("#");-1!==a&&(r=t.substr(a),t=t.substr(0,a));var o=t.indexOf("?");return-1!==o&&(n=t.substr(o),t=t.substr(0,o)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),o.state=t):(void 0===(o=(0,r.Z)({},e)).pathname&&(o.pathname=""),o.search?"?"!==o.search.charAt(0)&&(o.search="?"+o.search):o.search="",o.hash?"#"!==o.hash.charAt(0)&&(o.hash="#"+o.hash):o.hash="",void 0!==t&&void 0===o.state&&(o.state=t));try{o.pathname=decodeURI(o.pathname)}catch(l){throw l instanceof URIError?new URIError('Pathname "'+o.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):l}return n&&(o.key=n),a?o.pathname?"/"!==o.pathname.charAt(0)&&(o.pathname=i(o.pathname,a.pathname)):o.pathname=a.pathname:o.pathname||(o.pathname="/"),o}function m(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,a){if(null!=e){var o="function"==typeof e?e(t,n):e;"string"==typeof o?"function"==typeof r?r(o,a):a(!0):a(!1!==o)}else a(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,a):n.push(a),d({action:r,location:a,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",a=f(e,t,h(),w.location);u.confirmTransitionTo(a,r,n,(function(e){e&&(w.entries[w.index]=a,d({action:r,location:a}))}))},go:v,goBack:function(){v(-1)},goForward:function(){v(1)},canGo:function(e){var t=w.index+e;return t>=0&&t{"use strict";var r=n(9864),a={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},o={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},l={};function s(e){return r.isMemo(e)?i:l[e.$$typeof]||a}l[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},l[r.Memo]=i;var c=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(m){var a=f(n);a&&a!==m&&e(t,a,r)}var i=u(n);d&&(i=i.concat(d(n)));for(var l=s(t),h=s(n),g=0;g{"use strict";e.exports=function(e,t,n,r,a,o,i,l){if(!e){var s;if(void 0===t)s=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var c=[n,r,a,o,i,l],u=0;(s=new Error(t.replace(/%s/g,(function(){return c[u++]})))).name="Invariant Violation"}throw s.framesToPop=1,s}}},5826:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},2497:(e,t,n)=>{"use strict";n.r(t)},2295:(e,t,n)=>{"use strict";n.r(t)},4865:function(e,t,n){var r,a;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function a(e,t,n){return en?n:e}function o(e){return 100*(-1+e)}function i(e,t,n){var a;return(a="translate3d"===r.positionUsing?{transform:"translate3d("+o(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+o(e)+"%,0)"}:{"margin-left":o(e)+"%"}).transition="all "+t+"ms "+n,a}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=a(e,r.minimum,1),n.status=1===e?null:e;var o=n.render(!t),c=o.querySelector(r.barSelector),u=r.speed,d=r.easing;return o.offsetWidth,l((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(c,i(e,u,d)),1===e?(s(o,{transition:"none",opacity:1}),o.offsetWidth,setTimeout((function(){s(o,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*a(Math.random()*t,.1,.95)),t=a(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var a,i=t.querySelector(r.barSelector),l=e?"-100":o(n.status||0),c=document.querySelector(r.parent);return s(i,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(a=t.querySelector(r.spinnerSelector))&&f(a),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var l=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),s=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,a=e.length,o=t.charAt(0).toUpperCase()+t.slice(1);a--;)if((r=e[a]+o)in n)return r;return t}function a(e){return e=n(e),t[e]||(t[e]=r(e))}function o(e,t,n){t=a(t),e.style[t]=n}return function(e,t){var n,r,a=arguments;if(2==a.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&o(e,n,r);else o(e,a[1],a[2])}}();function c(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),r=n+t;c(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);c(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(a="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=a)},9901:e=>{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,n)=>{const r=n(9901),a=n(9642),o=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...o,...Object.keys(Prism.languages)];a(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(6500).resolve(t)],delete Prism.languages[e],n(6500)(t),o.add(e)}))}i.silent=!1,e.exports=i},6854:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,a,o){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(a,(function(e){if("function"==typeof o&&!o(e))return e;for(var a,l=i.length;-1!==n.code.indexOf(a=t(r,l));)++l;return i[l]=e,a})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var a=0,o=Object.keys(n.tokenStack);!function i(l){for(var s=0;s=o.length);s++){var c=l[s];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=o[a],d=n.tokenStack[u],p="string"==typeof c?c:c.content,f=t(r,u),m=p.indexOf(f);if(m>-1){++a;var h=p.substring(0,m),g=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),y=p.substring(m+f.length),b=[];h&&b.push.apply(b,i([h])),b.push(g),y&&b.push.apply(b,i([y])),"string"==typeof c?l.splice.apply(l,[s,1].concat(b)):c.content=b}}else c.content&&i(c.content)}return l}(n.tokens)}}}})}(Prism)},6726:(e,t,n)=>{var r={"./":2885};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=6726},6500:(e,t,n)=>{var r={"./":2885};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=6500},9642:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n "));var l={},s=e[r];if(s){function c(t){if(!(t in e))throw new Error(r+" depends on an unknown component "+t);if(!(t in l))for(var i in a(t,o),l[t]=!0,n[t])l[i]=!0}t(s.require,c),t(s.optional,c),t(s.modify,c)}n[r]=l,o.pop()}}return function(e){var t=n[e];return t||(a(e,r),t=n[e]),t}}function a(e){for(var t in e)return!0;return!1}return function(o,i,l){var s=function(e){var t={};for(var n in e){var r=e[n];for(var a in r)if("meta"!=a){var o=r[a];t[a]="string"==typeof o?{title:o}:o}}return t}(o),c=function(e){var n;return function(r){if(r in e)return r;if(!n)for(var a in n={},e){var o=e[a];t(o&&o.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+a+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+a+" because it is a component.");n[t]=a}))}return n[r]||r}}(s);i=i.map(c),l=(l||[]).map(c);var u=n(i),d=n(l);i.forEach((function e(n){var r=s[n];t(r&&r.require,(function(t){t in d||(u[t]=!0,e(t))}))}));for(var p,f=r(s),m=u;a(m);){for(var h in p={},m){var g=s[h];t(g&&g.modify,(function(e){e in d&&(p[e]=!0)}))}for(var y in d)if(!(y in u))for(var b in f(y))if(b in u){p[y]=!0;break}for(var v in m=p)u[v]=!0}var w={getIds:function(){var e=[];return w.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,r,a){var o=a?a.series:void 0,i=a?a.parallel:e,l={},s={};function c(e){if(e in l)return l[e];s[e]=!0;var a,u=[];for(var d in t(e))d in n&&u.push(d);if(0===u.length)a=r(e);else{var p=i(u.map((function(e){var t=c(e);return delete s[e],t})));o?a=o(p,(function(){return r(e)})):r(e)}return l[e]=a}for(var u in n)c(u);var d=[];for(var p in s)d.push(l[p]);return i(d)}(f,u,t,n)}};return w}}();e.exports=t},2703:(e,t,n)=>{"use strict";var r=n(414);function a(){}function o(){}o.resetWarningCache=a,e.exports=function(){function e(e,t,n,a,o,i){if(i!==r){var l=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw l.name="Invariant Violation",l}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:o,resetWarningCache:a};return n.PropTypes=n,n}},5697:(e,t,n)=>{e.exports=n(2703)()},414:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},4448:(e,t,n)=>{"use strict";var r=n(7294),a=n(3840);function o(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n