Skip to content

Commit 99d95e7

Browse files
updated: doc
1 parent bccb320 commit 99d95e7

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,22 +76,29 @@ loadImages($('img', '.main-content'))
7676

7777
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
7878

79+
#### Table of Contents
80+
81+
- [loadImage](#loadimage)
82+
- [Parameters](#parameters)
83+
- [loadImages](#loadimages)
84+
- [Parameters](#parameters-1)
85+
7986
### loadImage
8087

8188
Preload any image
8289

83-
**Parameters**
90+
#### Parameters
8491

85-
- `img` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/HTML/Element))** Path to the image or image object
92+
- `img` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \| [HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element))** Path to the image or image object
8693

87-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** a promise that will be resolved when the image will be completely loaded
94+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** a promise that will be resolved when the image will be completely loaded
8895

8996
### loadImages
9097

9198
Load in parallel a collection of images
9299

93-
**Parameters**
100+
#### Parameters
94101

95-
- `imgs` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) \| [NodeList](https://developer.mozilla.org/en-US/docs/Web/API/NodeList))** array of strings or <img> HTML elements
102+
- `imgs` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array) \| [NodeList](https://developer.mozilla.org/docs/Web/API/NodeList))** array of strings or <img> HTML elements
96103

97-
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** a promise that will be resolved when all the images will be loaded
104+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** a promise that will be resolved when all the images will be loaded

0 commit comments

Comments
 (0)