dontleaveme
v1.0.0
Published
Beg users to stay on your website with one line of code.
Downloads
4
Maintainers
braydentwReadme
dontleaveme 😭
🙏 Beg users to stay on your website with one line of code.
Usage
The dontLeaveMe.init() function has 2 parameters.
dontLeaveMe.init(awayTitle, defaultTitle)awayTitle: What the document.title will be once the user temporarily leaves the page.
defaultTitle: The document.title when the user is on the page.
Here is the function in action:
dontLeaveMe.init("Don't leave me! 😭", "My Website")Installation
CDN
A CDN script is perfect for using dontLeaveMe in static, HTML websites. Simply insert this script into your document's <head> tag:
<script src="https://unpkg.com/dontleaveme/src/index.js"></script>Once added, make sure to initialize dontLeaveMe on your page by adding this one line of JavaScript to your site:
dontLeaveMe.init("Don't leave me! 😭", "My Website")Are you using React?
Don't worry. I got you covered. 👍
If you are building a node-based website, simply install the following package into your project using NPM:
npm i dontleavemeThen import it into your React project.
Make sure you wrap the function with a useEffect() hook or else this will not work.
import React, { useEffect } from ‘react’;
import dontLeaveMe from 'dontleaveme';
useEffect(() => {
dontLeaveMe.init("Don't leave me! 😭", "My Website")
})Contributing to this project 👊
Thanks for showing interest to contribute to dontleaveme 💖, you rock!
Follow the directions below to setup your project and contribute to this repository.
Fork the repo (click the Fork button at the top right of this page)
Clone your fork locally
git clone https://github.com/<YOUR_USERNAME>/dontleaveme
cd dontleaveme- Setup all the dependencies and packages
npm installOnce you submit a PR, I'll respond as soon as possible so we can take a look at what you've made!
Making a Pull Request? 🔁
That's awesome! Start by following the instructions given earlier of how to run this project on your system locally.
Then, commit and push your changes:
git add .
git commit -m "My commit message"
git pushOnce finished, you can create a pull request!
Is it your first time? Check out this link to learn how to submit a pull request.
Think you found a bug? 🐛
Please submit an issue and provide a clear path to reproduction with a code example.
The clearer you are, the easier it will be for us help!
License
dontleaveme is open source software licensed as MIT.
Like my work?
I would appreciate it if you gave this repo a ✨ or if you Bought Me a Coffee 👇