📝 Document {clipDirection: 'closest'}

This commit is contained in:
Antonio Scandurra
2016-04-06 14:21:06 +02:00
parent 66b9383c4e
commit 00f03fd614

View File

@@ -1515,8 +1515,9 @@ class TextEditor extends Model
# * `options` (optional) {Object}
# * `clipDirection` {String} If `'backward'`, returns the first valid
# position preceding an invalid position. If `'forward'`, returns the
# first valid position following a valid position. Defaults to
# `'backward'`.
# first valid position following an invalid position. If `'closest'`,
# returns the first valid position closest to an invalid position.
# Defaults to `'closest'`.
#
# Returns a {Point}.
clipScreenPosition: (screenPosition, options) -> @displayLayer.clipScreenPosition(screenPosition, options)