Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Latest commit

 

History

History
56 lines (40 loc) · 2.33 KB

README.md

File metadata and controls

56 lines (40 loc) · 2.33 KB

F-Twelve

License js-standard-style Framework

In-DOM dev tools for troubleshooting environments that do not have the usual F12 dev console. Currently supports a Console and Network tab. The tool is designed to be included in Production code. Features include:

  • Automatically starts hidden and is attached to the DOM via JS or keyboard shortcut.
  • Provides callbacks for when attaching to the DOM. This could be used, for example, to use F-Twelve's "debug hotkey" to enable additional "debug mode" features in the consuming application.
  • Can be used as an ES import or global via HTML Tag.

Usage

npm install f-twelve --save-dev

Include dist/f-twelve.js. and dist/f-twelve.css in your web application. To view the tool, press Ctrl+F12 or call fTwelve.show(). A demo page with examples of the API can be found in demo/index.html. See it live at https://engineering.cerner.com/f-twelve/demo/.

The tool can be enabled via ES6 Import or HTML Tag:

ES6 Import

See webpack.config.js for example of required CSS loaders.

import "f-twelve";

HTML Tag

JS

<script src="./node_modules/f-twelve/dist/f-twelve.js"></script>

CSS:

<link rel="stylesheet" href="./node_modules/f-twelve/dist/f-twelve.css"/>

Initialization

Once the JS script is included, no further configuration is required. It will be hidden and waiting for the Ctrl+F12 keyboard shortcut. There is also a global fTwelve object available with an API.

Demo Page

The Demo Page demonstrates the tool's functionality and contains the documentation for the API. The following URL can be used to load the demo for any branch (dist files must be built and pushed). Replace BRANCH_NAME with the desired branch name:

https://combinatronics.com/cerner/f-twelve/BRANCH_NAME/demo/index.html