Skip to content

docs: add conceptual library design #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
varl merged 1 commit into from
Mar 25, 2020
Merged

docs: add conceptual library design #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Conceptual design of @dhis2/ui

## Monorepo

UI is a monorepo that contains all the UI-related packages for DHIS2.

## Main package

**@dhis2/ui** is the main package, and is a meta-package that wraps and
re-exports relevant packages in the UI suite.

This is the main entrypoint that an application should import and use.

```
import {
Button,
OrgUnitTree,
HeaderBar,
} from '@dhis2/ui'
```

## Sub-packages

**@dhis2/ui-constants** provides access to UI-related constants, such as
color, theme, spacer, and elevation values that are used across the UI packages
as well as in applications that need custom components for example.

**@dhis2/ui-core** contains the base components we use. These components
are pure style and structure, and used as building blocks to create the
components ready to be used in user interfaces found in, e.g.
**@dhis2/ui-widgets**.

**@dhis2/ui-forms**
**@dhis2/ui-icons**
**@dhis2/ui-layouts**
**@dhis2/ui-widgets**