packages/apps/onboarding/README.md
Onboarding wizard for Elementor.
npm install @elementor/onboarding
import { App, registerOnboardingSlice } from '@elementor/onboarding';
// Register the store slice
registerOnboardingSlice();
// Render the app
<App onComplete={() => console.log('Done!')} onClose={() => console.log('Closed')} />
The onboarding wizard has 7 steps:
import { useOnboarding } from '@elementor/onboarding';
function MyComponent() {
const { stepId, stepIndex, isFirst, isLast, actions } = useOnboarding();
return (
<button onClick={actions.nextStep}>Next</button>
);
}
import { useUpdateProgress } from '@elementor/onboarding';
function MyComponent() {
const updateProgress = useUpdateProgress();
const handleComplete = () => {
updateProgress.mutate({ complete_step: 'account' });
};
return (
<button onClick={handleComplete}>Complete Step</button>
);
}