Function Scaffold2

Parameters

• props: IScaffold2Props<T>

  The props object containing the component's properties.

  Represents the properties of the IScaffold2 component.

  • Optionalactions?: IScaffold2Action<T>[]

  • 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?: 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?: any

    Represents the type definition for the AfterAppName variable.

    Description

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

  • OptionalAfterContent?: any

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

  • OptionalAfterMenuContent?: any

    Type definition for the variable AfterMenuContent.

    Description

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

  • OptionalAfterSearch?: any

    Represents a React component type for the AfterSearch component.

  • OptionalappName?: string

  • OptionalBeforeActionMenu?: any

    Represents a React component BeforeActionMenu.

    Component

  • OptionalBeforeContent?: 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?: 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?: 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: ReactNode

  • OptionalclassName?: string

  • OptionalCopyright?: 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.

  • Optionaldense?: boolean

  • Optionaldeps?: any[]

    An array of dependencies.

  • OptionaldisableBackdropTransition?: boolean

    Flag to indicate whether backdrop transition should be disabled.

    Optional

  • OptionaldisableDiscovery?: boolean

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

    Default

    undefined
    Copy

  • OptionaldisableSwipeToOpen?: boolean

    Represents whether swipe to open functionality is disabled or not.

    Default

    false
    Copy

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

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

  • OptionalfixedHeader?: boolean

  • Optionalloading?: number | boolean

  • OptionalnoAppName?: boolean

  • OptionalnoContent?: boolean

  • OptionalnoOptionHover?: boolean

  • OptionalnoSearch?: boolean

  • OptionalonAction?: (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.

  • OptionalonInit?: () => 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?: (isOk: boolean) => void

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

  • OptionalonLoadStart?: () => void

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

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

    Callback function that is triggered when an option is clicked.

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

    Function called when an option group is clicked.

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

    Represents a callback for when a tab change event occurs.

  • options: IScaffold2Group<T>[]

  • Optionalpayload?: T

  • Optionalstyle?: any

  • OptionalswipeAreaWidth?: number

    The width of the swipe area.

  • Optionalsx?: any

  • OptionalthrowError?: boolean

    Indicates whether an error should be thrown.