public interface Npmjs
To install one of these packages, use:
npm install <package name> [flags]where the flags are as follows:
|Option Name||Argument Value||Description|
|path||A path (absolute or relative to the dependent module) specifying where to install
the Smart GWT runtime(s). Default is to place the runtime root directory
|number||Desired branch (e.g. 11.1). Default is the latest release.|
|date in format YYYY-MM-DD | ||Desired date. Default is to use the latest build available.|
|Desired runtime(s) to install. Default is to install them both.|
||Whether to keep the framework reference directory. Default is to not install it to save disk space.|
||Which skins (if any) to install. Default is to only install Tahoe.|
|string||The username for your Smart GWT account. Required for the Pro, Power, and Enterprise packages, and available subject to your licensing.|
|string||The password for your Smart GWT account. Required for the Pro, Power, and Enterprise packages, and available subject to your licensing.|
||Whether to install the optional
||Whether to install the optional
| ||Wait for input instead of assuming the default response to all queries during install; default is to not prompt to support newer npm releases.|
After installation, command-line configuration is persisted, so command-line arguments only need to be supplied when updating if the desired configuration has changed. If a username and password aren't supplied via the above options, you will be prompted to enter them by the update script. A password typed in response to the script won't be persisted to your configuration, so you may choose to always enter it interactively for security.
npm run update [flags]to update your installation to the latest runtimes. The supported flags are the same as during installation.
The install script for a module is no longer allowed to write output in npm v7, which means that we can no longer interactively query for decisions or show zip download progress. So, to still have a complete install process, the module now proceeds automatically, without waiting, wherever a default response is available for what was formerly an interactive query. Please be patient as the zip download and installation of framework, skins, and other assets may take more than a minute, during which no additional output indicating progress will be printed.
You have a few alternatives to this default behavior:
"Uninstall" is no longer a lifecycle event in npm v7, so a module's uninstall script declared in package.json no longer gets called during uninstallation. The recommended workaround is to run "npm run uninstall" from the module directory (under node_modules) before uninstalling.
npm install smartclient-eval --branch=11.1 --date=2018-12-30Update to latest nighlty build (run from package directory):
npm run update --date=latestUpdate to Smart GWT 12.1 branch, installing all skins:
npm run update --branch=12.1 --skins=all
App.tsxto make the framework available. However, if you are adding Smart GWT to an existing application, and you only plan to use Smart GWT for specific components like grids, or for
Reify screens, consider using
background downloadinstead of importing Smart GWT directly (importing causes Smart GWT to load immediately on all pages).
To directly import the release or debug framework, respectively, in your application, you can write:
import 'smartclient-eval/release';To import a skin as well, such as "Tahoe", you can add:
import 'smartclient-eval/skins/Tahoe';To import one of the optional modules, you'd write something like:
import 'smartclient-eval/release/analytics';respectively, to import the debug version of the Realtime Messaging module or the release version of the Analytics module.
Caution: you can't mix debug and release imports in a single app.
skin_styles.cssfile for your skin to the
src/styles.cssfile (or equivalent) for your app, in addition to importing the skin as described above.
For example, if you've installed the Smart GWT runtime in the default location, and are
importing Tahoe, you'd add the following to
src/style.css in your app:
@import '../isomorphic/skins/Tahoe/skin_styles.css';Note: if you are using the FileLoader to load a skin, it must be installed under
src/assets(for example copied from
isomorphic/skins) to work properly.
const ISC: typeof isc = window['isc'];after importing this package.
tsconfig.jsonfile with an include directive targeting Smart GWT's typescript file.
Alternatively, you can copy the typescript declaration file,
from the installed resources under the
isomorphic directory to your app's
source directory, and then import it from your app like:
import 'smartclient.d.ts';Smart GWT's TypeScript support is intended for IDE auto-completion and inline documentation, not for transpilation. So, if you run into compile errors, you can always remove any reference to our TypeScript file from your own TS file and application, remove
src/assets(if present), and instead make TypeScript active for your IDE only. For further details, see the TypeScript support documentation for
our frameworkor your IDE.