Vue Data Editors - Custom Text Editor Buttons

Text editors have built-in action buttons that allow users to open a drop-down menu, increase, decrease, or nullify the value, and perform other actions. To add custom action buttons for different scenarios, use the buttons[] array.

The USD/EUR rate is taken from www.wikipedia.org and is relevant on 14 April 2021

Backend API

<template> <div> <div class="dx-fieldset"> <div class="dx-field"> <div class="dx-field-label">Password TextBox</div> <div class="dx-field-value"> <DxTextBox v-model:mode="passwordMode" value="password" :input-attr="{ 'aria-label': 'Password' }" styling-mode="filled" placeholder="password" > <DxTextBoxButton :options="passwordButton" name="password" location="after" /> </DxTextBox> </div> </div> <div class="dx-field"> <div class="dx-field-label">Multi-currency NumberBox</div> <div class="dx-field-value"> <DxNumberBox v-model:value="currencyValue" :format="currencyFormat" :show-clear-button="true" :show-spin-buttons="true" :input-attr="{ 'aria-label': 'Currency Value' }" > <DxNumberBoxButton :options="currencyButton" name="currency" location="after" /> <DxNumberBoxButton name="clear"/> <DxNumberBoxButton name="spins"/> </DxNumberBox> </div> </div> <div class="dx-field"> <div class="dx-field-label">Advanced DateBox</div> <div class="dx-field-value"> <DxDateBox v-model:value="dateValue" :input-attr="{ 'aria-label': 'Date' }" styling-mode="outlined" > <DxDateBoxButton :options="todayButton" name="today" location="before" /> <DxDateBoxButton :options="prevDateButton" name="prevDate" location="before" /> <DxDateBoxButton :options="nextDateButton" name="nextDate" location="after" /> <DxDateBoxButton name="dropDown"/> </DxDateBox> </div> </div> </div> </div> </template> <script setup lang="ts"> import { ref } from 'vue'; import { DxTextBox, DxButton as DxTextBoxButton, type DxTextBoxTypes } from 'devextreme-vue/text-box'; import { DxNumberBox, DxButton as DxNumberBoxButton } from 'devextreme-vue/number-box'; import { DxDateBox, DxButton as DxDateBoxButton } from 'devextreme-vue/date-box'; import { type DxButtonTypes } from 'devextreme-vue/button'; const millisecondsInDay = 24 * 60 * 60 * 1000; const passwordMode = ref<DxTextBoxTypes.TextBoxType>('password'); const passwordButton = { icon: 'eyeopen', stylingMode: 'text', onClick: () => { passwordMode.value = passwordMode.value === 'text' ? 'password' : 'text'; }, }; const currencyFormat = ref('$ #.##'); const currencyValue = ref(14500.55); const currencyButton = { text: '€', stylingMode: 'text', width: 32, elementAttr: { class: 'currency', }, onClick: (e: DxButtonTypes.ClickEvent) => { if (e.component.option('text') === '$') { e.component.option('text', '€'); currencyFormat.value = '$ #.##'; currencyValue.value /= 0.836; } else { e.component.option('text', '$'); currencyFormat.value = '€ #.##'; currencyValue.value *= 0.836; } }, }; const dateValue = ref(new Date().getTime()); const todayButton = { text: 'Today', stylingMode: 'text', onClick: () => { dateValue.value = new Date().getTime(); }, }; const prevDateButton = { icon: 'spinprev', stylingMode: 'text', onClick: () => { dateValue.value -= millisecondsInDay; }, }; const nextDateButton = { icon: 'spinnext', stylingMode: 'text', onClick: () => { dateValue.value += millisecondsInDay; }, }; </script> <style> .dx-fieldset { min-height: 560px; width: 560px; margin: 0 auto; } .currency { min-width: 32px; } .dx-button.currency .dx-button-content { font-size: 120%; padding-left: 5px; padding-right: 5px; } </style>

import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#app');

<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/26.1.5/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="./bundle.css" /> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"> </div> </div> <script src="bundles/vendor/vue.vendor.js"></script> <script src="./bundle.js"></script> </body> </html>

Each object in the buttons[] array should have the name field—the button's identifier. In addition, specify the button's location relative to the input text field and options of the Button component used as the action button.

The buttons[] array also accepts string values—the names of built-in buttons. Declare them in the order the buttons should have in the component. String and object declarations can be used in the same array.