-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[O2B-1386] Check if clipboard is available #1774
Open
mariscalromeroalejandro
wants to merge
1
commit into
main
Choose a base branch
from
origin/amariscalr/02B-1386/clipboard-not-available
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+53
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -41,6 +41,56 @@ export class CopyToClipboardComponent extends StatefulComponent { | |
this.notify(); | ||
} | ||
|
||
/** | ||
* Checks if the clipboard is available and returns an object with availability status and a message. | ||
* | ||
* @returns {{ available: boolean, message: string }} | ||
* - `available`: True if the clipboard is available; false otherwise. | ||
* - `message`: A reason if the clipboard is not available, otherwise an empty string. | ||
*/ | ||
isClipboardAvailable() { | ||
if (!this.isContextSecure()) { | ||
return { available: false, message: 'Clipboard not available in a non-secure context.' }; | ||
} | ||
|
||
if (!this.isClipboardSupported()) { | ||
return { available: false, message: 'Clipboard API is not supported in this browser.', | ||
}; | ||
} | ||
|
||
if (this.isWindowEmbedded()) { | ||
return { available: false, message: 'Clipboard access is restricted in iframes.' }; | ||
} | ||
return { available: true, message: '' }; | ||
} | ||
|
||
/** | ||
* Checks if context is secure (HTTPS) | ||
* | ||
* @returns {boolean} Returns `true` if context is secure | ||
*/ | ||
isContextSecure() { | ||
return window.isSecureContext; | ||
} | ||
|
||
/** | ||
* Checks if the clipboard API is available in the user's browser. | ||
* | ||
* @returns {boolean} Returns `true` if it is available | ||
*/ | ||
isClipboardSupported() { | ||
return Boolean(navigator.clipboard); | ||
} | ||
|
||
/** | ||
* Check if the window is embeded in a frame. | ||
* | ||
* @returns {boolean} Returns `true` if it is embeded | ||
*/ | ||
isWindowEmbedded() { | ||
return window !== window.parent; | ||
} | ||
|
||
/** | ||
* Renders the button that allows copying text to the clipboard. | ||
* | ||
|
@@ -50,6 +100,7 @@ export class CopyToClipboardComponent extends StatefulComponent { | |
view(vnode) { | ||
const { attrs, children } = vnode; | ||
const { value: clipboardTargetValue = '', id } = attrs; | ||
const { available, message } = this.isClipboardAvailable(); | ||
|
||
const defaultContent = [iconLinkIntact(), children]; | ||
const successContent = [iconCheck(), h('', 'Copied!')]; | ||
|
@@ -59,6 +110,8 @@ export class CopyToClipboardComponent extends StatefulComponent { | |
{ | ||
id: `copy-${id}`, | ||
onclick: () => this.copyToClipboard(clipboardTargetValue), | ||
disabled: !available, | ||
title: `${message}`, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If message is already a string, no need for `` |
||
}, | ||
h('div.flex-row.g1', this._successStateTimeout ? successContent : defaultContent), | ||
); | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If message do not apply (meaning: it makes no sense to have a message, in the case the clipboard is available) you should rather use null or undefined (basically return
{ available: true }
).Another possibility is to have a function like
checkClipboardAvailability
that throws an error if one of the check fails, and you use the error message as message.