Customize Keyboard Navigation
The following options customize keyboard navigation:
-
enterKeyAction
Specifies the widget's actions when a user presses Enter key:- "moveFocus" - moves focus in the enterKeyDirection
- "startEdit" (default) - switches the cell to the editing state
-
enterKeyDirection
Specifies the direction in which to move focus when a user presses Enter:- "row"
- "column"
- "none" (default)
-
editOnKeyPress
Specifies whether to start entering a new cell value on a key press.
In this demo, you can use the controls under the DataGrid to change any of these options.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you!
We appreciate your feedback.
We appreciate your feedback.
<template>
<div id="data-grid-demo">
<dx-data-grid
:data-source="dataSource"
:show-borders="true"
:on-focused-cell-changing="onFocusedCellChanging"
key-expr="ID"
>
<dx-keyboard-navigation
:edit-on-key-press="editOnKeyPress"
:enter-key-action="enterKeyAction"
:enter-key-direction="enterKeyDirection"
/>
<dx-editing
:allow-updating="true"
mode="batch"
start-edit-action="dblClick"
/>
<dx-paging :enabled="false"/>
<dx-column
:width="70"
data-field="Prefix"
caption="Title"
/>
<dx-column
data-field="FirstName"
/>
<dx-column
data-field="LastName"
/>
<dx-column
:width="170"
data-field="Position"
/>
<dx-column
:width="125"
data-field="StateID"
caption="State"
>
<dx-lookup
:data-source="states"
value-expr="ID"
display-expr="Name"
/>
</dx-column>
<dx-column
data-field="BirthDate"
data-type="date"
/>
</dx-data-grid>
<div class="options">
<div class="caption">Options</div>
<div class="option-container">
<div class="option check-box">
<dx-check-box
:value.sync="editOnKeyPress"
text="Edit On Key Press"
/>
</div>
<div class="option">
<span class="option-caption">Enter Key Action</span>
<dx-select-box
:items="enterKeyActions"
:value.sync="enterKeyAction"
class="select"
/>
</div>
<div class="option">
<span class="option-caption">Enter Key Direction</span>
<dx-select-box
:items="enterKeyDirections"
:value.sync="enterKeyDirection"
class="select"
/>
</div>
</div>
</div>
</div>
</template>
<script>
import {
DxDataGrid,
DxKeyboardNavigation,
DxColumn,
DxPaging,
DxEditing,
DxLookup
} from 'devextreme-vue/data-grid';
import { DxCheckBox, DxSelectBox } from 'devextreme-vue';
import { employees, states } from './data.js';
export default {
components: {
DxDataGrid,
DxColumn,
DxPaging,
DxEditing,
DxKeyboardNavigation,
DxLookup,
DxCheckBox,
DxSelectBox
},
data() {
return {
dataSource: employees,
states: states,
editOnKeyPress: true,
enterKeyActions: ['startEdit', 'moveFocus'],
enterKeyDirections: ['none', 'column', 'row'],
enterKeyDirection: 'column',
enterKeyAction: 'moveFocus'
};
},
methods: {
onFocusedCellChanging(e) {
e.isHighlighted = true;
}
}
};
</script>
import Vue from 'vue';
import App from './App.vue';
new Vue({
el: '#app',
components: { App },
template: '<App/>'
});
<!DOCTYPE html>
<html>
<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=1.0" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/19.1.6/css/dx.common.css" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/19.1.6/css/dx.light.css" />
<link rel="stylesheet" type="text/css" href="styles.css" />
<script src="https://unpkg.com/core-js@2.4.1/client/shim.min.js"></script>
<script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script>
<script type="text/javascript" src="config.js"></script>
<script type="text/javascript">
System.import('./index.js');
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<div id="app">
<span v-if="false">Loading...</span>
</div>
</div>
</body>
</html>
.options {
margin-top: 20px;
padding: 20px;
background-color: rgba(191, 191, 191, 0.15);
position: relative;
}
.caption {
font-size: 18px;
font-weight: 500;
}
.option-container {
display: flex;
margin: 0 auto;
justify-content: space-between;
}
.option {
margin-top: 10px;
display: flex;
align-items: center;
}
.option-caption {
white-space: nowrap;
margin: 0 8px;
}
.option.check-box {
width: 150px;
}
.option > .select {
width: 120px;
}
export const employees = [{
'ID': 1,
'FirstName': 'John',
'LastName': 'Heart',
'Prefix': 'Mr.',
'Position': 'CEO',
'BirthDate': '1964/03/16',
'HireDate': '1995/01/15',
'Notes': 'John has been in the Audio/Video industry since 1990. He has led DevAv as its CEO since 2003.\r\n\r\nWhen not working hard as the CEO, John loves to golf and bowl. He once bowled a perfect game of 300.',
'Address': '351 S Hill St.',
'StateID': 5
}, {
'ID': 2,
'FirstName': 'Olivia',
'LastName': 'Peyton',
'Prefix': 'Mrs.',
'Position': 'Sales Assistant',
'BirthDate': '1981/06/03',
'HireDate': '2012/05/14',
'Notes': 'Olivia loves to sell. She has been selling DevAV products since 2012. \r\n\r\nOlivia was homecoming queen in high school. She is expecting her first child in 6 months. Good Luck Olivia.',
'Address': '807 W Paseo Del Mar',
'StateID': 5
}, {
'ID': 3,
'FirstName': 'Robert',
'LastName': 'Reagan',
'Prefix': 'Mr.',
'Position': 'CMO',
'BirthDate': '1974/09/07',
'HireDate': '2002/11/08',
'Notes': 'Robert was recently voted the CMO of the year by CMO Magazine. He is a proud member of the DevAV Management Team.\r\n\r\nRobert is a championship BBQ chef, so when you get the chance ask him for his secret recipe.',
'Address': '4 Westmoreland Pl.',
'StateID': 4
}, {
'ID': 4,
'FirstName': 'Greta',
'LastName': 'Sims',
'Prefix': 'Ms.',
'Position': 'HR Manager',
'BirthDate': '1977/11/22',
'HireDate': '1998/04/23',
'Notes': "Greta has been DevAV's HR Manager since 2003. She joined DevAV from Sonee Corp.\r\n\r\nGreta is currently training for the NYC marathon. Her best marathon time is 4 hours. Go Greta.",
'Address': '1700 S Grandview Dr.',
'StateID': 11
}, {
'ID': 5,
'FirstName': 'Brett',
'LastName': 'Wade',
'Prefix': 'Mr.',
'Position': 'IT Manager',
'BirthDate': '1968/12/01',
'HireDate': '2009/03/06',
'Notes': 'Brett came to DevAv from Microsoft and has led our IT department since 2012.\r\n\r\nWhen he is not working hard for DevAV, he coaches Little League (he was a high school pitcher).',
'Address': '1120 Old Mill Rd.',
'StateID': 13
}, {
'ID': 6,
'FirstName': 'Sandra',
'LastName': 'Johnson',
'Prefix': 'Mrs.',
'Position': 'Controller',
'BirthDate': '1974/11/15',
'HireDate': '2005/05/11',
'Notes': "Sandra is a CPA and has been our controller since 2008. She loves to interact with staff so if you've not met her, be certain to say hi.\r\n\r\nSandra has 2 daughters both of whom are accomplished gymnasts.",
'Address': '4600 N Virginia Rd.',
'StateID': 44
}, {
'ID': 7,
'FirstName': 'Kevin',
'LastName': 'Carter',
'Prefix': 'Mr.',
'Position': 'Shipping Manager',
'BirthDate': '1978/01/09',
'HireDate': '2009/08/11',
'Notes': 'Kevin is our hard-working shipping manager and has been helping that department work like clockwork for 18 months.\r\n\r\nWhen not in the office, he is usually on the basketball court playing pick-up games.',
'Address': '424 N Main St.',
'StateID': 5
}, {
'ID': 8,
'FirstName': 'Cynthia',
'LastName': 'Stanwick',
'Prefix': 'Ms.',
'Position': 'HR Assistant',
'BirthDate': '1985/06/05',
'HireDate': '2008/03/24',
'Notes': 'Cindy joined us in 2008 and has been in the HR department for 2 years. \r\n\r\nShe was recently awarded employee of the month. Way to go Cindy!',
'Address': '2211 Bonita Dr.',
'StateID': 4
}, {
'ID': 9,
'FirstName': 'Kent',
'LastName': 'Samuelson',
'Prefix': 'Dr.',
'Position': 'Ombudsman',
'BirthDate': '1972/09/11',
'HireDate': '2009/04/22',
'Notes': 'As our ombudsman, Kent is on the front-lines solving customer problems and helping our partners address issues out in the field. He is a classically trained musician and is a member of the Chamber Orchestra.',
'Address': '12100 Mora Dr',
'StateID': 26
}, {
'ID': 10,
'FirstName': 'Taylor',
'LastName': 'Riley',
'Prefix': 'Mr.',
'Position': 'Network Admin',
'BirthDate': '1982/08/14',
'HireDate': '2012/04/14',
'Notes': "If you are like the rest of us at DevAV, then you've probably reached out for help from Taylor. He does a great job as a member of our IT department.",
'Address': '7776 Torreyson Dr',
'StateID': 5
}];
export const states = [{
'ID': 1,
'Name': 'Alabama'
}, {
'ID': 2,
'Name': 'Alaska'
}, {
'ID': 3,
'Name': 'Arizona'
}, {
'ID': 4,
'Name': 'Arkansas'
}, {
'ID': 5,
'Name': 'California'
}, {
'ID': 6,
'Name': 'Colorado'
}, {
'ID': 7,
'Name': 'Connecticut'
}, {
'ID': 8,
'Name': 'Delaware'
}, {
'ID': 9,
'Name': 'District of Columbia'
}, {
'ID': 10,
'Name': 'Florida'
}, {
'ID': 11,
'Name': 'Georgia'
}, {
'ID': 12,
'Name': 'Hawaii'
}, {
'ID': 13,
'Name': 'Idaho'
}, {
'ID': 14,
'Name': 'Illinois'
}, {
'ID': 15,
'Name': 'Indiana'
}, {
'ID': 16,
'Name': 'Iowa'
}, {
'ID': 17,
'Name': 'Kansas'
}, {
'ID': 18,
'Name': 'Kentucky'
}, {
'ID': 19,
'Name': 'Louisiana'
}, {
'ID': 20,
'Name': 'Maine'
}, {
'ID': 21,
'Name': 'Maryland'
}, {
'ID': 22,
'Name': 'Massachusetts'
}, {
'ID': 23,
'Name': 'Michigan'
}, {
'ID': 24,
'Name': 'Minnesota'
}, {
'ID': 25,
'Name': 'Mississippi'
}, {
'ID': 26,
'Name': 'Missouri'
}, {
'ID': 27,
'Name': 'Montana'
}, {
'ID': 28,
'Name': 'Nebraska'
}, {
'ID': 29,
'Name': 'Nevada'
}, {
'ID': 30,
'Name': 'New Hampshire'
}, {
'ID': 31,
'Name': 'New Jersey'
}, {
'ID': 32,
'Name': 'New Mexico'
}, {
'ID': 33,
'Name': 'New York'
}, {
'ID': 34,
'Name': 'North Carolina'
}, {
'ID': 35,
'Name': 'Ohio'
}, {
'ID': 36,
'Name': 'Oklahoma'
}, {
'ID': 37,
'Name': 'Oregon'
}, {
'ID': 38,
'Name': 'Pennsylvania'
}, {
'ID': 39,
'Name': 'Rhode Island'
}, {
'ID': 40,
'Name': 'South Carolina'
}, {
'ID': 41,
'Name': 'South Dakota'
}, {
'ID': 42,
'Name': 'Tennessee'
}, {
'ID': 43,
'Name': 'Texas'
}, {
'ID': 44,
'Name': 'Utah'
}, {
'ID': 45,
'Name': 'Vermont'
}, {
'ID': 46,
'Name': 'Virginia'
}, {
'ID': 47,
'Name': 'Washington'
}, {
'ID': 48,
'Name': 'West Virginia'
}, {
'ID': 49,
'Name': 'Wisconsin'
}, {
'ID': 50,
'Name': 'Wyoming'
}, {
'ID': 51,
'Name': 'North Dakota'
}];
System.config({
transpiler: 'plugin-babel',
paths: {
'npm:': 'https://unpkg.com/'
},
map: {
vue: 'npm:vue@2.6.3/dist/vue.esm.browser.js',
'vue-loader': 'npm:systemjs-vue-browser@latest/index.js',
'devextreme': 'npm:devextreme@19.1',
'devextreme-vue': 'npm:devextreme-vue@19.1',
jszip: 'npm:jszip@3.1.3/dist/jszip.min.js',
'quill': 'npm:quill@1.3.6/dist/quill.js',
'devexpress-diagram': 'npm:devexpress-diagram',
'plugin-babel': 'npm:systemjs-plugin-babel@0/plugin-babel.js',
'systemjs-babel-build': 'npm:systemjs-plugin-babel@0/systemjs-babel-browser.js'
},
meta: {
'*.vue': {
loader: 'vue-loader'
}
},
packages: {
'devextreme-vue': {
main: 'index.js'
},
'devextreme': {
defaultExtension: 'js'
}
},
babelOptions: {
sourceMaps: false,
stage0: true
}
});