@payfit/unity-components
Version:
81 lines (80 loc) • 2.39 kB
TypeScript
import { VariantProps } from '@payfit/unity-themes';
import { PropsWithChildren } from 'react';
export declare const taskMenu: import('tailwind-variants').TVReturnType<{
[key: string]: {
[key: string]: import('tailwind-merge').ClassNameValue | {
base?: import('tailwind-merge').ClassNameValue;
};
};
} | {
[x: string]: {
[x: string]: import('tailwind-merge').ClassNameValue | {
base?: import('tailwind-merge').ClassNameValue;
};
};
} | {}, {
base: string[];
}, undefined, {
[key: string]: {
[key: string]: import('tailwind-merge').ClassNameValue | {
base?: import('tailwind-merge').ClassNameValue;
};
};
} | {}, {
base: string[];
}, import('tailwind-variants').TVReturnType<unknown, {
base: string[];
}, undefined, unknown, unknown, undefined>>;
export interface TaskMenuProps extends PropsWithChildren<VariantProps<typeof taskMenu>> {
/**
* The label for the task menu. This is used for accessibility purposes.
*/
label: string;
}
/**
* The `TaskMenu` component provides a navigation menu for tasks and task groups with expandable functionality.
* @example
* ```tsx
* import { TaskMenu, Task, TaskGroup, SubTask } from '@payfit/unity-components'
*
* <TaskMenu>
* <RawTask
* uniqueId="task1"
* label="Complete Profile"
* taskNumber={1}
* taskStatus="completed"
* href="/profile"
* />
* <RawTask
* uniqueId="task2"
* label="Upload Documents"
* taskNumber={2}
* taskStatus="uncompleted"
* href="/documents"
* />
* <TaskGroup
* uniqueId="onboarding"
* label="Onboarding Steps"
* taskNumber={3}
* taskStatus="uncompleted"
* >
* <RawSubTask
* uniqueId="step1"
* label="Welcome Video"
* href="/onboarding/welcome"
* taskStatus="completed"
* />
* <RawSubTask
* uniqueId="step2"
* label="Company Policies"
* href="/onboarding/policies"
* taskStatus="uncompleted"
* />
* </TaskGroup>
* </TaskMenu>
* ```
* @see {@link TaskMenuProps} for all available props
* @remarks [API Docs]{https://unity-components.payfit.io/?path=/story/navigation-taskmenu--docs}
*/
declare const TaskMenu: import('react').ForwardRefExoticComponent<TaskMenuProps & import('react').RefAttributes<HTMLDivElement>>;
export { TaskMenu };