@ guidelytech/ guide- runtime
指南SDK和仪表板编辑器使用的无框架DOM引擎:元素分辨率, 影子DOM主机和主题,阶梯渲染器(浮-地定位),向导控制器, 核对表 / 调查/ 资源中心部件、 允许列表 HTML 消毒器和作者拾取器.
pnpm add @guidelytech/guide-runtime
import { runGuide } from "@guidelytech/guide-runtime";
const controller = runGuide(publishedGuide, {
theme: config.theme,
ctx: () => targetingContext,
onEvent: (e) => console.log(e.name, e.stepId),
onNavigate: (url) => router.push(url),
});
controller.start();
选择器
| 导出 | 说明 |
|---|---|
resolveTarget(target | selectors, root?) | 调整策略id, (中文(简体) ), data-attr, (中文(简体) ), aria, (中文(简体) ), css, (中文(简体) ), text, (中文(简体) ), xpath; 策略只有在完全匹配一个可见元素时才会获胜. |
waitForTarget(target, { timeoutMs, signal, root, pollMs }) | 变异观察员+ 250米投票;以 TargetTimeoutError 编号 : AbortError。 。 。 . timeoutMs: 0 永远等待. |
generateSelectors(el) | 拾取者的强力第一策略:稳定的id(生成的ids如 :r1:, (中文(简体) ), radix-…长数字运行被跳过, data-testid编号 :data-tour编号 :data-*, (中文(简体) ), aria-label, (中文(简体) ), name编号 :role,短而独特的 CSS 路径(nth-of-type 仅在需要时), text 倒扣/链接/标题. |
describeElement(el) | { selectors, textSnapshot, rect, tag }。 。 。 . |
textSnapshotOf(el), (中文(简体) ), isVisible(el), (中文(简体) ), isStableId(id), (中文(简体) ), isGuidelyElement(el), (中文(简体) ), querySelectorStrategy(strategy, root), (中文(简体) ), normalizeText(text), (中文(简体) ), urlMatches(pattern, url) | 助会者. |
主机和主题
ensureHost() 附加单曲 <div id="guidely-root"> 带有全部打开的阴影根
样式( e):host{all:initial})和有礼貌的活区. createScope(theme, appearance) 创建一个
装货箱(--g-primary, (中文(简体) ), --g-bg, (中文(简体) ), --g-text, (中文(简体) ), --g-radius, (中文(简体) ), --g-font, (中文(简体) ), --g-z, (中文(简体) ),
--g-overlay· ; data-theme="light|dark", (中文(简体) ), data-anim) (中文(简体) ). auto 如下 prefers-color-scheme· ;
prefers-reduced-motion 禁用动画. resolveTheme, (中文(简体) ), applyTheme, (中文(简体) ), destroyHost, (中文(简体) ),
DEFAULT_THEME, (中文(简体) ), HOST_ID, (中文(简体) ), STYLES 也被导出.
渲染
renderStep({ scope, step, index, total, target, asModal, onButton, onClose, onOpen }) 制造任何
步骤类型和返回 { el, card, destroy }数字 :
modal——中卡,可选的叠加,role="dialog" aria-modal, Tab 焦点陷阱.tooltip编号 :popover以浮井为锚地(offset, (中文(简体) ),flip编号 :autoPlacement, (中文(简体) ),shift, (中文(简体) ),arrow, (中文(简体) ),autoUpdate, (中文(简体) ),role="tooltip", (中文(简体) ),aria-describedby设定目标.spotlight——四重覆被绕入目标(目标仍可点击)+环+锚地卡.hotspot——在目标拐角处脉冲点,点击或徘徊时打开卡.banner固定上下行,role="status"。 。 。 .slideout- 转角卡.custom——消毒处理customHtml只; 元素为data-g-action="next|back|dismiss|complete|skip"作为按钮.
Chrome: 关闭按钮( 退出时) showClose),图像,标题,消毒体,进步
("2 of 4"),按钮为: variants, 焦点移入卡片并恢复到闭合和屏幕阅读器上
通知,卡片夹住 100vw - 32px40px触摸目标.
anchor(reference, floating, options) 财务报告和审定财务报表 trackRect(el, cb) 揭发定位原始人.
主计长
runGuide(guide, options): GuideController - 选项: theme, (中文(简体) ), ctx, (中文(简体) ), onEvent, (中文(简体) ), onNavigate, (中文(简体) ),
onAction (单位:千美元)start_guide 编号 : event 编号 : open_resource_center, (中文(简体) ), onError, (中文(简体) ), onEnd, (中文(简体) ), eventBus
(计: advanceOn: "event", (中文(简体) ), startAtStep, (中文(简体) ), currentUrl, (中文(简体) ), container, (中文(简体) ), doc。 。 。 .
主计长: start(), (中文(简体) ), next(), (中文(简体) ), back(), (中文(简体) ), goTo(stepId), (中文(简体) ), dismiss(), (中文(简体) ), complete(), (中文(简体) ), skip(), (中文(简体) ),
resume() (重新检查一个步骤等待其URL), destroy(), (中文(简体) ), getState()。 。 。 .
处理 advanceOn (单位:千美元)button, (中文(简体) ), element_click, (中文(简体) ), element_visible, (中文(简体) ), event, (中文(简体) ), delay, (中文(简体) ), any, (中文(简体) ),
分支evaluateRules(branch.when, ctx) ),分级目标,多页
步骤(step.url,目标等待 skip 编号 : show_as_modal 编号 : end_guide 编号 : wait 后退,
发送 guide_viewed, (中文(简体) ), guide_started, (中文(简体) ), step_viewed, (中文(简体) ), step_completed, (中文(简体) ), guide_completed, (中文(简体) ),
guide_skipped, (中文(简体) ), guide_dismissed通过试验/渔获物包裹并报告制作情况 onError。 。 。 .
部件
renderChecklist({ scope, config, progress, open, onTaskClick, onDismiss, onOpen, onClose })→{ open, close, toggle, isOpen, setProgress, destroy }· ;isChecklistComplete(config, progress)。 。 。 .renderSurvey({ scope, config, title, onSubmit, onDismiss, onChange })→{ getAnswers, showThankYou, destroy }· ;isQuestionVisible(question, answers)评价showWhen。 。 。 .renderResourceCenter({ scope, config, guides, search, onStartGuide, onOpenChecklist, onArticleView, onOpen, onClose, hideLauncher })→{ open, close, toggle, isOpen, destroy }。 。 。 .
卫生剂
sanitizeHtml(html), (中文(简体) ), sanitizeToFragment(html), (中文(简体) ), setSanitizedHtml(el, html) - 许可名单
p br strong b em i u a ul ol li img h1-h4 code pre blockquote span div hr button属性
href src alt title target rel class (+ 数) data-g-action编号 :data-g-value页:1
script/style/iframe/object/embed/form/input, (中文(简体) ), on* 处理者, javascript:编号 :data: URL( 除外)
data:image/* 打开 img页:1 rel="noopener noreferrer" 打开 target="_blank"。 。 。 .
撰写
startAuthoring({ onPick, onExit, dashboardOrigin, message })→{ setStatus, setPicking, stop }工具栏、悬浮轮廓、捕捉相接点呼叫onPick({ selectors, textSnapshot, rect, url, element })。 。 。 .previewStep(step, theme, { appearance, onEnd })→{ controller, destroy }。 。 。 .highlightSelectors(selectors, { durationMs })→{ counts, resolved, destroy }。 。 。 .