Packages

case class CharacterCount(id: String = "", name: String = "", rows: Int = 5, value: Option[String] = None, maxLength: Option[Int] = None, maxWords: Option[Int] = None, threshold: Option[Int] = None, label: Label = Label(), hint: Option[Hint] = None, errorMessage: Option[ErrorMessage] = None, formGroup: FormGroup = FormGroup.empty, classes: String = "", attributes: Map[String, String] = Map.empty, countMessageClasses: String = "", charactersUnderLimitText: Option[Map[String, String]] = None, charactersAtLimitText: Option[String] = None, charactersOverLimitText: Option[Map[String, String]] = None, wordsUnderLimitText: Option[Map[String, String]] = None, wordsAtLimitText: Option[String] = None, wordsOverLimitText: Option[Map[String, String]] = None, textareaDescriptionText: Option[String] = None) extends Product with Serializable

Parameters to GovukCharacterCount Twirl template

id

the id of the textarea element

name

the name of the textarea element

rows

height of the textarea in rows

value

optional initial value of the textarea

maxLength

optional maximum length, in characters, of the text in the textarea

maxWords

optional maximum number of words in the textarea

threshold

optional threshold, in characters, for the textarea

label

optional Label for the control

hint

optional Hint for the control

errorMessage

optional ErrorMessage to display

formGroup

additional CSS classes/attributes/etc. to apply to the form group

classes

optional additional CSS classes to apply to the textarea

attributes

optional additional HTML attributes to apply to the textarea

countMessageClasses

optional additional CSS classes to apply to the max length/word count message

charactersUnderLimitText

optional text to display when the character count is under the limit (defaults to "You can enter up to {maxLength} characters")

charactersAtLimitText

optional text to display when the character count is at the limit

charactersOverLimitText

optional text to display when the character count is over the limit

wordsUnderLimitText

optional text to display when the word count is under the limit (defaults to "You can enter up to {maxWords} words")

wordsAtLimitText

optional text to display when the word count is at the limit

wordsOverLimitText

optional text to display when the word count is over the limit

textareaDescriptionText

optional text to display under the textarea

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CharacterCount
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CharacterCount(id: String = "", name: String = "", rows: Int = 5, value: Option[String] = None, maxLength: Option[Int] = None, maxWords: Option[Int] = None, threshold: Option[Int] = None, label: Label = Label(), hint: Option[Hint] = None, errorMessage: Option[ErrorMessage] = None, formGroup: FormGroup = FormGroup.empty, classes: String = "", attributes: Map[String, String] = Map.empty, countMessageClasses: String = "", charactersUnderLimitText: Option[Map[String, String]] = None, charactersAtLimitText: Option[String] = None, charactersOverLimitText: Option[Map[String, String]] = None, wordsUnderLimitText: Option[Map[String, String]] = None, wordsAtLimitText: Option[String] = None, wordsOverLimitText: Option[Map[String, String]] = None, textareaDescriptionText: Option[String] = None)

    id

    the id of the textarea element

    name

    the name of the textarea element

    rows

    height of the textarea in rows

    value

    optional initial value of the textarea

    maxLength

    optional maximum length, in characters, of the text in the textarea

    maxWords

    optional maximum number of words in the textarea

    threshold

    optional threshold, in characters, for the textarea

    label

    optional Label for the control

    hint

    optional Hint for the control

    errorMessage

    optional ErrorMessage to display

    formGroup

    additional CSS classes/attributes/etc. to apply to the form group

    classes

    optional additional CSS classes to apply to the textarea

    attributes

    optional additional HTML attributes to apply to the textarea

    countMessageClasses

    optional additional CSS classes to apply to the max length/word count message

    charactersUnderLimitText

    optional text to display when the character count is under the limit (defaults to "You can enter up to {maxLength} characters")

    charactersAtLimitText

    optional text to display when the character count is at the limit

    charactersOverLimitText

    optional text to display when the character count is over the limit

    wordsUnderLimitText

    optional text to display when the word count is under the limit (defaults to "You can enter up to {maxWords} words")

    wordsAtLimitText

    optional text to display when the word count is at the limit

    wordsOverLimitText

    optional text to display when the word count is over the limit

    textareaDescriptionText

    optional text to display under the textarea

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val attributes: Map[String, String]
  6. val charactersAtLimitText: Option[String]
  7. val charactersOverLimitText: Option[Map[String, String]]
  8. val charactersUnderLimitText: Option[Map[String, String]]
  9. val classes: String
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  11. val countMessageClasses: String
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. val errorMessage: Option[ErrorMessage]
  14. val formGroup: FormGroup
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. val hint: Option[Hint]
  17. val id: String
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val label: Label
  20. val maxLength: Option[Int]
  21. val maxWords: Option[Int]
  22. val name: String
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  26. def productElementNames: Iterator[String]
    Definition Classes
    Product
  27. val rows: Int
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. val textareaDescriptionText: Option[String]
  30. val threshold: Option[Int]
  31. val value: Option[String]
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. val wordsAtLimitText: Option[String]
  36. val wordsOverLimitText: Option[Map[String, String]]
  37. val wordsUnderLimitText: Option[Map[String, String]]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped