Skip to content

Latest commit

 

History

History
151 lines (105 loc) · 4.27 KB

README.md

File metadata and controls

151 lines (105 loc) · 4.27 KB
Raw

Peek.js

Tweet npm nuget license discussions Welcome coded by William Troup

🐛 A lightweight JavaScript library that attaches a viewer to a specific node type, allowing you to view the CSS properties, attributes, and size/position.

v1.8.1


Peek.js - CSS Mode Peek.js - Attribute Mode Peek.js - Size Mode Peek.js - Class Mode

What features does Peek.js have?

  • Zero-dependencies and extremely lightweight!
  • Written in TypeScript, allowing greater support for React, Angular, and other libraries!
  • Full API available via public functions.
  • 4 modes supported: CSS, Attributes, Size/Position, and Classes.
  • Fully configurable.
  • Edit CSS, Attribute, and Class values on the fly!
  • Exclude specific DOM elements by using the ignore attribute!
  • Show only the data you are interested in!
  • Copy, Paste, and Remove CSS, Attributes, and Classes!
  • Move the dialog away from the element to lock it!
  • Remove elements from the DOM.
  • Search your properties with ease (if more than 15 are available).


What browsers are supported?

All modern browsers (such as Google Chrome, FireFox, and Opera) are fully supported.

What are the most recent changes?

To see a list of all the most recent changes, click here.

How do I install Peek.js?

You can install the library with npm into your local modules directory using the following command:

npm install jpeek.js

Or, you can download the latest zipped up version here.

Or, you can also use the following CDN links:

https://cdn.jsdelivr.net/gh/williamtroup/Peek.js@1.8.1/dist/peek.min.js
https://cdn.jsdelivr.net/gh/williamtroup/Peek.js@1.8.1/dist/peek.js.min.css


How do I get started?

To get started using Peek.js, do the following steps:

1. Prerequisites:

Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows:

<!DOCTYPE html>

2. Include Files:

<link rel="stylesheet" href="dist/peek.js.css">
<script src="dist/peek.js"></script>

3. Start Viewing:

<script> 
  $peek.start( {
      nodeType: "button"
  } );
</script>

To see a list of all the available binding options you can use, click here.


4. Finishing Up:

That's it! Nice and simple. Please refer to the code if you need more help (fully documented).

How do I go about customizing Peek.js?

To customize, and get more out of Peek.js, please read through the following documentation.

1. Public Functions:

To see a list of all the public functions available, click here.

2. Configuration:

Configuration options allow you to customize how Peek.js will function. You can set them as follows:

<script> 
  $peek.setConfiguration( {
      dialogDisplayDelay: 500,
      text: {
        cssText: "CSS Properties"
      }
  } );
</script>

To see a list of all the available configuration options you can use, click here.