demotivator
v13.0.0
Published
A extremely large array of 300+ insults so you can integrate the power of (de)Motivator into your webapp.
Downloads
172
Maintainers
rpmullinReadme
(de)Motivator.js
Technologies Used
Description
An extensive JavaScript Library to integrate the power of (de)Motivator into your webapp.
Use Cases
- Casually throw shade at your users.
- Need a random insult
- Just been roasted, and you dont feel like visiting (de)Motivator
- You feel as if your userbase's ego is far too high
Installation
via npm
Install the demotivator package
npm i demotivator
Include the demotivator package in your package.json (this should be done automatically by npm)
In your javascript file, (de)Motivator
import deMotivator from 'demotivator';Usage
generateInsult will return a random insult. Run this function anytime you need to refresh the random insult. Takes one argument, the array of insults to generate from.
insultAtreturns the insult at the specified point in the array. Takes 2 arguments, the first of which is the spot in the array to return, and the second is the array to pick from.
insults gives you access to the full array of insults. Do with it as you wish.
profaneInsults gives you all of the profane, or "dirty" insults that come with the package.
createArray creates an array of insults based on a configuration of your choosing
deMotivator Contains all the functions and properties of the deMotivator.
DeMotivator A class version of the deMotivator object
Examples
This is an example for a basic web page integrated with (de)Motivator.js
HTML
<!--index.html-->
<!--As always, you'll need a module bundler like webpack or rollup to compile your code into a form the browser can understand. -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>(de)Motivator.js example</title>
<script src="dist/js/index.js" defer></script>
<!--Notice the "dist" directory ^^ -->
</head>
<body>
<br>
<h1>(de)Motivator.js example</h1>
<button onclick="generateInsult()">Click Me</button>
<br/>
<div>
<p id = "insult">
Insult will appear here
</p>
JavaScript
// src/index.js
// As always, you'll need a module bundler like webpack or rollup to compile your code into a form the browser can understand.
import { generateInsult } from 'demotivator';
const insult = document.getElementById('insult');
button.addEventListener('click', () => insult.innerHTML = generateInsult(createArray({
original: true,
profane: false,
));
Update Schedule
DMV.js will follow the same update schedule as (de)Motivator, with a release every 6-8 months.
License
We are licenced under the Apache-2.0 licnse. Please see LICENSE for more information.