tweekit v1.1.4

:rocket: Introduction

TweekIT is a simple yet powerful developer-focused file transformation tool.

TweekIT's core technology is based on the industry-leading MediaRich engine by Equilibrium Inc, which is currently powering some of the world's largest B2B portals.

Tweekit takes full advantage of the Tweekit REST API to provide you with an easy to use visual tool to perform image transformations.

:wrench: Installation

Get it by typing this on your terminal

npm i tweekit-widget

:running: Getting Started

Once you have an account you will need Register your widget so you can generate a domain specific AppID - this just takes a moment. Click here to start the process, the only information we require is the domain where you are going to host the Widget, and your user account.

To register your Widget you will need to enter the full domain for your site eg: www.yoursitename.com once you have done so, you will be able to generate the App Token and Widget Code. You will then use the Widget code to register your Widget from your site, and the Widget API to control it.

<script>
    var tweekit = new Tweekit('#tweekit-box', {
        appId: '{ your app ID }'
    })
</script>

:books: Constructor & Parameters

:pushpin: Paremeters

:pushpin: Options keys

example

var options = {
    appId: '{ your app ID }',
    message: 'drop or click to upload image',
    cropWidth: 500,
    cropHeight: 500,
    cropOnRender: true,
    header: {
        'Referrer Policy': 'strict-origin-when-cross-origin'
    }
}

var tweekit = new Tweekit('#canvas0', options})

:pushpin: Properties

example

var tweekit = new Tweekit('#tweekit-box')

var the_origin = tweekit.origin

var the_path = tweekit.path

var the_docId = tweekit.docId

var the_the_docId = tweekit.currentFile

var the_tweeks = tweekit.tweeks

var the_pageCount = tweekit.pageCount

var the_current_header = tweekit.headers
tweekit.headers = {
    'Referrer Policy': 'strict-origin-when-cross-origin'
}

var the_pageNumber = tweekit.pageNumber
tweekit.pageNumber = the_pageNumber + 1 // go to next page

var the_backgroundColor = tweekit.backgroundColor
tweekit.backgroundColor = '#FF0000'

var the_alpha = tweekit.alpha
tweekit.alpha = false

var the_format = tweekit.format
tweekit.format = "pdf"

var the_resultWidth = tweekit.resultWidth
tweekit.resultWidth = 500

var the_resultHeight = tweekit.resultHeight
tweekit.resultHeight = 900

:hammer: Methods

getParams( asJson )

gets format and parameters of the preview API call currently displaying an image in the widget.

Returns: A string of formatted parameters

addEventListener( name, listener )

Behaves much like the standard function of the same name, but accepts custom names for the TweekIt object.

removeEventListener( name, listener )

Behaves much like the standard function of the same name, but accepts custom names for the TweekIt object.

reset()

Resets the widget to it’s starting state

result()

Gives you a blob of the tweekit result

download( filename )

fires a download event with you desired file name

🎉 Events

render

Fired whenever a server-side render is performed with one of the REST APIs | Key | Type | Description | ----------- | ----------- | ----------- | | image | blob | The image element currently being managed by the widget. | crimg | node | The cropped image html element. | width | number | The natural width of the image managed by the widget. | height | number | The natural height of the image being managed by the widget. | isUploading | boolean | Whether or not the image is still being uploaded to the widget.

update

Fired whenever a client-side change is performed | Key | Type | Description | ----------- | ----------- | ----------- | | points | array | Crop coordinates. | zoom | number | Scale factor.

propertychange

Fired whenever one of the TweekIt objects properties changes | Key | Type | Description | ----------- | ----------- | ----------- | | name | string | Name of the property that changed. | oldValue | any | Value of property before change. | newValue | any | Value of the property after a change.