API Reference

qiankun provides a simple yet powerful API set for building micro-frontend applications. All APIs are fully typed with TypeScript definitions to ensure both developer experience and type safety.

📚 Core APIs

Application Registration & Startup

API	Description	Type
registerMicroApps	Register micro applications	(apps: RegistrableApp[], lifeCycles?: LifeCycles) => void
start	Start qiankun framework	(opts?: StartOpts) => void
loadMicroApp	Manually load micro application	(app: LoadableApp, configuration?: AppConfiguration, lifeCycles?: LifeCycles) => MicroApp

Utility APIs

API	Description	Type
isRuntimeCompatible	Check runtime compatibility	() => boolean

🎯 Quick Navigation

By Use Case

Route-based Mode

import { registerMicroApps, start } from 'qiankun';

// 1. Register micro apps
registerMicroApps([...]);

// 2. Start framework
start();

Manual Loading Mode

import { loadMicroApp } from 'qiankun';

// Manually load micro app
const microApp = loadMicroApp({...});

Compatibility Check

import { isRuntimeCompatible } from 'qiankun';

if (isRuntimeCompatible()) {
  // Start micro-frontend application
}

By Functionality

Category	Related APIs	Description
App Management	registerMicroApps, loadMicroApp	Register and load micro applications
Framework Control	start	Framework startup and configuration
Utilities	isRuntimeCompatible	Helper utility methods

🔧 Type Definitions

qiankun provides complete TypeScript type definitions:

import type {
  RegistrableApp,
  LoadableApp,
  MicroApp,
  LifeCycles,
  AppConfiguration,
} from 'qiankun';

See Type Definitions for detailed information.

📖 Detailed Documentation

Core APIs

• registerMicroApps - Register micro applications
• start - Start qiankun framework
• loadMicroApp - Manually load micro applications
• isRuntimeCompatible - Runtime compatibility check

Reference Documentation

• Lifecycles - Application lifecycle hooks
• Configuration - Framework configuration options
• Types - TypeScript type definitions

💡 Usage Recommendations

Recommended API Usage Patterns

1. Standard Route-based Mode (Recommended)

   registerMicroApps([...]) → start()

2. Dynamic Loading Mode

   loadMicroApp({...})

3. Hybrid Mode

   registerMicroApps([...]) → start() + loadMicroApp({...})

Best Practices

• ✅ Use TypeScript for complete type support

• ✅ Register all micro apps before starting the framework

• ✅ Use lifecycle hooks appropriately for state management

• ✅ Configure proper error handling

• ❌ Avoid registering duplicate app names

• ❌ Avoid calling main app APIs from micro apps

• ❌ Avoid time-consuming operations in lifecycle hooks