@awsui/components-react
Version:
On July 19th, 2022, we launched [Cloudscape Design System](https://cloudscape.design). Cloudscape is an evolution of AWS-UI. It consists of user interface guidelines, front-end components, design resources, and development tools for building intuitive, en
49 lines • 2.44 kB
TypeScript
/// <reference types="react" />
import { FunnelContextValue } from '../context/analytics-context';
/**
* Custom React Hook to manage and interact with FunnelSubStep.
* This hook will provide necessary properties and methods required
* to track and manage interactions with a FunnelSubStep component.
*
* The `onFocus` method is used to track the beginning of interaction with the FunnelSubStep.
* The `onBlur` method is used to track the completion of interaction with the FunnelSubStep.
* The subStepId is a unique identifier for the funnel sub-step.
* The subStepRef is a reference to the DOM element of the funnel sub-step.
*/
export declare const useFunnelSubStep: () => import("../context/analytics-context").FunnelSubStepContextValue | {
subStepIdentifier?: string | undefined;
subStepErrorContext?: string | undefined;
subStepId: string;
subStepSelector: string;
subStepNameSelector: string;
subStepRef: import("react").MutableRefObject<HTMLDivElement | null>;
mousePressed: import("react").MutableRefObject<boolean>;
isFocusedSubStep: import("react").MutableRefObject<boolean>;
focusCleanupFunction: import("react").MutableRefObject<(() => void) | undefined>;
isNestedSubStep: boolean;
funnelSubStepProps: Record<string, any>;
};
/**
* Custom React Hook to manage and interact with FunnelStep.
* This hook will provide necessary properties required to track
* and manage interactions with a FunnelStep component.
*
* The 'data-analytics-funnel-step' property of funnelStepProps is used to track the index of the current step in the funnel.
* The context contains additional properties of the FunnelStep.
*/
export declare const useFunnelStep: () => import("../context/analytics-context").FunnelStepContextValue;
/**
* Custom React Hook to manage and interact with Funnel.
* This hook will provide necessary properties required to track
* and manage interactions with a Funnel component.
*
* The 'data-analytics-funnel-interaction-id' property of funnelProps is used to track the unique identifier of the current interaction with the funnel.
*/
export type FunnelProps = Record<string, string | number | boolean | undefined>;
type UseFunnel = () => FunnelContextValue & {
funnelProps: FunnelProps;
};
export declare const useFunnel: UseFunnel;
export declare const useFunnelNameSelector: () => string | undefined;
export {};
//# sourceMappingURL=use-funnel.d.ts.map