`oro:clipboard`

oro:clipboard reads and writes clipboard text from the current application context.

Desktop integrations

Examples#

Read and write plain-text clipboard content:

import { writeText, readText, canWriteText } from 'oro:clipboard'

if (canWriteText()) {
  await writeText('Copied from Oro Runtime')
  console.log(await readText())
}

API reference#

Module specifiers#

oro:clipboard

TypeScript declarations#

These declarations are generated from the runtime's published TypeScript surface.

`oro:clipboard`#

declare module "oro:clipboard" {
    /**
     * Write a string to the system clipboard.
     * @param {string} text
     * @returns {Promise<void>}
     */
    export function writeText(text: string): Promise<void>;
    /**
     * Read the current text contents from the system clipboard.
     * @returns {Promise<string>}
     */
    export function readText(): Promise<string>;
    /**
     * @returns {boolean} True when clipboard write operations are supported.
     */
    export function canWriteText(): boolean;
    /**
     * @returns {boolean} True when clipboard read operations are supported.
     */
    export function canReadText(): boolean;
    namespace _default {
        export { writeText };
        export { readText };
        export { canWriteText };
        export { canReadText };
    }
    export default _default;
}

oro:clipboard

Related guides#