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

    Interface RefDirective

    The type of the class that powers this directive. Necessary for naming the directive's return type.

    interface RefDirective {
        isConnected: boolean;
        get _$isConnected(): boolean;
        _$initialize(
            part: Part,
            parent: Disconnectable,
            attributeIndex: undefined | number,
        ): void;
        disconnected(): void;
        reconnected(): void;
        render(_ref?: RefOrCallback<Element>): symbol;
        setValue(value: unknown): void;
        update(
            part: ElementPart,
            __namedParameters: [_ref?: RefOrCallback<Element>],
        ): symbol;
    }

    Hierarchy (View Summary)

    Index

    Properties

    isConnected

    Accessors

    _$isConnected

    Methods

    _$initialize disconnected reconnected render setValue update

    Properties

    isConnected: boolean

    The connection state for this Directive.

    Accessors

    _$isConnected

    • get _$isConnected(): boolean

      Returns boolean

    Methods

    _$initialize

    • _$initialize(
          part: Part,
          parent: Disconnectable,
          attributeIndex: undefined | number,
      ): void

      Initialize the part with internal fields

      Parameters

      Returns void

    • User callbacks for implementing logic to release any resources/subscriptions that may have been retained by this directive. Since directives may also be re-connected, reconnected should also be implemented to restore the working state of the directive prior to the next render.

      Returns void

    • Returns void

    • Parameters

      Returns symbol

    • Sets the value of the directive's Part outside the normal update/render lifecycle of a directive.

      This method should not be called synchronously from a directive's update or render.

      Parameters

      • value: unknown

        The value to set

      Returns void

    • Parameters

      Returns symbol

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods