docs: add JSDoc for attributes [skip ci] (#489) (#490)

vaadin · Jul 20, 2020 · 2fb4a7b · 2fb4a7b
1 parent ccf8e8c
commit 2fb4a7b
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/src/vaadin-number-field.html b/src/vaadin-number-field.html
@@ -119,6 +119,7 @@
           return {
             /**
              * Set to true to display value increase/decrease controls.
+             * @attr {boolean} has-controls
              * @type {boolean}
              */
             hasControls: {

diff --git a/src/vaadin-password-field.html b/src/vaadin-password-field.html
@@ -87,6 +87,7 @@
           return {
             /**
              * Set to true to hide the eye icon which toggles the password visibility.
+             * @attr {boolean} reveal-button-hidden
              * @type {boolean}
              */
             revealButtonHidden: {
@@ -96,6 +97,7 @@
 
             /**
              * True if the password is visible ([type=text]).
+             * @attr {boolean} password-visible
              * @type {boolean}
              */
             passwordVisible: {

diff --git a/src/vaadin-text-field-mixin.html b/src/vaadin-text-field-mixin.html
@@ -178,6 +178,7 @@
 
         /**
          * Set to true to display the clear icon which clears the input.
+         * @attr {boolean} clear-button-visible
          * @type {boolean}
          */
         clearButtonVisible: {
@@ -187,6 +188,7 @@
 
         /**
          * Error to show when the input value is invalid.
+         * @attr {string} error-message
          * @type {string}
          */
         errorMessage: {
@@ -228,6 +230,7 @@
 
         /**
          * String used for the helper text.
+         * @attr {string} helper-text
          * @type {string | null}
          */
         helperText: {
@@ -306,6 +309,7 @@
 
         /**
          * Specifies that the text field has value.
+         * @attr {boolean} has-value
          */
         hasValue: {
           type: Boolean,
@@ -315,6 +319,7 @@
         /**
          * When set to true, user is prevented from typing a value that
          * conflicts with the given `pattern`.
+         * @attr {boolean} prevent-invalid-input
          */
         preventInvalidInput: {
           type: Boolean