https://github.com/sebobo/shel.neos.imagechecker

Checks certain characteristics when choosing image in Neos CMS
https://github.com/sebobo/shel.neos.imagechecker

hacktoberfest neoscms

Last synced: 8 months ago
JSON representation

Checks certain characteristics when choosing image in Neos CMS

• Host: GitHub
• URL: https://github.com/sebobo/shel.neos.imagechecker
• Owner: Sebobo
• License: mit
• Created: 2022-05-27T09:13:22.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-04-03T13:57:45.000Z (about 1 year ago)
• Last Synced: 2025-10-07T12:56:15.056Z (8 months ago)
• Topics: hacktoberfest, neoscms
• Language: TypeScript
• Homepage:
• Size: 54.6 MB
• Stars: 10
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Image editor plugin with additional checks for Neos CMS

[![Tests](https://github.com/Sebobo/Shel.Neos.ColorPicker/actions/workflows/tests.yml/badge.svg)](https://github.com/Sebobo/Shel.Neos.ColorPicker/actions/workflows/tests.yml)

This package provides a Neos CMS plugin which extends the default Neos image editor with additional checks for the 

selected image. It supports global and individual configurations for each image type.

## Installation

Add the plugin as dependency to your Neos CMS project:

    composer require shel/neos-image-checker

## Examples

### Example with all checks passing

[![Example with passed checks](Documentation/imagechecker-valid.png)](Documentation/imagechecker-valid.png)

Note: the details are not shown by default and can be toggled by clicking on the "i" button.

### Example with some checks failing

[![Example with failed checks](Documentation/imagechecker-invalid.png)](Documentation/imagechecker-invalid.png)

Note: the details are shown in this case by default and can be toggled by clicking on the "alert" button.

## Configuration

After installation the default image editor in your Neos installation is replaced by the one from this package.

The additional functionality only wraps the provided Neos image editor, so it doesn't contain the editors code

and in most cases supports updating the Neos UI without needing updates for this plugin.

### Global settings

Global defaults for each image editor

```yaml

Neos:

  Neos:

    Ui:

     frontendConfiguration:

      'Shel.Neos.ImageChecker:ImageChecker':

        enabled: true # allows disabling the checks for all image properties

        defaults:

          fileSize:

            default: 2048

            svg: null

            png: null

            jpg: null

          fileDimensions:

            maxWidth: null

            maxHeight: null

            minWidth: null

            minHeight: null

          fileName:

            allowedPattern: '^[0-9a-zA-Z_\-.]+$'

```

### Individual settigns

For each image property of a nodetype you can override single or all of the following settings:

```yaml

My.Vendor:My.NodeType:

  properties:

    image:

      type: 'Neos\Media\Domain\Model\ImageInterface'

      ui:

        label: 'Some image'

        reloadIfChanged: true

        inspector:

          group: image

          editorOptions:

            features:

              imageCheck: # optional overrides

                fileSize: # in kb

                  default: 2048 # optional

                  svg: 100 # optional

                  jpg: 2048 # optional

                  png: 2048 # optional

                fileDimensions: # in px, only affects jpg and pngs

                  maxWidth: 500

                  maxHeight: 300

                fileName: # matches the filename without extension

                  allowedPattern: '^[a-z]+$'

```

## License

See [License](LICENSE.txt)