LabKey NPM Packages (@labkey)

This repository defines npm packages available in the @labkey scope.

Package listing

Package	Status	Description
@labkey/build		LabKey client-side build assets.
@labkey/components		All components, models, actions, and utility functions for LabKey applications and pages
@labkey/eslint-config-base		Base ESLint configuration with TypeScript and Prettier support.
@labkey/eslint-config-react		Extends the base configuration with React support.
@labkey/test		Utilities and configurations for running JavaScript tests with LabKey Server.
@labkey/themes		UI themes for LabKey Server.

Using @labkey npm packages

The easiest way to use @labkey components is to install them from npm and bundle them with your app. Before you run install, you'll want to make sure you set the appropriate registry for the @labkey scope.

Setting the Registry Scope

This package is currently available on LabKey's Artifactory package registry and relies on the @labkey/api package. To include this package, set the registry in npm for the @labkey scope. This can be done via command line using npm config:

npm config set @labkey:registry https://labkey.jfrog.io/artifactory/api/npm/libs-client/

or via a .npmrc file

# .npmrc
@labkey:registry=https://labkey.jfrog.io/artifactory/api/npm/libs-client/

Installing

To install using npm

npm install @labkey/components

You can then import @labkey/components in your application as follows:

import { Grid } from '@labkey/components';

Linting and Prettifying

First, install the @labkey/eslint-config-base or @labkey/eslint-config-react as appropriate. Once configured, you can run eslint in a variety of ways as described in the README for eslint-config-base