https://github.com/AlexSabur/orchid-editorjs-field

https://github.com/AlexSabur/orchid-editorjs-field

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/AlexSabur/orchid-editorjs-field
• Owner: AlexSabur
• License: mit
• Created: 2020-05-28T08:30:41.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-27T13:38:40.000Z (about 1 year ago)
• Last Synced: 2024-11-10T13:37:25.105Z (2 months ago)
• Language: PHP
• Size: 938 KB
• Stars: 13
• Watchers: 1
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-editorjs - orchid-editorjs-field

README

        
# Orchid Editorjs Field

[![GitHub Workflow Status](https://github.com/AlexSabur/orchid-editorjs-field/workflows/Run%20tests/badge.svg)](https://github.com/AlexSabur/orchid-editorjs-field/actions)

[![styleci](https://styleci.io/repos/188413486/shield)](https://styleci.io/repos/188413486)

[![Packagist](https://img.shields.io/packagist/v/AlexSabur/orchid-editorjs-field.svg)](https://packagist.org/packages/AlexSabur/orchid-editorjs-field)

[![Packagist](https://poser.pugx.org/AlexSabur/orchid-editorjs-field/d/total.svg)](https://packagist.org/packages/AlexSabur/orchid-editorjs-field)

[![Packagist](https://img.shields.io/packagist/l/AlexSabur/orchid-editorjs-field.svg)](https://packagist.org/packages/AlexSabur/orchid-editorjs-field)

Package description: Work in process

## Installation

Install via composer

```bash

composer require alexsabur/orchid-editorjs-field

```

## Usage

```php

    /**

     * Views.

     *

     * @return Layout[]

     */

    public function layout(): array

    {

        return [

            Layout::rows([

                EditorJS::make('mydata')->tools([

                    MarkerTool::make('marker'),

                    ImageTool::make('picture')

                    HeaderTool::make('header')

                ])

            ]),

        ];

    }

```

### Register new tool

```bash

php artisan orchid:editorjs:tool MySuperTool

```

And in js

```js

class MySuperTool {

    //code

}

window.editorJSTools = window.editorJSTools || [];

window.editorJSTools['MySuperTool'] = MySuperTool;

```

## Security

If you discover any security related issues, please email [email protected]

instead of using the issue tracker.

## Credits

- [Alex](https://github.com/AlexSabur/orchid-editorjs-field)

- [All contributors](https://github.com/AlexSabur/orchid-editorjs-field/graphs/contributors)

This package is bootstrapped with the help of

[melihovv/laravel-package-generator](https://github.com/melihovv/laravel-package-generator).