Download the PHP package nnagornyy/gtd.vueeditor without Composer
On this page you can find all versions of the php package nnagornyy/gtd.vueeditor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nnagornyy/gtd.vueeditor
More information about nnagornyy/gtd.vueeditor
Files in nnagornyy/gtd.vueeditor
Package gtd.vueeditor
Short Description Блочный редактор контента для 1с-bitrix
License MIT
Homepage https://github.com/nnagornyy/gtd.vueeditor
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package gtd.vueeditor
TO DO
Цели [модуль]
- [ ] Проверка установленной ноды и ее версии из админки
- [ ] Запуск билда из админки и парсинг данных (все ли блоки найдены)
- [x] Брать блоки из других мест, например из /local/vueeditor/ для отделения модуля и блоков чисто для проекта
- [x] Свойство для инфоблоков
- [ ] Свойство для пользовательских полей
- [ ] Блок текста с редактором - выбрать редактор
Блоки
на 22.12.2021
- vtext - Блок текста с виз.редактором quilljs
- vheader - Заголовок с выбором размера
- vquote - Текстовое поле для цитаты
- documents - Загрузка документов с названием и описанием
- gallery - Галерея изображений с названиями и описаниями
- youtubeVideo - Видео с youtube (по ссылке)
- vtable - Таблица
- vimage - Загрузка изображения
Регистрация своих блоков
каждый блок должен иметь файл конфигурации, наименование по принципу
blockName.config.json
пример конфига
name - используется для текстового представления названия блока
handler - класс для обработки данных перед выводом в публичную часть
conf - пробрасывается в ваш блок
Ссылки
https://github.com/webpack/webpack/issues/6680
Применение
Это модуль для 1С-Битрикс. В нём содержится
- vue-компонент редактора на typescript со сборкой через webpack (папка app)
- код для подключения компонента как типа свойств инфоблока и uf-поля
- бэк для некоторых блоков, например сохранение файлов (папка service)
Установка
После этого установить модуль в админке битрикса через Установленные решения.
После установки должна появиться папка /local/vueeditor
Подключите модуль в init.php \Bitrix\Main\Loader::includeModule('gtd.vueeditor'); (он подключит js и стили редактора).
Добавление блока
При сборке блоки из /local/vueeditor копируются в модуль/app/src/ext_block
При разработке блоков можно делать правки в самом ext_block, но потом обязательно скопировать в /local/vueeditor и закоммитить.
Структура блока:
папка = код названия блока,
конфиг = код.config.json,
компонент = код.vue
В компоненте в data обязательно должно быть поле editorData, информация из него будет сохраняться как значение блока.
В качестве примера можно скопировать vheader со своим названием и делать на основе него.
Префикс v в некоторых готовых блоках нужен только для того, чтобы они не пересекались с существующими тегами.
Пример компонента:
Если инициируем редактор вручную (например при использовании как вью-компонент), добавляем название нового блока в параметр allowBlock конструктора.
Сборка
Изнутри модуля
Или можно добавить команду сборки снаружи (пример для /local/package.json)
Артефакты сборки сохраняются в /local/vueeditor_assets/
Если вы коммитите артефакты - нужно руками добавлять папку в гит после пересборки с новыми блоками.
Если вы собираете налету - добавьте папку в гитигнор.
Использование как vue-компонента
Конструктор блочного редактора существует как глобальная переменная document.vueeditor(value, inputName, allowBlock, appId).
Можно добавить компонент-обертку в свой проект, которая будет инициировать объект редактора.
Пример:
А в компоненте, где используется блочный редактор, добавляем
Использование как свойства ИБ
// todo
Использование как UF-поля
// todo
Добавление обработчика на получение данных
При получении данных из БД можно воспользоваться хендлерами блоков и обработать данные прежде, чем вывести их.
Важно! В сам блочный редактор должны идти необработанными данные, обработка нужна для вывода в публичке.
- Используем парсер, чтобы получить обработанные данные блока
Первый параметр - десериализованный массив из БД как он пришёл из блочного редактора.
Второй параметр (необязательный) - где искать конфиги для кастомных блоков (по умолчанию ищет в модуль/app/src/ext_block).
Путь к конфигам нужен, если вы коммитите артефакты и не запускаете сборку на бою. Тогда компоненты из /local/vueeditor не попадут в модуль/app/src/ext_block на бою, и скрипт не найдет конфиги в папке по умолчанию.
-
Добавляем класс, имплементирующий интерфейс
\Gtd\VueEditor\Block\Handler -
Добавляем путь к классу в конфиг блока.
например, в myblock.conj.json:"handler": "\\My\\Module\\Blocks\\MyBlock" - Реализуем методы setBlock(\Gtd\VueEditor\Block\Block $block) и getData()
Можно скопировать их из дефолтного хендлера
\Gtd\VueEditor\Block\DefaultHandlerвgtd.vueeditor/lib/block/defaulthandler.php
Метод setBlock получает блок как есть, здесь можно обработать данные или просто записать их в переменную класса, чтобы потом использовать в getData.
Метод getData должен вернуть данные, которые попадут в поле content блока и будет потом использовать при выводе.
Пресеты
// todo
