docs: add docs

datocms · Jan 2, 2022 · a36b558 · a36b558
1 parent 4e8dbce
commit a36b558
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -247,8 +247,10 @@ export default withQuery(query)(Page);
 | fadeInDuration        | integer                  | :x:                | Duration (in ms) of the fade-in transition effect upoad image loading                                                                                                                                                                                                                         | 500               |
 | intersectionThreshold | float                    | :x:                | Indicate at what percentage of the placeholder visibility the loading of the image should be triggered. A value of 0 means that as soon as even one pixel is visible, the callback will be run. A value of 1.0 means that the threshold isn't considered passed until every pixel is visible. | 0                 |
 | intersectionMargin    | string                   | :x:                | Margin around the placeholder. Can have values similar to the CSS margin property (top, right, bottom, left). The values can be percentages. This set of values serves to grow or shrink each side of the placeholder element's bounding box before computing intersections.                  | "0px 0px 0px 0px" |
-| lazyLoad              | Boolean                  | :x:                | Wheter enable lazy loading or not                                                                                                                                                                                                                                                             | true              |
-| explicitWidth         | Boolean                  | :x:                | Wheter the image wrapper should explicitely declare the width of the image or keep it fluid                                                                                                                                                                                                   | false             |
+| lazyLoad              | Boolean                  | :x:                | Whether enable lazy loading or not                                                                                                                                                                                                                                                            | true              |
+| explicitWidth         | Boolean                  | :x:                | Whether the image wrapper should explicitely declare the width of the image or keep it fluid                                                                                                                                                                                                  | false             |
+| onLoad                | () => void               | :x:                | Function triggered when the image has finished loading                                                                                                                                                                                                                                        | undefined         |
+| usePlaceholder        | Boolean                  | :x:                | Whether the component should use a blurred image placeholder                                                                                                                                                                                                                                  | true              |
 
 ### The `ResponsiveImage` object
 

diff --git a/src/Image/index.tsx b/src/Image/index.tsx
@@ -61,7 +61,7 @@ type ImagePropTypes = {
   explicitWidth?: boolean;
   /** Triggered when the image finishes loading */
   onLoad?(): void;
-  /** Whether the image should use a blurred image placeholder */
+  /** Whether the component should use a blurred image placeholder */
   usePlaceholder?: boolean;
 };