lxm_front/eruda
1
0
Fork 0
mirror of https://github.com/liriliri/eruda.git synced 2026-03-20 09:38:37 +08:00
Code Issues Projects Releases Wiki Activity

Dev: Tool api doc

Browse Source
This commit is contained in:
surunzi
2016-12-31 19:06:07 +08:00
parent c3738be312
commit dbccb62173
1 changed files with 35 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
doc/TOOL_API.md
View File

@@ -66,17 +66,45 @@ console.html('<span style="color:red">Red</span>');
## Elements
Check dom element status.
### Config
|Name |Type |Desc |
|-------------------|-------|---------------------|
|overrideEventTarget|boolean|Catch Event Listeners|
## Network
Display performance timing, resource timing and xhr requests.
### Config
|Name |Type |Desc |
|------------------|-------|--------------------------|
|disablePerformance|boolean|Disable Performance Timing|
|hideXhrResource |boolean|Hide Xhr Resource Timing |
|overrideXhr |boolean|Catch Xhr Requests |
## Resources
LocalStorage, sessionStorage, cookies, scripts, styleSheets and images.
### Config
|Name |Type |Desc |
|----------------|-------|------------------|
|hideErudaSetting|boolean|Hide Eruda Setting|
## Sources
View json, html, js, css and http request detail.
## Info
Display special information, could be used for displaying user info to track
Display special information, could be used for displaying user info to track
user logs.
By default, page url and browser user agent is shown.
### clear
@@ -127,7 +155,7 @@ Add Snippet.
|desc|string |Snippet description |
```javascript
snippets.add('hello', function ()
snippets.add('hello', function ()
{
console.log('Hello World!');
}, 'Display hello on console');
@@ -147,10 +175,12 @@ snippets.remove('hello');
## Features
Browser feature detections, thanks to
Browser feature detections, thanks to
[modernizr](https://github.com/Modernizr/Modernizr) project.
Red means unsupported, otherwise ok. All buttons is linked directly to
Red means unsupported, otherwise ok. All buttons is linked directly to
related materials in [Can I Use](http://caniuse.com/) website.
## Settings
Customization for all tools.