API Docs

Set Keyboard Shortcuts

Set Keyboard Shortcuts - kintone.setKeyboardShortcuts()

Enables or disables keyboard shortcuts.

Function

kintone.setKeyboardShortcuts(config)

Parameters

Parameter Type Required Description
config Boolean or Object Required The keyboard shortcut settings.
Specify one of the following values.
  • true: Enable all keyboard shortcuts on the current page
  • false: Disable all keyboard shortcuts on the current page
  • Object: Enable/disable individual keyboard shortcuts. Shortcuts not specified will remain unchanged
config.shortcutName Boolean Optional Specifies whether to enable or disable a keyboard shortcut.
The following values can be specified for the shortcut name:
Record List Screen
  • SHOW_RECORD: Show details of the selected record (Enter or o)
  • FOCUS_SEARCH_BOX: Enter search keywords (/)
  • SHORTCUTS_HELP: Toggle the keyboard shortcuts screen (?)
  • CREATE_RECORD: New record (c)
  • EDIT_RECORD: Edit the selected record (e)
  • NEXT_RECORD: Move to the next record (j)
  • PREVIOUS_RECORD: Move to the previous record (k)
  • NEXT_PAGE: Go to the next page (n)
  • PREVIOUS_PAGE: Go to the previous page (p)
Record Details/Edit Screen
  • FOCUS_SEARCH_BOX: Enter search keywords (/)
  • CANCEL_EDITING: Cancel editing (Esc)
  • SHORTCUTS_HELP: Toggle the keyboard shortcuts screen (?)
  • CREATE_RECORD: New record (c)
  • EDIT_RECORD: Edit the selected record (e)
  • SHOW_VIEW: Return to the view (g + a)
  • SHOW_FILTER: Show the filter results (g + i)
  • NEXT_RECORD: Move to the next record (j)
  • PREVIOUS_RECORD: Move to the previous record (k)
  • SAVE_RECORD: Save changes (Ctrl + s)
Add/Duplicate Records Screen
  • FOCUS_SEARCH_BOX: Enter search keywords (/)
  • SHORTCUTS_HELP: Toggle the keyboard shortcuts screen (?)
  • SAVE_RECORD: Save changes (Ctrl + s)

Returns

A Promise object.
When the Promise object is fulfilled, no value is returned.

Available Pages

  • Record List
  • Record Details
  • Record Edit
  • Record Create