🎁 WebComponent: Patreon Box

     

> My Patreon Tier Box with avatars and link from rest/json api.

> ⛔ DISCLAIMER: This is an unofficial patreon library and offers no warranty! All trademarks and logos belong to their respective owners.

🎁 Support: Donate

> This project is free, open source and I try to provide excellent free support. Why donate? I work on this project several hours in my spare time and try to keep it up to date and working. THANK YOU!

   

 

📎 Menu

- 💡 Features
- 🕹 Demo
- 👔 Screenshot
- 🚀 How to use
- - 🌎 Web
- - 📦 Webpack/Browserify
- - 📖 Wordpress
- - ⚛️ React
- - 🅰️ Angular
- 🧰 Options / Attributes
- 📚 Documentation
- 👨‍💻 Contributing
- 🐛 Known Bugs
- 🍻 Community:
- Discord (🇬🇧 English Channel | 🇮🇹 Italian Channel | 🇵🇱 Polish Channel)

💡 Features

* [✔️] Easy to use
* [✔️] MIT License
* [✔️] Without jQuery depencence
* [✔️] Configurable with attributes
* [✔️] Work with: Browserify / Webpack / ReactJS / Angular / Wordpress
* [✔️] My Patreon Tier Box with avatars and link from rest/json api.
* [✔️] Translations: 🇬🇧 🇮🇹 🇵🇱 (Help me ❤️)

👔 Screenshot

See Demo here. Photos from ptkdev's patreon rest api:


🚀 Installation (Web)

1. Add html code to your page (and replace api with your endpoint):
``html

`
2. Require javascript in yourpage (before ):
`html

`

You can replace en in jsdelivr cdn with it or pl and load different languages or replace @latest with specific version, example @2.0.1.

See folder examples, run with npm run example. Below is available a description of options values and all logger methods.

📦 Installation (NPM Module - Browserify/Webpack)


1. Install npm module: npm install @ptkdev/webcomponent-patreon-box --save
2. Add html code to your page (and replace api with your endpoint):
`html

`
3. Require javascript in your app:
`javascript
require("@ptkdev/webcomponent-patreon-box");
`
or
`javascript
import '@ptkdev/webcomponent-patreon-box';
`

See folder examples, run with npm run example. Below is available a description of options values and all logger methods.

📖 Installation (Wordpress)


1. Download wordpress-plugin and install it.
1. Add code to your html widget, example: Appearance --> Widget --> insert HTML Widget and paste html code (and replace api with your endpoint):
`html

`

You can insert this html code in posts, widget, html box or theme. Where you want see patreon photos box.

⚛️ Installation (React)

1. Install npm module with npm install @ptkdev/webcomponent-patreon-box@latest --save:
2. Import module in your src/App.js on header:
`javascript
import '@ptkdev/webcomponent-patreon-box';
`
3. Add html code to your App.js template (and replace api with your endpoint):
`html

`

Below is available a description of options values and all logger methods.

🅰️ Installation (Angular)


1. Install npm module with npm install @ptkdev/webcomponent-patreon-box@latest --save:
2. Import module in your app/app.modules.ts on header:
`javascript
import '@ptkdev/webcomponent-patreon-box';
`
3. Add html code to your html component (and replace api with your endpoint):
`html

`

Below is available a description of options values and all logger methods.

🧰 Options / Attributes

| Parameter | Description | Values | Default value | Available since |
| --- | --- | --- | --- | --- |
| api | REST Api url | URI / URL of endpoint | https://api.ptkdev.io/backers/ | v1.0.0 |
| items-limit | Set the max number of pictures | number: from 0 to 100 | 100 | v1.0.0 |
| grid | Set grid aspect ratio | 1x1, 2x2, 3x3, etc... or responsive | responsive | v1.0.0 |
| image-width | Set width of images (NOTE: grid different than responsive overwrite this value) | length units: 100%, 100px, 100pt | 100% | v1.0.0 |
| image-height | Set height of images | length units: 100%, 100px, 100 | 100% | v1.0.0 |
| border-spacing | Set spacing around images | length units: 5%, 5px, 5pt | 2px | v1.0.0 |
| border-corners | Set border radius of corners: 0: square / 15: rounded / 100: circle | number: from 0 to 100 | 5 | v1.0.0 |
| force-square | Force square aspect ratio if you post photos with different size on your patreon | yes / no | yes | v1.0.0 |
| cache | Enable/disable cache | enabled / disabled | enabled | v1.0.0 |

#### HTML Code with attributes:
`html

`

🔨 Developer Mode


1. Download nightly, beta or stable.
2. Remove .tpl suffix from config.js.tpl file in configs folder and fill it properly.
3. Run npm install
4. Run npm run dev

📚 Documentation

Run npm run docs

👑 Sponsors

Support this project by becoming a sponsor. 🙏 Become a sponsor on patreon or become top3 sponsor on ko-fi. Your logo will show up here with a link to your website.

                 

🦄 Backers

Thank you to all our backers! 🙏 Become a backer on patreon.

              

👨‍💻 Contributing

I ❤️ contributions! I will happily accept your pull request! Translations, grammatical corrections (GrammarNazi you are welcome! Yes my English is bad, sorry), etc... Do not be afraid, if the code is not perfect we will work together 👯 and remember to insert your name in .all-contributorsrc and package.json` file.

Thanks goes to these wonderful people (emoji key):

Patryk Rzucidło 💻 🌍 📖 🐛

Emanuele Fricano 💻 🐛

Dominik Lubański 🐛

> 💰 In the future, if the donations allow it, I would like to share some of the success with those who helped me the most. For me open source is share of code, share development knowledges and share donations!

📲 Tools



🐍 Sorry for snake_case

I love snake_case syntax sorry for this 😭 don't hate me.

💫 License

* Code and Contributions have MIT License
* Images and logos have CC BY-NC 4.0 License (Freepik Premium License)
* Documentations and Translations have CC BY 4.0 License

###### Copyleft (c) 2020 Patryk Rzucidło (@PTKDev) <support@ptkdev.io>