ShadowSelection

• anchorNode: Node | null

  readonly

  module:utils/dom/getselection~ShadowSelection#anchorNode
  See source (with github icon)

• anchorOffset: number

  readonly

  module:utils/dom/getselection~ShadowSelection#anchorOffset
  See source (with github icon)

• direction: 'none' | 'forward' | 'backward'

  readonly

  module:utils/dom/getselection~ShadowSelection#direction

  The direction of the selection, resolved against the tree the first composed range lives in. It is already computed to orient the anchor and focus endpoints, so exposing it lets consumers read the orientation directly instead of re-deriving it from the endpoints.

  See source (with github icon)

• focusNode: Node | null

  readonly

  module:utils/dom/getselection~ShadowSelection#focusNode
  See source (with github icon)

• focusOffset: number

  readonly

  module:utils/dom/getselection~ShadowSelection#focusOffset
  See source (with github icon)

• isCollapsed: boolean

  readonly

  module:utils/dom/getselection~ShadowSelection#isCollapsed
  See source (with github icon)

• rangeCount: number

  readonly

  module:utils/dom/getselection~ShadowSelection#rangeCount
  See source (with github icon)

• _domSelection: ComposedSelection

  privatereadonly

  module:utils/dom/getselection~ShadowSelection#_domSelection

  The underlying document-level selection that mutations are delegated to and composed ranges read from.

  See source (with github icon)

• _shadowRoots: Array<ShadowRoot>

  privatereadonly

  module:utils/dom/getselection~ShadowSelection#_shadowRoots

  The shadow roots the composed ranges are resolved against.

  See source (with github icon)

Static properties

• _useLegacyComposedRanges: boolean

  privatestatic

  module:utils/dom/getselection~ShadowSelection._useLegacyComposedRanges

  Whether the engine only accepts the legacy rest-parameter form of getComposedRanges(). This is a fixed property of the engine, so it is detected once (the first call throws on the dictionary form) and cached for all instances, keeping the exception off the selection-read hot path.

  See source (with github icon)

• constructor( domSelection, shadowRoots )

  internal

  module:utils/dom/getselection~ShadowSelection#constructor
  See source (with github icon)

  Parameters

  domSelection: Selection

  shadowRoots: Array<ShadowRoot>

• addRange( range ) → void

  module:utils/dom/getselection~ShadowSelection#addRange
  See source (with github icon)

  Parameters

  range: Range

  Returns

  void

• collapse( node, offset? ) → void

  module:utils/dom/getselection~ShadowSelection#collapse
  See source (with github icon)

  Parameters

  node: Node | null

  offset?: number

  Returns

  void

• extend( node, offset? ) → void

  module:utils/dom/getselection~ShadowSelection#extend
  See source (with github icon)

  Parameters

  node: Node

  offset?: number

  Returns

  void

• getRangeAt( index ) → Range

  module:utils/dom/getselection~ShadowSelection#getRangeAt
  See source (with github icon)

  Parameters

  index: number

  Returns

  Range

• removeAllRanges() → void

  module:utils/dom/getselection~ShadowSelection#removeAllRanges
  See source (with github icon)

  Returns

  void

• setBaseAndExtent( anchorNode, anchorOffset, focusNode, focusOffset ) → void

  module:utils/dom/getselection~ShadowSelection#setBaseAndExtent
  See source (with github icon)

  Parameters

  anchorNode: Node

  anchorOffset: number

  focusNode: Node

  focusOffset: number

  Returns

  void

• _getComposedRanges() → Array<StaticRange>

  private

  module:utils/dom/getselection~ShadowSelection#_getComposedRanges

  The raw composed ranges reported for the shadow roots by the underlying selection.

  See source (with github icon)

  Returns

  Array<StaticRange>

• _getDirection( rootNode ) → string

  private

  module:utils/dom/getselection~ShadowSelection#_getDirection

  The direction of the underlying selection, preferring the one reported by Blink's shadow-scoped selection, which stays meaningful for a mouse selection made inside a shadow root.

  See source (with github icon)

  Parameters

  rootNode: Node

  Returns

  string

• _getEndpoint( endpoint ) → object

  private

  module:utils/dom/getselection~ShadowSelection#_getEndpoint

  The anchor or focus endpoint of the first composed range.

  getComposedRanges() returns ranges in document order (start before end); the anchor/focus orientation therefore has to come from Selection#direction. Known limitation: WebKit and Blink report direction as 'none' for a selection made with the mouse inside a shadow root (a keyboard selection reports it correctly). Blink's shadow-scoped selection still knows the direction in that case, so it is consulted first; it is of no use for the ranges themselves, as it covers a single tree only. Safari has no such API, so its mouse selections fall back to forward.

  See source (with github icon)

  Parameters

  endpoint: 'anchor' | 'focus'

  Returns

  object

• _getRanges() → Array<StaticRange>

  private

  module:utils/dom/getselection~ShadowSelection#_getRanges

  The composed ranges fully contained in one of the trees on the path from the given nodes to the document, in document order (start before end).

  Only ranges whose both endpoints resolve into the same tree can be represented as a live, single-tree Range. A range crossing a shadow boundary is therefore dropped, and so is one resolving into an unrelated tree, rather than surfacing foreign nodes. The document itself is one of those trees: it is where every node ends up when walking out of its shadow roots, and it is where a selection made in a sibling light-DOM editable lives, so such a selection is kept rather than dropped.

  A range with an endpoint outside its container is dropped as well, see isOffsetInNode() below.

  See source (with github icon)

  Returns

  Array<StaticRange>