Download the PHP package awcodes/richer-editor without Composer

On this page you can find all versions of the php package awcodes/richer-editor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of awcodes/richer-editor

Informations about the package richer-editor

richer editor opengraph image

Richer Editor

A collection of extensions and tools to enhance the Filament Rich Editor field.

Latest Version Total Downloads GitHub Repo stars

Compatibility

Package Version Filament Version
1.x 4.x
2.x 5.x

Installation

You can install the package via composer:

[!IMPORTANT] If you have not set up a custom theme and are using Filament Panels, follow the instructions in the Filament Docs first.

After setting up a custom theme, add the plugin's CSS and views to your theme.css file or your app.css file if using the standalone packages.

Editor Usage

[!WARNING] The following plugins are experimental and should not be used at the moment. See their docblocks for more information.

  • FigurePlugin
  • VideoPlugin

Plugins

Max Height

Nested Tool Groups (Dropdowns)

Prebuilt Tools

The following tools are depreciated and will be removed in a future release. Please use the heading tools provided by Filament instead.

Prebuilt Blocks

Highlighted Code Block (Phiki)

Code Block Syntax Highlighting (Shiki)

The CodeBlockShikiPlugin highlights code blocks in the editor using Shiki. You can set the theme used to render code blocks, and optionally supply separate light/dark themes.

Themes accept either a Phiki Theme enum case or any bundled Shiki theme name as a string. See Shiki's themes for the full list.

When you supply themes(), the light theme is rendered inline and the dark theme is exposed via CSS variables. The dark variant is applied automatically under Filament's dark mode by the styles in this package's resources/css/index.css — make sure it is imported into your theme (see Installation). Without themes(), only defaultTheme is used and code blocks stay a single theme.

Each code block shows a language dropdown so authors can switch the highlighting language. By default it lists every language Shiki bundles; pass languages() to curate the list:

Rendering outside the editor

Shiki runs in the browser, so it cannot highlight code blocks when stored content is rendered server-side. The plugin ships a PHP Tiptap extension that highlights codeBlock nodes with Phiki using the same themes. Register the plugin on the renderer with the same theme configuration to keep rendered output in sync with the editor:

The rendered output uses the .phiki styles in resources/css/index.css for dark-mode switching, so no extra setup is required beyond importing that file.

Rendering Usage

Rendering Headings as links

Rendering as Markdown

This feature uses HTML To Markdown for PHP by thephpleague. Please see their documentation for available options.

Rendering native code blocks with Phiki syntax highlighting.

[!CAUTION] This should NOT be used globally as it will not work with Filament's rich content attributes when storing/reading content in the database when in a form context.

Rendering Table of Contents

Utilities

Rich Content Faker

Testing

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

All versions of richer-editor with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
ext-dom Version *
filament/forms Version ^5.0
league/html-to-markdown Version *
phiki/phiki Version ^2.0
spatie/laravel-package-tools Version ^1.15.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package awcodes/richer-editor contains the following files

Loading the files please wait ...