@statisticsnorway/dapla-js-utilities

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
• Build and test locally
• Publish library
• Available stuff
  • Components
    • ssb-logo-rbg
  • Enums
    • 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 you need a user and a membership in the statisticsnorway organization on npm. The user must also have 2FA authentication enabled. Steps to follow:

• Login into your npm account in the terminal with npm login
• Make sure all tests works (test components in the example application aswell, if you made a new one)
• Bump version in package.json
• Run yarn package
• Dry run a release with npm pack
• 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:

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.