https://github.com/loadingio/ldcaret

caret manipulation library in Vanilla JS.
https://github.com/loadingio/ldcaret

Last synced: 18 days ago
JSON representation

caret manipulation library in Vanilla JS.

• Host: GitHub
• URL: https://github.com/loadingio/ldcaret
• Owner: loadingio
• License: mit
• Created: 2019-12-04T07:24:21.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T05:20:43.000Z (almost 3 years ago)
• Last Synced: 2025-10-11T14:12:35.774Z (4 months ago)
• Language: JavaScript
• Size: 1.09 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ldcaret

Caret Manipulation Library, in Vanilla JS.

## Usage

Install via npm:

    npm install --save ldcaret

include  js file:

    

call desired API (see below) provided by `ldcaret` object:

    ldcaret.get();

## API

ldcaret provides following API:

 * get() - get selection range in an object with following attributes:

   - ns: start container

   - os: start offset

   - ne: end container

   - oe: end offset

 * set(opt, edit) - set selection / caret based on option object `opt`

   - opt: selection range, in two possible format

     - simplified format:

       - ns: start container

       - os: start offset

       - ne: end container ( will use ns when ne is omitted )

       - oe: end offset ( will use os when oe is omitted )

     - range object

   - edit: when set to true, patch range into innermost element if possible. default false.

 * clear() - clear selection.

 * getContent() - get text content from current selection.

 * getBoundingBox() - get the bounding box of current selection.

 * setContent(content) - replace range of current selection with `content`.

 * insert(arg) - insert or replace current selection with arg. arg could be:

   - text

   - Element

 * byPtr({node, x, y, method}) - get a closest possible caret position under `node` based on `(x,y)` coordinates.

   - method: method name (string) of the distance calculation algorithm. possible values:

     - `euclidean` - straight line distnace

     - `vertical` - favor y distance against x distance. default value.

   - return value: {min, range, box}

     - min: minimal distance in px from the calculated caret to `(x,y)` coordinates.

     - range: corresponding range of the calculated caret.

     - box: bounding box of the calculated range.

## LICENSE

MIT License.