demotivator
TypeScript icon, indicating that this package has built-in type declarations

12.0.0 • Public • Published

demotivator.js

(de)Motivator.js

Technologies Used

TypeScript

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, import the required packages

import { insults, GenerateInsult, insultAt } from 'demotivator';

Usage

GenerateInsult() will return a random insult. Run this function anytime you need to refresh the random insult. insultAtreturns the insult at the specified point in the array. Takes 1 numerical argument, which is the spot in the array to return insults gives you access to the full array of insults. Do with it as you wish.

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 { insults, GenerateInsult } from 'demotivator';
const insult = document.getElementById('insult');
button.addEventListener('click', GenerateInsult, () => {
  insult.innerHTML = GenerateInsult();
});

Update Schedule

DMV.js will follow the same update schedule as (de)Motivator, with a release every 2-3 months.

License

We are licenced under the Apache-2.0 licnse. Please see LICENSE for more information.

Dependencies (0)

    Dev Dependencies (6)

    Package Sidebar

    Install

    npm i demotivator

    Weekly Downloads

    4

    Version

    12.0.0

    License

    Apache-2.0

    Unpacked Size

    67.1 kB

    Total Files

    19

    Last publish

    Collaborators

    • rpmullin