Interface IScaffold2InternalProps<T>

Represents the internal props for the IScaffold2 component.

interface IScaffold2InternalProps<T = Payload> {
    actions?: IScaffold2Action<T>[];
    activeOptionPath: string;
    activeTabPath?: string;
    AfterAppName?: any;
    AfterContent?: any;
    AfterMenuContent?: any;
    AfterSearch?: any;
    appName?: string;
    BeforeActionMenu?: any;
    BeforeContent?: any;
    BeforeMenuContent?: any;
    BeforeSearch?: any;
    children: ReactNode;
    className?: string;
    Copyright?: any;
    dense?: boolean;
    deps?: any[];
    disableBackdropTransition?: boolean;
    disableDiscovery?: boolean;
    disableSwipeToOpen?: boolean;
    fallback?: (e: Error) => void;
    fixedHeader?: boolean;
    loading?: number | boolean;
    noAppName?: boolean;
    noContent?: boolean;
    noOptionHover?: boolean;
    noSearch?: boolean;
    onAction?: (name: string) => void;
    onInit?: () => void | Promise<void>;
    onLoadEnd?: (isOk: boolean) => void;
    onLoadStart?: () => void;
    onOptionClick?: (path: string, id: string) => undefined | boolean | void;
    onOptionGroupClick?: (
        path: string,
        id: string,
    ) => undefined | boolean | void;
    onTabChange?: (path: string, tab: string, id: string) => void;
    options: IScaffold2GroupInternal<T>[];
    payload?: T;
    style?: any;
    swipeAreaWidth?: number;
    sx?: any;
    throwError?: boolean;
}

Type Parameters

Hierarchy

Other

actions? activeOptionPath activeTabPath? AfterAppName? AfterContent? AfterMenuContent? AfterSearch? appName? BeforeActionMenu? BeforeContent? BeforeMenuContent? BeforeSearch? children className? dense? deps? disableBackdropTransition? disableDiscovery? disableSwipeToOpen? fallback? fixedHeader? loading? noAppName? noContent? noOptionHover? noSearch? onAction? onInit? onLoadEnd? onLoadStart? onOptionClick? onOptionGroupClick? onTabChange? options payload? style? swipeAreaWidth? sx? throwError?

UI Components

Copyright?

Other

Optionalactions

actions?: IScaffold2Action<T>[]

activeOptionPath

activeOptionPath: string

Specifies the active option path.

Description

This variable holds the path of the currently active option. The path is represented as a string value.

OptionalactiveTabPath

activeTabPath?: string

Represents the path of the active tab.

Description

The activeTabPath variable is an optional string that represents the path of the active tab. It is used to track and store the current tab's path within the application.

OptionalAfterAppName

AfterAppName?: any

Represents the type definition for the AfterAppName variable.

Description

A variable of type React.ComponentType<any> representing a React component.

OptionalAfterContent

AfterContent?: any

Represents a React component type for rendering content after the main content.

OptionalAfterMenuContent

AfterMenuContent?: any

Type definition for the variable AfterMenuContent.

Description

A React component type that represents the content to be rendered after a menu component.

OptionalAfterSearch

AfterSearch?: any

Represents a React component type for the AfterSearch component.

OptionalappName

appName?: string

OptionalBeforeActionMenu

BeforeActionMenu?: any

Represents a React component BeforeActionMenu.

Component

OptionalBeforeContent

BeforeContent?: any

Represents the BeforeContent variable.

Description

This variable is a React component type that can accept any props. It is typically used to render content that should appear before the main content within a parent component

OptionalBeforeMenuContent

BeforeMenuContent?: any

Represents the type definition for the BeforeMenuContent variable.

Description

This variable represents a React component that serves as the content to be rendered before the menu component. It can accept any props as specified by the any type.

OptionalBeforeSearch

BeforeSearch?: any

BeforeSearch is a React component type used for rendering a component before the search functionality.

Memberof

module:components

See

https://reactjs.org/docs/react-component.html|React.ComponentType

children

children: ReactNode

OptionalclassName

className?: string

Optionaldense

dense?: boolean

Optionaldeps

deps?: any[]

An array of dependencies.

OptionaldisableBackdropTransition

disableBackdropTransition?: boolean

Flag to indicate whether backdrop transition should be disabled.

Optional

OptionaldisableDiscovery

disableDiscovery?: boolean

The variable disableDiscovery determines if the discovery feature is enabled or disabled.

Default

undefined

OptionaldisableSwipeToOpen

disableSwipeToOpen?: boolean

Represents whether swipe to open functionality is disabled or not.

Default

false

Optionalfallback

fallback?: (e: Error) => void

Represents a function that acts as a fallback, which is executed when an error occurs.

Type declaration

    • (e: Error): void

    • Parameters

      • e: Error

        The error that occurred.

      Returns void

OptionalfixedHeader

fixedHeader?: boolean

Optionalloading

loading?: number | boolean

OptionalnoAppName

noAppName?: boolean

OptionalnoContent

noContent?: boolean

OptionalnoOptionHover

noOptionHover?: boolean

OptionalnoSearch

noSearch?: boolean

OptionalonAction

onAction?: (name: string) => void

Represents a optional callback function that is triggered when an action is performed. The function takes a name parameter of type string and returns void.

Type declaration

    • (name: string): void

    • Parameters

      • name: string

        The name of the action being performed.

      Returns void

OptionalonInit

onInit?: () => void | Promise<void>

Description

Represents a function that may or may not initialize something. The function returns either void or a Promise that resolves to void.

OptionalonLoadEnd

onLoadEnd?: (isOk: boolean) => void

Represents a callback function that is called when the loading process ends.

Type declaration

    • (isOk: boolean): void

    • Parameters

      • isOk: boolean

        A boolean value indicating whether the loading process was successful.

      Returns void

      This callback does not return anything.

OptionalonLoadStart

onLoadStart?: () => void

Represents a callback function that will be invoked when a load operation starts.

Type declaration

    • (): void

    • Returns void

OptionalonOptionClick

onOptionClick?: (path: string, id: string) => undefined | boolean | void

Callback function that is triggered when an option is clicked.

Type declaration

    • (path: string, id: string): undefined | boolean | void

    • Parameters

      • path: string

        The path of the option.

      • id: string

        The ID of the option.

      Returns undefined | boolean | void

      • Returns undefined or a boolean value based on the processing of the option click.

OptionalonOptionGroupClick

onOptionGroupClick?: (path: string, id: string) => undefined | boolean | void

Function called when an option group is clicked.

Type declaration

    • (path: string, id: string): undefined | boolean | void

    • Parameters

      • path: string

        The path of the option group.

      • id: string

        The ID of the clicked option group.

      Returns undefined | boolean | void

      • Returns undefined or a boolean value.

OptionalonTabChange

onTabChange?: (path: string, tab: string, id: string) => void

Represents a callback for when a tab change event occurs.

Type declaration

    • (path: string, tab: string, id: string): void

    • Parameters

      • path: string

        The current path of the tab.

      • tab: string

        The name of the tab that was changed to.

      • id: string

        The unique identifier of the tab.

      Returns void

options

options: IScaffold2GroupInternal<T>[]

Optionalpayload

payload?: T

Optionalstyle

style?: any

OptionalswipeAreaWidth

swipeAreaWidth?: number

The width of the swipe area.

Optionalsx

sx?: any

OptionalthrowError

throwError?: boolean

Indicates whether an error should be thrown.

UI Components

OptionalCopyright

Copyright?: any

The Copyright component is a React component that represents a copyright notice. It can be used in a React application to display the copyright information.

Component

Param: props

The properties of the Copyright component.

Returns

The Copyright React component.

Settings

Member Visibility

On This Page

Other
UI Components