Skip to main content
Version: 2.0.0

Interface: useClipboardReturnType

Properties

clearClipboard

clearClipboard: () => void

Type declaration

▸ (): void

Clears the user clipboard.

Returns

void

Defined in

packages/firecms/src/hooks/useClipboard.tsx:63


clipboard

clipboard: string

Current selected clipboard content.

Defined in

packages/firecms/src/hooks/useClipboard.tsx:58


copy

copy: (text?: string) => void

Type declaration

▸ (text?): void

Use it to perform the copy operation

Parameters
NameType
text?string
Returns

void

Defined in

packages/firecms/src/hooks/useClipboard.tsx:43


cut

cut: () => void

Type declaration

▸ (): void

Use it to perform the cut operation

Returns

void

Defined in

packages/firecms/src/hooks/useClipboard.tsx:48


isCoppied

isCoppied: boolean

Indicates wheater the content was successfully copied or not.

Defined in

packages/firecms/src/hooks/useClipboard.tsx:53


isSupported

isSupported: () => boolean

Type declaration

▸ (): boolean

Check to see if the browser supports the new navigator.clipboard API.

Returns

boolean

Defined in

packages/firecms/src/hooks/useClipboard.tsx:68


ref

ref: MutableRefObject<any>

Use ref to pull the text content from.

Defined in

packages/firecms/src/hooks/useClipboard.tsx:38

Enterprise or start-up?

Learn how to get the most out of your project with the help of our consulting team.
Learn more
Sign up to our newsletter to get the latest news and updates. No spam!