open-index/open-npm huggingface dataset:
npm package: @statisticsnorway/dapla-js-utilities
Description: JavaScript common components library for Statistics Norway Data Platform applications
Author: Statistics Norway
Latest version: 0.4.5

# dapla-js-utilities

[![npm version](https://badge.fury.io/js/%40statisticsnorway%2Fdapla-js-utilities.svg)](https://badge.fury.io/js/%40statisticsnorway%2Fdapla-js-utilities)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_dapla-js-utilities&metric=coverage)](https://sonarcloud.io/summary/new_code?id=statisticsnorway_dapla-js-utilities)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_dapla-js-utilities&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=statisticsnorway_dapla-js-utilities)

This library is mainly built for developers at Statistics Norway and it aims to bundle together commonly used JavaScript
functions/configurations and React components used in various Statistics Norway Data Platform related frontend
applications.

- [Installing library](#installing-library)
- [Build and test locally](#build-and-test-locally)
- [Publish library](#publish-library)
- [Available stuff](#available-stuff)
    - [Components](#components)
        - [ssb-logo-rbg](#ssb-logo-rgb)
    - [Enums](#enums)
        - [LANGUAGE](#language)

----

## Installing library

If you want to use the library in your project, simply add it with yarn.

`yarn add @statisticsnorway/dapla-js-utilities`

In your project import any component, function or configuration.

`import { Component } from '@statisticsnorway/dapla-js-utilities'`

## Build and test locally

The first time you clone the repository, remember to run `yarn install`.

Run `yarn package` to build the library. A minified production ready version will be created in the `/lib` folder.

`yarn test` runs all tests and `yarn coverage` calculates (rather unreliably) test coverage.

## Publish library

To publish to [npm](https://www.npmjs.com) you need a user and a membership in the `statisticsnorway` organization on
npm. The user must also have 2FA authentication enabled. Steps to follow:

1. Login into your npm account in the terminal with `npm login`
2. Make sure all tests works (test components in the example application aswell, if you made a new one)
3. Bump version in `package.json`
4. Run `yarn package`
5. Dry run a release with `npm pack`
6. Publish with `npm publish --access public --otp=<code>` (`<code>` is your 2FA code, without `<>`)

## Available stuff

### Components

#### `ssb-logo-rgb`

Import and use a Statistics Norway logo i svg format:

```javascript
import { Image } from 'primereact/image'
import { ssb_logo_rgb } from '@statisticsnorway/dapla-js-utilities'

...

<Image src={ssb_logo_rgb} />
```

Alternatively you can import `ssb_logo_no_text_rgb` (a variant of the logo without the text). You can also swap `rgb`
with `white` for a white logo for darker backgrounds.

There is also a logo for Statistics Norway Data Platform logo available, which also has a white version.

`dapla_long_rgb`   
`dapla_short_rgb`

### Enums

#### `LANGUAGE`

Common setup for language choice with provided language and locale codes.