<web-share>

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

API documentation • Demo

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

Slots

CSS Parts

Methods

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

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.

Development setup

Prerequisites

The project requires Node.js and npm to be installed on your environment. Preferrably, use nvm Node Version Manager and use the version of Node.js specified in the .nvmrc file by running nvm use.

Install dependencies

Install the project dependencies by running the following command.

npm install

Build for development

Watch for changes and start a development server by running the following command.

npm start

Linting

Lint the code by running the following command.

npm run lint

Testing

Run the tests by running any of the following commands.

npm test
npm run test:watch # watch mode

Build for production

Create a production build by running the following command.

npm run build

License

The MIT License (MIT)