TagsField
Summary
Defines a form tags field.
Use Field.get method to get an instance of TagsField.
Constructor
TagsField
Syntax
TagsField
-
conf
Summary
Parameters:
-
confObjectA field configuration object
Example:
var Field = require('@openveo/test').e2e.fields.Field;
var TagsField = Field.get({
type: 'tags',
name: 'My field',
baseElement: element(by.css('form'))
});Item Index
Methods
Properties
Methods
clear
Syntax
Summary
Clears field value by removing all tags.
Returns:
Promise resolving when the field is cleared
Example:
myField.clear().then(function() {
console.log('Field cleared');
});getDescription
Syntax
Summary
Gets field description.
Returns:
Promise resolving with the description
Example:
myField.getDescription().then(function(description) {
console.log('Field description is : ' + description);
});getElement
Syntax
Summary
Gets field element wrapper.
Look for a form element label and return its parent.
Returns:
Promise resolving with the element
getErrorMessage
Syntax
Summary
Gets field error message.
Returns:
Promise resolving with the error message
Example:
myField.getErrorMessage().then(function(errorMessage) {
console.log('Error message : ' + errorMessage);
});getLabel
Syntax
Summary
Gets field label.
Returns:
Promise resolving with the label
Example:
myField.getLabel().then(function(label) {
console.log('Field label is : ' + label);
});getText
Syntax
Summary
Gets field text representation in case of an inline editable field.
Returns:
Promise resolving with field text representation
Example:
myField.getText().then(function(text) {
console.log(text);
});getValue
Syntax
Summary
Gets field values, the list of tags.
Returns:
Promise resolving with the list of tags
Example:
myField.getValue().then(function(tags) {
console.log(tags);
});isOnError
Syntax
Summary
Tests if a field is considered as on error.
Returns:
Promise resolving with a boolean indicating if the field is on error
Example:
myField.isOnError().then(function(isOnError) {
console.log('Is field on error ? ' + isOnError);
});selectTagInAutoComplete
Syntax
Summary
Selects a tag in auto complete.
Parameters:
-
TheStringvalue of the tag to select in the auto complete. It should be the same value as the one in the available options
Returns:
Promise resolving when given tag has been selected in auto complete
setValue
Syntax
Summary
Sets field value.
Parameters:
-
[values=[]]Array optionalField's list of tags
Returns:
Promise resolving when the field is filled
Example:
myField.setValue(['tag 1', 'tag 2']).then(function() {
console.log('Value set');
});setValueUsingAutoCompletion
Syntax
Summary
Sets field value using auto completion.
Parameters:
-
[values=[]]Array optionalField's list of tags
Returns:
Promise resolving when the field is filled
Example:
myField.setValueUsingAutoCompletion(['tag 1', 'tag 2']).then(function() {
console.log('Value set');
});