@georapbox/web-share-element
TypeScript icon, indicating that this package has built-in type declarations

3.1.0 • Public • Published

npm version npm license

<web-share>

A custom element that implements the Web Share API to share user-defined data.

API documentationDemo

Install

$ npm install --save @georapbox/web-share-element

Usage

Script

import { WebShare } from './node_modules/@georapbox/web-share-element/dist/web-share.js';

// Manually define the element.
WebShare.defineCustomElement();

Alternatively, you can import the automatically defined custom element.

import './node_modules/@georapbox/web-share-element/dist/web-share-defined.js';

Markup

<web-share 
  share-url="https://developer.mozilla.org" 
  share-title="MDN" 
  share-text="Learn web development on MDN!"
></web-share>

Style

By default, the component is style-free to remain as less opinionated as possible. However, you can style the various elements of the component using CSS Parts provided for this purpose.

API

Properties

Name Reflects Type Default Description
shareUrl
share-url
String '' A string representing a URL to be shared.
shareTitle
share-title
String '' A string representing a title to be shared.
shareText
share-text
String '' A string representing text to be shared.
shareFiles - Array [] An array of File objects representing files to be shared. this property will be omitted if the device does not support sharing files or a file type is not shareable and it will try to share the rest of the properties. Check here for shareable file types.
disabled Boolean false Determines if the share button is disabled.

Slots

Name Description
button Override the share button with another element of your preference. Example: <a href="#" slot="button" role="button">Share this page</a>
button-content Override the share button's content with content of your preference. Useful if all you need is to change the button's label. Example: <span slot="button-content">Share this page</span>

CSS Parts

Name Description
button The share button.
button--disabled The share button when is disabled.

Methods

Name Type Description Arguments
defineCustomElement Static Defines/registers the custom element with the name provided. If no name is provided, the default name is used. The method checks if the element is already defined, hence will skip trying to redefine it. elementName='web-share'
share1 Instance Shares the shareable data taken from the element's properties. -

1 Instance methods are only available after the component has been defined. To ensure that the component has been defined, you can use the whenDefined method of the CustomElementRegistry interface. For example:

customElements.whenDefined('web-share').then(() => {
  /* call methods here */
});

Events

Name Description Event Detail
web-share:success Emitted when share is successful. { shareData: { url?: String, title?: String, text?: String, files?: File[] } }
web-share:abort Emitted when share is aborted. { error: AbortError }
web-share:error Emitted when share fails for any reason. Here is a full list of possible exceptions. { error: TypeError }

Utilities

isWebShareSupported()

Returns true if Web Share API is supported by the platform, otherwise returns false. By default, it checks if navigator.share is supported. If you want to check for support of a specific shareable data type, you can pass an object as argument with the shareable data you want to check for support. For example, if you want to check if sharing files is supported, you can pass {files: [File, ...]} as argument. Available shareable data types are url, text, title and files.

isWebShareSupported({ 
  files: [new File(['foo'], 'foo.txt', { type: 'text/plain', })]
});

NOTE: You don't necessarily need to check for Web Share API support. The component handles errors regarding support internally; you can catch them by registering the web-share:error event. The utility might come handy for a scenario that you want to dynamically import the custom element only if the API is supported (check example below). In cases that the Web Share API is partially supported, (eg Firefox in Android supports sharing url and title but not text or files), the component will try to share the other shareable data if provided and will omit any unsupported shareable data.

import { isWebShareSupported } from './node_modules/@georapbox/web-share-element/dist/is-web-share-supported.js';

// Check if Web Share API is supported
if (isWebShareSupported()) {
  // Import component dynamically...
  const { WebShare } = await import('./node_modules/@georapbox/web-share-element/dist/web-share.js');

  WebShare.defineCustomElement();
}

Changelog

For API updates and breaking changes, check the CHANGELOG.

Browser support

Browsers without native custom element support require a polyfill.

  • Firefox
  • Chrome
  • Microsoft Edge
  • Safari

License

The MIT License (MIT)

Package Sidebar

Install

npm i @georapbox/web-share-element

Weekly Downloads

28

Version

3.1.0

License

MIT

Unpacked Size

84 kB

Total Files

18

Last publish

Collaborators

  • georapbox