Class: Rule | KARABINERGE

Rule(desc)

A complex modification rule

Constructor

new Rule(desc)

Parameters:

Name	Type	Description
`desc`	string	rule description

Methods

cond(cond) → Rule

Defines a condition

Parameters:

Name	Type	Description
`cond`	object	condition definition like: `{ type: 'variable_if', ... }`

Returns:

this

Type:: Rule

Examples

let rule = new Rule('VSCode Rules')
  .cond(if_app('com.microsoft.VSCode'))
  .remap( ... )
  .remap( ... );Remap rules only for VSCode

let rule = new Rule('VSCode Rules')
  .cond(if_var('foo', 1))  // if variable 'foo' is 1
  .cond(if_app('com.microsoft.VSCode'))
  .remap( ... )
  .remap( ... );Multiple conditions

remap(map) → Rule

Defines a from-to remap rule

Parameters:

Name	Type	Description
`map`	object	rule definition like: `{ from: ... , to: ... }`

Returns:

this

Type:: Rule

Examples

let rule = new Rule('control + H to backspace')
  .remap({
    from: key('h', 'control'),
    to:   key('delete_or_backspace')
  });Remap control + H to backspace

let rule = new Rule('Various Remaps')
  .remap( ... )
  .remap( ... )
  .remap( ... );Multiple remap rules

toJSON() → object

Returns a plain object representation of this rule

Returns:

an object like: { description: ... , manipulators: ... }

Type:: object