API Reference

This is the core runtime API for NavigateMe.

🚀 Initialization

window.navigateme_guides = [...]
window.navigateme_apiconfig = {...}

NavigateMe.loader();

⚙️ Global Config

`window.navigateme_guides`

Defines all guides

`window.navigateme_apiconfig`

Controls API communication

window.navigateme_apiconfig = {
  url: "https://your-api.com",
  prebody: {},
  headers: {},
  params: {}
};

🌐 API Config Fields

`url`

Endpoint for requests

`prebody`

Default payload

prebody: {
  app: "my-app",
  env: "production"
}

`headers`

headers: {
  "Content-Type": "text/plain"
}

`params`

params: {
  mode: "no-cors"
}

⚡ Loader

`NavigateMe.loader()`

Initializes guides and starts engine

NavigateMe.loader();

🧠 Lifecycle

1. Load script
2. Define guides
3. (Optional) set API config
4. Call loader

🔄 Runtime Behavior

• Guides are registered globally
• Engine parses steps
• Executes based on type (`navigate`, `splash`, `survey`)
• Tracks interactions via API config

🎯 Minimal Setup

window.navigateme_guides = [
  {
    id: "demo",
    type: "navigate",
    steps: [
      {
        selector: "button:contains(Start)",
        showMessage: "Click to begin"
      }
    ]
  }
];

NavigateMe.loader();

🧪 Error Handling

If initialization fails:

try {
  NavigateMe.loader();
} catch (e) {
  console.error("NavigateMe failed to start");
}

🎨 Styling (CSS Hooks)

You can override styles using your CSS:

.navigateme-tooltip {
  background: #111;
  color: #fff;
  border-radius: 8px;
}

.navigateme-overlay {
  backdrop-filter: blur(4px);
}

🚀 Summary

• Define guides
• Configure API (optional)
• Call loader

Everything else is automatic.