Interface MainAspectComponentOptions

Interface defining the props for the MainAspectComponent.

interface MainAspectComponentOptions {
    backgroundColor?: string;
    children: ReactNode;
    showControls?: boolean;
    containerWidthFraction?: number;
    containerHeightFraction?: number;
    defaultFraction?: number;
    updateIsWideScreen: ((isWide: boolean) => void);
    updateIsMediumScreen: ((isMedium: boolean) => void);
    updateIsSmallScreen: ((isSmall: boolean) => void);
}

Properties

backgroundColor? children showControls? containerWidthFraction? containerHeightFraction? defaultFraction? updateIsWideScreen updateIsMediumScreen updateIsSmallScreen

Properties

OptionalbackgroundColor

backgroundColor?: string

The background color of the component.

Default

'transparent'

children

children: ReactNode

The child elements to be rendered inside the component.

OptionalshowControls

showControls?: boolean

Flag to determine if controls are shown, affecting the height calculation.

Default

true

OptionalcontainerWidthFraction

containerWidthFraction?: number

Fraction of the window width to be used for the container's width.

Default

1

OptionalcontainerHeightFraction

containerHeightFraction?: number

Fraction of the window height to be used for the container's height.

Default

1

OptionaldefaultFraction

defaultFraction?: number

Default fraction to adjust the height when controls are shown.

Default

0.94

updateIsWideScreen

updateIsWideScreen: ((isWide: boolean) => void)

Callback function to update the wide screen state.

updateIsMediumScreen

updateIsMediumScreen: ((isMedium: boolean) => void)

Callback function to update the medium screen state.

updateIsSmallScreen

updateIsSmallScreen: ((isSmall: boolean) => void)

Callback function to update the small screen state.

Settings

Member Visibility

On This Page

Properties