Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Jul 20, 2020
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/vaadin-number-field.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@
return {
/**
* Set to true to display value increase/decrease controls.
* @attr {boolean} has-controls
* @type {boolean}
*/
hasControls: {
Expand Down
2 changes: 2 additions & 0 deletions src/vaadin-password-field.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand All @@ -96,6 +97,7 @@

/**
* True if the password is visible ([type=text]).
* @attr {boolean} password-visible
* @type {boolean}
*/
passwordVisible: {
Expand Down
5 changes: 5 additions & 0 deletions src/vaadin-text-field-mixin.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@

/**
* Set to true to display the clear icon which clears the input.
* @attr {boolean} clear-button-visible
* @type {boolean}
*/
clearButtonVisible: {
Expand All @@ -187,6 +188,7 @@

/**
* Error to show when the input value is invalid.
* @attr {string} error-message
* @type {string}
*/
errorMessage: {
Expand Down Expand Up @@ -228,6 +230,7 @@

/**
* String used for the helper text.
* @attr {string} helper-text
* @type {string | null}
*/
helperText: {
Expand Down Expand Up @@ -306,6 +309,7 @@

/**
* Specifies that the text field has value.
* @attr {boolean} has-value
*/
hasValue: {
type: Boolean,
Expand All @@ -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
Expand Down