zmk/app/dts/bindings/behaviors/zmk,behavior-hold-tap.yaml

# Copyright (c) 2020 The ZMK Contributors
# SPDX-License-Identifier: MIT

description: Hold or Tap behavior

compatible: "zmk,behavior-hold-tap"

include: two_param.yaml

properties:
  bindings:
    type: phandles
    required: true
  tapping-term-ms:
    type: int
  tapping_term_ms: # deprecated
    type: int
  quick-tap-ms:
    type: int
    default: -1
  quick_tap_ms: # deprecated
    type: int
  global-quick-tap:
    type: boolean
  flavor:
    type: string
    required: false
    default: "hold-preferred"
    enum:
      - "hold-preferred"
      - "balanced"
      - "tap-preferred"
      - "tap-unless-interrupted"
  retro-tap:
    type: boolean
  hold-trigger-key-positions:
    type: array
    required: false
    default: []
fix: Switch to single AUTHORS file.* Closes #164 4 years ago			`# Copyright (c) 2020 The ZMK Contributors`
Initial implementation of hold-tap 4 years ago			`# SPDX-License-Identifier: MIT`

			`description: Hold or Tap behavior`

			`compatible: "zmk,behavior-hold-tap"`

			`include: two_param.yaml`

			`properties:`
			`bindings:`
			`type: phandles`
			`required: true`
style(hold-tap)!: Write hold-tap params with dashes tapping_term_ms -> tapping-term-ms quick_tap_ms -> quick-tap-ms The old style works, although it's deprecated. 4 years ago			`tapping-term-ms:`
fix: Switch to single AUTHORS file.* Closes #164 4 years ago			`type: int`
style(hold-tap)!: Write hold-tap params with dashes tapping_term_ms -> tapping-term-ms quick_tap_ms -> quick-tap-ms The old style works, although it's deprecated. 4 years ago			`tapping_term_ms: # deprecated`
			`type: int`
			`quick-tap-ms:`
behaviors(hold-tap): Implement quick_tap_ms (TAPPING_FORCE_HOLD) Tap-and-hold a hold-tap to hold the tap behavior so it can repeat. After a tap, if the same key is pressed within `quick_tap_ms`, the tap behavior is always picked. This is useful for things like `&ht LSHFT BACKSPACE` where holding the backspace is required. Implements #288. 4 years ago			`type: int`
			`default: -1`
style(hold-tap)!: Write hold-tap params with dashes tapping_term_ms -> tapping-term-ms quick_tap_ms -> quick-tap-ms The old style works, although it's deprecated. 4 years ago			`quick_tap_ms: # deprecated`
			`type: int`
feat(behaviors): Add `global-quick-tap` 3 years ago			`global-quick-tap:`
			`type: boolean`
Initial implementation of hold-tap 4 years ago			`flavor:`
			`type: string`
			`required: false`
			`default: "hold-preferred"`
			`enum:`
fix: Switch to single AUTHORS file.* Closes #164 4 years ago			`- "hold-preferred"`
			`- "balanced"`
			`- "tap-preferred"`
feat: hold/tap flavor tap-unless-interrupted Implements new hold/tap flavor, tap-unless-interrupted Adds tests Adds docs 3 years ago			`- "tap-unless-interrupted"`
feature(hold-tap): Retro tapping 4 years ago			`retro-tap:`
			`type: boolean`
feat(behaviors) Required keys for tap-hold behaviors * Add optional `hold-trigger-key-positions` hold-tap configuration * Leverage configuration for decision making around when to trigger hold decision in hold-taps. * Add docs for new configuration. * Tests for the new config/decision logic. 3 years ago			`hold-trigger-key-positions:`
			`type: array`
			`required: false`
			`default: []`