jPeek.js
1.0.0
See the version list below for details.
dotnet add package jPeek.js --version 1.0.0
NuGet\Install-Package jPeek.js -Version 1.0.0
<PackageReference Include="jPeek.js" Version="1.0.0" />
paket add jPeek.js --version 1.0.0
#r "nuget: jPeek.js, 1.0.0"
// Install jPeek.js as a Cake Addin #addin nuget:?package=jPeek.js&version=1.0.0 // Install jPeek.js as a Cake Tool #tool nuget:?package=jPeek.js&version=1.0.0
Peek.js v1.0.0
🐛 A lightweight JavaScript library that attaches a viewer to a specific node type, allowing you to view the CSS properties, attributes, and size/position.
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.
- 3 modes supported: CSS, Attributes, and Size/Position
- Fully configurable.
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
You can also use the following CDN links:
https://cdn.jsdelivr.net/gh/williamtroup/Peek.js@1.0.0/dist/peek.min.js
https://cdn.jsdelivr.net/gh/williamtroup/Peek.js@1.0.0/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
} );
</script>
To see a list of all the available configuration options you can use, click here.
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.