@mestrak/made-with-stuff
v1.0.3
Published
A simple, fun Vue.js (and React using Vuera) component to display a customisable 'made with ❤ by someone' tag
Downloads
349
Readme
Made with stuff is a fun component to add a made with ❤ by me with a randomly selected emoji to your website. Build with Vue.js, works with React using Vuera.
Some examples:
Made with 👍 by Strak.
Made with 💚 by me.
Made with 🍕 + ☕ by our awesome team.
Built by Little One, fuelled by ☕.
Built With
Usage
Install the component in your project.
yarn add @mestrak/made-with-stuff
or
npm install @mestrak/made-with-stuff
Then add it to the pages or components where you want to display it. Font style, etc. will be inherited from your existing css.
Set beforetext and aftertext props to configure the text. If they are not configured the component will display Made with ❤ by me (with random emoji).
Set :maxemojis to display more than one emoji, like this: Made with ❤ + 👍 by me.
Set :maxemojis to an integer from 1-5 to adjust the size of the emojis (1 is smallest).
<template>
<span>
<MadeWithStuff beforetext="Made with" aftertext="by us!" :maxemojis="3" :emojisize="1"></MadeWithStuffVue>
</span>
</template>
<script lang="ts">
import MadeWithStuff from "@mestrak/made-with-stuff";
export default {
components: {
MadeWithStuff
}
};
</script>
Roadmap
- Configurable emoji list
- Random number of emojis
- Badge style display
- Fruit machine type shuffle when selecting emojis
- Possibly some different icon/font choices
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Project Link: https://github.com/mestrak/made-with-stuff