Giter Club home page Giter Club logo

fin-tag's Introduction

Fin Tag

npm version

Overview

Give anchor tags the ability to launch the OpenFin powered version of your app.

Usage

fin-tag can be used as a node module, or inlcuded as a script tag.

Node Module

npm install --save fin-tag
const enableFinTags = require('fin-tag');
enableFinTags();

Script Tag

// Note: This is the equivalent of the two lines above; the script tag will call enableFinTags
<script src="https://dcchuck.github.io/fin-tag/dist/fin-tag.js"></script>

How

For the relevant anchor tags, add a data-manifest attribute targeting your app.json using the fin or fins protocol.

<a href="https://yourwebapp.com" data-manifest="fins://yourapp.json">Launch</a>

enableFinTags() queries the document for anchor tags that have set the data-manifest attribute. It attempts to open the manifest link via the custom protocol handlers provided by OpenFin's RVM. If the protocol is not supported, it will navigate to the href, the default anchor tag behavior. Inlcuding the script tag will make the call to enableFinTags for your document.


This package is based on custom-protocol-detection

Building

git clone https://github.com/dcchuck/fin-tag
npm install
npm run build

The hostable javascript file will be output as dist/fin-tag.js

For your convenience, the minified file is hosted via gh-pages

fin-tag's People

Contributors

dcchuck avatar dependabot[bot] avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.