Skip to content

Commit 515cf94

Browse files
tabacitutabacitu
committed
polish v7 wysiwygs docs
1 parent 6741015 commit 515cf94

File tree

2 files changed

+49
-83
lines changed

2 files changed

+49
-83
lines changed

‎7.x-dev/crud-columns.md

Lines changed: 34 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,23 @@ Show connected items selected via checklist_dependency field. It's definition is
208208

209209
<hr>
210210

211+
<a name="ckeditor"></a>
212+
### ckeditor <span class="badge badge-pill badge-info">PRO</span>
213+
214+
The perfect match for the [CKEditor field](https://github.com/Laravel-Backpack/ckeditor-field). The CKEditor column will just output the non-escaped text value of a db column (or model attribute). Its definition is simple:
215+
216+
```php
217+
[
218+
'name' => 'info', // The db column name
219+
'label' => 'Info', // Table column heading
220+
'type' => 'ckeditor',
221+
],
222+
```
223+
224+
For more information, please see [backpack/ckeditor-field](https://github.com/Laravel-Backpack/ckeditor-field) on Github - that is the add-on that provides this functionality.
225+
226+
<hr>
227+
211228
<a name="closure"></a>
212229
### closure
213230

@@ -818,6 +835,23 @@ The text column will just output the text value of a db column (or model attribu
818835

819836
<hr>
820837

838+
<a name="tinymce"></a>
839+
### tinymce <span class="badge badge-pill badge-info">PRO</span>
840+
841+
The perfect match for the [`tinymce` field](https://github.com/Laravel-Backpack/tinymce-field). The tinymce column will just output the non-escaped text value of a db column (or model attribute). Its definition is simple:
842+
```php
843+
[
844+
'name' => 'info', // The db column name
845+
'label' => 'Info', // Table column heading
846+
'type' => 'tinymce',
847+
],
848+
```
849+
850+
For more information on the TinyMCE field and column, see [backpack/tinymce-field](
851+
The perfect match for the [`tinymce` field](https://github.com/Laravel-Backpack/tinymce-field)) on Github - that's the addon that provides this functionality.
852+
853+
<hr>
854+
821855
<a name="time"></a>
822856
### time
823857

@@ -983,21 +1017,6 @@ Show a thumbnail image stored in the db column as `base64` image string.
9831017

9841018
<hr>
9851019

986-
<a name="ckeditor"></a>
987-
### ckeditor <span class="badge badge-pill badge-info">PRO</span>
988-
989-
The ckeditor column will just output the non-escaped text value of a db column (or model attribute). Its definition is:
990-
991-
```php
992-
[
993-
'name' => 'info', // The db column name
994-
'label' => 'Info', // Table column heading
995-
'type' => 'ckeditor',
996-
],
997-
```
998-
999-
<hr>
1000-
10011020
<a name="date_picker"></a>
10021021
### date_picker <span class="badge badge-pill badge-info">PRO</span>
10031022

@@ -1363,21 +1382,6 @@ Its definition is very similar to the [table *field type*](/docs/{{version}}/cru
13631382

13641383
<hr>
13651384

1366-
<a name="tinymce"></a>
1367-
### tinymce <span class="badge badge-pill badge-info">PRO</span>
1368-
1369-
The tinymce column will just output the non-escaped text value of a db column (or model attribute). Its definition is:
1370-
1371-
```php
1372-
[
1373-
'name' => 'info', // The db column name
1374-
'label' => 'Info', // Table column heading
1375-
'type' => 'tinymce',
1376-
],
1377-
```
1378-
1379-
<hr>
1380-
13811385
<a name="video"></a>
13821386
### video <span class="badge badge-pill badge-info">PRO</span>
13831387

@@ -1394,21 +1398,6 @@ Display a small screenshot for a YouTube or Vimeo video, stored in the database
13941398

13951399
<hr>
13961400

1397-
<a name="wysiwyg"></a>
1398-
### wysiwyg <span class="badge badge-pill badge-info">PRO</span>
1399-
1400-
The wysiwyg column will just output the non-escaped text value of a db column (or model attribute). Its definition is:
1401-
1402-
```php
1403-
[
1404-
'name' => 'info', // The db column name
1405-
'label' => 'Info', // Table column heading
1406-
'type' => 'wysiwyg',
1407-
],
1408-
```
1409-
1410-
<hr>
1411-
14121401
<a name="overwriting-default-column-types"></a>
14131402
## Overwriting Default Column Types
14141403

‎7.x-dev/crud-fields.md

Lines changed: 15 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,13 @@ Input preview:
383383

384384
<hr>
385385

386+
<a name="ckeditor"></a>
387+
### ckeditor
388+
389+
Show a WYSIWIG field to the user, powered by CKEditor. This field is provided as a first-party add-on - see instructions [here](https://github.com/Laravel-Backpack/ckeditor-field).
390+
391+
<hr>
392+
386393
<a name="color"></a>
387394
### color
388395

@@ -839,7 +846,7 @@ Input preview:
839846
<a name="summernote"></a>
840847
### summernote
841848

842-
Show a [Summernote wysiwyg editor](http://summernote.org/) to the user.
849+
Show a [Summernote WYSIWYG editor](http://summernote.org/) to the user.
843850

844851
```php
845852
CRUD::field([ // Summernote
@@ -963,6 +970,13 @@ CRUD::field([ // Time
963970

964971
<hr>
965972

973+
<a name="tinymce"></a>
974+
### tinymce
975+
976+
Show a WYSIWYG editor powered by TinyMCE to the admin. This is provided using a first-party add-on - see instructions [here](https://github.com/Laravel-Backpack/tinymce-field).
977+
978+
<hr>
979+
966980
<a name="upload"></a>
967981
### upload
968982

@@ -1193,13 +1207,6 @@ Input preview:
11931207

11941208
<hr>
11951209

1196-
<a name="ckeditor"></a>
1197-
### ckeditor
1198-
1199-
This field is providedy by a third-party integration, you can find instructions on how to install and use it [here](https://github.com/Laravel-Backpack/ckeditor-field).
1200-
1201-
<hr>
1202-
12031210
<a name="date-range"></a>
12041211
### date_range <span class="badge badge-pill badge-info">PRO</span>
12051212

@@ -2541,13 +2548,6 @@ Input preview:
25412548
![CRUD Field - table](https://backpackforlaravel.com/uploads/docs-4-2/fields/table.png)
25422549

25432550

2544-
<hr>
2545-
2546-
<a name="tinymce"></a>
2547-
### tinymce
2548-
2549-
TinyMCE is now provided by a third-party package, you can find instructions on how to use and configure it [here](https://github.com/Laravel-Backpack/tinymce-field).
2550-
25512551
<hr>
25522552

25532553
<a name="video"></a>
@@ -2581,29 +2581,6 @@ So you should use [attribute casting](https://mattstauffer.com/blog/laravel-5.0-
25812581
Vimeo does not require an API key in order to query their DB, but YouTube does, even though their free quota is generous. You can get a free YouTube API Key inside [Google Developers Console](https://console.developers.google.com/) ([video tutorial here](https://www.youtube.com/watch?v=pP4zvduVAqo)). Please DO NOT use our API Key - create your own. The key above is there just for your convenience, to easily try out the field. As soon as you decide to use this field type, create an API Key and use _your_ API Key. Our key hits its ceiling every month, so if you use our key most of the time it won't work.
25822582

25832583

2584-
<hr>
2585-
2586-
<a name="wysiwyg"></a>
2587-
### wysiwyg <span class="badge badge-pill badge-info">PRO</span>
2588-
2589-
Show a wysiwyg (CKEditor) to the user.
2590-
2591-
```php
2592-
CRUD::field([ // WYSIWYG Editor
2593-
'name' => 'description',
2594-
'label' => 'Description',
2595-
'type' => 'wysiwyg',
2596-
2597-
// optional configuration
2598-
'options' => [], // ckeditor configuration options
2599-
2600-
// elfinder configuration options when using [the file manager package](https://github.com/Laravel-Backpack/FileManager)
2601-
// to use this feature you need to be running backpack/pro:2.2.1 or higher and backpack/filemanager:3.0.8 or higher
2602-
// for `elfinderOptions` passing an empty array or `true` will enable the file manager with default options
2603-
'elfinderOptions' => [],
2604-
]);
2605-
```
2606-
26072584
<a name="overwriting-default-field-types"></a>
26082585
## Overwriting Default Field Types
26092586

0 commit comments

Comments
 (0)