Giter Club home page Giter Club logo

selectjs's Introduction

@selectjs/core

A package to enhance your developing experience with selection, using the Selection API and Range API.

The latest source code and releases are on GitHub.

WARNING: This package is under heavy development, the APIs may be changed in the future!

The developing branch is dev

Any contribution would be appreciate <3

I specially need support on unit testing to make the API as stable as possible!

Supported APIs

  • defineSelectable attach neccessary attributes to the element, got checked and called by default in some others APIs
  • getSelection get the selection from the 2 sub APIs
    • getSelectionInputOrTextarea get the selection text, start, end and select direction
    • getSelectionContenteditable get the selection HTML, start, end, select direction is not supported
  • getSelectionRect get the coresponding pixel-position of the selection by getting their bouding rects
  • setSelection set the selection by using the 3 sub APIs
    • setSelectionNode
    • setSelectionInputOrTextareaElement
    • setSelectionContenteditableElement
  • setHighlight create an underline by using the bounding boxes from getSelectionRect
  • removeSelectionContent remove the selected content
  • replaceSelectionContent replace the selected content with a new content
  • attachFloating attach a floating tooltip to the selection bounding box
  • keepSelection keep the selection from being deselected, helpful for interacting with Google Translate or Grammarly-like feature
  • watchSelection watch the selection change and provide a callback hook for event handling

Installation

npm i @selectjs/core

# Or with pnpm
pnpm add @selectjs/core

# Or with yarn
yarn add @selectjs/core

Usage (WORK IN PROGRESS)

Set selection

Example

Select any editable elements, input, textarea or element with contenteditable attribute from character to character using start and end options.

import { setSelection } from "@selectjs/core"

const element = document.querySelector('input')
// const element = document.querySelector('textarea')
// const element = document.querySelector('[contenteditable]')

setSelection(element, { start: 0, end: 5 })

setSelection Options

Option Type Description
start number Start offset of the selection
end number End offset of the selection
keep boolean Keep selecting the element until the selection is changed to empty and the element got blur

Get selection

Get the current selection information of the selected element.

import { getSelection } from "@selectjs/core"

const element = document.querySelector('input')
// const element = document.querySelector('textarea')
// const element = document.querySelector('[contenteditable]')

const result = getSelection(element)

selectjs's People

Contributors

imrim12 avatar

Stargazers

Nguyễn Thanh Việt avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.