npm Packages

TX Text Control .NET Server provides npm packages that add the Document Editor and the Document Viewer to Angular and React applications, and the Document Editor to Node.js applications. Besides the packages themselves, you find how their versions relate to the product version and which backend each package connects to.

You need these packages only if your frontend is an Angular, React or Node.js application. ASP.NET Core applications use the NuGet packages alone, a plain JavaScript page loads the scripts directly from your backend, and the Blazor components are NuGet packages as well.

The Packages

The Document Editor and Document Viewer pages list the latest version of each package. Packages with -ds- in their name belong to TX Text Control DS Server, a separate product, and are not described in this documentation.

Public Packages Without Credentials

The packages are published on the public npm registry (npmjs.com) under the scope @txtextcontrol. You install them with npm install like any other public package, without an account, an API token or feed credentials:

npm install @txtextcontrol/tx-ng-document-editor

This is different from the NuGet packages of your backend, which licensed developers install from the Text Control Private NuGet Feed with their email address and an API token.

The npm packages contain only the user interface that runs in the browser. The documents are loaded, edited and rendered on the server by TX Text Control .NET Server, and the TX Text Control license is included in the NuGet packages of that server application. See Development Licenses.

Every Package Needs a Backend

None of the packages works on its own. Each one connects to a server that runs TX Text Control .NET Server:

With Angular and React, the frontend and the backend are separate applications. One ASP.NET Core application can host the backend for both the Document Editor and the Document Viewer.

The synchronization service is the Document Editor backend TXTextControl.Web.Server.Core; The Backend for Node.js describes how a Node.js application reaches it.

Package Versions and Product Versions

• The major version is the TX Text Control version. Packages with version 34.x belong to TX Text Control .NET Server 34.0. The version history in the README of @txtextcontrol/tx-ng-document-editor, for example, lists 33.0.0 for TX Text Control 33.0 and 34.0.0 for TX Text Control 34.0.
• Use packages with the same major version as your backend. For a backend with the 34.0 NuGet packages, install the 34.x npm packages. The README of @txtextcontrol/tx-document-editor 34.0.0 names TX Text Control .NET Server 34.0 or higher as its environment.
• Minor and patch versions are counted per package. They do not have to match the service pack of TX Text Control .NET Server: Service Pack 5 is the current service pack, while the latest Angular and React packages are 34.0.0 and 34.0.1 and @txtextcontrol/tx-websocket-server is 34.5.0. The NuGet packages follow the same scheme, as Package Versioning explains.
• The framework versions are peer dependencies. The Angular and React packages declare the Angular or React versions they support. npm checks these ranges during the installation and stops if your project uses a version outside them. The Angular and React pages list the ranges.

Choose a Page