Skip to content

Commit 7acb9cb

Browse files
Merge pull request #2341 from syncfusion-content/EJ2-1009416-vue-hf
1009416: Vue documentation revamp in hotfix
2 parents 6edcd29 + f9094ac commit 7acb9cb

125 files changed

Lines changed: 1371 additions & 1529 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Document-Processing/PDF/PDF-Viewer/vue/Redaction/mobile-view.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ documentation: ug
99

1010
# Redaction in Mobile View in Vue PdfViewer Component
1111

12-
The Redaction Tool enables users to permanently mark and remove sensitive content from PDF documents in mobile view using the Vue PdfViewer component. This feature is optimized for touch interactions and provides a streamlined redaction workflow specifically designed for mobile devices.
12+
The Redaction Tool enables permanent marking and removal of sensitive content from PDF documents in mobile view using the Vue PdfViewer component. This feature is optimized for touch interactions and provides a streamlined redaction workflow specifically designed for mobile devices.
1313

1414
![Redaction in Mobile View](./redaction-annotations-images/redaction-mobile-view.png)
1515

16-
N> In mobile view, the redaction toolbar appears at the bottom of the viewer for easy thumb access. Mobile layout activates automatically on small screens.
16+
N> In mobile view, the redaction toolbar appears at the bottom of the viewer for easy thumb access. The mobile layout activates automatically on small screens.
1717

1818
## Adding Redaction in Mobile View
1919

@@ -110,11 +110,10 @@ When you enter redaction mode in mobile view, a specialized redaction toolbar ap
110110

111111
### Redaction Annotation Tool
112112

113-
The Redaction Annotation tool is the primary redaction feature that allows you to draw redaction rectangles on specific content:
113+
The Redaction Annotation tool is the primary redaction feature that allows drawing redaction rectangles on specific content.
114114

115-
Function: Creates visual redaction annotations that mark content for permanent removal
116-
Usage:
117-
Touch and drag to draw rectangular redaction overlays on any content area.
115+
Function: Creates visual redaction annotations that mark content for permanent removal.
116+
Usage: Touch and drag to draw rectangular redaction overlays on any content area.
118117

119118
Process:
120119
- Selected content appears with a customizable overlay (default black)
@@ -129,8 +128,8 @@ The Page Redaction tool enables batch redaction of entire pages based on specifi
129128

130129
![Page Redaction Tool](./redaction-annotations-images/page-redaction-annot.png)
131130

132-
Function: Redacts complete pages or page ranges with a single action
133-
Options Available:
131+
Function: Redacts complete pages or page ranges with a single action.
132+
Options available:
134133
- Odd Pages: Redacts only odd-numbered pages (1, 3, 5, etc.)
135134
- Even Pages: Redacts only even-numbered pages (2, 4, 6, etc.)
136135
- Specific Page: Specify single pages, ranges (e.g., 1-5, 10-15), or comma-separated lists (e.g., 1,3,5-7)
@@ -148,7 +147,7 @@ The Redaction Properties tool allows customization of redaction appearance befor
148147
![Redaction Properties Mobile View](./redaction-annotations-images/redaction-properties-annot.png)
149148

150149
Function: Customize the visual appearance of redaction overlays and text replacement
151-
Customizable Properties:
150+
Customizable properties:
152151
- Fill Color: Change the redaction overlay color (default: black)
153152
- Outline Color: Set outline color for redaction boxes (optional)
154153
- Overlay Text: Add custom text to appear on redacted areas (e.g., "REDACTED", "CONFIDENTIAL")

Document-Processing/PDF/PDF-Viewer/vue/Redaction/overview.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ domainurl: ##DomainURL##
1010

1111
# Redaction in Vue PdfViewer
1212

13-
Redaction annotations are used to hide confidential or sensitive information in a PDF. The Syncfusion Vue PDF Viewer (EJ2) lets you mark areas or entire pages for redaction, customize their appearance, and permanently apply them with a single action.
13+
Redaction annotations hide confidential or sensitive information in a PDF. The Syncfusion Vue PDF Viewer (EJ2) enables marking regions or entire pages for redaction, customizing appearance, and permanently applying redaction with a single action.
1414

1515
## Enable the redaction toolbar
1616

@@ -100,49 +100,47 @@ export default {
100100
{% endhighlight %}
101101
{% endtabs %}
102102

103-
N> Prerequisites: Add the PdfViewer control to your Vue application and ensure the redaction feature is available in the version you are using. Once applied, redaction permanently removes the selected content.
103+
N> Add the PdfViewer control to the Vue application and ensure the redaction feature is included in the installed package version. Once applied, redaction permanently removes the selected content.
104104

105105
![Toolbar with the Redaction tool highlighted](redaction-annotations-images/redaction-icon-toolbar.png)
106106

107107
## Add Redaction Annotations
108108

109-
You can mark specific content for redaction using the toolbar or through code.
109+
Mark specific content for redaction using the toolbar or programmatically.
110110

111-
Select the **Redaction tool** and draw over the text or graphics you want to hide. You can also add overlay text (such as “Confidential”) and adjust the style fill color, border color, and opacity.
111+
Select the **Redaction tool** and draw over text or graphics to hide. Optionally add overlay text (for example, “Confidential”) and adjust style properties: fill color, border color, and opacity.
112112

113113
![Drawing a redaction region over page content](redaction-annotations-images/adding-redaction-annotation.png)
114114

115115
## Delete Redaction Annotations
116116

117-
Redaction annotations can be removed easily:
117+
Remove redaction annotations using the toolbar or keyboard shortcuts:
118118

119-
- Click the **Delete** button on the toolbar, or
119+
- Click the **Delete** button on the toolbar, or
120120
- Select the annotation and press the **Delete** key.
121121

122122
![Toolbar showing the Delete command for redaction](redaction-annotations-images/redaction-delete-icon.png)
123123

124124
## Redact Entire Pages
125125

126-
The viewer allows you to redact whole pages that contain sensitive information. You can choose specific pages, page ranges, or redact all pages using the built‑in dialog, or perform the same action programmatically.
126+
The viewer supports redacting entire pages that contain sensitive information. Use the built-in dialog to select specific pages, page ranges, or all pages, or invoke the same behavior programmatically.
127127

128128
![Toolbar showing the Redact Page option](redaction-annotations-images/redact-page-icon.png)
129129

130130
## Apply Redaction
131131

132-
Once annotations are added, you can permanently apply them to the document. This action cannot be undone.
133-
134-
Use the **Apply Redaction** button on the toolbar or call the API method:
132+
After adding redaction annotations, permanently apply them to the document using the **Apply Redaction** toolbar button or the corresponding API method.
135133

136134
- The button is disabled until at least one redaction annotation exists.
137135
- It becomes active when redaction annotations are present.
138136

139137
![Toolbar showing the Apply Redaction button](redaction-annotations-images/redact-button-icon.png)
140138

141-
A confirmation dialog appears before applying redaction to ensure you acknowledge the irreversible nature of the process.
139+
A confirmation dialog appears before applying redaction to ensure acknowledgement of the irreversible action.
142140

143141
![Confirmation dialog for applying redaction](redaction-annotations-images/apply-redaction-dialog.png)
144142

145-
N> After redaction is applied, the original content cannot be recovered.
143+
N> Applying redaction is irreversible. Once applied, the original content cannot be recovered.
146144

147145
## Comment Support
148146

Document-Processing/PDF/PDF-Viewer/vue/Redaction/programmatic-support.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Programmatic support for redaction in Vue PdfViewer
1111

12-
The Syncfusion Vue PDF Viewer provides APIs to add, update, delete, and apply redaction annotations programmatically. You can also redact entire pages, configure default properties, and work with the redaction property panel.
12+
The Syncfusion Vue `PdfViewer` control provides APIs to add, update, delete, and apply redaction annotations programmatically. You can also redact entire pages, configure default properties, and work with the redaction property panel.
1313

1414
## Enable the redaction toolbar
1515

@@ -216,7 +216,7 @@ export default {
216216

217217
## Delete redaction annotations programmatically
218218

219-
Redaction annotations can be removed using the `deleteAnnotationById` event or by selecting and deleting them through code.
219+
Redaction annotations can be removed using the `deleteAnnotationById` method or by selecting and deleting them through code.
220220

221221
{% tabs %}
222222
{% highlight html tabtitle="App.vue" %}
@@ -621,7 +621,7 @@ export default {
621621
{% endhighlight %}
622622
{% endtabs %}
623623

624-
N> Applying redaction is irreversible. Once applied, the original content cannot be recovered.
624+
N> Applying redaction is irreversible. Before calling `redact()`, save or export a backup copy of the document; the original content cannot be recovered.
625625

626626
## Configure default redaction annotation properties
627627

@@ -729,7 +729,7 @@ export default {
729729

730730
The redaction property panel allows users to update annotation properties through the UI. Programmatically, you can invoke the property panel by selecting an annotation and calling the relevant APIs. Properties such as overlay text, font style, and fill color can be updated directly in the panel.
731731

732-
![Redaction Property Panel](../redaction/redaction-annotations-images/redaction-property-panel-icon.png)
732+
![Redaction property panel showing overlay text and color options](../redaction/redaction-annotations-images/redaction-property-panel-icon.png)
733733

734734
## See also
735735

Document-Processing/PDF/PDF-Viewer/vue/Redaction/search-redact.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,17 @@ documentation: ug
88
domainurl: ##DomainURL##
99
---
1010

11-
# Search text and redact in Vue PdfViewer
11+
# Search text and redact in Vue PDF Viewer
1212

13-
You can search for a keyword in the loaded PDF and automatically add redaction annotations over each match. The example below wires the extractTextCompleted event, triggers text extraction, performs a search, and places redaction annotations for every result.
13+
You can search for a keyword in the loaded PDF and automatically add redaction annotations over each match. The example below wires the `extractTextCompleted` event, triggers text extraction, performs a search, and places redaction annotations for every result.
1414

15-
N> Prerequisites: Add the PdfViewer control to your Vue application and ensure a document is loaded. Make sure the redaction feature is available in the version you are using. Once applied, redaction permanently removes the selected content.
15+
N> Prerequisites: Add the PDF Viewer control to your Vue application and ensure a document is loaded. Confirm the redaction feature is available in the viewer version in use and that text extraction is enabled (`isExtractText: true`). Redaction is permanent once applied.
1616

17-
## Steps to add Redaction annotations on search Text Bounds
17+
## Steps to add redaction annotations on search text bounds
1818

19-
**Step 1:** Follow the steps provided in the [link](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/Vue/getting-started) to create a simple PDF Viewer sample.
19+
**Step 1:** Follow the steps in [PDF Viewer - Getting started](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/vue/getting-started) to create a simple PDF Viewer sample.
2020

21-
22-
**Step 2:** Use the following code-snippets to Add Redaction annotation on Search Text Bounds.
21+
**Step 2:** Use the following code snippets to add redaction annotations to search text bounds.
2322

2423
{% tabs %}
2524
{% highlight html tabtitle="App.vue" %}

Document-Processing/PDF/PDF-Viewer/vue/Redaction/toolbar.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ documentation: ug
99

1010
# Redaction toolbar customization in Vue
1111

12-
The redaction toolbar in the Syncfusion Vue PDF Viewer can be customized by rearranging existing items, hiding default items, or adding new ones. You can also place custom items at specific index positions among the existing toolbar items.
12+
The redaction toolbar in the Syncfusion Vue PDF Viewer can be customized by rearranging items, hiding default items, or adding custom items. Custom items can be inserted at specific index positions within the existing toolbar.
1313

1414
## Enable the redaction toolbar
1515

16-
To enable the redaction toolbar, configure the `toolbarSettings.toolbarItems` property of the PdfViewer instance to include the **RedactionEditTool**.
16+
To enable the redaction toolbar, configure the `toolbarSettings.toolbarItems` property of the PdfViewer instance to include the `RedactionEditTool`.
1717

1818
The following example shows how to enable the redaction toolbar:
1919

@@ -105,17 +105,17 @@ Refer to the following image for the toolbar view:
105105

106106
## Show or hide the redaction toolbar
107107

108-
You can toggle the redaction toolbar either using the built‑in toolbar icon or programmatically with the `showRedactionToolbar` method.
108+
The redaction toolbar can be toggled using the built‑in toolbar icon or programmatically with the `showRedactionToolbar` method.
109109

110110
### Display the redaction toolbar using the toolbar icon
111111

112-
When **RedactionEditTool** is included in the toolbar settings, clicking the redaction icon in the primary toolbar will show or hide the redaction toolbar.
112+
When `RedactionEditTool` is included in the toolbar settings, clicking the redaction icon in the primary toolbar will show or hide the redaction toolbar.
113113

114114
![Show redaction toolbar from the primary toolbar](../redaction/redaction-annotations-images/redaction-icon-toolbar.png)
115115

116116
### Display the redaction toolbar programmatically
117117

118-
You can also control visibility through code by calling `viewer.toolbar.showRedactionToolbar(true/false)`.
118+
Programmatic control is available via the viewer instance. For example, call `this.pdfViewer.toolbar.showRedactionToolbar(true)` to display the redaction toolbar, or `this.pdfViewer.toolbar.showRedactionToolbar(false)` to hide it.
119119

120120
The following example demonstrates toggling the redaction toolbar programmatically:
121121

Document-Processing/PDF/PDF-Viewer/vue/Redaction/ui-interaction.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
layout: post
33
title: Redaction UI interactions in Vue PDF Viewer | Syncfusion
4-
description: Learn about UI interactions in Redaction annotations of the Syncfusion Vue PDF Viewer component.
4+
description: Learn about the various UI interactions in Redaction annotations of the Syncfusion Vue PDF Viewer component and more
55
platform: document-processing
66
control: PDF Viewer
77
documentation: ug
88
---
99

10-
# Redaction UI interactions in Vue PdfViewer
10+
# Redaction UI interactions in Vue PDF Viewer
1111

1212
## Add redaction annotations from the toolbar
1313

@@ -27,21 +27,21 @@ N> The redaction tool is hidden by default. Customize the toolbar to include it.
2727

2828
## Add redaction annotations using the context menu
2929

30-
In addition to the toolbar, you can add redaction annotations directly from the context menu. Select the text or region, right‑click (or long‑press on mobile), and choose the **Redact Annotation** option. This creates a redaction mark over the selected content.
30+
In addition to the toolbar, redaction annotations can be added directly from the context menu. To add from the context menu, select the text or region, right‑click (or long‑press on mobile), and choose the **Redact Annotation** option. This creates a redaction mark over the selected content.
3131

3232
![Context menu showing Redact Annotation option](redaction-annotations-images/redact-text-context-menu.png)
3333

3434
## Update redaction properties
3535

36-
After adding a redaction annotation, you can update its properties through the property panel or programmatically.
36+
After adding a redaction annotation, properties can be updated through the property panel or programmatically.
3737

3838
### Update using the property panel
3939

40-
When a redaction annotation is selected, a two‑tab property panel (General and Appearance) lets you customize text and styling. Changes are reflected instantly on the redaction mark.
40+
When a redaction annotation is selected, a two‑tab property panel (General and Appearance) allows customization of text and styling. Changes are reflected instantly on the redaction mark.
4141

4242
The property panel can be opened in two ways:
4343

44-
* By clicking the **redaction property panel** icon in the toolbar.
44+
* By clicking the **Redaction property panel** icon in the toolbar.
4545
![Redaction Property Panel Icon](redaction-annotations-images/redaction-property-panel-icon.png)
4646

4747
* By right‑clicking (or long‑pressing) the annotation and choosing **Properties** from the context menu.
@@ -62,7 +62,7 @@ Use the General tab to define how the content will look after redaction. These s
6262

6363
![Fill Color in General Tab](redaction-annotations-images/after-redaction-fill-color.png)
6464

65-
Note: Hovering the mouse over a redaction annotation shows a preview of this final look. After you click Apply Redaction, these settings are flattened into the page and can’t be edited. Tip: Click Save in the dialog to keep your changes.
65+
N> Hovering over a redaction annotation shows a preview of the final look. After Apply Redaction is selected, these settings are flattened into the page and cannot be edited. Tip: Select Save in the dialog to persist changes.
6666

6767
#### Appearance tab
6868

@@ -72,18 +72,18 @@ Use the Appearance tab to style the redaction annotation itself (before applying
7272
* Outline Color – Optional border for the annotation.
7373
* Fill Opacity – Controls how transparent the annotation appears during review.
7474

75-
Note: The Appearance tab affects only the temporary annotation. The final look after applying redaction comes from the General tab settings.
75+
N> The Appearance tab affects only the temporary annotation. The final look after applying redaction comes from the General tab settings.
7676

7777
![Appearance Tab Settings](redaction-annotations-images/redaction-annotation-appearance.png)
7878

7979
### What changes after applying redaction?
8080

81-
When you click Apply Redaction:
81+
When Apply Redaction is selected:
8282

8383
* The selected content is permanently removed from the page.
8484
* The redaction region is flattened into the page with a solid fill that uses the General tab Fill Color.
8585
* If overlay text was enabled, the text is burned into the page. If Repeat Overlay Text was enabled, the text is tiled across the region.
86-
* All properties become read‑only. You cannot edit overlay text, fill color, outline, or opacity after applying. Set the final look in the General tab and use the Appearance tab only to style the annotation before you apply.
86+
* All properties become read‑only. Overlay text, fill color, outline, and opacity cannot be edited after applying. Set the final look in the General tab and use the Appearance tab only to style the annotation before applying.
8787

8888
## Delete redaction annotations
8989

@@ -107,7 +107,7 @@ Entire pages can be marked for redaction using the **Redact Pages** option in th
107107
* **Even Pages Only** – Redacts all even‑numbered pages.
108108
* **Specific Pages** – Enter page numbers or ranges (e.g., 1, 3–5, 7) to redact.
109109

110-
After choosing the range, click **Save** to apply redaction marks to the selected pages.
110+
After choosing the range, select **Save** to apply redaction marks to the selected pages.
111111

112112
![Page Redaction Panel](redaction-annotations-images/page-redaction-panel.png)
113113

@@ -120,7 +120,7 @@ The **Apply Redaction** button permanently removes all marked content from the d
120120

121121
![Redact Button Icon](redaction-annotations-images/redact-button-icon.png)
122122

123-
A confirmation dialog appears before applying redaction to ensure you acknowledge the irreversible nature of the process.
123+
A confirmation dialog appears before applying redaction to ensure acknowledgement of the irreversible nature of the process.
124124

125125
![Apply Redaction Dialog](redaction-annotations-images/apply-redaction-dialog.png)
126126

0 commit comments

Comments
 (0)