Clipboard

Bindings for @solid-primitives/clipboard, which wraps the MDN clipboard API.

ClipboardItem

type ClipboardItem = interface

An interface to the MDN clipboard API's ClipboardItem. To create one, see newClipboardItem.

member presentationStyle: PresentationStyle with get

See PresentationStyle.

member types: string[] with get

member getType(``type``: string): JS.Promise<obj>

Resolves to the item's data for one MIME type; rejects if the item has none.

PresentationStyle

type PresentationStyle = StringEnum

| Attachment
| Inline
| Unspecified

newClipboardItem

let newClipboardItem(``type``: string, data: obj): ClipboardItem

Creates a ClipboardItem from a MIME type and a data object.

readClipboard

let readClipboard(): JS.Promise<ClipboardItem[]>

Reads the clipboard. Returns a promise that resolves to an array of ClipboardItem.

writeClipboard

let writeClipboard(input: string): unit

let writeClipboard(input: ClipboardItem[]): unit

Writes to the clipboard. To build a ClipboardItem, see newClipboardItem.

let writeClipboard'(input: string): JS.Promise<unit>

let writeClipboard'(input: ClipboardItem[]): JS.Promise<unit>

createClipboard

let createClipboard(
    ?data: Accessor<string | ClipboardItem[]>,
    ?deferInitial: bool
    ): ClipboardResult

Version with an apostrophe

let createClipboard'(
    ?data: Accessor<string | ClipboardItem[]>,
    ?deferInitial: bool
    ):
    SolidResource<ClipboardItem[]> *
    (unit -> unit) *
    (string -> JS.Promise<unit>)

createClipboard reads and writes. Write with the write member or through the input signal; reads come back as a Solid resource. Use the named members of ClipboardResult, or destructure the apostrophe version's tuple.

ClipboardResult

type ClipboardResult = interface

Named access to what createClipboard returns.

member resourceItems: SolidResource<ClipboardItem[]>

member refetch: (unit -> unit)

member write: (string -> JS.Promise<unit>)

Edit this page