# tagknight

> tagknight for web apps

Latest version **1.0.3** (published 2017-01-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install tagknight
pnpm add tagknight
yarn add tagknight
bun add tagknight
```

## 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.0.3 |
| Published | 2017-01-06 |
| First published | 2017-01-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | seki |
| Maintainers | f81 |

## Links

- npm: https://www.npmjs.com/package/tagknight
- npm.io page: https://npm.io/package/tagknight

## Recent versions

- 1.0.3 (latest) — 2017-01-06
- 1.0.2 — 2017-01-06
- 1.0.1 — 2017-01-06
- 1.0.0 — 2017-01-06

## README

# Tagknight

- SPAルータ向けTagKnightモジュール

## 注意事項
- サイト内遷移でのリファラ条件発火は行うことが出来ません。リファラ条件発火を利用できるのはサイト流入前のページ判定のみとなります。

## 利用方法 

#### インストール 

```bash
npm i -S tagknight
```

#### インスタンスの初期化

- サイト内でTagKnightを扱うに当たっての初期設定を行います。
- アプリケーションライフサイクルの中で１回だけ実行すれば良いものです。

```js
// 実行例
var TagKnight = require('tagknight');
var tkInstance = new TagKnight({mtuId: 'abcdefgh', targetId: 'container-elm'});
```

- コンストラクタ引数
    - mtuId: TagKnightタグの`window.mtuId=`の右辺の文字列を指定します。
    - targetId: TagKnightに登録したタグを出力するHTML親要素の`id` 属性を指定します。JavaScriptが書き出すHTML要素ではなく、元のHTMLファイルに定義された要素を指定します。

#### 外部タグ発火

- TagKnightに登録したタグを受取り、ページに挿入を行う
- 各ページの初期化処理(React.componentDidMount等)で実行します。
- SPAルータのページ遷移によって外部タグを呼び出す際、前回呼び出した親要素内の既存外部タグは自動的に破棄されます。

```js
// 実行例(React)
componentDidMount: function() {
  ...
  tkInstance.run();
}
```

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