Cueflow.check()

Manually trigger a check for new messages. Useful for custom navigation handling.

Syntax

Cueflow.check()

Parameters

None.

Basic Example

// Manually check for messages
Cueflow.check();

When to Use

Automatic Navigation Detection

Cueflow automatically detects navigation in most cases:

• Browser back/forward buttons (popstate)

• history.pushState() and history.replaceState()

You typically don't need to call check() manually.

Custom Navigation

If your app uses custom routing that doesn't trigger standard navigation events, call check() after navigation:

// Custom router navigation
customRouter.navigate('/dashboard');
Cueflow.check();

Hash-Based Routing

For apps using hash-based routing (#/page):

window.addEventListener('hashchange', () => {
  Cueflow.check();
});

After Dynamic Content

If page content changes significantly without navigation:

function loadNewContent() {
  // Load content via AJAX
  fetchContent().then(content => {
    renderContent(content);

    // Check if new messages should appear
    Cueflow.check();
  });
}

Framework Examples

React Router (Custom)

If React Router events aren't detected:

import { useLocation } from 'react-router-dom';
import { useEffect } from 'react';

function CueflowNavigationHandler() {
  const location = useLocation();

  useEffect(() => {
    if (window.Cueflow) {
      Cueflow.check();
    }
  }, [location]);

  return null;
}

Vue Router

// router/index.js
router.afterEach(() => {
  if (window.Cueflow) {
    Cueflow.check();
  }
});

Angular

// app.component.ts
import { Router, NavigationEnd } from '@angular/router';

constructor(private router: Router) {
  this.router.events.subscribe(event => {
    if (event instanceof NavigationEnd && window.Cueflow) {
      window.Cueflow.check();
    }
  });
}

What Happens

When you call check():

1. Gets current page context - URL, path, query params

2. Sends to Cueflow - Checks which messages match

3. Updates display - Shows new messages, hides irrelevant ones

Requirements

• Must call Cueflow.init() first

• Calling before init shows a warning: "Cueflow: Not initialized"

Performance

check() is lightweight and debounced internally. You can call it frequently without performance concerns.

// This is fine
window.addEventListener('scroll', () => {
  Cueflow.check();
});

Next Steps

• Page Targeting - Target by URL/path

• Cueflow.update() - Update user data