Skip to content

Commit

Permalink
Chore: Release a new version v3.12.15🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
AhmeeedMostafa committed Feb 25, 2021
1 parent 68e3aae commit 90a4883
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 63 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,20 @@ Types of changes:
- ...

-------------
## 3.12.15 - 2020-2-25
### Improved
- The styles of footer for the editor with changing the full-screen icon.
- Moving react v17.0.1 & react-dom v17.0.1 from peerDependencies to dependencies for working with projects have lower versions of react.
- Improving full-screen logic.

### Added
- `finishButtonLabel` for customizing the label of the finish button.
- `imageName` & `imageMime` to the returned object in the callbacks passed in default/downlaod mode.

### Fixed
- The icon of fullscreen at the footer which wasn't shown for some OS users.
- The issue of not changing width or height of image before start editing.

## 3.12.14 - 2020-2-20
### Improved
- Update dependencies (styled-components v5.1.1, React v17.0.1, react-dom v17.0.1 & @babel).
Expand Down
57 changes: 10 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
> Repository includes React version and Vanilla JS adapter for standalone usage
[![Release](https://img.shields.io/badge/release-v3.12.14-blue.svg)](https://github.com/scaleflex/filerobot-image-editor/releases)
[![Release](https://img.shields.io/badge/release-v3.12.15-blue.svg)](https://github.com/scaleflex/filerobot-image-editor/releases)
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange.svg)](#contributing)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Scaleflex team](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-the%20Scaleflex%20team-6986fa.svg)](https://www.scaleflex.it/en/home)
Expand Down Expand Up @@ -140,7 +140,7 @@ or use your custom color scheme
Use the latest CDNized plugin version:

```html
<script src="https://cdn.scaleflex.it/plugins/filerobot-image-editor/3.12.14/filerobot-image-editor.min.js"></script>
<script src="https://cdn.scaleflex.it/plugins/filerobot-image-editor/3.12.15/filerobot-image-editor.min.js"></script>
```

### <a name="quick_start"></a>Quick start
Expand All @@ -164,7 +164,7 @@ Initialization of Filerobot Image Editor plugin.

**`callbacks.onOpen(src: string/blob)`**: function - triggered when modal is opened

**`callbacks.onBeforeComplete({ status: string, canvas: canvas element })`**: function - triggered before onComplete; if it returns `false`, it cancels the default behaviour and you can use canvas element to upload to a 3rd-party service
**`callbacks.onBeforeComplete({ status: string, imageName: string, imageMime: string, canvas: canvas element })`**: function - triggered before onComplete; if it returns `false`, it cancels the default behaviour and you can use canvas element to upload to a 3rd-party service

**`callbacks.onComplete(url: string, file: object)`**: function - triggered on completion and returnes the URL of the edited image

Expand Down Expand Up @@ -315,7 +315,7 @@ config.translations = {
};
```

[See all translation keys here](https://github.com/scaleflex/filerobot-image-editor/blob/master/projects/react/assets/i18n/en.js)
[See all translation keys here](https://github.com/scaleflex/filerobot-image-editor/blob/master/src/assets/i18n/en.js)

### `reduceBeforeEdit`: object

Expand Down Expand Up @@ -385,7 +385,7 @@ Color schemes; currently two themes are available: 'dark', 'light'. There is a p

### `theme`: object

Possibility to make your custom theme [See the example here](https://github.com/scaleflex/filerobot-image-editor/blob/master/projects/react/assets/theme/dark.js).
Possibility to make your custom theme [See the example here](https://github.com/scaleflex/filerobot-image-editor/blob/master/src/assets/theme/dark.js).

example:

Expand Down Expand Up @@ -426,11 +426,11 @@ config.theme = {

### `cropPresets`: object

Add custom crop templates. [See the example here](https://github.com/scaleflex/filerobot-image-editor/blob/master/projects/react/assets/templates/cropPresets.js)
Add custom crop templates. [See the example here](https://github.com/scaleflex/filerobot-image-editor/blob/master/src/assets/templates/cropPresets.js)

### `resizePresets`: object

Add custom resize templates. [See the example here](https://github.com/scaleflex/filerobot-image-editor/blob/master/projects/react/assets/templates/resizePresets.js)
Add custom resize templates. [See the example here](https://github.com/scaleflex/filerobot-image-editor/blob/master/src/assets/templates/resizePresets.js)

### `beginCropArea`: number | [0-1] - default: 1 (image size)
The crop area size shown/used automatically on starting crop.
Expand All @@ -441,12 +441,6 @@ The minimum size in pixels for crop area's width custom resizing, the user won't
### `minCropAreaHeight`: number | default: undefined (no minimum)
The minimum size in pixels for crop area's height custom resizing, the user won't be able to resize the crop area height less than that size unless the crop area is resized through some crop preset.

### `showGoBackBtn`: bool

**default**: false

Display back button all the time, duplication of cross button.

### `showInModal`: bool

**default**: true
Expand All @@ -472,42 +466,11 @@ Disabling the auto capitalizing of first letter of strings using (text-transform

Removes the iconed close button on the top right & replaces it with an iconed back button on the top left.

##### `label`: string

**default**: Close

The label of the button to be shown for the user.

##### `noLabel`: boolean
**default**: false

for choosing whether to show or hide the string label of the button.

##### `title`: string

**default**: Close window

The title of the button to be shown for the user when hovering the mouse on the button and leave the mouse hovered a bit.

##### `styles`: object

**default**: null

Styles passed to the main styles of button's styles and it must be in normal CSS format.

##### `beforeStyles`: object

**default**: null

Styles passed to the `:before` pseudo class of button's styles and it must be in normal CSS format.

##### `hoverStyles`: object

**default**: null
### `finishButtonLabel`: string

Styles passed to the `:hover` pseudo class of button's styles and it must be in normal CSS format.
**default**: download for default mode - save for other modes

##### Any other acceptable property/event to HTML span element is accepted (ex., onContextMenu ...etc).
The label shown in the finish button that triggers the completition methods & finish editing.

## <a name="filerobot_integration"></a>Filerobot Integration

Expand Down

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions build/3/filerobot-image-editor.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion examples/js/src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ <h2>Ready to get started?</h2>
Include the following script into your project
</p>
<figure class="highlight">
<pre><code class="javascript">&lt;script src="https://cdn.scaleflex.it/plugins/filerobot-image-editor/3.12.14/filerobot-image-editor.min.js"/&gt;&lt;/script&gt;</code></pre>
<pre><code class="javascript">&lt;script src="https://cdn.scaleflex.it/plugins/filerobot-image-editor/3.12.15/filerobot-image-editor.min.js"/&gt;&lt;/script&gt;</code></pre>
</figure>
</div>

Expand Down
12 changes: 5 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "filerobot-image-editor",
"version": "3.12.14",
"version": "3.12.15",
"main": "dist/index.js",
"description": "Edit, resize, and filter any image!",
"author": "scaleflex",
Expand All @@ -22,7 +22,9 @@
"js-sha1": "^0.6.0",
"styled-components": "5.1.1",
"throttle-debounce": "^2.1.0",
"uuid": "^3.4.0"
"uuid": "^3.4.0",
"react": "^17.0.1",
"react-dom": "^17.0.1"
},
"devDependencies": {
"@babel/cli": "^7.12.17",
Expand Down Expand Up @@ -51,10 +53,6 @@
"webpack-cli": "^3.3.9",
"webpack-dev-server": "^3.8.2"
},
"peerDependencies": {
"react": "^17.0.1",
"react-dom": "^17.0.1"
},
"scripts": {
"start-demo-js": "webpack-dev-server --mode development --config config/webpack.demo-js-config.js",
"start-demo-react": "webpack-dev-server --mode development --config config/webpack.demo-react-config.js",
Expand All @@ -68,7 +66,7 @@
"build": "npm run clean-build && npm run build-new && ./scripts/copy_build.sh",
"build-w": "npm run clean-build && npm run build-new && .\\scripts\\copy_build.sh",
"clean-dist": "rm -rf dist",
"dist": "npm run clean-dist && npx babel projects/react --out-dir dist --copy-files",
"dist": "npm run clean-dist && npx babel src --out-dir dist --copy-files",
"deploy": "gh-pages -d examples/js/dist",
"publish-demo": "npm run build-demo-js && npm run deploy"
}
Expand Down

0 comments on commit 90a4883

Please sign in to comment.