@arcmantle/adapter-element
    Preparing search index...

    Interface RootPart

    A top-level ChildPart returned from render that manages the connected state of AsyncDirectives created throughout the tree below it.

    interface RootPart {
        _$committedValue: unknown;
        options: undefined | RenderOptions;
        type: 2;
        get _$isConnected(): boolean;
        get endNode(): null | Node;
        get parentNode(): Node;
        get startNode(): null | Node;
        _$setValue(value: unknown, directiveParent?: DirectiveParent): void;
        setConnected(isConnected: boolean): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _$committedValue options type

    Accessors

    _$isConnected endNode parentNode startNode

    Methods

    _$setValue setConnected

    Properties

    _$committedValue

    _$committedValue: unknown
    options: undefined | RenderOptions
    type: 2

    Accessors

    _$isConnected

    • get _$isConnected(): boolean

      Returns boolean

    • get endNode(): null | Node

      The part's trailing marker node, if any. See .parentNode for more information.

      Returns null | Node

    • get parentNode(): Node

      The parent node into which the part renders its content.

      A ChildPart's content consists of a range of adjacent child nodes of .parentNode, possibly bordered by 'marker nodes' (.startNode and .endNode).

      • If both .startNode and .endNode are non-null, then the part's content consists of all siblings between .startNode and .endNode, exclusively.

      • If .startNode is non-null but .endNode is null, then the part's content consists of all siblings following .startNode, up to and including the last child of .parentNode. If .endNode is non-null, then .startNode will always be non-null.

      • If both .endNode and .startNode are null, then the part's content consists of all child nodes of .parentNode.

      Returns Node

    • get startNode(): null | Node

      The part's leading marker node, if any. See .parentNode for more information.

      Returns null | Node

    Methods

    _$setValue

    • _$setValue(value: unknown, directiveParent?: DirectiveParent): void

      Parameters

      Returns void

    • Sets the connection state for AsyncDirectives contained within this root ChildPart.

      lit-html does not automatically monitor the connectedness of DOM rendered; as such, it is the responsibility of the caller to render to ensure that part.setConnected(false) is called before the part object is potentially discarded, to ensure that AsyncDirectives have a chance to dispose of any resources being held. If a RootPart that was previously disconnected is subsequently re-connected (and its AsyncDirectives should re-connect), setConnected(true) should be called.

      Parameters

      • isConnected: boolean

        Whether directives within this tree should be connected or not

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods