Interface IWizardOutlet<Data, Payload>

Represents an interface for a wizard outlet.

interface IWizardOutlet<Data = IAnything, Payload = IAnything> {
    element: (props: IWizardOutletProps<Data, Payload>) => ReactElement;
    id: string;
    isActive: (pathname: string) => boolean;
    isAvailable?: (pathname: string) => boolean;
}

Type Parameters

Data = IAnything
The data type for the outlet.
Payload = IAnything
The payload type for the outlet.

Hierarchy

Omit<IOutlet<Data, Payload>, keyof { element: never }>
- IWizardOutlet

Index

Properties

element id isActive isAvailable?

Properties

element

element: (props: IWizardOutletProps<Data, Payload>) => ReactElement

id

id: string

isActive

isActive: (pathname: string) => boolean

Determines if the given pathname is active.

Type declaration

- (pathname: string): boolean
- Parameters
  - pathname: string
    The URL pathname to check.
  Returns boolean
  - True if the pathname is active, false otherwise.

`Optional`isAvailable

isAvailable?: (pathname: string) => boolean

Checks if a given path is available.

Type declaration

- (pathname: string): boolean
- Parameters
  - pathname: string
    The path to be checked.
  Returns boolean
  - True if the path is available, false otherwise.