LibWeb: Implement the ClipboardItem API

Spec: https://w3c.github.io/clipboard-apis/#clipboard-item-interface
Author: https://github.com/F3n67u Commit: b3edbd7bf2 Pull-request: https://github.com/LadybirdBrowser/ladybird/pull/2664 Reviewed-by: https://github.com/awesomekling Reviewed-by: https://github.com/tcl3 ✅
2025-08-24 19:28:48 +00:00 · 2024-11-30 20:23:38 -08:00 · 2024-11-30 20:23:38 -08:00 · b3edbd7bf2 · 2024-12-20 15:30:21 +00:00
commit b3edbd7bf2
parent bdd6729d78
12 changed files with 484 additions and 0 deletions
--- a/Libraries/LibWeb/Clipboard/ClipboardItem.h
+++ b/Libraries/LibWeb/Clipboard/ClipboardItem.h
@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2024, Feng Yu <f3n67u@outlook.com>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <LibGC/Ptr.h>
+#include <LibJS/Runtime/PromiseCapability.h>
+#include <LibWeb/Bindings/ClipboardItemPrototype.h>
+#include <LibWeb/DOM/Event.h>
+#include <LibWeb/Forward.h>
+#include <LibWeb/HTML/DataTransfer.h>
+#include <LibWeb/MimeSniff/MimeType.h>
+
+namespace Web::Clipboard {
+
+constexpr auto WEB_CUSTOM_FORMAT_PREFIX = "web "sv;
+
+inline constexpr Array MANDATORY_DATA_TYPES = {
+    "text/plain"sv, "text/html"sv, "image/png"sv
+};
+
+struct ClipboardItemOptions {
+    Bindings::PresentationStyle presentation_style { Bindings::PresentationStyle::Unspecified };
+};
+
+// https://w3c.github.io/clipboard-apis/#clipboard-item-interface
+class ClipboardItem : public Bindings::PlatformObject {
+    WEB_PLATFORM_OBJECT(ClipboardItem, Bindings::PlatformObject);
+    GC_DECLARE_ALLOCATOR(ClipboardItem);
+
+public:
+    struct Representation {
+        String mime_type;              // The MIME type (e.g., "text/plain").
+        bool is_custom;                // Whether this is a web custom format.
+        GC::Ref<WebIDL::Promise> data; // The actual data for this representation.
+    };
+
+    static WebIDL::ExceptionOr<GC::Ref<ClipboardItem>> construct_impl(JS::Realm&, OrderedHashMap<String, GC::Root<WebIDL::Promise>> const& items, ClipboardItemOptions const& options = {});
+
+    virtual ~ClipboardItem() override;
+
+    Bindings::PresentationStyle presentation_style() const { return m_presentation_style; }
+
+    Vector<String> const& types() const { return m_types; }
+
+    WebIDL::ExceptionOr<GC::Ref<WebIDL::Promise>> get_type(String const& type);
+
+    static bool supports(JS::VM&, String const& type);
+
+private:
+    ClipboardItem(JS::Realm&);
+
+    virtual void initialize(JS::Realm&) override;
+    virtual void visit_edges(Cell::Visitor&) override;
+
+    Bindings::PresentationStyle m_presentation_style;
+    Vector<String> m_types;
+    Vector<Representation> m_representations;
+};
+
+}