Skip to content

Commit bb12080

Browse files
committed
apply feedback
1 parent b50976a commit bb12080

File tree

16 files changed

+29
-28
lines changed

16 files changed

+29
-28
lines changed

docs/api/focal-point.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: FocalPoint
33
---
44

5-
The `FocalPoint` is the TypeScript interface that represents the focal point X and Y coordinates in percentage.
5+
The `FocalPoint` is a TypeScript interface that represents the X and Y coordinates of the focal point in percent.
66

77
:::note
88

9-
You can see the default value in [Props section](image-focal-point/#props).
9+
You can check the default value in [Props section](image-focal-point/#props).
1010

1111
:::
1212

docs/api/image-focal-point-props.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The `ImageFocalPointProps` is the TypeScript interface used by the [ImageFocalPo
66

77
:::note
88

9-
You can see the default values in [Props section](image-focal-point/#props).
9+
You can check the default values in [Props section](image-focal-point/#props).
1010

1111
:::
1212

@@ -26,7 +26,7 @@ export interface ImageFocalPointProps {
2626

2727
## Example of use
2828

29-
The intention of exporting this interface is to be able to use it in other components, for example as a wrapper. The following example shows how to use the `ImageFocalPointProps` interface in a TypeScript project.
29+
The goal of exporting this interface is to be able to use it in other components, for example as a wrapper. The following example shows how to use the `ImageFocalPointProps` interface in a TypeScript project.
3030

3131
```tsx title="wrapper.tsx" showLineNumbers
3232
import React from 'react';

docs/api/image-focal-point.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ImageFocalPoint (Component)
33
---
44

5-
The ImageFocalPoint component is the main file of the library. It is a wrapper of the HTML image element that allows you to drag and drop the focal point button on the image.
5+
The ImageFocalPoint component is the main file of the library. It is a wrapper of the HTML image element that allows you to drag and drop a focal point button on top of the image element.
66

77
## Internal HTML structure
88

docs/examples/basic-with-apply.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Basic example, apply button
55
import Tabs from '@theme/Tabs';
66
import TabItem from '@theme/TabItem';
77

8-
This example is quite similar to the [basic example](basic), but instead of applying the changes real time, the user has to click on an 'apply' button to see the updates reflected.
8+
This example is quite similar to the [basic example](basic), but instead of applying the changes in real time, the user has to click on an 'apply' button to see the updates reflected.
99

1010
## Live example
1111

docs/examples/basic.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Basic
55
import Tabs from '@theme/Tabs';
66
import TabItem from '@theme/TabItem';
77

8-
Minimum example, here you can just drag the focal point and the example pictures focal point will be updated on real time.
8+
Minimal example, here you can just drag the focal point and the example pictures focal point will be updated on real time.
99

1010
## How to apply this feature in your code
1111

@@ -37,7 +37,7 @@ const App = () => {
3737
<ImageFocalPoint
3838
src="your-image-src"
3939
onChange={focalPoint => {
40-
// Whatever you want to do when the user clicks on the image
40+
// Add here your code to do whatever you want to when the user drags on the focal point
4141
}}
4242
/>
4343
// highlight-end

docs/examples/controlled.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ const App = () => {
2323
<ImageFocalPoint
2424
src="your-image-src"
2525
onChange={newFocalPoint => {
26-
// Whatever you want to do when the user clicks on the image
26+
// Add here your code to do whatever you want to when the user drags on the focal point
2727
}}
2828
/>
2929
// highlight-end

docs/examples/styled.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Styled
55
import Tabs from '@theme/Tabs';
66
import TabItem from '@theme/TabItem';
77

8-
This example shows how to provide styles to the image focal point component.
8+
This example shows how to override the standard component styles with your custom ones and apply them to the image focal point component.
99

1010
## How to apply this feature in your code
1111

@@ -20,7 +20,7 @@ const App = () => {
2020
<ImageFocalPoint
2121
src="your-image-src"
2222
onChange={newFocalPoint => {
23-
// Whatever you want to do when the user clicks on the image
23+
// Add here your code to do whatever you want to when the user drags on the focal point
2424
}}
2525
/>
2626
);
@@ -51,7 +51,7 @@ const App = () => {
5151
+ className="image-focal-point"
5252
src="your-image-src"
5353
onChange={(newFocalPoint) => {
54-
// Whatever you want to do when the user clicks on the image
54+
// Add here your code to do whatever you want to when the user drags on the focal point
5555
}}
5656
/>
5757
);
@@ -97,7 +97,7 @@ const App = () => {
9797
+ }}
9898
src="your-image-src"
9999
onChange={(newFocalPoint) => {
100-
// Whatever you want to do when the user clicks on the image
100+
// Add here your code to do whatever you want to when the user drags on the focal point
101101
}}
102102
/>
103103
);

docs/examples/webpack-entry-point.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Webpack entry point
55
import Tabs from '@theme/Tabs';
66
import TabItem from '@theme/TabItem';
77

8-
This example is the same as the [basic example](basic), but using the webpack entry point to import the library styles.
8+
This example is the same as the [basic example](basic), but using webpack entry point in order to import the library (you can use the entry section of your _webpack.config.js_ and add there the path to the library css file instead of having to add it in your main HTML / JS file in your app.
99

1010
## How to apply this feature in your code
1111

@@ -20,7 +20,7 @@ const App = () => {
2020
<ImageFocalPoint
2121
src="your-image-src"
2222
onChange={newFocalPoint => {
23-
// Whatever you want to do when the user clicks on the image
23+
// Add here your code to do whatever you want to when the user drags on the focal point
2424
}}
2525
/>
2626
);

docs/getting-started.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ const App = () => {
4545
<ImageFocalPoint
4646
src="your-image-src" // Same src as <img> HTML element
4747
onChange={focalPoint => {
48-
// Whatever you want to do when the user clicks on the image
48+
// Add here your code to do whatever you want to when the user drags on the focal point
4949
}}
5050
/>
5151
// highlight-end
@@ -80,7 +80,7 @@ const App = () => {
8080
<ImageFocalPoint
8181
src="your-image-src" // Same src as <img> HTML element
8282
onChange={focalPoint => {
83-
// Whatever you want to do when the user clicks on the image
83+
// Add here your code to do whatever you want to when the user drags on the focal point
8484
}}
8585
/>
8686
);

examples/basic-with-apply/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Basic example, apply button
22

3-
This example is quite similar to the [basic example](https://github.com/Lemoncode/react-image-focal-point/tree/main/examples/basic), but instead of applying the changes real time, the user has to click on an 'apply' button to see the updates reflected.
3+
This example is quite similar to the [basic example](https://github.com/Lemoncode/react-image-focal-point/tree/main/examples/basic), but instead of applying the changes in real time, the user has to click on an 'apply' button to see the updates reflected.
44

55
<a target="_blank" href="https://stackblitz.com/github/Lemoncode/react-image-focal-point/tree/main/examples/basic-with-apply">
66
<img

0 commit comments

Comments
 (0)