CreatechStudio / TurnRight

TurnRight

A lightweight HTML5 redirection tag.

Download & Import
1. Download
  
  Download from official page or release page.
2. Import
  1. Online
    
    Insert the following codes between the <head> tags.
```
<script src="https://www.atatc.net/turnright/turn-right.js"></script>
```
  2. Offline
    
    For example, save the .js file as assets/js/turn-right.js, and insert the following codes between the <head> tags.
```
<script src="assets/js/turn-right.js"></script>
```
Properties
1. Url
  
  Use property url to specify the target url you want to redirect to. For example, I want to redirect to https://www.atatc.net, I can code like this:
```
<turn-right url="https://www.atatc.net"></turn-right>
```
  The protocol names like http:// or https:// are dispensable. If not sepcified, it will be regarded as https://.
2. Wait
  1. Redirect Immediately
    
    See demo-immediately.html or visit online demo page for the actual effect.
    
    To redirect immediately, having loaded the page, specify property wait as false.
```
<turn-right url="(e.g) https://www.atatc.net" wait=false></turn-right>
```
    Property wait can be either boolean or boolean-string. It's set as true defaultly.
    
    However, in this case, only the first <turn-right> in the entire page will be triggered.
  2. Redirect after clicking
    
    See demo-afterclicking.html or visit online demo page for the actual effect.
    
    To redirect after an action, set an id and optionally specify property wait as true.
```
<turn-right id="tr_a" url="(e.g) https://www.atatc.net"></turn-right>
```
    or
```
<turn-right id="tr_a" url="(e.g) https://www.atatc.net" wait=true></turn-right>
```
    Then trigger the redirection through JavaScript when needed.
```
let tr_a = document.getElementById("tr_a");
tr_a.turnRight();
```
3. Pass
  
  Introduced in version 0.0.2.
  
  If you don't want a tag to be activated, set property pass as true.
```
<turn-right url="(e.g) https://www.atatc.net" pass=true></turn-right>
```
  Property pass can be either boolean or boolean-string. It's set as false defaultly.

About

GNU General Public License v3.0

Languages

Language:JavaScript 74.3%Language:HTML 25.7%