[{"data":1,"prerenderedAt":787},["ShallowReactive",2],{"navigation":3,"/events/widget":272,"/events/widget-surround":782},[4,22,59,95,120,161,183,200,243,264],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":6},"Getting Started",false,"/getting-started","01.getting-started",[10,14,18],{"title":11,"path":12,"stem":13},"Introduction","/getting-started/introduction","01.getting-started/1.introduction",{"title":15,"path":16,"stem":17},"Installation","/getting-started/installation","01.getting-started/2.installation",{"title":19,"path":20,"stem":21},"Quick Start","/getting-started/quick-start","01.getting-started/3.quick-start",{"title":23,"path":24,"stem":25,"children":26,"page":6},"Configuration","/configuration","02.configuration",[27,31,35,39,43,47,51,55],{"title":28,"path":29,"stem":30},"Overview","/configuration/overview","02.configuration/1.overview",{"title":32,"path":33,"stem":34},"Size","/configuration/size","02.configuration/2.size",{"title":36,"path":37,"stem":38},"Steps","/configuration/steps","02.configuration/3.steps",{"title":40,"path":41,"stem":42},"Placement","/configuration/placement","02.configuration/4.placement",{"title":44,"path":45,"stem":46},"Animation","/configuration/animation","02.configuration/5.animation",{"title":48,"path":49,"stem":50},"Scroll","/configuration/scroll","02.configuration/6.scroll",{"title":52,"path":53,"stem":54},"Skip","/configuration/skip","02.configuration/7.skip",{"title":56,"path":57,"stem":58},"Styles","/configuration/styles","02.configuration/8.styles",{"title":60,"path":61,"stem":62,"children":63,"page":6},"Components","/components","03.components",[64,68,72,76,80,84,88,91],{"title":65,"path":66,"stem":67},"Container","/components/container","03.components/1.container",{"title":69,"path":70,"stem":71},"Overlay","/components/overlay","03.components/2.overlay",{"title":73,"path":74,"stem":75},"Tooltip","/components/tooltip","03.components/3.tooltip",{"title":77,"path":78,"stem":79},"Image","/components/image","03.components/4.image",{"title":81,"path":82,"stem":83},"Buttons","/components/buttons","03.components/5.buttons",{"title":85,"path":86,"stem":87},"Progress","/components/progress","03.components/6.progress",{"title":52,"path":89,"stem":90},"/components/skip","03.components/7.skip",{"title":92,"path":93,"stem":94},"Close Button","/components/close-button","03.components/8.close-button",{"title":96,"path":97,"stem":98,"children":99,"page":6},"Features","/features","04.features",[100,104,108,112,116],{"title":101,"path":102,"stem":103},"Visibility","/features/visibility","04.features/1.visibility",{"title":105,"path":106,"stem":107},"Responsive","/features/responsive","04.features/2.responsive",{"title":109,"path":110,"stem":111},"Keyboard","/features/keyboard","04.features/3.keyboard",{"title":113,"path":114,"stem":115},"Highlight","/features/highlight","04.features/4.highlight",{"title":117,"path":118,"stem":119},"Overrides","/features/overrides","04.features/5.overrides",{"title":121,"path":122,"stem":123,"children":124,"page":6},"API Reference","/api-reference","05.api-reference",[125,129,133,137,141,145,149,153,157],{"title":126,"path":127,"stem":128},"useBorda","/api-reference/use-borda","05.api-reference/1.use-borda",{"title":130,"path":131,"stem":132},"useConfig","/api-reference/use-config","05.api-reference/2.use-config",{"title":134,"path":135,"stem":136},"useHighlight","/api-reference/use-highlight","05.api-reference/3.use-highlight",{"title":138,"path":139,"stem":140},"Borda Instance","/api-reference/borda-instance","05.api-reference/4.borda-instance",{"title":142,"path":143,"stem":144},"Controller API","/api-reference/controller-api","05.api-reference/5.controller-api",{"title":146,"path":147,"stem":148},"Events API","/api-reference/events-api","05.api-reference/6.events-api",{"title":150,"path":151,"stem":152},"Visibility API","/api-reference/visibility-api","05.api-reference/7.visibility-api",{"title":154,"path":155,"stem":156},"Skip API","/api-reference/skip-api","05.api-reference/8.skip-api",{"title":158,"path":159,"stem":160},"Scroll API","/api-reference/scroll-api","05.api-reference/9.scroll-api",{"title":162,"path":163,"stem":164,"children":165,"page":6},"Events","/events","06.events",[166,170,174,177,180],{"title":167,"path":168,"stem":169},"Tour","/events/tour","06.events/1.tour",{"title":171,"path":172,"stem":173},"Widget","/events/widget","06.events/2.widget",{"title":52,"path":175,"stem":176},"/events/skip","06.events/3.skip",{"title":101,"path":178,"stem":179},"/events/visibility","06.events/4.visibility",{"title":109,"path":181,"stem":182},"/events/keyboard","06.events/5.keyboard",{"title":184,"path":185,"stem":186,"children":187,"page":6},"Custom Element","/custom-element","07.custom-element",[188,192,196],{"title":189,"path":190,"stem":191},"Setup","/custom-element/setup","07.custom-element/1.setup",{"title":193,"path":194,"stem":195},"Usage","/custom-element/usage","07.custom-element/2.usage",{"title":197,"path":198,"stem":199},"DOM Events","/custom-element/events","07.custom-element/3.events",{"title":201,"path":202,"stem":203,"children":204,"page":6},"Examples","/examples","08.examples",[205,209,213,217,220,223,226,229,233,236,240],{"title":206,"path":207,"stem":208},"Basic Setup","/examples/basic-setup","08.examples/01.basic-setup",{"title":210,"path":211,"stem":212},"Multi-step","/examples/multi-step","08.examples/02.multi-step",{"title":214,"path":215,"stem":216},"Custom Styling","/examples/custom-styling","08.examples/03.custom-styling",{"title":113,"path":218,"stem":219},"/examples/highlight","08.examples/04.highlight",{"title":105,"path":221,"stem":222},"/examples/responsive","08.examples/05.responsive",{"title":117,"path":224,"stem":225},"/examples/overrides","08.examples/06.overrides",{"title":109,"path":227,"stem":228},"/examples/keyboard","08.examples/07.keyboard",{"title":230,"path":231,"stem":232},"Don't Show Again","/examples/skip","08.examples/08.skip",{"title":44,"path":234,"stem":235},"/examples/animation","08.examples/09.animation",{"title":237,"path":238,"stem":239},"Transition","/examples/transition","08.examples/10.transition",{"title":85,"path":241,"stem":242},"/examples/progress","08.examples/11.progress",{"title":244,"path":245,"stem":246,"children":247,"page":6},"Distribution","/distribution","09.distribution",[248,252,256,260],{"title":249,"path":250,"stem":251},"Formats","/distribution/formats","09.distribution/1.formats",{"title":253,"path":254,"stem":255},"Browser Support","/distribution/browser-support","09.distribution/2.browser-support",{"title":257,"path":258,"stem":259},"Bundle Size","/distribution/bundle-size","09.distribution/3.bundle-size",{"title":261,"path":262,"stem":263},"TypeScript","/distribution/typescript","09.distribution/4.typescript",{"title":265,"path":266,"stem":267,"children":268,"page":6},"Accessibility","/accessibility","10.accessibility",[269],{"title":28,"path":270,"stem":271},"/accessibility/overview","10.accessibility/1.overview",{"id":273,"title":171,"body":274,"description":776,"extension":777,"links":778,"meta":779,"navigation":407,"path":172,"seo":780,"stem":173,"__hash__":781},"docs/06.events/2.widget.md",{"type":275,"value":276,"toc":770},"minimark",[277,281,285,354,357,622,626,633,745,749,766],[278,279,280],"p",{},"Widget events fire for structural lifecycle and user interactions with the overlay and close button. They carry no payload and require no arguments in the handler.",[282,283,162],"h2",{"id":284},"events",[286,287,288,304],"table",{},[289,290,291],"thead",{},[292,293,294,298,301],"tr",{},[295,296,297],"th",{},"Event",[295,299,300],{},"String value",[295,302,303],{},"When",[305,306,307,324,339],"tbody",{},[292,308,309,316,321],{},[310,311,312],"td",{},[313,314,315],"code",{},"ON_BORDA_DESTROY",[310,317,318],{},[313,319,320],{},"borda:on-destroy",[310,322,323],{},"Widget is about to be destroyed, before cleanup",[292,325,326,331,336],{},[310,327,328],{},[313,329,330],{},"ON_CLOSE_CLICK",[310,332,333],{},[313,334,335],{},"close:click",[310,337,338],{},"Close button is clicked",[292,340,341,346,351],{},[310,342,343],{},[313,344,345],{},"ON_OVERLAY_CLICK",[310,347,348],{},[313,349,350],{},"overlay:click",[310,352,353],{},"Overlay backdrop is clicked or activated via Enter/Space",[282,355,193],{"id":356},"usage",[358,359,364],"pre",{"className":360,"code":361,"language":362,"meta":363,"style":363},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","import { BordaEvent } from '@retoo/borda';\n\ninstance.api.events.on(BordaEvent.ON_BORDA_DESTROY, () => {\n  console.log('Widget is being destroyed');\n});\n\ninstance.api.events.on(BordaEvent.ON_CLOSE_CLICK, () => {\n  console.log('Close button clicked');\n});\n\ninstance.api.events.on(BordaEvent.ON_OVERLAY_CLICK, () => {\n  console.log('Overlay backdrop clicked');\n});\n","ts","",[313,365,366,402,409,451,478,488,493,524,546,555,560,591,613],{"__ignoreMap":363},[367,368,371,375,379,383,386,389,392,396,399],"span",{"class":369,"line":370},"line",1,[367,372,374],{"class":373},"s7zQu","import",[367,376,378],{"class":377},"sMK4o"," {",[367,380,382],{"class":381},"sTEyZ"," BordaEvent",[367,384,385],{"class":377}," }",[367,387,388],{"class":373}," from",[367,390,391],{"class":377}," '",[367,393,395],{"class":394},"sfazB","@retoo/borda",[367,397,398],{"class":377},"'",[367,400,401],{"class":377},";\n",[367,403,405],{"class":369,"line":404},2,[367,406,408],{"emptyLinePlaceholder":407},true,"\n",[367,410,412,415,418,421,423,425,427,431,434,436,438,441,444,448],{"class":369,"line":411},3,[367,413,414],{"class":381},"instance",[367,416,417],{"class":377},".",[367,419,420],{"class":381},"api",[367,422,417],{"class":377},[367,424,284],{"class":381},[367,426,417],{"class":377},[367,428,430],{"class":429},"s2Zo4","on",[367,432,433],{"class":381},"(BordaEvent",[367,435,417],{"class":377},[367,437,315],{"class":381},[367,439,440],{"class":377},",",[367,442,443],{"class":377}," ()",[367,445,447],{"class":446},"spNyl"," =>",[367,449,450],{"class":377}," {\n",[367,452,454,457,459,462,466,468,471,473,476],{"class":369,"line":453},4,[367,455,456],{"class":381},"  console",[367,458,417],{"class":377},[367,460,461],{"class":429},"log",[367,463,465],{"class":464},"swJcz","(",[367,467,398],{"class":377},[367,469,470],{"class":394},"Widget is being destroyed",[367,472,398],{"class":377},[367,474,475],{"class":464},")",[367,477,401],{"class":377},[367,479,481,484,486],{"class":369,"line":480},5,[367,482,483],{"class":377},"}",[367,485,475],{"class":381},[367,487,401],{"class":377},[367,489,491],{"class":369,"line":490},6,[367,492,408],{"emptyLinePlaceholder":407},[367,494,496,498,500,502,504,506,508,510,512,514,516,518,520,522],{"class":369,"line":495},7,[367,497,414],{"class":381},[367,499,417],{"class":377},[367,501,420],{"class":381},[367,503,417],{"class":377},[367,505,284],{"class":381},[367,507,417],{"class":377},[367,509,430],{"class":429},[367,511,433],{"class":381},[367,513,417],{"class":377},[367,515,330],{"class":381},[367,517,440],{"class":377},[367,519,443],{"class":377},[367,521,447],{"class":446},[367,523,450],{"class":377},[367,525,527,529,531,533,535,537,540,542,544],{"class":369,"line":526},8,[367,528,456],{"class":381},[367,530,417],{"class":377},[367,532,461],{"class":429},[367,534,465],{"class":464},[367,536,398],{"class":377},[367,538,539],{"class":394},"Close button clicked",[367,541,398],{"class":377},[367,543,475],{"class":464},[367,545,401],{"class":377},[367,547,549,551,553],{"class":369,"line":548},9,[367,550,483],{"class":377},[367,552,475],{"class":381},[367,554,401],{"class":377},[367,556,558],{"class":369,"line":557},10,[367,559,408],{"emptyLinePlaceholder":407},[367,561,563,565,567,569,571,573,575,577,579,581,583,585,587,589],{"class":369,"line":562},11,[367,564,414],{"class":381},[367,566,417],{"class":377},[367,568,420],{"class":381},[367,570,417],{"class":377},[367,572,284],{"class":381},[367,574,417],{"class":377},[367,576,430],{"class":429},[367,578,433],{"class":381},[367,580,417],{"class":377},[367,582,345],{"class":381},[367,584,440],{"class":377},[367,586,443],{"class":377},[367,588,447],{"class":446},[367,590,450],{"class":377},[367,592,594,596,598,600,602,604,607,609,611],{"class":369,"line":593},12,[367,595,456],{"class":381},[367,597,417],{"class":377},[367,599,461],{"class":429},[367,601,465],{"class":464},[367,603,398],{"class":377},[367,605,606],{"class":394},"Overlay backdrop clicked",[367,608,398],{"class":377},[367,610,475],{"class":464},[367,612,401],{"class":377},[367,614,616,618,620],{"class":369,"line":615},13,[367,617,483],{"class":377},[367,619,475],{"class":381},[367,621,401],{"class":377},[282,623,625],{"id":624},"unsubscribing","Unsubscribing",[278,627,628,629,632],{},"Pass the same handler reference to ",[313,630,631],{},"off()",":",[358,634,636],{"className":360,"code":635,"language":362,"meta":363,"style":363},"const onDestroy = () => console.log('Destroyed');\n\ninstance.api.events.on(BordaEvent.ON_BORDA_DESTROY, onDestroy);\n\n// Later\ninstance.api.events.off(BordaEvent.ON_BORDA_DESTROY, onDestroy);\n",[313,637,638,673,677,706,710,716],{"__ignoreMap":363},[367,639,640,643,646,649,651,653,656,658,660,662,664,667,669,671],{"class":369,"line":370},[367,641,642],{"class":446},"const",[367,644,645],{"class":381}," onDestroy ",[367,647,648],{"class":377},"=",[367,650,443],{"class":377},[367,652,447],{"class":446},[367,654,655],{"class":381}," console",[367,657,417],{"class":377},[367,659,461],{"class":429},[367,661,465],{"class":381},[367,663,398],{"class":377},[367,665,666],{"class":394},"Destroyed",[367,668,398],{"class":377},[367,670,475],{"class":381},[367,672,401],{"class":377},[367,674,675],{"class":369,"line":404},[367,676,408],{"emptyLinePlaceholder":407},[367,678,679,681,683,685,687,689,691,693,695,697,699,701,704],{"class":369,"line":411},[367,680,414],{"class":381},[367,682,417],{"class":377},[367,684,420],{"class":381},[367,686,417],{"class":377},[367,688,284],{"class":381},[367,690,417],{"class":377},[367,692,430],{"class":429},[367,694,433],{"class":381},[367,696,417],{"class":377},[367,698,315],{"class":381},[367,700,440],{"class":377},[367,702,703],{"class":381}," onDestroy)",[367,705,401],{"class":377},[367,707,708],{"class":369,"line":453},[367,709,408],{"emptyLinePlaceholder":407},[367,711,712],{"class":369,"line":480},[367,713,715],{"class":714},"sHwdD","// Later\n",[367,717,718,720,722,724,726,728,730,733,735,737,739,741,743],{"class":369,"line":490},[367,719,414],{"class":381},[367,721,417],{"class":377},[367,723,420],{"class":381},[367,725,417],{"class":377},[367,727,284],{"class":381},[367,729,417],{"class":377},[367,731,732],{"class":429},"off",[367,734,433],{"class":381},[367,736,417],{"class":377},[367,738,315],{"class":381},[367,740,440],{"class":377},[367,742,703],{"class":381},[367,744,401],{"class":377},[282,746,748],{"id":747},"notes","Notes",[750,751,752,758],"ul",{},[753,754,755,757],"li",{},[313,756,315],{}," fires before cleanup. After this event, the event emitter is cleared and all handlers are removed automatically.",[753,759,760,762,763,765],{},[313,761,330],{}," and ",[313,764,345],{}," are user interaction events — they fire regardless of whether the tour has a close handler configured.",[767,768,769],"style",{},"html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}",{"title":363,"searchDepth":370,"depth":404,"links":771},[772,773,774,775],{"id":284,"depth":404,"text":162},{"id":356,"depth":404,"text":193},{"id":624,"depth":404,"text":625},{"id":747,"depth":404,"text":748},"Handle widget destruction with ON_BORDA_DESTROY and interactions with ON_CLOSE_CLICK and ON_OVERLAY_CLICK.","md",null,{},{"title":171,"description":776},"pHsEstS7Dk4vUh2TaI9R9HUfx2Se2CP5W3nKc4zDPgI",[783,785],{"title":167,"path":168,"stem":169,"description":784,"children":-1},"Lifecycle events for tour start, finish, close, navigation, and step changes.",{"title":52,"path":175,"stem":176,"description":786,"children":-1},"Handle \"Don't show again\" state changes with ON_SKIP_CHANGE and ON_SKIP_CLEAR.",1784550679565]