# @dhis2/d2-ui-core

> Core components for DHIS2 in d2-ui

Latest version **7.4.3** (published 2023-04-27) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @dhis2/d2-ui-core
pnpm add @dhis2/d2-ui-core
yarn add @dhis2/d2-ui-core
bun add @dhis2/d2-ui-core
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 7.4.3 |
| Published | 2023-04-27 |
| First published | 2018-04-19 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 162.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19 |
| Maintainers | edoardo.sabadelli, varl, amcgee, ismay, dhis2-bot, martinkrulltott, birk |

## Links

- npm: https://www.npmjs.com/package/@dhis2/d2-ui-core
- Repository: https://github.com/dhis2/d2-ui
- Homepage: https://github.com/dhis2/d2-ui#readme
- Issues: https://github.com/dhis2/d2-ui/issues
- npm.io page: https://npm.io/package/@dhis2/d2-ui-core

## Dependencies (5)

- [d2](https://npm.io/package/d2.md) ~31.7
- [rxjs](https://npm.io/package/rxjs.md) ^5.5.7
- [lodash](https://npm.io/package/lodash.md) ^4.17.10
- [material-ui](https://npm.io/package/material-ui.md) ^0.20.0
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.26.0

## Recent versions

- 7.4.3 (latest) — 2023-04-27
- 7.4.2 — 2023-03-14
- 7.4.1 — 2022-12-07
- 7.4.0 — 2022-05-10
- 7.3.4 — 2022-04-05
- 7.3.3 — 2021-09-02
- 7.3.2 — 2021-08-25
- 7.3.1 — 2021-06-23
- 7.3.0 — 2021-05-25
- 7.2.0 — 2021-04-22
- 7.1.8 — 2021-04-20
- 7.1.6 — 2021-03-09
- 7.1.5 — 2021-03-03
- 7.1.4 — 2021-02-19
- 7.1.3 — 2020-12-14
- … 93 more at https://npm.io/package/@dhis2/d2-ui-core/versions

## README

# d2-ui

[![Build Status](https://travis-ci.com/dhis2/d2-ui.svg?branch=master)](https://travis-ci.com/dhis2/d2-ui)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdhis2%2Fd2-ui.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdhis2%2Fd2-ui?ref=badge_shield)

## Introduction

D2-UI is a user interface component library for developing
[DHIS2](http://www.dhis2.org) applications. The core development team
uses and maintains these components to ensure visual consistency between
DHIS2 web applications.

## Structure

This is a monorepo comprised of many packages which are individually
published to [NPM](https://npmjs.com) using [Yarn Workspaces](https://yarnpkg.com/lang/en/docs/workspaces/). Yarn Workspaces
handles linking the packages in this repository together, and ensures that
everything is using the latest code.

See [packages](https://github.com/dhis2/d2-ui/blob/master/packages) to
see what components are available.

## The example application

In [examples](https://github.com/dhis2/d2-ui/blob/master/examples) you
will find an application bootstrapped with
[create-react-app](https://github.com/facebook/create-react-app) which
demonstrates how one consumes the components d2-ui provides.

## Getting started

In the d2-ui root directory:

```
yarn install
yarn watch
```

In the
[examples/create-react-app](https://github.com/dhis2/d2-ui/blob/master/examples/create-react-app)
subdirectory:

```
yarn start
```

Now you are able to change any component in
[packages/](https://github.com/dhis2/d2-ui/blob/master/packages) and the
changes will be reflected live in the example application.

## Linking individual components

When working on a component that's consumed by a different app, you can preview the changes without publishing by using `yarn link`. Let's say you're working on the `legend` component. First you'll need to build the components. Run this from the d2-ui root directory:

```
yarn install
yarn run build
```

After that link the components you're working on (we'll use legend for this example):

```
cd d2-ui/packages/legend/build
yarn link
```

After that, change directory to the app that consumes the component you're working on (let's say the maintenance-app). From the root of that project run:

```
yarn link @dhis2/d2-ui-legend`
```

This will link your local version of the component and your local changes will be reflected in the app.

## Contributing

See [how to
contribute](https://github.com/dhis2/d2-ui/blob/master/docs/CONTRIBUTING.md).

## Release process

Documented in [RELEASING](https://github.com/dhis2/d2-ui/blob/master/docs/RELEASING.md).

## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdhis2%2Fd2-ui.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdhis2%2Fd2-ui?ref=badge_large)

## Report an issue

The issue tracker can be found in [DHIS2 JIRA](https://jira.dhis2.org)
under the [LIBS](https://jira.dhis2.org/projects/LIBS) project.

Deep links:

-   [Bug](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10006&components=11012)
-   [Feature](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10300&components=11012)
-   [Task](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10003&components=11012)

---
_Source: https://npm.io/package/@dhis2/d2-ui-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._