Skip to content
πŸ“² Bringing your PWA app to iOS. Evidently.
Branch: master
Clone or download
Latest commit 38b6a02 Apr 11, 2019

README.md

react-add-to-homescreen

CircleCI License: MIT Coverage Status code style: prettier

Bringing your PWA app to iOS. Evidently.

What is it?

react-add-to-homescreen allows you to inform the iOS users that your web app is installable on the iOS home screen. It mimics the behavior of Android's Add to home screen widget visible when the user visits your PWA.

Installation

$ yarn react-add-to-homescreen

Demo

You can check out the demo Progressive Web App here. I am not the designer of this one though 😎

Usage

react-add-to-homescreen is designed to be as simple as possible. First import the component:

import AddToHomescreen from 'react-add-to-homescreen';

Then add the component to the main component of your app:

<AddToHomescreen onAddToHomescreenClick={this.handleAddToHomescreenClick} />

Finally, create a handler for the banner:

handleAddToHomescreenClick = () => {
  alert(`
    1. Open Share menu
    2. Tap on "Add to Home Screen" button`);
};

Options

All options are passed as props.

Prop Type Description
onAddToHomescreenClick function function to call on banner click
title? string Custom title for banner
icon? string Icon for banner

Contributing

If you have comments, complaints, or ideas for improvements, feel free to open an issue or a pull request! If you are using or intend to use react-add-to-homescreen, please let me know πŸ™‚

License

react-add-to-homescreen was created by @kkoscielniak. It is available under the MIT license. See the LICENSE file for more info.

You can’t perform that action at this time.