customberg / customberg-php

A Gutenberg custom fields generator with a few predefined field types

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Demo GIF

Instalation

composer require customberg/customberg-php:"*"

Add vendor files to your project (CSS, JS, Config, Views):

php artisan vendor:publish --provider="VanOns\Laraberg\LarabergServiceProvider"
php artisan vendor:publish --provider="Customberg\PHP\CustombergServiceProvider"

Usage

The model that you want to use this block editor should have:

use VanOns\Laraberg\Traits\RendersContent;

class Page extends Model
{
    use RendersContent;
}

In the backpack crud controller you must create the crud field like this:

CRUD::field('content')
    ->label('Page content')
    ->type('customberg')
    ->view_namespace('customberg::');

Update

After an update, get the latest assets using:

php artisan vendor:publish --tag="customberg-assets" --force
php artisan vendor:publish --provider="VanOns\Laraberg\LarabergServiceProvider" --tag="public" --force

Example project

git clone https://github.com/customberg/customberg-php
cd customberg-php/example
docker compose up -d
docker-compose exec php su app -c 'cd example; composer install'
docker-compose exec php su app -c 'cd example; cp .env.example .env; php artisan key:generate'
docker-compose exec nginx su app -c 'cd /app/example/public/; ln -s ../storage/app/public storage'

Navigate to http://localhost:8084 and press login.

Enjoy !

Roadmap:

A checkbox and a switch field
Radio field
Slider field
Google Maps field
Documentation !
Icon picker field

Changelog:

v0.10 - 2023-04-02

  • Added file extension validation to upload_image.
    Use 'allowed_types' => ['png', 'jpg', 'webp', 'svg'],
  • Added upload_file for files without preview.
    Use 'multiple' => true, if you want multiple files in the same field.

v0.9 - 2023-01-01

  • Multilanguage fine tuning, made configurable language list and bugfixing
  • Multilanguage only supports fields text and rich_text, and works inside repeatable field.

v0.8 - 2022-12-31

  • Fine tuning for repeatable field frontend
  • Added buttons to move and duplicate a item inside repeatable
  • Added example block for repeatable

v0.7 - 2022-12-30

  • First version published to packagist.org ! 🎉🥳
  • Only available fields are: text, rich_text, color, upload_image
  • Repeatable is present but untested. Multilanguage present but untested and hardcoded.

About

A Gutenberg custom fields generator with a few predefined field types


Languages

Language:JavaScript 80.3%Language:CSS 15.1%Language:PHP 1.8%Language:SCSS 1.6%Language:HTML 0.9%Language:Blade 0.2%Language:Dockerfile 0.0%Language:Shell 0.0%