Git Product home page Git Product logo

clamp's Introduction

Clamp

Text clamping JS-style. Largely inspired by Joseph Schmitt's $clamp, but largely simplified to avoid the issues that library has.

Usage

Initialize a Clamp instance on an element containing a single text node:

new Clamp(HTMLElement, optionsObject);

Methods

.render()

Renders clamp based on current layout. Can be used to relayout if layout changes, such as on resize.

.reset()

Resets text node to contain original content

Options

lines {Integer} (Default: 2)

Probably the most important option. Specify how many lines you want.

splitOnChars {Array} (Default: ['.', '-', '–', '—', ' '])

Defines characters to split in prioritized order. Defaults to sentences (periods), hypens, en-dashes, em-dashes, and words (spaces).

truncationChar {String} (Default: '…')

Character to append to truncated string. Defaults to a simple ellipsis.

Contact, attribution & contribution

All code here is either created by me or shamelessly stolen from other great libraries. I've tried to attribute authors whenever relevant. Contribute by simply forking your own repository and commit away.

I will review pull requests as quickly as I can.

If anything leaves a bad taste in your mouth, contact info can be found at ljd.dk.

License

Clamp is licensed under WTFPL.

clamp's People

Contributors

laustdeleuran avatar

Watchers

James Cloos avatar  avatar

Forkers

asqwrd

clamp's Issues

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.