Interface MandatorySpec<T>

Mandatory shared value locator specifier.

Type Parameters

T

Share value type.

Hierarchy

ShareLocator.Spec<T>
- MandatorySpec

Index

Properties

host? local? share

Properties

`Optional` `Readonly` host

host?: ((this: void, element: Element) => undefined | Element)

Type declaration

- (this: void, element: Element): undefined | Element
- Detects a host element of the given one.
  
  By default utilizes a nodeHost() function that founds parent element crossing shadow DOM bounds.
  
  A drekHost() can be uses to also cross a rendered fragment bounds.
  
  Returns
  Either a host element, or undefined if no host found.
  Parameters
  - this: void
  - element: Element
    
    An element to detect a host of.
  Returns undefined | Element

`Optional` `Readonly` local

local?: boolean | "too"

Whether to search locally, in consumer component itself.

false (by default), to start the search from consumer's parent,
true to search locally, i.e. only in consumer component, or
'too' to start the search from consumer component.

`Readonly` share

share: ShareRef<T>

Target share.

Generated using TypeDoc