Gathering detailed insights and metrics for fun-tui-image-editor
Gathering detailed insights and metrics for fun-tui-image-editor
🍞🎨 Full-featured photo image editor using canvas. It is really easy, and it comes with great filters.
3.16.5
MIT
JavaScript
3.62 MB
Installations
npm install fun-tui-image-editorDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
18.18.0
NPM Version
9.8.1
Releases
Unable to fetch releases
Languages
6
JavaScript
Stylus
HTML
TypeScript
CSS
Vue
JavaScript (90.11%)
Stylus (4.67%)
HTML (3.22%)
TypeScript (0.93%)
CSS (0.76%)
Vue (0.31%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
690 Commits
1 Branches
1 Contributors
Updated on Aug 25, 2023
Maintainers
1
Package Meta Information
Latest Version
3.16.5
Package Id
fun-tui-image-editor@3.16.5
Unpacked Size
3.62 MB
Size
762.31 kB
File Count
383
NPM Version
9.8.1
Node Version
18.18.0
Published on
Dec 17, 2023
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
1
Full featured image editor using HTML5 Canvas. It's easy to use and provides powerful filters.
🚩 Table of Contents
Collect statistics on the use of open source
TOAST UI ImageEditor applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI ImageEditor is used throughout the world. It also serves as important index to determine the future course of projects. location.hostname (e.g. > “ui.toast.com") is to be collected and the sole purpose is nothing but to measure statistics on the usage. To disable GA, use the following usageStatistics option when creating the instance.
1const options = {
2 //...
3 usageStatistics: false,
4};
5
6const imageEditor = new tui.ImageEditor('#tui-image-editor-container', options);Or, include tui-code-snippet(v1.4.0 or later) and then immediately write the options as follows:
1tui.usageStatistics = false;
💾 Install
The TOAST UI products can be installed by using the package manager or downloading the source directly. However, we highly recommend using the package manager.
Via Package Manager
You can find TOAST UI products via npm and bower package managers. Install by using the commands provided by each package manager. When using npm, be sure Node.js is installed in the environment.
npm
1. ImageEditor installation
1$ npm install --save tui-image-editor # Latest version 2$ npm install --save tui-image-editor@<version> # Specific version
2. If the installation of the fabric.js dependency module does not go smoothly
To solve the problem, you need to refer to Some Steps to solve the problem.
bower
1$ bower install tui-image-editor # Latest version 2$ bower install tui-image-editor#<tag> # Specific version
Via Contents Delivery Network (CDN)
TOAST UI products are available over the CDN powered by NHN Cloud.
You can use the CDN as below.
1<link 2 rel="stylesheet" 3 href="https://uicdn.toast.com/tui-image-editor/latest/tui-image-editor.css" 4/> 5<script src="https://uicdn.toast.com/tui-image-editor/latest/tui-image-editor.js"></script>
If you want to use a specific version, use the tag name instead of latest in the URL.
The CDN directory has the following structure.
tui-image-editor/
├─ latest/
│ ├─ tui-image-editor.js
│ ├─ tui-image-editor.min.js
│ └─ tui-image-editor.css
├─ v3.1.0/
│ ├─ ...
Download Source Files
🔨 Usage
HTML
Add the container element where TOAST UI ImageEditor will be created.
1<body> 2 ... 3 <div id="tui-image-editor"></div> 4 ... 5</body>
javascript
Add dependencies & initialize ImageEditor class with given element to make an image editor.
1const ImageEditor = require('tui-image-editor'); 2const FileSaver = require('file-saver'); //to download edited image to local. Use after npm install file-saver 3const blackTheme = require('./js/theme/black-theme.js'); 4const locale_ru_RU = { 5 // override default English locale to your custom 6 Crop: 'Обзрезать', 7 'Delete-all': 'Удалить всё', 8 // etc... 9}; 10const instance = new ImageEditor(document.querySelector('#tui-image-editor'), { 11 includeUI: { 12 loadImage: { 13 path: 'img/sampleImage.jpg', 14 name: 'SampleImage', 15 }, 16 locale: locale_ru_RU, 17 theme: blackTheme, // or whiteTheme 18 initMenu: 'filter', 19 menuBarPosition: 'bottom', 20 }, 21 cssMaxWidth: 700, 22 cssMaxHeight: 500, 23 selectionStyle: { 24 cornerSize: 20, 25 rotatingPointOffset: 70, 26 }, 27});
Or
1const ImageEditor = require('tui-image-editor'); 2const instance = new ImageEditor(document.querySelector('#tui-image-editor'), { 3 cssMaxWidth: 700, 4 cssMaxHeight: 500, 5 selectionStyle: { 6 cornerSize: 20, 7 rotatingPointOffset: 70, 8 }, 9});
Menu svg icon setting
There are two ways to set icons.
- Use default svg built into imageEditor without setting svg file path (Features added since version v3.9.0).
- There is a way to use the actual physical svg file and set the file location manually.
Can find more details in this document.
TypeScript
If you use TypeScript, You must import module = require('module') on importing.
export = and import = require()
1import ImageEditor = require('tui-image-editor'); 2const FileSaver = require('file-saver'); //to download edited image to local. Use after npm install file-saver 3 4const instance = new ImageEditor(document.querySelector('#tui-image-editor'), { 5 cssMaxWidth: 700, 6 cssMaxHeight: 500, 7 selectionStyle: { 8 cornerSize: 20, 9 rotatingPointOffset: 70, 10 }, 11});
See details for additional information.
No vulnerabilities found.
No security vulnerabilities found.