https://github.com/flownative/neos-editors

A package with additional editors for the Neos inspector
https://github.com/flownative/neos-editors

Last synced: 2 months ago
JSON representation

A package with additional editors for the Neos inspector

• Host: GitHub
• URL: https://github.com/flownative/neos-editors
• Owner: flownative
• License: gpl-3.0
• Created: 2017-02-10T14:57:32.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-03-04T15:14:46.000Z (over 2 years ago)
• Last Synced: 2024-04-14T20:45:23.177Z (about 1 year ago)
• Language: JavaScript
• Size: 1.52 MB
• Stars: 1
• Watchers: 5
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![GPL-3.0 license](http://img.shields.io/badge/license-GPL3.0-brightgreen.svg)](https://opensource.org/licenses/GPL-3.0)

[![Packagist](https://img.shields.io/packagist/v/flownative/neos-editors.svg)](https://packagist.org/packages/flownative/neos-editors)

[![Maintenance level: Acquaintance](https://img.shields.io/badge/maintenance-%E2%99%A1-ff69b4.svg)](https://www.flownative.com/en/products/open-source.html)

# Flownative Neos Editors

This package is home to additional editors (and validators) for use with

[Neos](https://www.neos.io/).

## Installation

`composer require flownative/neos-editors`

## Usage

To use the included editors, simply configure your property accordingly

in `NodeTypes.yaml`. Here is an example:

    properties:

      'yamlProperty':

        type: 'string'

        ui:

          label: 'YAML property'

          inspector:

            group: 'document'

            editor: 'Flownative.Neos.Editors/Inspector/Editors/Yaml'

        validation:

          'Flownative.Neos.Editors/Inspector/Validators/Yaml': []

## Available Editors

### YAML

Name: `Flownative.Neos.Editors/Inspector/Editors/Yaml`

The YAML editor provides syntax highlighting for YAML and makes sure no

tab characters are used for indentation.

![YAML editor](Documentation/Images/yaml-editor.png)

The editor supports `buttonLabel` as an `editorOption`, like the

`CodeEditor` in Neos.

## Available Validators

### YAML

Name: `Flownative.Neos.Editors/Inspector/Validators/Yaml`

The YAML validator provides validation of YAML. Internally it tries to

parse using [JS-YAML](https://github.com/nodeca/js-yaml) and fails

validation if that throws an exception.

![YAML error message](Documentation/Images/yaml-error.png)

The validator has no options.