#ctx.location

Current route location information, equivalent to the React Router location object. It is typically used in conjunction with ctx.router and ctx.route to read the current path, query string, hash, and state passed through the route.

#Use Cases

Note: ctx.location is only available in RunJS environments with a routing context (e.g., JSBlock within a page, FlowEngine, etc.); it may be null in pure backend or non-routing contexts (e.g., Workflows).

#Type Definition

location: Location;

Location comes from react-router-dom, consistent with the return value of React Router's useLocation().

#Common Fields

#Relationship with ctx.router and ctx.urlSearchParams

ctx.urlSearchParams is parsed from ctx.location.search. If you only need query parameters, using ctx.urlSearchParams is more convenient.

#Examples

#Branching Based on Path

if (ctx.location.pathname.startsWith('/admin/users')) {
  ctx.message.info('Currently on the user management page');
}

#Parsing Query Parameters

// Method 1: Using ctx.urlSearchParams (Recommended)
const page = ctx.urlSearchParams.page || 1;
const status = ctx.urlSearchParams.status;

// Method 2: Using URLSearchParams to parse search
const params = new URLSearchParams(ctx.location.search);
const page = params.get('page') || '1';
const status = params.get('status');

#Receiving State Passed via Route Navigation

// When navigating from the previous page: ctx.router.navigate('/users/123', { state: { from: 'dashboard' } })
const prevState = ctx.location.state;
if (prevState?.from === 'dashboard') {
  ctx.message.info('Navigated from the dashboard');
}

#Locating Anchors via Hash

const hash = ctx.location.hash; // e.g., "#edit"
if (hash === '#edit') {
  // Scroll to the edit area or execute corresponding logic
}

#Related

• ctx.router: Route navigation; the state from ctx.router.navigate can be retrieved via ctx.location.state on the target page.
• ctx.route: Current route match information (parameters, configuration, etc.), often used in conjunction with ctx.location.