-
Notifications
You must be signed in to change notification settings - Fork 202
feat: Add Web Share API support via Page.share() and Page.isShareSupported() #24325
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
Open
Artur-
wants to merge
2
commits into
main
Choose a base branch
from
feature/web-share
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.
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 hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| /* | ||
| * Copyright 2000-2026 Vaadin Ltd. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy of | ||
| * the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations under | ||
| * the License. | ||
| */ | ||
|
|
||
| /** | ||
| * Returns whether the current browser exposes the Web Share API | ||
| * (`navigator.share`). Used by the bootstrap path to seed the server-side | ||
| * support signal without waiting for a DOM event. | ||
| */ | ||
| export function isShareSupported(): boolean { | ||
| return typeof navigator.share === 'function'; | ||
| } | ||
|
|
||
| const $wnd = window as any; | ||
| $wnd.Vaadin ??= {}; | ||
| $wnd.Vaadin.Flow ??= {}; | ||
| $wnd.Vaadin.Flow.share = { | ||
| isSupported: isShareSupported, | ||
|
|
||
| share(title: string | null, text: string | null, url: string | null): Promise<void> { | ||
| const data: ShareData = {}; | ||
| if (title !== null) { | ||
| data.title = title; | ||
| } | ||
| if (text !== null) { | ||
| data.text = text; | ||
| } | ||
| if (url !== null) { | ||
| data.url = url; | ||
| } | ||
| return navigator.share(data); | ||
| } | ||
| }; |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
64 changes: 64 additions & 0 deletions
64
flow-server/src/main/java/com/vaadin/flow/component/page/WebShareSupport.java
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| /* | ||
| * Copyright 2000-2026 Vaadin Ltd. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy of | ||
| * the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations under | ||
| * the License. | ||
| */ | ||
| package com.vaadin.flow.component.page; | ||
|
|
||
| /** | ||
| * Whether the browser exposes the Web Share API ({@code navigator.share}). | ||
| * <p> | ||
| * Held by {@link Page#shareSupportSignal()}. Reading the value does not show | ||
| * any browser dialog — it reports whether a subsequent | ||
| * {@link Page#share(String, String, String)} call would succeed in invoking the | ||
| * native share sheet, or whether it would fail because the API is missing in | ||
| * the current browser context. | ||
| * <p> | ||
| * Typical usage: | ||
| * <ul> | ||
| * <li>{@link #SUPPORTED} — show a "Share" button that triggers | ||
| * {@link Page#share(String, String, String)}.</li> | ||
| * <li>{@link #UNSUPPORTED} — fall back to a copy-link or social-network | ||
| * affordance; the native sheet is unavailable in this browser.</li> | ||
| * <li>{@link #UNKNOWN} — only seen in the brief window before the bootstrap | ||
| * handshake completes; treat the same as {@link #UNSUPPORTED} until a real | ||
| * value arrives.</li> | ||
| * </ul> | ||
| */ | ||
| public enum WebShareSupport { | ||
|
|
||
| /** | ||
| * No value has been reported by the browser yet. Used only as the initial | ||
| * value of the signal before the first client handshake delivers the real | ||
| * one. In normal request handling the signal is seeded before any user code | ||
| * (UI initialization, {@code UIInitListener}, component attach) runs, so | ||
| * this value is essentially never observed in practice; once a real value | ||
| * has arrived, the signal never returns to {@code UNKNOWN}. | ||
| */ | ||
| UNKNOWN, | ||
|
|
||
| /** | ||
| * The browser exposes {@code navigator.share}; calls to | ||
| * {@link Page#share(String, String, String)} will invoke the native share | ||
| * sheet. | ||
| */ | ||
| SUPPORTED, | ||
|
|
||
| /** | ||
| * The browser does not expose {@code navigator.share}; calls to | ||
| * {@link Page#share(String, String, String)} will throw | ||
| * {@link UnsupportedOperationException}. Some desktop browsers, in | ||
| * particular older Firefox versions, fall in this bucket. | ||
| */ | ||
| UNSUPPORTED | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
getShareSupportSignal()or perhaps onlygetShareSupport()as Sinal is the return type.