Represents a master-detail component with various modes and customizations.

  • Type Parameters

    • Payload extends unknown = any

      The payload type for the component.

    Parameters

    • props: IMasterDetailProps<Payload>

      The component props.

      Props interface for the IMasterDetail component.

      • OptionalactiveOption?: string

        The currently active option.

      • children: ReactNode

        The child components of the master detail component.

      • OptionalclassName?: string

        The CSS class name for the component.

      • Optionaldeps?: any[]

        The dependencies for the component.

      • OptionalError?: any

        The error component to use.

      • Optionalfallback?: (e: Error) => void

        The fallback function in case of an error.

      • OptionalfixedPosHeaderAdjust?: number

        The number of pixels to adjust the header when the component has a fixed position.

      • OptionalLoader?: any

        The loader component to use.

      • Optionalmode?: MasterDetailMode

        The mode of the master detail component.

      • OptionalonActiveOptionChange?: (activeOption: string, initial: boolean) => void

        Callback function called when the active option is changed.

      • OptionalonLoadEnd?: (isOk: boolean) => void

        Callback function called when the data loading ends.

      • OptionalonLoadStart?: () => void

        Callback function called when the data loading starts.

      • options: IMasterDetailOption<Payload>[]

        The options for the component.

      • Optionalpayload?: Payload

        The payload data.

      • Optionalstyle?: any

        The inline style for the component.

      • Optionalsx?: any

        The custom styling props for the component.

      • OptionalthrowError?: boolean

        Determines if an error should be thrown.

      • Optionaltitle?: string

        The title of the component.

      • OptionalwithFixedPos?: boolean

        Determines if the component should have a fixed position.

      • OptionalwithMenuCollapse?: boolean

        Determines if the menu should collapse when the detail view is open.

      • OptionalwithTransparentTabs?: boolean

        Determines if the tabs should have a transparent background.

    Returns Element

    • The rendered component.