awesome-skeleton
Skeleton generation tool
English | 简体中文
Contributors
 zivyangll |
|---|
Effect preview
View online effects: Kaola cart:
Description
- skeleton generation component, only for the node side. This component provides two capabilities for skeleton generation and skeleton template injection.
- Skeletal diagram generation logic: Open the page address by using the Puppeteer headless browser by passing in the page address, perform gray background processing on the first screen image and text of the page, and then take a screenshot of the first screen of the page to generate a compressed base64 png image.
Installation
Global installation
$ npm i awesome-skeleton -gInstallation in the project
$ npm i awesome-skeleton -DInstructions
Adding a configuration file
skeleton.config.json:
Globally generated skeleton
$ skeleton -c ./skeleton.config.jsonAfter 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:
- base64-baidu.png # skeleton picture
- base64-baidu.txt # skeleton diagram Base64 encoding
- base64-baidu.html # Final HTML generationL
The html file can be used directly, copy the following location:
<!--- skeleton html code --> note:
- The skeleton is destroyed by default after onload event.
- Manual destruction method：
windowSKELETON && SKELETON;Of course, you can also use the generated Base64 image directly in your project
Creating a skeleton screen in the project
Add a script to package.json :
"scripts": {
"skeleton": "skeleton -c ./skeleton.config.json"
}
Generate skeleton screen:：
$ npm run skeletonSolve the login status
If the page requires a login, you'll need to download the Chrome plugin EditThisCookie to copy the cookie into the configuration parameters.
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 |
dom node attribute
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:
abcabcabcabcdevelopment
Installation dependencies
$ git clone git@github.com:kaola-fed/awesome-skeleton.git$ cd awesome-skeleton && npm iRunning the project
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 devModify the configuration in demo/index.js to generate a skeleton of the different pages:
$ cd demo$ node index.js