clipboard

Read, write, and dispatch clipboard operations in the browser

Access BrowserClipboard from the browser context. Clipboard operations target the active page unless you provide another page.

TypeScript

Quick start

const clipboard = browser.context.clipboard;
await clipboard.writeText("Hello");

readText()

Read plain text from the browser clipboard.

const text = await browser.context.clipboard.readText();

options · ClipboardOptions

Options that select a target page and configure the operation.

options.page · Page

The page to target. Defaults to the active page.

result · Promise<string>

The clipboard text.

writeText()

Write plain text to the browser clipboard.

await browser.context.clipboard.writeText("Hello");

text · string

The plain text to write.

options · ClipboardOptions

Options that select a target page and configure the operation.

options.page · Page

The page to target. Defaults to the active page.

result · Promise<void>

Resolves after the clipboard operation completes.

clear()

Clear the browser clipboard.

await browser.context.clipboard.clear();

options · ClipboardOptions

Options that select a target page and configure the operation.

options.page · Page

The page to target. Defaults to the active page.

result · Promise<void>

Resolves after the clipboard operation completes.

paste()

Paste the clipboard contents into the active element.

await browser.context.clipboard.paste();

options · ClipboardPasteOptions

Options that select a target page and configure the operation.

options.page · Page

The page to target. Defaults to the active page.

options.shortcut · 'ControlOrMeta+V' | 'Meta+V' | 'Control+V'

The keyboard shortcut to dispatch.

result · Promise<void>

Resolves after the clipboard operation completes.

copy()

Copy the current selection to the browser clipboard.

await browser.context.clipboard.copy();

options · ClipboardOptions

Options that select a target page and configure the operation.

options.page · Page

The page to target. Defaults to the active page.

result · Promise<void>

Resolves after the clipboard operation completes.

cut()

Cut the current selection to the browser clipboard.

await browser.context.clipboard.cut();

options · ClipboardOptions

Options that select a target page and configure the operation.

options.page · Page

The page to target. Defaults to the active page.

result · Promise<void>

Resolves after the clipboard operation completes.

Python

Quick start

clipboard = browser.context.clipboard
await clipboard.write_text("Hello")

read_text()

Read plain text from the browser clipboard.

text = await browser.context.clipboard.read_text()

page · Page | None

The page to target. Defaults to the active page.

result · str

The clipboard text.

write_text()

Write plain text to the browser clipboard.

await browser.context.clipboard.write_text("Hello")

text · str

The plain text to write.

page · Page | None

The page to target. Defaults to the active page.

result · None

Resolves after the clipboard operation completes.

clear()

Clear the browser clipboard.

await browser.context.clipboard.clear()

page · Page | None

The page to target. Defaults to the active page.

result · None

Resolves after the clipboard operation completes.

paste()

Paste the clipboard contents into the active element.

await browser.context.clipboard.paste()

page · Page | None

The page to target. Defaults to the active page.

shortcut · Literal['ControlOrMeta+V', 'Meta+V', 'Control+V']

The keyboard shortcut used to paste.

result · None

Resolves after the clipboard operation completes.

copy()

Copy the current selection to the browser clipboard.

await browser.context.clipboard.copy()

page · Page | None

The page to target. Defaults to the active page.

result · None

Resolves after the clipboard operation completes.

cut()

Cut the current selection to the browser clipboard.

await browser.context.clipboard.cut()

page · Page | None

The page to target. Defaults to the active page.

result · None

Resolves after the clipboard operation completes.

Go

Quick start

clipboard := browser.Context().Clipboard()
if err := clipboard.WriteText(ctx, "Hello", nil); err != nil {
    return err
}

Every method takes a context.Context first. Methods with options accept a pointer options struct; pass nil for defaults.

ReadText()

Read plain text from the browser clipboard.

text, err := browser.Context().Clipboard().ReadText(ctx, nil)
if err != nil {
    return err
}
fmt.Println(text)

options · *ClipboardOptions

Options that select a target page. Pass nil to use the active page.

options.Page · *Page

The page to target. Defaults to the active page.

result · (string, error)

The clipboard text and any operation error.

WriteText()

Write plain text to the browser clipboard.

if err := browser.Context().Clipboard().WriteText(ctx, "Hello", nil); err != nil {
    return err
}

text · string

The plain text to write.

options · *ClipboardOptions

Options that select a target page. Pass nil to use the active page.

options.Page · *Page

The page to target. Defaults to the active page.

result · error

Returns nil after the clipboard operation completes.

Clear()

Clear the browser clipboard.

if err := browser.Context().Clipboard().Clear(ctx, nil); err != nil {
    return err
}

options · *ClipboardOptions

Options that select a target page. Pass nil to use the active page.

options.Page · *Page

The page to target. Defaults to the active page.

result · error

Returns nil after the clipboard operation completes.

Paste()

Paste the clipboard contents into the active element.

if err := browser.Context().Clipboard().Paste(ctx, nil); err != nil {
    return err
}

options · *ClipboardPasteOptions

Options that select a target page and configure the operation. Pass nil for defaults.

options.Page · *Page

The page to target. Defaults to the active page.

options.Shortcut · *ContextClipboardPasteParamsShortcut

The keyboard shortcut to dispatch: ContextClipboardPasteParamsShortcutControlOrMetaV, ContextClipboardPasteParamsShortcutMetaV, or ContextClipboardPasteParamsShortcutControlV.

result · error

Returns nil after the clipboard operation completes.

Copy()

Copy the current selection to the browser clipboard.

if err := browser.Context().Clipboard().Copy(ctx, nil); err != nil {
    return err
}

options · *ClipboardOptions

Options that select a target page. Pass nil to use the active page.

options.Page · *Page

The page to target. Defaults to the active page.

result · error

Returns nil after the clipboard operation completes.

Cut()

Cut the current selection to the browser clipboard.

if err := browser.Context().Clipboard().Cut(ctx, nil); err != nil {
    return err
}

options · *ClipboardOptions

Options that select a target page. Pass nil to use the active page.

options.Page · *Page

The page to target. Defaults to the active page.

result · error

Returns nil after the clipboard operation completes.