matrix-react-sdk/lib/src/hooks/useUserOnboardingTasks.d.ts

SDK for matrix.org using React

import { ButtonEvent } from "../components/views/elements/AccessibleButton";
import { UseCase } from "../settings/enums/UseCase";
import { UserOnboardingContext } from "./useUserOnboardingContext";
interface UserOnboardingTask {
    id: string;
    title: string | (() => string);
    description: string | (() => string);
    relevant?: UseCase[];
    action?: {
        label: string;
        onClick?: (ev: ButtonEvent) => void;
        href?: string;
        hideOnComplete?: boolean;
    };
    completed: (ctx: UserOnboardingContext) => boolean;
    disabled?(): boolean;
}
export interface UserOnboardingTaskWithResolvedCompletion extends Omit<UserOnboardingTask, "completed"> {
    completed: boolean;
}
export declare function useUserOnboardingTasks(context: UserOnboardingContext): UserOnboardingTaskWithResolvedCompletion[];
export {};