Comment

Comment

Visually transforms a question into a comment modal that can be shown on its linked question.

Constructor

new Comment()

Source:

Extends

Members

(static) helpersRequired :string

Source:
Type:
  • string

(static) selector :string

Source:
Type:
  • string

(readonly) downloadButtonHtml :Element

Source:
Inherited From:

Returns a HTML document fragment for a download button.

Type:
  • Element

(readonly) originalInputValue :*

Source:
Overrides:

Obtains the value from the original form control the widget is instantiated on. This form control is often hidden by the widget.

Type:
  • *

(readonly) props :object

Source:
Inherited From:

Returns widget properties. May need to be extended.

Type:
  • object

(readonly) resetButtonHtml :Element

Source:
Inherited From:

Returns a HTML document fragment for a reset button.

Type:
  • Element

(readonly) value :*

Source:
Overrides:

Obtains the value from the current widget state. Should be overridden.

Type:
  • *

Methods

_commentHasError() → {boolean}

Source:
Returns:

whether comment has error

Type
boolean

_getLinkedQuestion(input) → {Element}

Source:
Parameters:
Name Type Description
input Element

form control HTML element

Returns:

the HTML question the widget is linked with

Type
Element

_getProps() → {object}

Source:
Inherited From:

Not meant to be overridden, but could be. Recommend to extend get props() instead.

Returns:

props object

Type
object

_hideCommentModal(linkedQuestion)

Source:

Hides comment modal

Parameters:
Name Type Description
linkedQuestion Element

the HTML question the widget is linked with

_init()

Source:
Overrides:

Meant to be overridden, but automatically called.

_isCommentModalShown(linkedQuestion) → {boolean}

Source:
Parameters:
Name Type Description
linkedQuestion Element

the HTML question the widget is linked with

Returns:

whether comment modal is currently shown

Type
boolean

_setCommentButtonHandler()

Source:

Sets comment button handler

_setCommentButtonState(value, error)

Source:
Parameters:
Name Type Description
value *

comment value

error Error

error instance

_setFocusHandler()

Source:

Sets focus handler

_setValidationHandler()

Source:

Sets validation handler

_showCommentModal()

Source:

Shows comment modal

disable()

Source:
Inherited From:

Disallow user input into widget by making it readonly.

enable()

Source:
Inherited From:

Performs opposite action of disable() function.

update()

Source:
Inherited From:

Updates form-defined language strings,