Class DraftailInlineAnnotation

Controls the positioning of a comment that has been added to Draftail. getAnchorNode is called by the comments app to determine which node to float the comment alongside

Implements

Annotation

Index

Constructors

constructor

new DraftailInlineAnnotation(field: Element): DraftailInlineAnnotation
Parameters
- field: Element
Returns DraftailInlineAnnotation
- Defined in components/Draftail/CommentableEditor/CommentableEditor.tsx:76

Properties

cachedMedianRef

cachedMedianRef: null | DecoratorRef

decoratorRefs

decoratorRefs: Map<DecoratorRef, string>

field

field: Element

Create an inline annotation

Param: field

an element to provide the fallback position for comments without any inline decorators

focusedBlockKey

focusedBlockKey: string

Methods

addDecoratorRef

addDecoratorRef(ref: DecoratorRef, blockKey: string): void
Parameters
- ref: DecoratorRef
- blockKey: string
Returns void
- Defined in components/Draftail/CommentableEditor/CommentableEditor.tsx:83

getAnchorNode

getAnchorNode(focused?: boolean): Element
Parameters
- focused: boolean = false
Returns Element
Implementation of Annotation.getAnchorNode
- Defined in components/Draftail/CommentableEditor/CommentableEditor.tsx:124

getTab

getTab(): undefined | null | string
Returns undefined | null | string
Implementation of Annotation.getTab
- Defined in components/Draftail/CommentableEditor/CommentableEditor.tsx:120

removeDecoratorRef

removeDecoratorRef(ref: DecoratorRef): void
Parameters
- ref: DecoratorRef
Returns void
- Defined in components/Draftail/CommentableEditor/CommentableEditor.tsx:90

setFocusedBlockKey

setFocusedBlockKey(blockKey: string): void
Parameters
- blockKey: string
Returns void
- Defined in components/Draftail/CommentableEditor/CommentableEditor.tsx:97

`Static`getHeightForRef

getHeightForRef(ref: DecoratorRef): number
Parameters
- ref: DecoratorRef
Returns number
- Defined in components/Draftail/CommentableEditor/CommentableEditor.tsx:101

`Static`getMedianRef

getMedianRef(refArray: DecoratorRef[]): null | DecoratorRef
Parameters
- refArray: DecoratorRef[]
Returns null | DecoratorRef
- Defined in components/Draftail/CommentableEditor/CommentableEditor.tsx:108

Class DraftailInlineAnnotation

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DraftailInlineAnnotation

Properties

cachedMedianRef

decoratorRefs

field

Param: field

focusedBlockKey

Methods

addDecoratorRef

Parameters

Returns void

getAnchorNode

Parameters

Returns Element

getTab

Returns undefined | null | string

removeDecoratorRef

Parameters

Returns void

setFocusedBlockKey

Parameters

Returns void

`Static`getHeightForRef

Parameters

Returns number

`Static`getMedianRef

Parameters

Returns null | DecoratorRef

Settings

On This Page

Class DraftailInlineAnnotation

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DraftailInlineAnnotation

Properties

cachedMedianRef

decoratorRefs

field

Param: field

focusedBlockKey

Methods

addDecoratorRef

Parameters

Returns void

getAnchorNode

Parameters

Returns Element

getTab

Returns undefined | null | string

removeDecoratorRef

Parameters

Returns void

setFocusedBlockKey

Parameters

Returns void

StaticgetHeightForRef

Parameters

Returns number

StaticgetMedianRef

Parameters

Returns null | DecoratorRef

Settings

On This Page

`Static`getHeightForRef

`Static`getMedianRef