Offset


A flexible modern offset js plugin.

Samples

Introduction

$3

#### Yarn

``javascript
yarn add @pluginjs/offset
`

#### NPM

`javascript
npm i @pluginjs/offset
`

Getting Started

CDN:

Development:

`html


`

Production:

`html


`

$3

HTML:

`html



`

ECMAScript Module:

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

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

CommonJS:

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

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

Browser:

`html



`

API

$3

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

Name | Description | Default
--|--|--
"locale" | Set locale environment | en
"template" | Set default template | function() {...}
"defaultUnit" | Set defaultUnit | px
"data" | Set data | null
"min" | Set min | -1000
"max" | Set max | 1000
"process" | The type of object change the type of JSON | function() {...}
"parse" | The type of JSON change the type of object | function() {...}

$3

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

Name | Description
--|--
"ready" | Gets fired when plugin has ready
"enable" | Gets fired when plugin has enabled
"disable" | Gets fired when plugin has disabled
"destroy" | Gets fired when plugin has destroy
"change" | Gets fired when plugin has changed

$3

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

Name | Description
--|--
"get" | Get value by key
"set" | Set value by key
"val" | Set or get value by key
"move" | Get value of move
"enable" | Enabled plugin if plugin is disabled
"disable" | Disable plugin
"destroy" | Destroy plugin
"clear" | Clear plugin

$3

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

$3

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

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/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.