gentics-ui-image-editor

Gentics UI Image Editor

An Angular module for cropping, resizing and setting the focal point of images.

Installation

Install from npm:

$ npm install gentics-ui-image-editor --save

and import the GenticsUIImageEditorModule into your Angular app. Note that this module depends on Gentics UI Core v6.1.0 or above.

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { GenticsUICoreModule } from 'gentics-ui-core';
import { GenticsUIImageEditorModule } from 'gentics-ui-image-editor';

import { AppComponent } from './app.component';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    GenticsUICoreModule.forRoot(),
    GenticsUIImageEditorModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Components

gentics-ui-image-editor

<gentics-ui-image-editor [src]="sourceUrl"
                         [(transform)]="transformParams"
                         (editing)="isEditing"
                         [disableAspectRatios]="disableAspectRatios"
                         [customAspectRatios]="customAspectRatios"
                         [canCrop]="canCrop"
                         [canResize]="canResize"
                         [canSetFocalPoint]="canSetFocalPoint"
                         [language]="language"></gentics-ui-image-editor>

Inputs

• src [string] required The url of the image to be edited.
• transform [ImageTransformParams] Sets the image transformation (see below).
• disableAspectRatios [AspectRatio[]] Disable crop aspect ratios. Defaults to [].
• customAspectRatios [AspectRatio[]] Provide custom aspect ratios. Defaults to [].
• canCrop [boolean] Enables the crop functionality. Defaults to true.
• canResize [boolean] Enables the resize functionality. Defaults to true.
• canSetFocalPoint [boolean] Enables the focal point functionality. Defaults to true.
• language ['en' | 'de'] Specifies the language for labels used in the editor. Defaults to 'en'.

Outputs

• transformChange [ImageTransformParams] Emits whenever a transformation is applied to the image. The ImageTransformParams type is given below.
• editing [boolean] Emits true whenever the editor transitions to crop/edit/focal point mode, and false when transitioning to preview mode.

type ImageTransformParams = {
    width: number;
    height: number;
    scaleX: number;
    scaleY: number;
    cropRect: {
        startX: number;
        startY: number;
        width: number;
        height: number;
    };
    focalPointX: number;
    focalPointY: number;
};

This module does not modify the source image in any way. It simply returns the above parameters which can then be used to process the image. This is typically done using an image manipulation API such as that offered by Gentics Mesh.

Disable built-in aspect ratios

You can pass the following 3 built-in aspect ratios to the disableAspectRatios input as an array: AspectRatio.get(AspectRatios.Original), AspectRatio.get(AspectRatios.Square), AspectRatio.get(AspectRatios.Free).

Note: If no built-in nor custom aspect ratios are available, then Free aspect ratio will be enabled.

Provide custom aspect ratios

You can pass custom aspect ratios to the disableAspectRatios input as an array, eg.: { kind: AspectRatios.Dimensions, width: 16, height: 9 }. You can also reuse built-in types as kind: AspectRatios.Original, AspectRatios.Square, AspectRatios.Free. Use the label property to specify the label of aspect ratio, and use display to specify where you want to display the aspect ratio: radio or select.

Full example for custom 16:9 ratio as radio button, with label "Wide": { kind: AspectRatios.Dimensions, width: 16, height: 9, display: 'radio', label: 'Wide' }

gentics-ui-image-preview

<gentics-ui-image-preview [src]="sourceUrl"
                          [transform]="transformParams"
                          [maxHeight]="maxHeight"
                          (imageLoad)="onImageLoad($event)"></gentics-ui-image-preview>

Inputs

• src [string] required The url of the image to be previewed.
• transform [ImageTransformParams] Any transformations applied to the preview image.
• maxHeight [number] The maximum height of the preview image in pixels. The maximum width is defined by that of the containing element.

Outputs

• imageLoad [HTMLImageElement] Emits the image element when it has loaded.

Development

1. Clone this repo
2. $ npm install
3. $ npm run playground
4. Once the initial build has completed, open http://localhost:3000/ in a browser.

The Playground app demonstrates each of the functions of the image editor and is the suggested way to develop new features or bug fixes.

Testing

$ npm run test

Linting

$ npm run lint

Building for Production

To generate all *.js, *.d.ts and *.metadata.json files:

$ npm run build

These will be placed in the /dist directory, which contains all elements required for the npm package.

Publish to npm

1. Make sure the version has been increased per SemVer in the src/package.json file, not the root package.json.
2. Update the changelog with any features or fixes in this release.
3. $ npm run build
4. $ cd dist
5. $ npm publish

Maintaining demo on GitHub pages

The demo is built as a static Angular app into "demo" and maintained on the branch "gh-pages". The easiest way to manage the branch is to check it out in the "demo" subfolder:

# check out repo twice, master in ./ and gh-pages in ./demo
$ git clone -o github -b gh-pages [e-mail]:gentics/gentics-ui-image-editor ./demo

# build the demo
$ npm run demo:build

# commit and push gh-pages
$ cd demo
$ git add .
$ git commit -m "Update demo to vX.Y.Z"
$ git push github