scrivito-clippath-image

Scrivito Clippath Image

A nimage with clippath mask as a React component/ Scrivito widget for the Scrivito CMS.

Installation

Open your terminal.

$ cd to your Scrivito project

$ npm install scrivito-clippath-image

Import the widget in your javascript src/Widgets/index.js.

Add this line to your index.js:

import "scrivito-clippath-image";

Also add the styling of the widget to your app. This can be done by either loading it via css-loader (e.g. in index.js or Widgets/index.js):

import "scrivito-clippath-image/index.css";

Or by including the styling to your style sheets (e.g. in index.scss):

import "~scrivito-clippath-image/index.css";

Features

The Clippath Image Widget renders an image, with a mask defined by CSS clippath. 23 clippath masks are configurable via the Widget form.

Development

With npm run build you can build the package into build/.

With npm start you'll start a continues process, that rebuilds build/ automatically once the source code is changed.

To add this library locally do the following in your scrivito app:

npm install file:<path to build folder>

e.g.

npm install file:../scrivito-clippath-image/build/

To publish the package:

npm i && npm run build && cd build/ && npm publish

Check code quality

With npm run eslint and npm run es-check you can check your coding quality.