Interface MainAspectComponentOptions

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);
    containerProps?: HTMLAttributes<HTMLDivElement>;
    renderContent?: ((options: {
        defaultContent: ReactNode;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
    renderContainer?: ((options: {
        defaultContainer: ReactNode;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

backgroundColor? children showControls? containerWidthFraction? containerHeightFraction? defaultFraction? updateIsWideScreen updateIsMediumScreen updateIsSmallScreen containerProps? renderContent? renderContainer?

Properties

OptionalbackgroundColor

backgroundColor?: string

children

children: ReactNode

OptionalshowControls

showControls?: boolean

OptionalcontainerWidthFraction

containerWidthFraction?: number

OptionalcontainerHeightFraction

containerHeightFraction?: number

OptionaldefaultFraction

defaultFraction?: number

updateIsWideScreen

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

updateIsMediumScreen

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

updateIsSmallScreen

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

OptionalcontainerProps

containerProps?: HTMLAttributes<HTMLDivElement>

OptionalrenderContent

renderContent?: ((options: {
    defaultContent: ReactNode;
    dimensions: {
        width: number;
        height: number;
    };
}) => ReactNode)

OptionalrenderContainer

renderContainer?: ((options: {
    defaultContainer: ReactNode;
    dimensions: {
        width: number;
        height: number;
    };
}) => ReactNode)

Settings

Member Visibility

On This Page

Properties