From 563a1b5452e384a2142da5017195e01b51d31ca1 Mon Sep 17 00:00:00 2001 From: John Lewin Date: Sat, 11 Jan 2025 12:46:23 -0800 Subject: [PATCH 1/3] Update page titles to match file names - Resolves duplicate `CropperBackgroundImage` results in tree --- example/docs/components/CropperBackgroundWrapper.mdx | 2 +- example/docs/components/TransformableImage.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/example/docs/components/CropperBackgroundWrapper.mdx b/example/docs/components/CropperBackgroundWrapper.mdx index 012285db..51c205e3 100644 --- a/example/docs/components/CropperBackgroundWrapper.mdx +++ b/example/docs/components/CropperBackgroundWrapper.mdx @@ -1,5 +1,5 @@ --- -title: CropperBackgroundImage +title: CropperBackgroundWrapper --- :::note diff --git a/example/docs/components/TransformableImage.mdx b/example/docs/components/TransformableImage.mdx index 012285db..8955cdcd 100644 --- a/example/docs/components/TransformableImage.mdx +++ b/example/docs/components/TransformableImage.mdx @@ -1,5 +1,5 @@ --- -title: CropperBackgroundImage +title: TransformableImage --- :::note From 9777cb0248e0644617dabbed2031156836f2f8b2 Mon Sep 17 00:00:00 2001 From: John Lewin Date: Sat, 11 Jan 2025 13:08:50 -0800 Subject: [PATCH 2/3] Add component details from comp-hooks page --- example/docs/components/CircleStencil.mdx | 2 ++ example/docs/components/CropperBackgroundImage.mdx | 2 ++ example/docs/components/CropperBackgroundWrapper.mdx | 2 ++ example/docs/components/CropperCanvas.mdx | 2 ++ example/docs/components/RectangleStencil.mdx | 2 ++ example/docs/components/StretchableBoundary.mdx | 2 ++ example/docs/guides/components-and-hooks.mdx | 2 +- 7 files changed, 13 insertions(+), 1 deletion(-) diff --git a/example/docs/components/CircleStencil.mdx b/example/docs/components/CircleStencil.mdx index 932e1df0..75035e50 100644 --- a/example/docs/components/CircleStencil.mdx +++ b/example/docs/components/CircleStencil.mdx @@ -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. + ## Props diff --git a/example/docs/components/CropperBackgroundImage.mdx b/example/docs/components/CropperBackgroundImage.mdx index 012285db..818fa67e 100644 --- a/example/docs/components/CropperBackgroundImage.mdx +++ b/example/docs/components/CropperBackgroundImage.mdx @@ -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. ::: diff --git a/example/docs/components/CropperBackgroundWrapper.mdx b/example/docs/components/CropperBackgroundWrapper.mdx index 51c205e3..f3383fbc 100644 --- a/example/docs/components/CropperBackgroundWrapper.mdx +++ b/example/docs/components/CropperBackgroundWrapper.mdx @@ -2,6 +2,8 @@ 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. ::: diff --git a/example/docs/components/CropperCanvas.mdx b/example/docs/components/CropperCanvas.mdx index 854028c4..269f6c58 100644 --- a/example/docs/components/CropperCanvas.mdx +++ b/example/docs/components/CropperCanvas.mdx @@ -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. ::: diff --git a/example/docs/components/RectangleStencil.mdx b/example/docs/components/RectangleStencil.mdx index 57fc873c..15c2be7a 100644 --- a/example/docs/components/RectangleStencil.mdx +++ b/example/docs/components/RectangleStencil.mdx @@ -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. + ## Props diff --git a/example/docs/components/StretchableBoundary.mdx b/example/docs/components/StretchableBoundary.mdx index 2e355f4a..21a975e8 100644 --- a/example/docs/components/StretchableBoundary.mdx +++ b/example/docs/components/StretchableBoundary.mdx @@ -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. ::: diff --git a/example/docs/guides/components-and-hooks.mdx b/example/docs/guides/components-and-hooks.mdx index 2d9edb4f..7ab348a5 100644 --- a/example/docs/guides/components-and-hooks.mdx +++ b/example/docs/guides/components-and-hooks.mdx @@ -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` From a0f58c6f33f4ec20774fe2e45ea843ce6588e2de Mon Sep 17 00:00:00 2001 From: John Lewin Date: Sat, 11 Jan 2025 13:09:11 -0800 Subject: [PATCH 3/3] Revised Edit page url --- example/docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/example/docusaurus.config.js b/example/docusaurus.config.js index 9be05e13..44687fa2 100644 --- a/example/docusaurus.config.js +++ b/example/docusaurus.config.js @@ -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/', }, blog: { showReadingTime: true,