Shorten

A flexible modern shorten js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/shorten

NPM

npm i @pluginjs/shorten

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/shorten/dist/shorten.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/shorten/dist/shorten.css">

Production:

<script src="https://unpkg.com/@pluginjs/shorten/dist/shorten.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/shorten/dist/shorten.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import Shorten from "@pluginjs/shorten"
import "@pluginjs/shorten/dist/shorten.css"

Shorten.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/shorten/dist/shorten.css")
const Shorten = require("@pluginjs/shorten")

Shorten.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/shorten/dist/shorten.css">
<script src="https://unpkg.com/@pluginjs/shorten/dist/shorten.js"></script>
<script>
  Pj.shorten('.element', options)
</script>

API

Options

Options are called on shorten instances through the shorten options itself. You can also save the instances to variable for further use.

Name | Description | Default --|--|-- "theme" | Add plugin theme option | null "chars" | Set chars | 100 "ellipses" | Set ellipses text | ... "more" | Set more text | more "less" | Set less text | less

Events

Events are called on shorten instances through the shorten events itself. You can also save the instances to variable for further use.

Name | Description --|-- "ready" | Gets fired when plugin is ready "destroy" | Gets fired when plugin is destroy "expand" | Gets fired when plugin is expand "collapse" | Gets fired when plugin is collapse

Methods

Methods are called on shorten instances through the shorten method itself. You can also save the instances to variable for further use.

Name | Description --|-- "collapse" | Setup plugin into collapse status "expand" | Setup plugin into expand status "destroy" | Destroy plugin

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-shorten "THEME" | Declare plugin theme | {namespace}--{theme} "EXPAND" | Delcare plugin is at expend status | {namespace}-expand "DETAIL" | Declare detail node | {namespace}-detail "ELLIPSES" | Declare ellipses node | {namespace}-ellipses "TOGGLE" | Declare toggle node | {namespace}-toggle

Browser support

Tested on all major browsers.

| IE / Edge | Firefox | Chrome | Safari | Opera | | --------- | --------- | --------- | --------- | --------- | | IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|

License

@pluginjs/shorten is Licensed under the GPL-v3 license.

If you want to use @pluginjs/shorten project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us purchase@thecreation.co.

Copyright

Copyright (C) 2022 Creation Studio Limited.