copyable fields

Author: iamgergo

resources/views/components/copyable.blade.php

@@ -0,0 +1,17 @@
+{{ $text }}
+<button
+    type="button"
+    class="btn btn--light btn--sm btn--icon"
+    aria-label="{{ __('Copy') }}"
+    x-cloak
+    x-bind:disabled="copied"
+    x-data="{ copied: false }"
+    x-on:click="(event) => {
+        navigator.clipboard.writeText('{{ $value }}');
+        copied = true;
+        setTimeout(() => copied = false, 2500);
+    }"
+>
+    <x-root::icon x-show="! copied" name="clipboard" class="btn__icon" />
+    <x-root::icon x-show="copied" name="check" class="btn__icon" />
+</button>

resources/views/icons/clipboard.blade.php

@@ -0,0 +1,17 @@
+<svg
+    aria-hidden="true"
+    fill="none"
+    focusable="false"
+    height="24"
+    stroke-linecap="round"
+    stroke-linejoin="round"
+    stroke-width="2.5"
+    stroke="currentColor"
+    viewBox="0 0 24 24"
+    width="24"
+    xmlns="http://www.w3.org/2000/svg"
+    {{ $attributes }}
+>
+    <path d="M16 4h2a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6a2 2 0 0 1 2-2h2"></path>
+    <rect x="8" y="2" width="8" height="4" rx="1" ry="1"></rect>
+</svg>

src/Fields/Field.php

@@ -7,6 +7,7 @@
 use Closure;
 use Cone\Root\Filters\Filter;
 use Cone\Root\Filters\RenderableFilter;
+use Cone\Root\Support\Copyable;
 use Cone\Root\Traits\Authorizable;
 use Cone\Root\Traits\HasAttributes;
 use Cone\Root\Traits\Makeable;
@@ -144,6 +145,11 @@ abstract class Field implements Arrayable, JsonSerializable
      */
     protected bool|Closure $translatable = false;
 
+    /**
+     * Indicates whether the field is copyable.
+     */
+    protected bool|Closure $copyable = false;
+
     /**
      * Create a new field instance.
      */
@@ -360,6 +366,24 @@ public function resolveSearchQuery(Request $request, Builder $query, mixed $valu
             : $query;
     }
 
+    /**
+     * Set the copyable attribute.
+     */
+    public function copyable(bool|Closure $value = true): static
+    {
+        $this->copyable = $value;
+
+        return $this;
+    }
+
+    /**
+     * Determine whether the field value is copyable.
+     */
+    public function isCopyable(): bool
+    {
+        return $this->copyable instanceof Closure ? call_user_func($this->copyable) : $this->copyable;
+    }
+
     /**
      * Set the translatable attribute.
      */
@@ -520,15 +544,22 @@ public function resolveFormat(Request $request, Model $model): ?string
     {
         $value = $this->resolveValue($request, $model);
 
-        if (is_null($this->formatResolver)) {
-            return match (true) {
-                is_array($value) => json_encode($value),
-                is_null($value) => $value,
-                default => (string) $value,
-            };
+        $formattedValue = match (true) {
+            ! is_null($this->formatResolver) => call_user_func_array($this->formatResolver, [$request, $model, $value]),
+            is_array($value) => json_encode($value),
+            is_null($value) => $value,
+            default => (string) $value,
+        };
+
+        if (! $this->isCopyable()) {
+            return $formattedValue;
         }
 
-        return call_user_func_array($this->formatResolver, [$request, $model, $value]);
+        return (string) Copyable::make($formattedValue, match (true) {
+            is_array($value) => json_encode($value),
+            is_null($value) => $value,
+            default => (string) $value,
+        });
     }
 
     /**

src/Support/Alert.php

@@ -5,10 +5,11 @@
 namespace Cone\Root\Support;
 
 use Illuminate\Contracts\Support\Arrayable;
+use Illuminate\Contracts\Support\Htmlable;
 use Illuminate\Contracts\Support\Jsonable;
 use Stringable;
 
-class Alert implements Arrayable, Jsonable, Stringable
+class Alert implements Arrayable, Htmlable, Jsonable, Stringable
 {
     public const string INFO = 'info';
 
@@ -90,11 +91,19 @@ public function toJson($options = 0): string
         return json_encode($this->toArray());
     }
 
+    /**
+     * Get content as a string of HTML.
+     */
+    public function toHtml(): string
+    {
+        return $this->message;
+    }
+
     /**
      * Get the string representation of the object.
      */
     public function __toString(): string
     {
-        return $this->message;
+        return $this->toHtml();
     }
 }

src/Support/Copyable.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cone\Root\Support;
+
+use Illuminate\Contracts\Support\Htmlable;
+use Illuminate\Contracts\Support\Renderable;
+use Illuminate\Support\Facades\Blade;
+use Stringable;
+
+class Copyable implements Htmlable, Renderable, Stringable
+{
+    /**
+     * Create a new copyable instance.
+     */
+    public function __construct(protected string $text, protected string $value)
+    {
+        //
+    }
+
+    /**
+     * Make a new copyable instance.
+     */
+    public static function make(string $text, ?string $value = null): static
+    {
+        return new static($text, $value ?: $text);
+    }
+
+    /**
+     * Get the evaluated contents of the object.
+     */
+    public function render(): string
+    {
+        return Blade::render(sprintf('<x-root::copyable text="%s" value="%s" />', $this->text, $this->value));
+    }
+
+    /**
+     * Get content as a string of HTML.
+     */
+    public function toHtml(): string
+    {
+        return $this->render();
+    }
+
+    /**
+     * Get the string representation of the object.
+     */
+    public function __toString(): string
+    {
+        return $this->toHtml();
+    }
+}

src/View/Components/Copyable.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cone\Root\View\Components;
+
+use Illuminate\View\Component;
+use Illuminate\View\View;
+
+class Copyable extends Component
+{
+    /**
+     * Create a new component instance.
+     */
+    public function __construct(protected string $text, protected string $value)
+    {
+        //
+    }
+
+    /**
+     * Get the view / view contents that represent the component.
+     */
+    public function render(): View
+    {
+        return $this->view('root::components.copyable', [
+            'text' => $this->text,
+            'value' => $this->value,
+        ]);
+    }
+}