@pluginjs/offset v0.8.16

Offset

A flexible modern offset js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/offset

NPM

npm i @pluginjs/offset

Getting Started

CDN:

Development:

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

Production:

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

Initialize

HTML:

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

ECMAScript Module:

import Offset from "@pluginjs/offset"
import "@pluginjs/offset/dist/offset.css"

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

CommonJS:

require("@pluginjs/offset/dist/offset.css")
const Offset = require("@pluginjs/offset")

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

Browser:

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

API

Options

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

Events

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

Methods

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

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-offset "THEME" | Declare plugin theme | {namespace}--{theme} "DISABLED" | Announce plugin is disabled | {namespace}-disabled "INNER" | Declare plugin inner | {namespace}-inner "ITEM" | Declare plugin item | {namespace}-item "MARGINTOP" | Declare plugin marginTop | {namespace}-marginTop "MARGINBOTTOM" | Declare plugin marginBottom | {namespace}-marginBottom "MARGINLEFT" | Declare plugin marginLeft | {namespace}-marginLeft "MARGINRIGHT" | Declare plugin marginRight | {namespace}-marginRight "PADDINGTOP" | Declare plugin paddingTop | {namespace}-paddingTop "PADDINGBOTTOM" | Declare plugin paddingBottom | {namespace}-paddingBottom "PADDINGLEFT" | Declare plugin paddingLeft | {namespace}-paddingLeft "PADDINGRIGHT" | Declare plugin paddingLeft | {namespace}-paddingRight "VIEW" | Declare plugin view | {namespace}-view "UNITSHOW" | Declare plugin unit show | {namespace}-unit-show "CONNECT" | Declare plugin connect | {namespace}-connect "CONNECTLINK" | Declare plugin connect link | {namespace}-connect-link "CONNECTUNLINK" | Declare plugin connect unlink | {namespace}-connect-unlink "CONNECTACTIVE" | Declare plugin connect active | {namespace}-connect-active

Translations

Name | EN | ZH --||- "brokenLink" | Broken Link | 解开链接 "keepLink" | Keep Them Constant | 保持链接

Browser support

Tested on all major browsers.

License

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

If you want to use @pluginjs/offset 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.