[{"data":1,"prerenderedAt":738},["ShallowReactive",2],{"navigation":3,"/api-reference/events-api":272,"/api-reference/events-api-surround":733},[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":146,"body":274,"description":727,"extension":728,"links":729,"meta":730,"navigation":424,"path":147,"seo":731,"stem":148,"__hash__":732},"docs/05.api-reference/6.events-api.md",{"type":275,"value":276,"toc":721},"minimark",[277,286,291,371,374,696,700,706,710,717],[278,279,280,281,285],"p",{},"The event emitter provides a typed pub/sub system for listening to tour, widget, and feature events. Access it through ",[282,283,284],"code",{},"instance.api.events",".",[287,288,290],"h2",{"id":289},"methods","Methods",[292,293,294,307],"table",{},[295,296,297],"thead",{},[298,299,300,304],"tr",{},[301,302,303],"th",{},"Method",[301,305,306],{},"Description",[308,309,310,321,331,341,351,361],"tbody",{},[298,311,312,318],{},[313,314,315],"td",{},[282,316,317],{},"on(eventName, handler)",[313,319,320],{},"Subscribe a handler to an event",[298,322,323,328],{},[313,324,325],{},[282,326,327],{},"once(eventName, handler)",[313,329,330],{},"Subscribe; auto-unsubscribes after first call",[298,332,333,338],{},[313,334,335],{},[282,336,337],{},"off(eventName, handler)",[313,339,340],{},"Unsubscribe a specific handler",[298,342,343,348],{},[313,344,345],{},[282,346,347],{},"emit\u003CT>(eventName, data?)",[313,349,350],{},"Emit an event with optional data",[298,352,353,358],{},[313,354,355],{},[282,356,357],{},"remove(eventName)",[313,359,360],{},"Remove all handlers for a specific event",[298,362,363,368],{},[313,364,365],{},[282,366,367],{},"clear()",[313,369,370],{},"Remove all handlers for all events",[287,372,193],{"id":373},"usage",[375,376,381],"pre",{"className":377,"code":378,"language":379,"meta":380,"style":380},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","import { BordaEvent } from '@retoo/borda';\n\n// Subscribe\ninstance.api.events.on(BordaEvent.ON_TOUR_START, () => {\n  console.log('Tour started');\n});\n\n// Unsubscribe\nconst handler = () => console.log('finished');\ninstance.api.events.on(BordaEvent.ON_TOUR_FINISH, handler);\ninstance.api.events.off(BordaEvent.ON_TOUR_FINISH, handler);\n\n// One-time subscription\ninstance.api.events.once(BordaEvent.ON_TOUR_CLOSE, () => {\n  console.log('Tour closed (once)');\n});\n","ts","",[282,382,383,419,426,433,476,503,513,518,524,560,591,621,626,632,665,687],{"__ignoreMap":380},[384,385,388,392,396,400,403,406,409,413,416],"span",{"class":386,"line":387},"line",1,[384,389,391],{"class":390},"s7zQu","import",[384,393,395],{"class":394},"sMK4o"," {",[384,397,399],{"class":398},"sTEyZ"," BordaEvent",[384,401,402],{"class":394}," }",[384,404,405],{"class":390}," from",[384,407,408],{"class":394}," '",[384,410,412],{"class":411},"sfazB","@retoo/borda",[384,414,415],{"class":394},"'",[384,417,418],{"class":394},";\n",[384,420,422],{"class":386,"line":421},2,[384,423,425],{"emptyLinePlaceholder":424},true,"\n",[384,427,429],{"class":386,"line":428},3,[384,430,432],{"class":431},"sHwdD","// Subscribe\n",[384,434,436,439,441,444,446,449,451,455,458,460,463,466,469,473],{"class":386,"line":435},4,[384,437,438],{"class":398},"instance",[384,440,285],{"class":394},[384,442,443],{"class":398},"api",[384,445,285],{"class":394},[384,447,448],{"class":398},"events",[384,450,285],{"class":394},[384,452,454],{"class":453},"s2Zo4","on",[384,456,457],{"class":398},"(BordaEvent",[384,459,285],{"class":394},[384,461,462],{"class":398},"ON_TOUR_START",[384,464,465],{"class":394},",",[384,467,468],{"class":394}," ()",[384,470,472],{"class":471},"spNyl"," =>",[384,474,475],{"class":394}," {\n",[384,477,479,482,484,487,491,493,496,498,501],{"class":386,"line":478},5,[384,480,481],{"class":398},"  console",[384,483,285],{"class":394},[384,485,486],{"class":453},"log",[384,488,490],{"class":489},"swJcz","(",[384,492,415],{"class":394},[384,494,495],{"class":411},"Tour started",[384,497,415],{"class":394},[384,499,500],{"class":489},")",[384,502,418],{"class":394},[384,504,506,509,511],{"class":386,"line":505},6,[384,507,508],{"class":394},"}",[384,510,500],{"class":398},[384,512,418],{"class":394},[384,514,516],{"class":386,"line":515},7,[384,517,425],{"emptyLinePlaceholder":424},[384,519,521],{"class":386,"line":520},8,[384,522,523],{"class":431},"// Unsubscribe\n",[384,525,527,530,533,536,538,540,543,545,547,549,551,554,556,558],{"class":386,"line":526},9,[384,528,529],{"class":471},"const",[384,531,532],{"class":398}," handler ",[384,534,535],{"class":394},"=",[384,537,468],{"class":394},[384,539,472],{"class":471},[384,541,542],{"class":398}," console",[384,544,285],{"class":394},[384,546,486],{"class":453},[384,548,490],{"class":398},[384,550,415],{"class":394},[384,552,553],{"class":411},"finished",[384,555,415],{"class":394},[384,557,500],{"class":398},[384,559,418],{"class":394},[384,561,563,565,567,569,571,573,575,577,579,581,584,586,589],{"class":386,"line":562},10,[384,564,438],{"class":398},[384,566,285],{"class":394},[384,568,443],{"class":398},[384,570,285],{"class":394},[384,572,448],{"class":398},[384,574,285],{"class":394},[384,576,454],{"class":453},[384,578,457],{"class":398},[384,580,285],{"class":394},[384,582,583],{"class":398},"ON_TOUR_FINISH",[384,585,465],{"class":394},[384,587,588],{"class":398}," handler)",[384,590,418],{"class":394},[384,592,594,596,598,600,602,604,606,609,611,613,615,617,619],{"class":386,"line":593},11,[384,595,438],{"class":398},[384,597,285],{"class":394},[384,599,443],{"class":398},[384,601,285],{"class":394},[384,603,448],{"class":398},[384,605,285],{"class":394},[384,607,608],{"class":453},"off",[384,610,457],{"class":398},[384,612,285],{"class":394},[384,614,583],{"class":398},[384,616,465],{"class":394},[384,618,588],{"class":398},[384,620,418],{"class":394},[384,622,624],{"class":386,"line":623},12,[384,625,425],{"emptyLinePlaceholder":424},[384,627,629],{"class":386,"line":628},13,[384,630,631],{"class":431},"// One-time subscription\n",[384,633,635,637,639,641,643,645,647,650,652,654,657,659,661,663],{"class":386,"line":634},14,[384,636,438],{"class":398},[384,638,285],{"class":394},[384,640,443],{"class":398},[384,642,285],{"class":394},[384,644,448],{"class":398},[384,646,285],{"class":394},[384,648,649],{"class":453},"once",[384,651,457],{"class":398},[384,653,285],{"class":394},[384,655,656],{"class":398},"ON_TOUR_CLOSE",[384,658,465],{"class":394},[384,660,468],{"class":394},[384,662,472],{"class":471},[384,664,475],{"class":394},[384,666,668,670,672,674,676,678,681,683,685],{"class":386,"line":667},15,[384,669,481],{"class":398},[384,671,285],{"class":394},[384,673,486],{"class":453},[384,675,490],{"class":489},[384,677,415],{"class":394},[384,679,680],{"class":411},"Tour closed (once)",[384,682,415],{"class":394},[384,684,500],{"class":489},[384,686,418],{"class":394},[384,688,690,692,694],{"class":386,"line":689},16,[384,691,508],{"class":394},[384,693,500],{"class":398},[384,695,418],{"class":394},[287,697,699],{"id":698},"cleanup","Cleanup",[278,701,702,703,285],{},"All handlers are automatically cleared when the instance is unmounted. There is no need to unsubscribe manually before calling ",[282,704,705],{},"borda.unmount()",[287,707,709],{"id":708},"events-list","Events list",[278,711,712,713,716],{},"See the ",[714,715,162],"a",{"href":168}," section for the full list of available events organized by category.",[718,719,720],"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 .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}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);}",{"title":380,"searchDepth":387,"depth":421,"links":722},[723,724,725,726],{"id":289,"depth":421,"text":290},{"id":373,"depth":421,"text":193},{"id":698,"depth":421,"text":699},{"id":708,"depth":421,"text":709},"Pub/sub event emitter for subscribing to tour and widget lifecycle events.","md",null,{},{"title":146,"description":727},"butznvw5dACk_I3218InG3Y30W_PIgk7XZeboWA_gTk",[734,736],{"title":142,"path":143,"stem":144,"description":735,"children":-1},"Tour navigation API — currentStep, next, prev, changeStep, finish, and move prevention.",{"title":150,"path":151,"stem":152,"description":737,"children":-1},"Show, hide, and check the widget's visibility state at runtime.",1784550679066]