Interface DisplaySettingsModalOptions

Configuration options for the DisplaySettingsModal component.

DisplaySettingsModalOptions

Modal Control:

interface DisplaySettingsModalOptions {
    isDisplaySettingsModalVisible: boolean;
    onDisplaySettingsClose: (() => void);
    onModifyDisplaySettings?: ((options: ModifyDisplaySettingsOptions) => Promise<void>);
    parameters: DisplaySettingsModalParameters;
    position?:
        | "topLeft"
        | "topRight"
        | "bottomLeft"
        | "bottomRight";
    backgroundColor?: string;
    style?: StyleProp<ViewStyle>;
    renderContent?: ((options: {
        defaultContent: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => Element);
    renderContainer?: ((options: {
        defaultContainer: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

isDisplaySettingsModalVisible onDisplaySettingsClose onModifyDisplaySettings? parameters position? backgroundColor? style? renderContent? renderContainer?

Properties

isDisplaySettingsModalVisible

isDisplaySettingsModalVisible: boolean

Controls modal visibility

onDisplaySettingsClose

onDisplaySettingsClose: (() => void)

Callback when modal is closed

Settings Handler:

OptionalonModifyDisplaySettings

onModifyDisplaySettings?: ((options: ModifyDisplaySettingsOptions) => Promise<void>)

Custom handler for applying display settings (defaults to modifyDisplaySettings)

State Parameters:

parameters

parameters: DisplaySettingsModalParameters

Display settings state and configuration

Customization:

Optionalposition

position?:
    | "topLeft"
    | "topRight"
    | "bottomLeft"
    | "bottomRight"

Modal position on screen

OptionalbackgroundColor

backgroundColor?: string

Modal background color

Optionalstyle

style?: StyleProp<ViewStyle>

Additional custom styles for modal container

Advanced Render Overrides:

OptionalrenderContent

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

Custom render function for modal content

OptionalrenderContainer

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

Custom render function for modal container

Settings

Member Visibility

On This Page

Properties