type PlacementOptions

Type definition for global rendering placement options.

static

type PlacementOptions = Readonly<{
    mode: PlacementMode;
    mountId?: string;
    ref?: Output;
    shade?: boolean;
    transform?: Readonly<{
        show?: OutputTransformer;
        hide?: OutputTransformer;
    }>;
}>

Description

An object of this type can be provided when rendering a view object using app.render(), or RenderContext.DynamicRendererWrapper.

The following properties determine how root view elements are placed on the screen:

• mode — One of the RenderContext.PlacementMode options.
• mountId — The mount element ID (e.g. HTML element ID), if mode is set to mount.
• ref — The existing output element that determines the position of modal view output, if any.
• shade — True if the modal element should be surrounded by a backdrop shade.
• transform — A set of functions or names of theme animations that should run for the view output. By default, showing and hiding (or removing) output can be animated.

Related

• class RenderContext abstractAn abstract class that supports global view rendering, part of the global application context.