Skip to content

NOW MANAGED ON CODEBERG

Input WYSIWYG: Added dynamic options for entity selector popups

Dan Brown2fbed3919bce
diff --git a/resources/js/components/entity-selector-popup.js b/resources/js/components/entity-selector-popup.js
index 9ff67d53e..6fb461968 100644
--- a/resources/js/components/entity-selector-popup.js
+++ b/resources/js/components/entity-selector-popup.js
@@ -15,8 +15,15 @@ export class EntitySelectorPopup extends Component {
window.$events.listen('entity-select-confirm', this.handleConfirmedSelection.bind(this));
}
- show(callback, searchText = '') {
+ /**
+ * Show the selector popup.
+ * @param {Function} callback
+ * @param {String} searchText
+ * @param {EntitySelectorSearchOptions} searchOptions
+ */
+ show(callback, searchText = '', searchOptions = {}) {
this.callback = callback;
+ this.getSelector().configureSearchOptions(searchOptions);
this.getPopup().show();
if (searchText) {
diff --git a/resources/js/components/entity-selector.js b/resources/js/components/entity-selector.js
index b12eeb402..5ad991437 100644
--- a/resources/js/components/entity-selector.js
+++ b/resources/js/components/entity-selector.js
@@ -1,6 +1,13 @@
import {onChildEvent} from '../services/dom';
import {Component} from './component';
+/**
+ * @typedef EntitySelectorSearchOptions
+ * @property entityTypes string
+ * @property entityPermission string
+ * @property searchEndpoint string
+ */
+
/**
* Entity Selector
*/
@@ -8,21 +15,35 @@ export class EntitySelector extends Component {
setup() {
this.elem = this.$el;
- this.entityTypes = this.$opts.entityTypes || 'page,book,chapter';
- this.entityPermission = this.$opts.entityPermission || 'view';
- this.searchEndpoint = this.$opts.searchEndpoint || '/search/entity-selector';
this.input = this.$refs.input;
this.searchInput = this.$refs.search;
this.loading = this.$refs.loading;
this.resultsContainer = this.$refs.results;
+ this.searchOptions = {
+ entityTypes: this.$opts.entityTypes || 'page,book,chapter',
+ entityPermission: this.$opts.entityPermission || 'view',
+ searchEndpoint: this.$opts.searchEndpoint || '',
+ };
+
this.search = '';
this.lastClick = 0;
this.setupListeners();
this.showLoading();
- this.initialLoad();
+
+ if (this.searchOptions.searchEndpoint) {
+ this.initialLoad();
+ }
+ }
+
+ /**
+ * @param {EntitySelectorSearchOptions} options
+ */
+ configureSearchOptions(options) {
+ Object.assign(this.searchOptions, options);
+ this.reset();
}
setupListeners() {
@@ -103,6 +124,10 @@ export class EntitySelector extends Component {
}
initialLoad() {
+ if (!this.searchOptions.searchEndpoint) {
+ throw new Error('Search endpoint not set for entity-selector load');
+ }
+
window.$http.get(this.searchUrl()).then(resp => {
this.resultsContainer.innerHTML = resp.data;
this.hideLoading();
@@ -110,10 +135,15 @@ export class EntitySelector extends Component {
}
searchUrl() {
- return `${this.searchEndpoint}?types=${encodeURIComponent(this.entityTypes)}&permission=${encodeURIComponent(this.entityPermission)}`;
+ const query = `types=${encodeURIComponent(this.searchOptions.entityTypes)}&permission=${encodeURIComponent(this.searchOptions.entityPermission)}`;
+ return `${this.searchOptions.searchEndpoint}?${query}`;
}
searchEntities(searchTerm) {
+ if (!this.searchOptions.searchEndpoint) {
+ throw new Error('Search endpoint not set for entity-selector load');
+ }
+
this.input.value = '';
const url = `${this.searchUrl()}&term=${encodeURIComponent(searchTerm)}`;
window.$http.get(url).then(resp => {
diff --git a/resources/js/components/page-picker.js b/resources/js/components/page-picker.js
index 9bb0bee04..39af67229 100644
--- a/resources/js/components/page-picker.js
+++ b/resources/js/components/page-picker.js
@@ -14,6 +14,8 @@ export class PagePicker extends Component {
this.defaultDisplay = this.$refs.defaultDisplay;
this.buttonSep = this.$refs.buttonSeperator;
+ this.selectorEndpoint = this.$opts.selectorEndpoint;
+
this.value = this.input.value;
this.setupListeners();
}
@@ -33,6 +35,10 @@ export class PagePicker extends Component {
const selectorPopup = window.$components.first('entity-selector-popup');
selectorPopup.show(entity => {
this.setValue(entity.id, entity.name);
+ }, '', {
+ searchEndpoint: this.selectorEndpoint,
+ entityTypes: 'page',
+ entityPermission: 'view',
});
}
diff --git a/resources/js/markdown/actions.js b/resources/js/markdown/actions.js
index 4909a59d0..511f1ebda 100644
--- a/resources/js/markdown/actions.js
+++ b/resources/js/markdown/actions.js
@@ -73,7 +73,11 @@ export class Actions {
const selectedText = selectionText || entity.name;
const newText = `[${selectedText}](${entity.link})`;
this.#replaceSelection(newText, newText.length, selectionRange);
- }, selectionText);
+ }, selectionText, {
+ searchEndpoint: '/search/entity-selector',
+ entityTypes: 'page,book,chapter,bookshelf',
+ entityPermission: 'view',
+ });
}
// Show draw.io if enabled and handle save.
diff --git a/resources/js/wysiwyg/config.js b/resources/js/wysiwyg/config.js
index f0a2dbe1c..2bd4b630b 100644
--- a/resources/js/wysiwyg/config.js
+++ b/resources/js/wysiwyg/config.js
@@ -85,7 +85,11 @@ function filePickerCallback(callback, value, meta) {
text: entity.name,
title: entity.name,
});
- }, selectionText);
+ }, selectionText, {
+ searchEndpoint: '/search/entity-selector',
+ entityTypes: 'page,book,chapter,bookshelf',
+ entityPermission: 'view',
+ });
}
if (meta.filetype === 'image') {
diff --git a/resources/js/wysiwyg/shortcuts.js b/resources/js/wysiwyg/shortcuts.js
index 147e3c2d5..da9e02270 100644
--- a/resources/js/wysiwyg/shortcuts.js
+++ b/resources/js/wysiwyg/shortcuts.js
@@ -58,6 +58,10 @@ export function register(editor) {
editor.selection.collapse(false);
editor.focus();
- }, selectionText);
+ }, selectionText, {
+ searchEndpoint: '/search/entity-selector',
+ entityTypes: 'page,book,chapter,bookshelf',
+ entityPermission: 'view',
+ });
});
}
diff --git a/resources/views/books/parts/form.blade.php b/resources/views/books/parts/form.blade.php
index d380c5871..a3d4be5e9 100644
--- a/resources/views/books/parts/form.blade.php
+++ b/resources/views/books/parts/form.blade.php
@@ -53,6 +53,7 @@
'name' => 'default_template_id',
'placeholder' => trans('entities.books_default_template_select'),
'value' => $book->default_template_id ?? null,
+ 'selectorEndpoint' => '/search/entity-selector-templates',
])
</div>
</div>
@@ -65,5 +66,5 @@
<button type="submit" class="button">{{ trans('entities.books_save') }}</button>
</div>
-@include('entities.selector-popup', ['entityTypes' => 'page', 'selectorEndpoint' => '/search/entity-selector-templates'])
+@include('entities.selector-popup')
@include('form.editor-translations')
\ No newline at end of file
diff --git a/resources/views/chapters/parts/form.blade.php b/resources/views/chapters/parts/form.blade.php
index 7c565f43c..c6052c93a 100644
--- a/resources/views/chapters/parts/form.blade.php
+++ b/resources/views/chapters/parts/form.blade.php
@@ -27,5 +27,5 @@
<button type="submit" class="button">{{ trans('entities.chapters_save') }}</button>
</div>
-@include('entities.selector-popup', ['entityTypes' => 'page', 'selectorEndpoint' => '/search/entity-selector-templates'])
+@include('entities.selector-popup')
@include('form.editor-translations')
\ No newline at end of file
diff --git a/resources/views/entities/selector-popup.blade.php b/resources/views/entities/selector-popup.blade.php
index d4c941e9a..ac91725d6 100644
--- a/resources/views/entities/selector-popup.blade.php
+++ b/resources/views/entities/selector-popup.blade.php
@@ -5,7 +5,7 @@
<div class="popup-title">{{ trans('entities.entity_select') }}</div>
<button refs="popup@hide" type="button" class="popup-header-close">@icon('close')</button>
</div>
- @include('entities.selector', ['name' => 'entity-selector'])
+ @include('entities.selector', ['name' => 'entity-selector', 'selectorEndpoint' => ''])
<div class="popup-footer">
<button refs="entity-selector-popup@select" type="button" disabled class="button">{{ trans('common.select') }}</button>
</div>
diff --git a/resources/views/form/page-picker.blade.php b/resources/views/form/page-picker.blade.php
index d9810d575..ad0a9d516 100644
--- a/resources/views/form/page-picker.blade.php
+++ b/resources/views/form/page-picker.blade.php
@@ -1,6 +1,7 @@
{{--Depends on entity selector popup--}}
-<div component="page-picker">
+<div component="page-picker"
+ option:page-picker:selector-endpoint="{{ $selectorEndpoint }}">
<div class="input-base overflow-hidden height-auto">
<span @if($value) hidden @endif refs="page-picker@default-display" class="text-muted italic">{{ $placeholder }}</span>
<a @if(!$value) hidden @endif href="{{ url('/link/' . $value) }}" target="_blank" rel="noopener" class="text-page" refs="page-picker@display">#{{$value}}, {{$value ? \BookStack\Entities\Models\Page::query()->visible()->find($value)->name ?? '' : '' }}</a>
diff --git a/resources/views/settings/customization.blade.php b/resources/views/settings/customization.blade.php
index 7112ebcff..4845e2055 100644
--- a/resources/views/settings/customization.blade.php
+++ b/resources/views/settings/customization.blade.php
@@ -3,7 +3,7 @@
@section('card')
<h1 id="customization" class="list-heading">{{ trans('settings.app_customization') }}</h1>
<form action="{{ url("/settings/customization") }}" method="POST" enctype="multipart/form-data">
- {!! csrf_field() !!}
+ {{ csrf_field() }}
<input type="hidden" name="section" value="customization">
<div class="setting-list">
@@ -133,7 +133,12 @@
</select>
<div refs="setting-homepage-control@page-picker-container" style="display: none;" class="mt-m">
- @include('form.page-picker', ['name' => 'setting-app-homepage', 'placeholder' => trans('settings.app_homepage_select'), 'value' => setting('app-homepage')])
+ @include('form.page-picker', [
+ 'name' => 'setting-app-homepage',
+ 'placeholder' => trans('settings.app_homepage_select'),
+ 'value' => setting('app-homepage'),
+ 'selectorEndpoint' => '/search/entity-selector',
+ ])
</div>
</div>
</div>
@@ -168,5 +173,5 @@
@endsection
@section('after-content')
- @include('entities.selector-popup', ['entityTypes' => 'page'])
+ @include('entities.selector-popup')
@endsection
diff --git a/resources/views/shelves/parts/form.blade.php b/resources/views/shelves/parts/form.blade.php
index a724c99ce..a75dd6ac1 100644
--- a/resources/views/shelves/parts/form.blade.php
+++ b/resources/views/shelves/parts/form.blade.php
@@ -89,5 +89,5 @@
<button type="submit" class="button">{{ trans('entities.shelves_save') }}</button>
</div>
-@include('entities.selector-popup', ['entityTypes' => 'page', 'selectorEndpoint' => '/search/entity-selector-templates'])
+@include('entities.selector-popup')
@include('form.editor-translations')
\ No newline at end of file