Vue UI Components Documentation

Vue TextArea Component

The TextArea component for Vue represents a textarea widget with auto-complete capabilities.

Prerequisites

Refer to Vue Getting Started before you start with this help topic.

Configuration

After you have created your App.vue file, here is how you should structure it:

The TextArea component for Vue requires the following import:

import JqxTextArea from 'jqwidgets-scripts/jqwidgets-vue/vue_jqxtextarea.vue';

Add the jqxTextArea component to the components section of the the Vue class:

 components: {
    JqxTextArea
 },

Template

The App.vue has a <template> structural tag where we determine the application structure. There we will also set the tags for the new components - <JqxTextArea/>

<template>
    <JqxTextArea :width="width" :height="height" :source="generateSource"
                 :placeHolder="placeHolder" :minLength="minLength">
    </JqxTextArea>
</template>

Properties

The properties of the <JqxTextArea/> component are defined in the data member of the Vue class. We should put them in the return object of the data function:

data: function () {
    return {
        width: 300,
        height: 100,
        placeHolder: 'Enter a Sentence',
        minLength: 1
    }
}

Events

The events in Vue are set as an attribute with @ prefix, for example:

<JqxTextArea :open="onOpen()"
             :width="width" :height="height" :source="generateSource"
             :placeHolder="placeHolder" :minLength="minLength">
</JqxTextArea>

All events that are bound to a component are implemented in the methods member of the Vue class.

methods: {
    onOpen: function () {
        // Do something...
    }
}

Methods

To use a component's method we should have its reference. In Vue we refer to a component by the special $refs property. Before that we need to add the desired name reference to that component:

<JqxTextArea ref="textarea"></JqxTextArea>

Here how you can use a component's method:

this.$refs.textarea.selectAll();

If we want to add additional methods we should also implement them in the methods member.

methods: {
    // Add here all used callbacks and/or events
    onOpen: function () {
        // Do something...
        this.refs.textarea.selectAll();
    },
    generateSource: function () {
        const quotes = [];
 
        quotes.push('Life is a dream for the wise, a game for the fool, a comedy for the rich, a tragedy for the poor.');
        quotes.push('Yesterday is not ours to recover, but tomorrow is ours to win or lose.');
        quotes.push('It does not matter how slowly you go as long as you do not stop.');
        quotes.push('Success depends upon previous preparation, and without such preparation there is sure to be failure.');
        quotes.push('Better a diamond with a flaw than a pebble without.');
        quotes.push('To succeed in life, you need two things: ignorance and confidence.');
        quotes.push('A successful man is one who can lay a firm foundation with the bricks others have thrown at him.');
        quotes.push('Sleep is the best meditation.');
 
        return quotes;
    }
}

In case we need to do some precalculation or something else before the components are rendered, we should use the beforeCreate member. It depends on the case.

If you have followed the above steps, you App.vue file would look like this:

App.vue:

<template>
    <JqxTextArea ref="textarea" :open="onOpen()"
                 :width="width" :height="height" :source="generateSource"
                 :placeHolder="placeHolder" :minLength="minLength">
    </JqxTextArea>
</template>
 
<script>
    // Import the components that will be used
    import JqxTextArea from 'jqwidgets-scripts/jqwidgets-vue/vue_jqxtextarea.vue';
     
    export default {
        components: {
            // Adding imported widgets here
            JqxTextArea
        },
        data: function () {
            // Define properties which will use in the widget
            return {
                width: 300,
                height: 100,
                placeHolder: 'Enter a Sentence',
                minLength: 1
            }
        },
        beforeCreate: function () {
            // Add here any data where you want to transform before components be rendered
        },
        methods: {
            // Add here all used callbacks and/or events
            onOpen: function () {
                // Do something...
                this.refs.textarea.selectAll();
            },
            generateSource: function () {
                const quotes = [];
                quotes.push('Life is a dream for the wise, a game for the fool, a comedy for the rich, a tragedy for the poor.');
                quotes.push('Yesterday is not ours to recover, but tomorrow is ours to win or lose.');
                quotes.push('It does not matter how slowly you go as long as you do not stop.');
                quotes.push('Success depends upon previous preparation, and without such preparation there is sure to be failure.');
                quotes.push('Better a diamond with a flaw than a pebble without.');
                quotes.push('To succeed in life, you need two things: ignorance and confidence.');
                quotes.push('A successful man is one who can lay a firm foundation with the bricks others have thrown at him.');
                quotes.push('Sleep is the best meditation.');
                return quotes;
            }
        }
    }
</script>
 
<style>
</style>

TextArea Example

<template>
    <JqxTextArea ref="myTextArea"
                 :width="300" :height="100" :source="source"
                 :placeHolder="'Enter a Country'" :renderer="renderer" />
</template>
 
<script>
    import JqxTextArea from 'jqwidgets-scripts/jqwidgets-vue/vue_jqxtextarea.vue';
 
    export default {
        components: {
            JqxTextArea
        },
        data: function () {
            return {
                countries: ['Afghanistan', 'Albania', 'Algeria', 'Andorra', 'Angola', 'Antarctica', 'Antigua and Barbuda', 'Argentina', 'Armenia', 'Australia', 'Austria', 'Azerbaijan', 'Bahamas', 'Bahrain', 'Bangladesh', 'Barbados', 'Belarus', 'Belgium', 'Belize', 'Benin', 'Bermuda', 'Bhutan', 'Bolivia', 'Bosnia and Herzegovina', 'Botswana', 'Brazil', 'Brunei', 'Bulgaria', 'Burkina Faso', 'Burma', 'Burundi', 'Cambodia', 'Cameroon', 'Canada', 'Cape Verde', 'Central African Republic', 'Chad', 'Chile', 'China', 'Colombia', 'Comoros', 'Congo, Democratic Republic', 'Congo, Republic of the', 'Costa Rica', 'Cote d\'Ivoire', 'Croatia', 'Cuba', 'Cyprus', 'Czech Republic', 'Denmark', 'Djibouti', 'Dominica', 'Dominican Republic', 'East Timor', 'Ecuador', 'Egypt', 'El Salvador', 'Equatorial Guinea', 'Eritrea', 'Estonia', 'Ethiopia', 'Fiji', 'Finland', 'France', 'Gabon', 'Gambia', 'Georgia', 'Germany', 'Ghana', 'Greece', 'Greenland', 'Grenada', 'Guatemala', 'Guinea', 'Guinea-Bissau', 'Guyana', 'Haiti', 'Honduras', 'Hong Kong', 'Hungary', 'Iceland', 'India', 'Indonesia', 'Iran', 'Iraq', 'Ireland', 'Israel', 'Italy', 'Jamaica', 'Japan', 'Jordan', 'Kazakhstan', 'Kenya', 'Kiribati', 'Korea, North', 'Korea, South', 'Kuwait', 'Kyrgyzstan', 'Laos', 'Latvia', 'Lebanon', 'Lesotho', 'Liberia', 'Libya', 'Liechtenstein', 'Lithuania', 'Luxembourg', 'Macedonia', 'Madagascar', 'Malawi', 'Malaysia', 'Maldives', 'Mali', 'Malta', 'Marshall Islands', 'Mauritania', 'Mauritius', 'Mexico', 'Micronesia', 'Moldova', 'Mongolia', 'Morocco', 'Monaco', 'Mozambique', 'Namibia', 'Nauru', 'Nepal', 'Netherlands', 'New Zealand', 'Nicaragua', 'Niger', 'Nigeria', 'Norway', 'Oman', 'Pakistan', 'Panama', 'Papua New Guinea', 'Paraguay', 'Peru', 'Philippines', 'Poland', 'Portugal', 'Qatar', 'Romania', 'Russia', 'Rwanda', 'Samoa', 'San Marino', ' Sao Tome', 'Saudi Arabia', 'Senegal', 'Serbia and Montenegro', 'Seychelles', 'Sierra Leone', 'Singapore', 'Slovakia', 'Slovenia', 'Solomon Islands', 'Somalia', 'South Africa', 'Spain', 'Sri Lanka', 'Sudan', 'Suriname', 'Swaziland', 'Sweden', 'Switzerland', 'Syria', 'Taiwan', 'Tajikistan', 'Tanzania', 'Thailand', 'Togo', 'Tonga', 'Trinidad and Tobago', 'Tunisia', 'Turkey', 'Turkmenistan', 'Uganda', 'Ukraine', 'United Arab Emirates', 'United Kingdom', 'United States', 'Uruguay', 'Uzbekistan', 'Vanuatu', 'Venezuela', 'Vietnam', 'Yemen', 'Zambia', 'Zimbabwe']
            }
        },
        methods: {
            source: function (query, response) {
                const item = query.split(/,\s*/).pop();
                // update the search query.
                this.$refs.myTextArea.query = item;
                response(this.countries);
            },
            renderer: function (itemValue, inputValue) {
                const terms = inputValue.split(/,\s*/);
 
                // remove the current input
                terms.pop();
                // add the selected item
                terms.push(itemValue);
                // add placeholder to get the comma-and-space at the end
                terms.push('');
                return terms.join(', ');
            }
        }
    }
</script>

Run Code