awesome-skeleton
Advanced tools
Skeleton generation tool
English | 简体中文
 zivyangll |
|---|
View online effects: Kaola cart:
$ npm i awesome-skeleton -g
$ npm i awesome-skeleton -D
skeleton.config.json:
{
"pageName": "baidu",
"pageUrl": "https://www.baidu.com",
"openRepeatList": false,
"device": "iPhone X",
"minGrayBlockWidth": 80,
"minGrayPseudoWidth": 10,
"debug": true,
"debugTime": 3000,
"cookies": [
{
"domain": ".baidu.com",
"expirationDate": 1568267131.555328,
"hostOnly": false,
"httpOnly": false,
"name": "BDORZ",
"path": "/",
"sameSite": "unspecified",
"secure": false,
"session": false,
"storeId": "0",
"value": "yyyyyyyyy",
"id": 2
}
]
}
$ skeleton -c ./skeleton.config.json
After the page DomReady, a red button appears at the top of the page: Start generating the skeleton screen.
After the build is complete, a skeleton-output file is generated in the run directory, which includes the skeleton screen png image, base64 text, and html file:
The html file can be used directly, copy the following location:
<html>
<head>
<!--- skeleton html code -->
</head>
</html>
note:
window.SKELETON && SKELETON.destroy();
Of course, you can also use the generated Base64 image directly in your project
Add a script to package.json :
"scripts": {
"skeleton": "skeleton -c ./skeleton.config.json"
}
Generate skeleton screen:：
$ npm run skeleton
If the page requires a login, you'll need to download the Chrome plugin [EditThisCookie] (https://chrome.google.com/webstore/detail/editthiscookie/fngmhnnpilhplaeedifhccceomclgfbg) to copy the cookie into the configuration parameters.
| Parameter Name | Required | Default | Description |
|---|---|---|---|
| pageUrl | Yes | - | Page address (this address must be accessible) |
| pageName | no | output | page name (English only) |
| cookies | no | page cookies to resolve login status issues | |
| OutputPath | no | skeleton-output | skeleton file output folder path, default to project skeleton-output |
| openRepeatList | no | true | by default will copy the first item of each list |
| device | no | empty for PC | reference puppeteer/DeviceDescriptors.js, can be set to 'iPhone 6 Plus' |
| debug | no | false | turn on debug switch |
| debugTime | No | 0 | Time in the debug mode, the page stays in the skeleton |
| minGrayBlockWidth | No | 0 | Minimum processing width of gray blocks |
| minGrayPseudoWidth | No | 0 | Minimum processing pseudo-class width |
This is the main point of obtaining a high-quality skeleton. By setting the following dom node attributes, some nodes are removed, ignored, and specified in the skeleton to remove the interference of redundant nodes, thus making the skeleton effect Get the best.
| Parameter Name | Description |
|---|---|
| data-skeleton-remove | Specifies the dom node properties to remove |
| data-skeleton-bgcolor | Specify the background color added in a dom node |
| data-skeleton-ignore | Specifies to ignore dom node properties without any processing |
| data-skeleton-empty | Set a dom's innerHTML to an empty string |
Example:
<div data-skeleton-remove><span>abc</span></div>
<div data-skeleton-bgcolor="#EE00EE"><span>abc</span></div>
<div data-skeleton-ignore><span>abc</span></div>
<div data-skeleton-empty><span>abc</span></div>
$ git clone git@github.com:kaola-fed/awesome-skeleton.git
$ cd awesome-skeleton && npm i
Since the code that generates the skeleton is inserted through dynamic scripts, the code in src/script needs to be packaged into src/script/dist/index.js by Rollup.
$ npm run dev
Modify the configuration in demo/index.js to generate a skeleton of the different pages:
$ cd demo
$ node index.js
FAQs
We found that awesome-skeleton demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh discusses the recent npm supply chain attacks on PodRocket, covering novel attack vectors and how developers can protect themselves.
Security News
Maintainers back GitHub’s npm security overhaul but raise concerns about CI/CD workflows, enterprise support, and token management.
Product
Socket Firewall is a free tool that blocks malicious packages at install time, giving developers proactive protection against rising supply chain attacks.