Skip to content

Commit 54ae0eb

Browse files
1009405: UG Revamp in JS III
1 parent 7da6507 commit 54ae0eb

58 files changed

Lines changed: 294 additions & 290 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/javascript-es5/accessibility.md

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

1111
# Accessibility in Syncfusion JavaScript ES5 PDF Viewer components
1212

13-
The PDF Viewer component follows established accessibility guidelines and standards, including [ADA](https://www.ada.gov/), [Section 508](https://www.section508.gov/), [WCAG 2.2](https://www.w3.org/TR/WCAG22/), and [WCAG roles](https://www.w3.org/TR/wai-aria/#roles) that are commonly used to evaluate accessibility.
14-
15-
The accessibility compliance for the PDF Viewer component is summarized below.
13+
The PDF Viewer complies with widely adopted accessibility standards and guidance, including [ADA](https://www.ada.gov/), [Section 508](https://www.section508.gov/), [WCAG 2.2](https://www.w3.org/TR/WCAG22/), and WAI-ARIA roles. The following table summarizes the component's accessibility coverage.
1614

1715
| Accessibility Criteria | Compatibility |
1816
| -- | -- |
@@ -42,7 +40,7 @@ Note: Mobile device support is marked as partial due to platform-level constrain
4240

4341
## WAI-ARIA attributes
4442

45-
[WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/alert/) (Accessibility Initiative – Accessible Rich Internet Applications) defines a way to increase the accessibility of web pages, dynamic content, and user interface components developed with Ajax, HTML, JavaScript, and related technologies. ARIA provides additional semantics to describe the role, state, and functionality of web components. The following ARIA attributes are used in the PDF Viewer component:
43+
[WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/alert/) (Accessible Rich Internet Applications) provides semantics that improve the accessibility of dynamic web content. The following ARIA attributes are used by the PDF Viewer to expose roles, states, and relationships to assistive technologies:
4644

4745
| Attributes | Purpose |
4846
| --- | --- |
@@ -62,7 +60,7 @@ Note: Mobile device support is marked as partial due to platform-level constrain
6260

6361
## Keyboard interaction
6462

65-
The PDF Viewer component follows the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/alert/#keyboardinteraction) guideline, making it easy for people who use assistive technologies (AT) and those who rely on keyboard navigation. The following keyboard shortcuts are supported by the PDF Viewer component.
63+
The PDF Viewer follows WAI-ARIA [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/alert/#keyboardinteraction) recommendations to support users who rely on keyboard navigation and assistive technologies. The following keyboard shortcuts are supported.
6664

6765
| **Press (Windows)** |**Press (Macintosh)** | **To do this** |
6866
| --- | --- | --- |

Document-Processing/PDF/PDF-Viewer/javascript-es5/download.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ domainurl: ##DomainURL##
99
---
1010
# Download in JavaScript PDF Viewer control
1111

12-
The PDF Viewer supports downloading the loaded PDF file. You can enable/disable the download using the following code snippet.
12+
The PDF Viewer supports downloading the currently loaded PDF document. Use the `enableDownload` option to enable or disable download functionality. The examples below demonstrate standalone and server-backed configurations.
1313

1414
```html
1515
{% raw %}
@@ -61,7 +61,7 @@ pdfviewer.appendTo('#PdfViewer');
6161

6262
![Alt text](./images/download.png)
6363

64-
You can invoke download action using following code snippet.,
64+
Invoke the download action programmatically with a simple button example:
6565

6666
```
6767
<button id="download">Download</button>
@@ -101,7 +101,7 @@ document.getElementById('download').addEventListener('click', function () {
101101

102102
## How to get the base64 string while downloading the PDF document
103103

104-
The [downloadEnd](https://ej2.syncfusion.com/documentation/api/pdfviewer/#downloadend) event of the PDF viewer allows you to get the downloaded document as a base64 string.
104+
The [downloadEnd](https://ej2.syncfusion.com/javascript/documentation/api/pdfviewer/#downloadend) event fires after a download completes and exposes the downloaded document as a base64 string.
105105

106106
The following code illustrates how to get the downloaded document as a base64 string.
107107

Document-Processing/PDF/PDF-Viewer/javascript-es5/event.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ domainurl: ##DomainURL##
1010

1111
# Events in JavaScript PDF Viewer
1212

13-
The PDF Viewer component triggers events for creation, page navigation, document life cycle, context menu interactions, comments, bookmarks, download and export, hyperlinks, annotation import/export, custom keyboard commands, printing, signatures, text search, and text selection. Use these events to integrate custom logic into application workflows.
13+
The PDF Viewer component triggers events for creation, page navigation, document lifecycle, context menu interactions, comments, bookmarks, download and export, hyperlinks, annotation import/export, custom keyboard commands, printing, signatures, text search, and text selection. Use these events to integrate custom logic into application workflows.
1414

1515
The following table lists commonly used events supported by the PDF Viewer component:
1616

Document-Processing/PDF/PDF-Viewer/javascript-es5/feature-module.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ domainurl: ##DomainURL##
1010

1111
# Feature module in JavaScript PDF Viewer Control
1212

13-
The PDF Viewer features are segregated into individual feature-wise modules to enable selectively referencing in the application. The required modules should be injected to extend its functionality. The following are the selective modules of PDF Viewer that can be included as required:
14-
15-
The available PDF Viewer modules are:
13+
The PDF Viewer features are organized into discrete modules so applications can include only the functionality they require. Inject the necessary modules to extend the viewer's behavior and reduce bundle size. The modules listed below are available for selective inclusion:
1614

1715
* [**Toolbar**](./toolbar-customization/primary-toolbar):- Built-in toolbar for better user interaction.
1816
* [**Magnification**](./magnification):- Perform zooming operation for better viewing experience.

Document-Processing/PDF/PDF-Viewer/javascript-es5/getting-started-with-server-backed.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ This guide explains how to create the PDF Viewer component and configure its fea
3737
{% endhighlight %}
3838
{% endtabs %}
3939

40-
N> We have provided the support to dynamically change the [serviceURL](https://ej2.syncfusion.com/documentation/api/pdfviewer#serviceurl). So, after changing the `serviceURL` dynamically, you need invoke the `pdfViewer.dataBind()` method to update the `serviceURL` quickly. This will effectively change the `serviceURL` dynamically. Ensure that this step is performed after version 23.1.36.
40+
N> The PDF Viewer supports dynamically changing the [serviceURL](https://ej2.syncfusion.com/documentation/api/pdfviewer#serviceurl). After changing `serviceUrl` at runtime, call `pdfViewer.dataBind()` to apply the new value. This behavior applies to versions after 23.1.36.
4141
document.getElementById('load').addEventListener('click', function () {
4242
pdfViewer.serviceUrl = "https://document.syncfusion.com/web-services/pdf-viewer/api/pdfviewer";
4343
pdfViewer.documentPath = "https://cdn.syncfusion.com/content/pdf/pdf-succinctly.pdf";
4444
pdfViewer.dataBind();
4545
pdfViewer.load(pdfViewer.documentPath, null);
4646
});
4747

48-
N> The Web API hosted link https://document.syncfusion.com/web-services/pdf-viewer/api/pdfviewer utilized in the PDF viewer's serviceUrl property is intended solely for demonstration and evaluation purposes. For production deployment, please host your own web service with your required server configurations. You can refer and reuse the [GitHub Web Service example](https://github.com/SyncfusionExamples/EJ2-PDFViewer-WebServices) or [Docker image](https://hub.docker.com/r/syncfusion/pdfviewer-server) for hosting your own web service and use for the serviceUrl property. **We strongly recommend using the standalone mode.**
48+
N> The demo Web API hosted at https://document.syncfusion.com/web-services/pdf-viewer/api/pdfviewer is provided for evaluation only. For production, host a web service with appropriate server configuration. See the [GitHub Web Service example](https://github.com/SyncfusionExamples/EJ2-PDFViewer-WebServices) or the [Docker image](https://hub.docker.com/r/syncfusion/pdfviewer-server) for reference. Standalone mode is recommended for client-side rendering.
4949

5050
{% previewsample "/document-processing/code-snippet/pdfviewer/javascript-es5/es5-getting-started-cs1" %}
5151

@@ -102,7 +102,7 @@ var pdfviewer = new ej.pdfviewer.PdfViewer({
102102
});
103103
```
104104

105-
N> When configuring the server-backed PDF viewer, it's essential to understand that there is no need to include the pdfium.js and pdfium.wasm files. Unlike the standalone PDF viewer, which relies on these files for local rendering, the server-backed PDF viewer fetches and renders PDFs directly from the server. Consequently, you can exclude the copy command for deployment process, as they are not required to load and display PDFs in this context.
105+
N> The server-backed PDF Viewer does not require `pdfium.js` and `pdfium.wasm` files. Those files are used by the standalone viewer for client-side rendering; server-backed setups render PDFs on the server and therefore do not need to include them in deployment.
106106

107107
> Refer to the [JavaScript PDF Viewer feature tour](https://www.syncfusion.com/pdf-viewer-sdk) for an overview of capabilities. Explore the [JavaScript PDF Viewer example](https://document.syncfusion.com/demos/pdf-viewer/javascript-es5/#/tailwind3/pdfviewer/default.html) to see core features in action.
108108

Document-Processing/PDF/PDF-Viewer/javascript-es5/getting-started.md

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

11-
# Getting started in JavaScript Standalone PDF Viewer control
11+
# Getting started in JavaScript standalone PDF Viewer control
1212

13-
The Essential JS 2 for JavaScript (global script) is an ES5 formatted pure JavaScript framework which can be directly used in latest web browsers.
13+
Essential JS 2 for JavaScript provides an ES5-compatible global script build that works in modern browsers without a build step.
1414

15-
## Component Initialization with CDN link for script and style reference
15+
## Component initialization with CDN links for script and style reference
1616

1717
**Step 1:** Create an app folder `my-app` for the Essential JS 2 JavaScript components.
1818

19-
**Step 2:** The Essential JS 2 component's global scripts and styles are already hosted in the below CDN link formats.
19+
**Step 2:** The Essential JS 2 component's global scripts and styles are hosted at the following CDN link formats.
2020

2121
**Syntax:**
2222
> Script: `https://cdn.syncfusion.com/ej2/{Version}/dist/{PACKAGE_NAME}.min.js`

Document-Processing/PDF/PDF-Viewer/javascript-es5/how-to-overview.md

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

11-
# Frequently Asked Questions Section in JavaScript PDF Viewer control
11+
## Frequently Asked Questions in JavaScript PDF Viewer
1212

13-
The frequently asked questions in Essential<sup>&reg;</sup> PDF Viewer are listed below.
13+
The frequently asked questions for the Essential<sup>&reg;</sup> PDF Viewer are listed below.
1414

1515
* [How to add annotation in text search in typescript?](./how-to/add-annotation-in-text-search-js)
1616
* [How to add custom header to the PDF Viewer ajax request?](./how-to/add-header-value)

Document-Processing/PDF/PDF-Viewer/javascript-es5/how-to/add-annotation-in-text-search-js.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ domainurl: ##DomainURL##
1010

1111
# Add rectangle annotations using text search bounds in JS PDF Viewer
1212

13-
A concise guide to adding rectangle annotations at highlighted text search results in the JavaScript PDF Viewer to visually emphasize matches and improve readability.
13+
A concise guide that demonstrates how to add rectangle annotations at highlighted text search results in the JavaScript PDF Viewer. The guide explains where to wire the callback, required services, and quick troubleshooting steps.
1414

1515
## Steps to add rectangle annotations on search result highlight
1616

Document-Processing/PDF/PDF-Viewer/javascript-es5/how-to/add-header-value.md

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

1010
# Add header values in the JavaScript PDF Viewer
1111

12-
Use the ajaxHeaders property in the PDF Viewer’s [ajaxRequestSettings](https://ej2.syncfusion.com/documentation/api/pdfviewer/#ajaxrequestsettings) to include custom headers with each AJAX request.
12+
Use the `ajaxHeaders` property inside the PDF Viewer’s [ajaxRequestSettings](https://ej2.syncfusion.com/javascript/documentation/api/pdfviewer/#ajaxrequestsettings) to send custom HTTP headers with each request made by the viewer.
1313

14-
Example: Add a custom Authorization header using ajaxRequestSettings
14+
Example: Add a custom Authorization header using `ajaxRequestSettings` in an JavaScript component
1515

1616
```ts
1717

Document-Processing/PDF/PDF-Viewer/javascript-es5/how-to/add-new-page-to-the-pdf-document.md

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

1111
# Add a new page to a PDF document in JavaScript PDF Viewer control
1212

13-
The JavaScript PDF Viewer library can append a blank page to any loaded PDF document through the accompanying PDF library service.
13+
The JavaScript PDF Viewer can append a blank page to a loaded PDF document by using the accompanying PDF library service on the server.
1414

1515
**Step 1:** Follow the guidance in the [Getting started with the JavaScript PDF Viewer](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/javascript-es5/getting-started) article to configure a working sample.
1616

17-
**Step 2:** Complete the web service setup by using this [guide](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/javascript-es5/how-to/create-pdfviewer-service).
17+
**Step 2:** Complete the web service setup using this [guide](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/javascript-es5/how-to/create-pdfviewer-service).
1818

19-
**Step 3:** Add the following controller action to insert a new page into the loaded PDF document before returning it to the viewer.
19+
**Step 3:** Add the following controller action to insert a new page into the loaded PDF document before returning it to the viewer. The example below is a server-side controller action; validate inputs and add appropriate error handling for production use.
2020

2121
```javascript
2222

0 commit comments

Comments
 (0)