Merge pull request #6901 from getkirby/v5/enhancement/view-buttons-query

View buttons: i18n + query support, component name from key

config/areas/languages/views.php

@@ -75,9 +75,8 @@
 				],
 				'props'      => [
 					'buttons' => fn () =>
-						ViewButtons::view('language')
+						ViewButtons::view('language', model: $language)
 							->defaults('preview', 'settings', 'delete')
-							->bind(['language' => $language])
 							->render(),
 					'deletable'    => $language->isDeletable(),
 					'code'         => Escape::html($language->code()),

src/Cms/Language.php

@@ -34,6 +34,11 @@ class Language implements Stringable
 	 */
 	use HasSiblings;
 
+	/**
+	 * Short human-readable version used in template queries
+	 */
+	public const CLASS_ALIAS = 'language';
+
 	/**
 	 * The parent Kirby instance
 	 */

src/Panel/File.php

@@ -76,10 +76,7 @@ public function buttons(): array
 			'preview',
 			'settings',
 			'languages'
-		)->bind([
-			'file'  => $this->model(),
-			'model' => $this->model()
-		])->render();
+		)->render();
 	}
 
 	/**

src/Panel/Page.php

@@ -51,10 +51,7 @@ public function buttons(): array
 			'settings',
 			'languages',
 			'status'
-		)->bind([
-			'page'  => $this->model(),
-			'model' => $this->model()
-		])->render();
+		)->render();
 	}
 
 	/**

src/Panel/Site.php

@@ -33,10 +33,7 @@ public function buttons(): array
 		return ViewButtons::view($this)->defaults(
 			'preview',
 			'languages'
-		)->bind([
-			'model' => $this->model(),
-			'site'  => $this->model()
-		])->render();
+		)->render();
 	}
 
 	/**

src/Panel/Ui/Button.php

@@ -2,6 +2,8 @@
 
 namespace Kirby\Panel\Ui;
 
+use Kirby\Toolkit\I18n;
+
 /**
  * @package   Kirby Panel
  * @author    Bastian Allgeier <[email protected]>
@@ -28,9 +30,9 @@ public function __construct(
 		public string|null $size = null,
 		public string|null $style = null,
 		public string|null $target = null,
-		public string|null $text = null,
+		public string|array|null $text = null,
 		public string|null $theme = null,
-		public string|null $title = null,
+		public string|array|null $title = null,
 		public string $type = 'button',
 		public string|null $variant = null,
 	) {
@@ -51,9 +53,9 @@ public function props(): array
 			'responsive' => $this->responsive,
 			'size'       => $this->size,
 			'target'     => $this->target,
-			'text'       => $this->text,
+			'text'       => I18n::translate($this->text, $this->text),
 			'theme'      => $this->theme,
-			'title'      => $this->title,
+			'title'      => I18n::translate($this->title, $this->title),
 			'type'       => $this->type,
 			'variant'    => $this->variant,
 		];

src/Panel/Ui/Buttons/LanguagesDropdown.php

@@ -25,17 +25,18 @@ class LanguagesDropdown extends ViewButton
 	protected App $kirby;
 
 	public function __construct(
-		protected ModelWithContent $model
+		ModelWithContent $model
 	) {
 		$this->kirby = $model->kirby();
 
 		parent::__construct(
 			component: 'k-languages-dropdown',
+			model: $model,
 			class: 'k-languages-dropdown',
 			icon: 'translate',
 			// Fiber dropdown endpoint to load options
 			// only when dropdown is opened
-			options: $this->model->panel()->url(true) . '/languages',
+			options: $model->panel()->url(true) . '/languages',
 			responsive: 'text',
 			text: Str::upper($this->kirby->language()?->code())
 		);

src/Panel/Ui/Buttons/ViewButton.php

@@ -4,6 +4,8 @@
 
 use Closure;
 use Kirby\Cms\App;
+use Kirby\Cms\Language;
+use Kirby\Cms\ModelWithContent;
 use Kirby\Panel\Panel;
 use Kirby\Panel\Ui\Button;
 use Kirby\Toolkit\Controller;
@@ -24,6 +26,7 @@ class ViewButton extends Button
 {
 	public function __construct(
 		public string $component = 'k-view-button',
+		public readonly ModelWithContent|Language|null $model = null,
 		public array|null $badge = null,
 		public string|null $class = null,
 		public string|bool|null $current = null,
@@ -38,9 +41,9 @@ public function __construct(
 		public string|null $size = 'sm',
 		public string|null $style = null,
 		public string|null $target = null,
-		public string|null $text = null,
+		public string|array|null $text = null,
 		public string|null $theme = null,
-		public string|null $title = null,
+		public string|array|null $title = null,
 		public string $type = 'button',
 		public string|null $variant = 'filled',
 	) {
@@ -53,15 +56,18 @@ public function __construct(
 	 */
 	public static function factory(
 		string|array|Closure $button,
+		string|int|null $name = null,
 		string|null $view = null,
+		ModelWithContent|Language|null $model = null,
 		array $data = []
 	): static|null {
 		// referenced by name
 		if (is_string($button) === true) {
 			$button = static::find($button, $view);
 		}
 
-		$button = static::resolve($button, $data);
+		// turn closure into actual button (object or array)
+		$button = static::resolve($button, $model, $data);
 
 		if (
 			$button === null ||
@@ -70,7 +76,17 @@ public static function factory(
 			return $button;
 		}
 
-		return new static(...static::normalize($button));
+		// flatten definition array into list of arguments for this class
+		$button = static::normalize($button);
+
+		// if button definition has a name, use it for the component name
+		if (is_string($name) === true) {
+			// If this specific component does not exist,
+			// `k-view-buttons` will fall back to `k-view-button` again
+			$button['component'] ??= 'k-' . $name . '-view-button';
+		}
+
+		return new static(...$button, model: $model);
 	}
 
 	/**
@@ -125,8 +141,20 @@ public static function normalize(array $button): array
 
 	public function props(): array
 	{
+		// helper for props that support Kirby queries
+		$resolve = fn ($value) =>
+			$value ?
+			$this->model?->toSafeString($value) ?? $value :
+			null;
+
 		return [
-			...parent::props(),
+			...$props = parent::props(),
+			'dialog'  => $resolve($props['dialog']),
+			'drawer'  => $resolve($props['drawer']),
+			'icon'    => $resolve($props['icon']),
+			'link'    => $resolve($props['link']),
+			'text'    => $resolve($props['text']),
+			'theme'   => $resolve($props['theme']),
 			'options' => $this->options
 		];
 	}
@@ -138,12 +166,25 @@ public function props(): array
 	 */
 	public static function resolve(
 		Closure|array $button,
+		ModelWithContent|Language|null $model = null,
 		array $data = []
 	): static|array|null {
 		if ($button instanceof Closure) {
 			$kirby      = App::instance();
 			$controller = new Controller($button);
-			$button     = $controller->call(data: [
+
+			if (
+				$model instanceof ModelWithContent ||
+				$model instanceof Language
+			) {
+				$data = [
+					'model'             => $model,
+					$model::CLASS_ALIAS => $model,
+					...$data
+				];
+			}
+
+			$button = $controller->call(data: [
 				'kirby' => $kirby,
 				'site'  => $kirby->site(),
 				'user'  => $kirby->user(),

src/Panel/Ui/Buttons/ViewButtons.php

@@ -3,8 +3,9 @@
 namespace Kirby\Panel\Ui\Buttons;
 
 use Kirby\Cms\App;
+use Kirby\Cms\Language;
+use Kirby\Cms\ModelWithContent;
 use Kirby\Panel\Model;
-use Kirby\Toolkit\A;
 
 /**
  * Collects view buttons for a specific view
@@ -21,9 +22,12 @@ class ViewButtons
 {
 	public function __construct(
 		public readonly string $view,
+		public readonly ModelWithContent|Language|null $model = null,
 		public array|false|null $buttons = null,
 		public array $data = []
 	) {
+		// if no specific buttons are passed,
+		// use default buttons for this view from config
 		$this->buttons ??= App::instance()->option(
 			'panel.viewButtons.' . $view
 		);
@@ -62,32 +66,38 @@ public function render(): array
 			return [];
 		}
 
-		$buttons = A::map(
-			$this->buttons ?? [],
-			fn ($button) =>
-				ViewButton::factory(
-					$button,
-					$this->view,
-					$this->data
-				)?->render()
-		);
+		$buttons = [];
+
+		foreach ($this->buttons ?? [] as $name => $button) {
+			$buttons[] = ViewButton::factory(
+				button: $button,
+				name: $name,
+				view: $this->view,
+				model: $this->model,
+				data: $this->data
+			)?->render();
+		}
 
-		return array_values(array_filter($buttons));
+		return array_filter($buttons);
 	}
 
 	/**
 	 * Creates new instance for a view
 	 * with special support for model views
 	 */
-	public static function view(string|Model $view): static
-	{
+	public static function view(
+		string|Model $view,
+		ModelWithContent|Language|null $model = null
+	): static {
 		if ($view instanceof Model) {
-			$blueprint = $view->model()->blueprint()->buttons();
-			$view      = $view->model()::CLASS_ALIAS;
+			$model     = $view->model();
+			$blueprint = $model->blueprint()->buttons();
+			$view      = $model::CLASS_ALIAS;
 		}
 
 		return new static(
 			view: $view,
+			model: $model ?? null,
 			buttons: $blueprint ?? null
 		);
 	}

src/Panel/User.php

@@ -50,10 +50,7 @@ public function buttons(): array
 			'theme',
 			'settings',
 			'languages'
-		)->bind([
-			'model' => $this->model(),
-			'user'  => $this->model()
-		])->render();
+		)->render();
 	}
 
 	/**

tests/Panel/Ui/ButtonTest.php

@@ -44,4 +44,20 @@ public function testProps()
 			'variant'    => 'filled',
 		], $component->props());
 	}
+
+	/**
+	 * @covers ::props
+	 */
+	public function testPropsWithI18n()
+	{
+		$component = new Button(
+			text: [
+				'en' => 'Congrats',
+				'de' => 'Glückwunsch'
+			],
+		);
+
+		$props = $component->props();
+		$this->assertSame('Congrats', $props['text']);
+	}
 }