openGuideScene(params?: OpenGuideScene)

Requires:
@ray-js/ray≥1.4.32

Description

Navigate to the scene onboarding page

Parameters

ParameterTypeRequiredDescription
NoOnboarding page parameters

Return Value

Type: Promise<void>
Promise for the navigation result; resolves on success, rejects on failure

Valid Values

OpenGuideScene.action
ValueDescriptionSince
add--
edit--

Examples

import { openGuideScene } from '@ray-js/ray';

const guideScene = async () => {
  try {
    await openGuideScene({ action: 'add' });
    console.log('Navigated to the scene guide page');
  } catch (err) {
    console.error('Navigation failed:', err);
  }
};