Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

GITBOOK-20: doc: file picker #125

Merged
merged 1 commit into from
Apr 5, 2024
Merged

GITBOOK-20: doc: file picker #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
* [Customize ImageStorage](advanced-usage/customize-imagestorage.md)
* [Integrating NovaFileArtisan (Larupload) with Image Resource](advanced-usage/integrating-novafileartisan-larupload-with-image-resource.md)
* [Customize AudioStorage](advanced-usage/customize-audiostorage.md)
* [Customize FileStorage](advanced-usage/customize-audiostorage-1.md)
* [Multiple Toolbars](advanced-usage/multiple-toolbars.md)
* [Customize Toolbar Items](advanced-usage/customize-toolbar-items.md)
* [Media Embed](advanced-usage/media-embed.md)
Expand All @@ -32,6 +33,7 @@
* [Image Browser](advanced-usage/ckeditor-field-options/image-browser.md)
* [Audio Browser](advanced-usage/ckeditor-field-options/audio-browser.md)
* [Video Browser](advanced-usage/ckeditor-field-options/video-browser.md)
* [File Browser](advanced-usage/ckeditor-field-options/audio-browser-1.md)
* [Snippets](advanced-usage/ckeditor-field-options/snippets.md)
* [Configuration](advanced-usage/configuration/README.md)
* [Video Model](advanced-usage/configuration/video-model.md)
Expand All @@ -42,6 +44,7 @@
* [Image Max Height](advanced-usage/configuration/image-max-height.md)
* [Image Naming Method](advanced-usage/configuration/image-naming-method.md)
* [Audio Naming Method](advanced-usage/configuration/audio-naming-method.md)
* [File Naming Method](advanced-usage/configuration/audio-naming-method-1.md)
* [Toolbars](advanced-usage/configuration/toolbars/README.md)
* [Defualt Toolbar](advanced-usage/configuration/toolbars/defualt-toolbar.md)
* [Toolbar 1](advanced-usage/configuration/toolbars/toolbar-1/README.md)
Expand All @@ -58,6 +61,7 @@
* [Image Browser](advanced-usage/configuration/toolbars/toolbar-1/image-browser.md)
* [Audio Browser](advanced-usage/configuration/toolbars/toolbar-1/audio-browser.md)
* [Video Browser](advanced-usage/configuration/toolbars/toolbar-1/video-browser.md)
* [File Browser](advanced-usage/configuration/toolbars/toolbar-1/audio-browser-1.md)
* [Insert Image Types](advanced-usage/configuration/toolbars/toolbar-1/insert-image-types.md)
* [Insert Image Size](advanced-usage/configuration/toolbars/toolbar-1/insert-image-size.md)
* [Snippets](advanced-usage/configuration/toolbars/toolbar-1/snippets.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-usage/ckeditor-field-options/audio-browser-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This method allows you to enable or disable the file picker functionality within

By utilizing the `fileBrowser` method, you have control over whether the file picker is enabled or disabled for the CKEditor field. The method accepts a boolean value as the `enabled` argument, where `true` enables the file picker, and `false` disables it.

Enabling the file picker provides a convenient way for users to select and insert file files directly into the CKEditor field. This feature streamlines the file insertion process, enhancing the content creation experience. On the other hand, disabling the file picker removes the option for users to select file files through the CKEditor field, limiting the content to text-only input.
Enabling the file picker provides a convenient way for users to select and insert files directly into the CKEditor field. This feature streamlines the file insertion process, enhancing the content creation experience. On the other hand, disabling the file picker removes the option for users to select files through the CKEditor field, limiting the content to text-only input.

To utilize the `fileBrowser` method, simply pass `true` or `false` as the `status` argument based on whether you want to enable or disable the file picker, respectively.

Expand Down
6 changes: 5 additions & 1 deletion docs/advanced-usage/configuration/audio-naming-method-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: file-naming-method
| ------------------ | ------ | ------------------------------------------- |
| file-naming-method | string | <mark style="color:red;">`hash-file`</mark> |

The `file-naming-method` configuration option allows you to specify the naming method for uploaded files within the CKEditor field. This setting determines how the files will be named when they are saved to the storage.
The `file-naming-method` configuration option allows you to specify the naming method for uploaded files within the CKEditor field. This setting determines how files will be named when they are saved to the storage.

By default, the `file-naming-method` configuration option is set to `hash-file`, which generates a unique hash-based name for each uploaded file. This helps avoid naming conflicts and ensures uniqueness of the file names.

Expand All @@ -24,5 +24,9 @@ To configure the `file-naming-method` option, update the value in the configurat



{% hint style="info" %}
This feature was introduced in version <mark style="color:red;">7.3.0</mark> of the NovaCKEditor
{% endhint %}



14 changes: 4 additions & 10 deletions docs/advanced-usage/configuration/toolbars/toolbar-1/audio-browser-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,13 @@ description: toolbars.toolbar-1.browser.file

# File Browser

<table><thead><tr><th width="340">Property Name</th><th width="158.33333333333331">Type</th><th>Default</th></tr></thead><tbody><tr><td>toolbars.toolbar-1.browser.file</td><td>bool</td><td>false</td></tr></tbody></table>
<table><thead><tr><th width="340">Property Name</th><th width="158.33333333333331">Type</th><th>Default</th></tr></thead><tbody><tr><td>toolbars.toolbar-1.browser.file</td><td>bool</td><td>true</td></tr></tbody></table>

This option allows you to enable or disable the file picker within the toolbar. By default, this option is set to <mark style="color:red;">`false`</mark>, indicating that the file picker is disabled.
This option allows you to enable or disable the file picker within the toolbar. By default, this option is set to `true`, indicating that the file picker is enabled.

The file picker provides a convenient way to select and insert files into the CKEditor field. However, in some cases, you may want to enable/disable the file picker functionality.
The file picker provides a convenient way to select and insert files into the CKEditor field. However, in some cases, you may want to disable the file picker functionality.

To enable the file picker within Toolbar 1, update the value of `toolbars.toolbar-1.browser.file` in the `config/nova-ckeditor.php` file to `true`.



{% hint style="info" %}
This feature was introduced in version <mark style="color:red;">7.3.0</mark> of the NovaCKEditor
{% endhint %}
To disable the file picker within Toolbar 1, update the value of `toolbars.toolbar-1.browser.file` in the `config/nova-ckeditor.php` file to `false`.



1 change: 0 additions & 1 deletion docs/advanced-usage/customize-audiostorage-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ You have the option to override the `FileStorage` service by binding your own ex
use Illuminate\Http\Request;
use Mostafaznv\NovaCkEditor\FileStorage;


class MyFileStorage extends FileStorage
{
public function __invoke(Request $request)
Expand Down
Loading