Download the PHP package ermakk/ms-cs-component without Composer
On this page you can find all versions of the php package ermakk/ms-cs-component. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 ms-cs-component
MoonShine content parse to structure menu component
Данный пакет представляет собой компонент для структурирования и обработки контентных блоков. Компонент предназначен для удобного разделения текста на логические блоки и автоматического формирования структуры документа. Использование компонента помогает упростить работу с большими объемами контента и повысить читаемость материала.
Компонент парсит переданное в него содержимое на предмет заголовков разного уровня (h1-h6). Модифицирует контент таким образом, чтобы все заголовки имели идентификатор. Строит из них иерархическую структуру и формирует из этой структуры меню с якорными ссылками на обновленный контент.
Заголовки, которые уже имеют идентификатор, так же попадут в меню, при этом их идентификатор затронут и изменен не будет!
Requirements
- MoonShine v3+
- Laravel v10+
- PHP v8.2+
Install
Добавьте провайдер в ваш config/app.php
Usage
Для вывода оглавления используется компонент Menu.
Для инициализации обязателен один параметр - content
В качестве контента в меню передается класс реализующий интерфейс ContentContract
Задача этого класса - преобразование содержимого из необходимой вам разметки в HTML
для дальнейшего парсинга заголовков.
Вы можете создавать свои классы контента для вашей разметки, либо использовать существующие:
\Ermakk\CSComponent\Converters\MarkdownConverter(Преобразует markdown разметку в html для дальнейшей работы парсера)\Ermakk\CSComponent\Converters\Html(не конвертирует контент, но даже если у вас контент был в html разметке - необходимо передавать его в меню именно через класс)
В качестве второго аргумента можно передать класс парсера, для того чтобы переопределить поведение, разметку, правила генерации идентификаторов и т. п.
По умолчанию используется Ermakk\CSComponent\Parsers\HTMLParser
По умолчанию все якорные ссылки генерируются исходя из текущей, но могут появиться ситуации,
когда будет необходимость вручную задать базу для ссылки. Для этого можно воспользоваться методом
setRoute(?Closure $route) у объекта Menu
Последнее, что осталось сделать для полноценной работы - заменить контент на обновленный, чтобы у всех заголовков появились идентификаторы.
Для этого можно компонент не сразу встраивать в методы формирующие страницу moonshine,
а объявить в классе страницы переменную и в нее при формировании страницы поместить наше меню.
А затем с помощью метода getParser() получить объект парсера и от него уже можно будет вернуть обновленную разметку
В таком случае вы можете повторно использовать компонент Menu без повторного парсинга
Второй метод, для возврата обновленной разметки - это использовать метод getNewHtml() прямо от объекта Menu
в метод getNewHtml необходимо передать переменную, куда будет помещено новое значение
Methods
-
setTitle(string $title)- устанавливает заголовок меню -
setPlaceholder(string $placeholder)- устанавливает сообщение, которое отображается, когда нет содержимого simpleMode(bool $condition)- меняет режим отображенияtrue- простой режим, отображает только набор пунктовfalse- стандартный режим, используемый по умолчанию, отображает заголовок меню и пункты в контейнере .box
getNewHtml()- принимает в качестве параметра переменную, куда по ссылке помещает обновленную разметку- так как
MenuнаследуетMoonShineComponent, то будут доступны любые другие доступные для родительского класса методы
Published
Вы можете стандартными средствами laravel опубликовать ресурсы, для изменения внешнего вида
Advanced
Пакет построен так, чтобы можно было дополнять его своими парсерами или конвертерами. Поэтому вы можете менять логику его работы
