# samedo-badge

> shows an badge on websites with partner

Latest version **1.1.6** (published 2019-11-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install samedo-badge
pnpm add samedo-badge
yarn add samedo-badge
bun add samedo-badge
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.6 |
| Published | 2019-11-22 |
| First published | 2019-01-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 190.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ronny Krübel |
| Maintainers | rkruebel |

## Links

- npm: https://www.npmjs.com/package/samedo-badge
- Repository: https://github.com/rkruebel/samedo-badge
- Homepage: https://github.com/rkruebel/samedo-badge#readme
- Issues: https://github.com/rkruebel/samedo-badge/issues
- npm.io page: https://npm.io/package/samedo-badge

## Dependencies (12)

- [cp](https://npm.io/package/cp.md) ^0.2.0
- [cpx](https://npm.io/package/cpx.md) ^1.5.0
- [del](https://npm.io/package/del.md) ^3.0.0
- [less](https://npm.io/package/less.md) ~1.7.5
- [eslint](https://npm.io/package/eslint.md) ^3.19.0
- [jquery](https://npm.io/package/jquery.md) ^3.4.1
- [cssnano](https://npm.io/package/cssnano.md) ^4.1.10
- [del-cli](https://npm.io/package/del-cli.md) ^1.1.0
- [watchify](https://npm.io/package/watchify.md) ^3.11.1
- [uglify-js](https://npm.io/package/uglify-js.md) ^3.6.8
- [browserify](https://npm.io/package/browserify.md) ^16.5.0
- [postcss-cli](https://npm.io/package/postcss-cli.md) ^5.0.0

## Recent versions

- 1.1.6 (latest) — 2019-11-22
- 1.1.5 — 2019-11-22
- 1.1.4 — 2019-01-25
- 1.1.3 — 2019-01-23
- 1.1.2 — 2019-01-22
- 1.1.0 — 2019-01-22
- 1.0.6 — 2019-01-22
- 1.0.5 — 2019-01-21
- 1.0.4 — 2019-01-21
- 1.0.3 — 2019-01-21
- 1.0.2 — 2019-01-21
- 1.0.1 — 2019-01-21
- 1.0.0 — 2019-01-21

## README

![networcare Logo](http://www.networcare.de/wp-content/uploads/2013/11/logo.png)

<span style="padding-right:.5rem;">![](https://img.shields.io/github/license/rkruebel/samedo-badge.svg?style=plastic)</span>
<span style="padding-right:.5rem;">![](https://img.shields.io/github/issues/rkruebel/samedo-badge.svg?style=plastic)</span>
<span style="padding-right:.5rem;">[![npm version](https://badge.fury.io/js/samedo-badge.svg)](https://badge.fury.io/js/samedo-badge)</span>
<span style="padding-right:.5rem;">[![GitHub version](https://badge.fury.io/gh/rkruebel%2Fsamedo-badge.svg)](https://badge.fury.io/gh/rkruebel%2Fsamedo-badge)</span>
## samedo Badge
Das Plugin für den Badge benötigt [jQuery](https://code.jquery.com/).
### Installation des Plugins

Der Badge kann mittels verschiedenen Möglichkeiten installiert werden. Neben der klassischen Installation via HTMl gibt es auch die Möglichkeit über [github.com](https://github.com/rkruebel/samedo-badge) und [npmjs.com](https://www.npmjs.com/package/samedo-badge).


##### Installation via ```npm```:
```sh
npm install samedo-badge
```

##### Installation via ```github```:
```sh
git clone https://github.com/rkruebel/samedo-badge.git
```
### Einbinden des Plugin
Das Plugin binden Sie via `html` wiefolgt ein:

```javascript
<script src="https://cdn.samedo.de/samedo-badge.min.js"></script>
```
##### Einbindung via ```typo3```

Für die Einbindung bei Typo3 muss folgender Code verwendet werden:

```typescript
page.includeJSFooter.samedo = https://cdn.samedo.de/samedo-badge.min.js
page.includeJSFooter.samedo.external = 1
page.includeJSFooter.samedo.async = 0
```

---

##### Einbindung via ```WordPress```

Bei Wordpress Instanzen kann man unter der Pfadangabe
`wp-content/themes/function/functions.php` nach dem Bereich

```php
/*-----------------------------------------------------------------------------------*/
/* You can add custom functions below */
/*-----------------------------------------------------------------------------------*/
```

seine eigenen Funktionen wie im folgenden Code-Beispiel einbinden:

```php
function samedo_badge_js()
{
    wp_enqueue_script(
        'custom-js',
        'https://cdn.samedo.de/samedo-badge.min.js',
        false,
        null,
        true);
}
add_action('wp_enqueue_scripts','samedo_badge_js');
```
---
Damit das samedo Badge immer auf dem aktuellen Stand ist, was Updates
und die Behebung von Bugs betrifft, ist es erforderlich die EInbindung
der **Javascript-Datei** entsprechend dieser Anleitung vorzunehmen. Bei
einer lokalen Kopie des Scriptes kann keine Aktualisierung vorgenommen
werden.

### Funktionsweise

Das Plugin erstellt im oberen zentralen Bereich des Fensters einen Badge
mit dem samedo Logo und dem Link zum Onlineshop. Der Link verweist dabei
auf Ihre **Landing Page** im Onlineshop. Sobald Sie mit der Maus über
den Badge fahren wird dieser vergrößert dargestellt und Sie sehen ein
Angebot zum Onlineshop. Im rechten Teil unten finden Sie ein **X** zum
Schliessen des Badges und sobald Sie mit der Maus aus dem Angebot heraus
sind, zählt im oberen Bereich ein Countdown **3 Sekunden rückwärts** bis
das Badge automatisch wieder verkleinert wird. Auch wird bei
vergrößertem Badge die jeweilige **Partnerfirma** hinter den
**Onlineshop-Link** angezeigt.

### Anpassen des Angebotes

Wenn Sie ein eigenes Produkt über Ihren Badge angezeigt haben möchten,
so können Sie mit folgendem Code-Beispiel ihr indiviuelles Produkt aus
dem [samedo Onlineshop](https://www.samedo.de) anzeigen lassen.
Vorraussetzung ist die Angabe der Artikelnummer beginnend mit **SW**.
Sie finden die Artikelnummer auf der Produktdetailseite des Onlineshops
unterhalb des **Warenkorb Button**.

```javascript
<script type="text/javascript">
$(function() {
   samedoBadge.setProduct('SW13167'); 
});
</script>
```

### Änderung der Position des Badges
Die Position des Badges wird unter Angabe der ```position``` geändert:
```javascript
<script type="text/javascript">
$(function() {
   samedoBadge.setPosition({position:"top"}); 
});
</script>
```
Es kann auch folgende Schreibweise verwendet werden:
```javascript
<script type="text/javascript">
$(function() {
   samedoBadge.setPosition("bottom-right"); 
});
</script>
```
Mögliche Werte sind `top`, `top-left`, `top-right`, `bottom`, `bottom-left`, `bottom-right`, `left` oder `right`. Wenn Sie das Badge ohne diese Angaben einbinden bleibt das Badge standardmäßig auf der Position `top`. Bei den Positionen ```left``` und ```right``` wird der Text erst eingeblendet, sobald man mit der Maus über das Icon fährt.

#### jQuery Konflikt
Sollte es bei der Einbindung zu Problemen in Verbindung mit `jQuery` kommen, kann man auch folgende Anweisungen anstelle des `$-Zeichen` verwenden:
```javascript
<script>
    jQuery(function() {
       // ausgewählter Code für setPosition oder setProduct
    });
</script>
```

---
_Source: https://npm.io/package/samedo-badge · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._