Interface IMasterDetailProps<Payload>

Props interface for the IMasterDetail component.

interface IMasterDetailProps<Payload = any> {
    activeOption?: string;
    children: ReactNode;
    className?: string;
    deps?: any[];
    Error?: any;
    fallback?: (e: Error) => void;
    fixedPosHeaderAdjust?: number;
    Loader?: any;
    mode?: MasterDetailMode;
    onActiveOptionChange?: (activeOption: string, initial: boolean) => void;
    onLoadEnd?: (isOk: boolean) => void;
    onLoadStart?: () => void;
    options: IMasterDetailOption<Payload>[];
    payload?: Payload;
    style?: any;
    sx?: any;
    throwError?: boolean;
    title?: string;
    withFixedPos?: boolean;
    withMenuCollapse?: boolean;
    withTransparentTabs?: boolean;
}

Type Parameters

  • Payload = any

    The type of the payload data.

Properties

activeOption? children className? deps? Error? fallback? fixedPosHeaderAdjust? Loader? mode? onActiveOptionChange? onLoadEnd? onLoadStart? options payload? style? sx? throwError? title? withFixedPos? withMenuCollapse? withTransparentTabs?

Properties

OptionalactiveOption

activeOption?: string

The currently active option.

children

children: ReactNode

The child components of the master detail component.

OptionalclassName

className?: string

The CSS class name for the component.

Optionaldeps

deps?: any[]

The dependencies for the component.

OptionalError

Error?: any

The error component to use.

Optionalfallback

fallback?: (e: Error) => void

The fallback function in case of an error.

OptionalfixedPosHeaderAdjust

fixedPosHeaderAdjust?: number

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

OptionalLoader

Loader?: any

The loader component to use.

Optionalmode

mode?: MasterDetailMode

The mode of the master detail component.

OptionalonActiveOptionChange

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

Callback function called when the active option is changed.

OptionalonLoadEnd

onLoadEnd?: (isOk: boolean) => void

Callback function called when the data loading ends.

OptionalonLoadStart

onLoadStart?: () => void

Callback function called when the data loading starts.

options

options: IMasterDetailOption<Payload>[]

The options for the component.

Optionalpayload

payload?: Payload

The payload data.

Optionalstyle

style?: any

The inline style for the component.

Optionalsx

sx?: any

The custom styling props for the component.

OptionalthrowError

throwError?: boolean

Determines if an error should be thrown.

Optionaltitle

title?: string

The title of the component.

OptionalwithFixedPos

withFixedPos?: boolean

Determines if the component should have a fixed position.

OptionalwithMenuCollapse

withMenuCollapse?: boolean

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

OptionalwithTransparentTabs

withTransparentTabs?: boolean

Determines if the tabs should have a transparent background.

Settings

Member Visibility

On This Page

Properties