Skip to content

Small documentation update #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jlewin wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Small documentation update #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
563a1b5
Update page titles to match file names
jlewin Jan 11, 2025
9777cb0
Add component details from comp-hooks page
jlewin Jan 11, 2025
a0f58c6
Revised Edit page url
jlewin Jan 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions example/docs/components/CircleStencil.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_position: 3

import TOCInline from "@theme/TOCInline";

Used to display the current cropped area and change it by interaction with it.
Copy link
Author

@jlewin jlewin Jan 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simple high level details when landing on the components pages might help new users with the learning curve. Details sourced from existing content in components-and-hooks.mdx


<TOCInline toc={toc} />

## Props
Expand Down
2 changes: 2 additions & 0 deletions example/docs/components/CropperBackgroundImage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: CropperBackgroundImage
---

This component is used to display cropper image. It's recommended to use it to display the image, because it handle transforms and transitions internally in the convenient way.

:::note
This section has not been documented yet. Stay up to date.
:::
4 changes: 3 additions & 1 deletion example/docs/components/CropperBackgroundWrapper.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: CropperBackgroundImage
title: CropperBackgroundWrapper
---

This component that wraps cropper background and stencil. It processes touch and mouse events to transform image.

:::note
This section has not been documented yet. Stay up to date.
:::
2 changes: 2 additions & 0 deletions example/docs/components/CropperCanvas.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: CropperCanvas
---

This component is the auxiliary component to draw the cropped area on canvas.

:::note
This section has not been documented yet. Stay up to date.
:::
2 changes: 2 additions & 0 deletions example/docs/components/RectangleStencil.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_position: 2
---
import TOCInline from "@theme/TOCInline";

Used to display the current cropped area and change it by interaction with it.

<TOCInline toc={toc} />

## Props
Expand Down
2 changes: 2 additions & 0 deletions example/docs/components/StretchableBoundary.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: StretchableBoundary
---

This component is the auxiliary component that gives the possibility to stretch it easily to the image size. It's very conveniently for adaptive croppers.

:::note
This section has not been documented yet. Stay up to date.
:::
2 changes: 1 addition & 1 deletion example/docs/components/TransformableImage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: CropperBackgroundImage
title: TransformableImage
Copy link
Author

@jlewin jlewin Jan 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There were previously three "CropperBackgroundImage" components in the tree. These title changes correct the confusing duplication

---

:::note
Expand Down
2 changes: 1 addition & 1 deletion example/docs/guides/components-and-hooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ This component wraps the cropper itself. It can be used to inject some content i

#### `CropperBackgroundWrapper`

This component that wraps cropper background and stencil. It process touch and mouse events to transform image.
This component that wraps cropper background and stencil. It processes touch and mouse events to transform image.

#### `CropperBackground`

Expand Down
2 changes: 1 addition & 1 deletion example/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ require('dotenv').config();
docs: {
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
editUrl: 'https://github.com/facebook/docusaurus/edit/main/website/',
editUrl: 'https://github.com/advanced-cropper/react-advanced-cropper/tree/master/example/',
Copy link
Author

@jlewin jlewin Jan 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not yet able to test and verify this fixes the Edit this page link but it seems correct and works if a simple replace operation is performed on the redirect url, using the old and new editUrl values

},
blog: {
showReadingTime: true,
Expand Down