https://github.com/esign/inline-editing
https://github.com/esign/inline-editing
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/esign/inline-editing
- Owner: esign
- License: mit
- Created: 2022-04-28T12:56:29.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-17T15:15:09.000Z (over 3 years ago)
- Last Synced: 2025-12-14T11:46:32.875Z (6 months ago)
- Language: PHP
- Size: 154 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Edit website text/translations inline
[](https://packagist.org/packages/:vendor/:package_slug)
[](https://packagist.org/packages/:vendor/:package_slug)
This package enables you to edit your websites text and translations inline.
## Installation
You can install the package via composer:
```bash
composer require esign/inline-edit
```
The package will automatically register a service provider.
Next up, you can publish the configuration file:
```bash
php artisan vendor:publish --provider="Esign\InlineEdit\InlineEditServiceProvider" --tag=config --tag=public
```
Publish the InlineEdit file to use it in your frontend.
```bash
php artisan inline-editing:install
```
The file will be copied to ```resources/assets/js/utils/InlineEdit.js```
Add the following to your ``app.js``
```javascript
import InlineEdit from './utils/inlineEdit';
InlineEdit();
```
To use the rich text editor, include de ckeditor cdn before including your ``app.js`` file by adding the following line to your `app.blade.php` file:
```php
```
Make the base url public by adding following line to your ``app.blade.php`` file.
```php
var base_url = '{{ config('app.url') }}';
```
Make sure you have an accessible csrf token by adding
```php
```
Include the inline edit css by adding
```php
```
## Usage
This package assumes you have a translations table in your database with these required columns ``term, type, value``.
The default table is ``dictionary`` but can be changed any other table by changing the specified table in the config file.
You can use the inline editor by calling following function in your blade files
```php
{!! esign_inline('term') !!}
```
Depending on the type of the term the richtext editor will be loaded.
Supported types are `text, richtext`
> **!! IMPORTANT !!**
> It is important to protect the inline edit routes so only admins can use the functionality.
> **This package does not handle authentication**
You can add a middleware to the config file that handles the authentication.
The available options are default limited to `'styles', 'bold', 'italic', 'link', 'blockQuote'` but can be expanded in the `inlineEdit.js` file.
For all available options check: https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editorconfig-EditorConfig.html
### Testing
```bash
composer test
```
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.