Interface MainScreenComponentOptions

Interface defining the props for the MainScreenComponent.

interface MainScreenComponentOptions {
    children: ReactNode;
    mainSize: number;
    doStack: boolean;
    containerWidthFraction?: number;
    containerHeightFraction?: number;
    updateComponentSizes: ((sizes: ComponentSizes) => void);
    defaultFraction?: number;
    showControls: boolean;
    componentSizes: ComponentSizes;
}

Properties

children mainSize doStack containerWidthFraction? containerHeightFraction? updateComponentSizes defaultFraction? showControls componentSizes

Properties

children

children: ReactNode

The child components to be rendered inside the main screen.

mainSize

mainSize: number

The percentage size of the main component when stacking is enabled.

doStack

doStack: boolean

Flag indicating whether the components should be stacked.

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

updateComponentSizes

updateComponentSizes: ((sizes: ComponentSizes) => void)

Callback function to update the sizes of the components.

OptionaldefaultFraction

defaultFraction?: number

Default fraction to adjust the height when controls are shown.

Default

0.94

showControls

showControls: boolean

Flag indicating whether controls are shown, affecting the container height.

componentSizes

componentSizes: ComponentSizes

An object containing the current sizes of the components.

Settings

Member Visibility

On This Page

Properties