Skip to content
This repository has been archived by the owner on May 24, 2024. It is now read-only.

update to use terra-dev-site v7 #220

Merged
merged 11 commits into from
Sep 1, 2021
Merged
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ jobs:
- npm run build
- npm run build:dist
# These can't be built in parallel because the cache is a single object and you can't add to it in parallel
- npm run compile:prod -- --env.disableAggregateThemes --output-path $TRAVIS_BUILD_DIR/travis-build/default
- npm run compile:lowlight -- --output-path $TRAVIS_BUILD_DIR/travis-build/lowlight
- npm run compile:fusion -- --output-path $TRAVIS_BUILD_DIR/travis-build/fusion
- npm run compile:prod -- --output-path $TRAVIS_BUILD_DIR/travis-build/default
# - npm run compile:lowlight -- --output-path $TRAVIS_BUILD_DIR/travis-build/lowlight
# - npm run compile:fusion -- --output-path $TRAVIS_BUILD_DIR/travis-build/fusion
# Prime the docker cache
- docker-compose --file ./node_modules/@cerner/terra-functional-testing/lib/docker/docker-compose.yml pull
# Save docker cache
Expand Down
149 changes: 61 additions & 88 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,32 +25,28 @@ Terra Graphs is a graphing library built using D3 visualization library. It prov
- [Dependencies](#dependencies)
- [Install](#install)
- [Features](#features)
- [Graph types](#graph-types)
- [Graph Settings and Toggles](#graph-settings-and-toggles)
- [Other highlights](#other-highlights)
- [Graph types](#graph-types)
- [Graph Settings and Toggles](#graph-settings-and-toggles)
- [Other highlights](#other-highlights)
- [Internationalization (I18n)](#internationalization-i18n)
- [Packages Requiring I18n](#packages-requiring-i18n)
- [Contributing](#contributing)
- [Local Development](#local-development)
- [LICENSE](#license)

---

<hr>
<!-- -->
## Packages

<h2 id="packages">
Packages
</h2>
This repo consists of two packages:

This repo consists of two packages:
1. Carbon-graphs: Vanilla JavaScript implementation of the graphing library.
2. Terra-graphs: React implementation of graphing library.

<h3 id="versioning">
Versioning
</h3>
### Versioning

When a component reaches v1.0.0., it is considered to be stable and will follow [SemVer](http://semver.org/) for versioning.

1. MAJOR versions represent breaking changes
2. MINOR versions represent added functionality in a backwards-compatible manner
3. PATCH versions represent backwards-compatible bug fixes
Expand All @@ -62,23 +58,17 @@ We view the React.js props API of our components as our main public API. We use
Prior to components reaching v1.0.0, a component is considered to be in a beta stage.
Components in beta stage may include breaking changes, new features, and bug fixes all within v0.x.x releases.

<h3 id="status">
Status
</h3>
### Status

![Stable](https://badgen.net/badge/status/Stable/green)
![Beta](https://badgen.net/badge/status/Beta/orange)
![Deprecated](https://badgen.net/badge/status/Deprecated/grey)

<!-- AUTO-GENERATED-CONTENT:START (SUBPACKAGELIST) -->
| Packages | Version | Status | Dependencies |
|--------------------|---------|--------|--------------|
| [Carbon-graphs](./packages/carbon-graphs/README.md)| ![npm](https://img.shields.io/npm/v/@cerner/carbon-graphs)| ![Stable](https://badgen.net/badge/status/Stable/green)| [![carbon-graphs](https://img.shields.io/david/cerner/terra-graphs?path=packages%2Fcarbon-graphs)](https://david-dm.org/cerner/terra-graphs?path=packages/carbon-graphs)|

<!-- AUTO-GENERATED-CONTENT:END *-->

<hr>
<!-- -->
---

## Supported Browsers

Expand All @@ -90,16 +80,16 @@ Components in beta stage may include breaking changes, new features, and bug fix
| Internet Explorer | 10 & 11 |
| Safari & Mobile Safari | Current |

<hr>
<!-- -->
---

## Getting Started

### Dependencies
- D3
- Polyfills:
- Object.assign
- Object.values

- D3
- Polyfills:
- Object.assign
- Object.values

### Install

Expand All @@ -109,102 +99,85 @@ You can install Carbon via `npm` or download the [latest release](https://github
npm i @cerner/carbon-graphs --save-dev
```

### Getting Started
- [Getting Started](./packages/terra-graphs-docs/docs/getting-started/GettingStarted.md)
- [API Reference](./packages/terra-graphs-docs/docs/README.md)

- [Getting Started](./packages/terra-graphs-docs/docs/getting-started/GettingStarted.md)
- [API Reference](./packages/terra-graphs-docs/docs/README.md)

<hr>
<!-- -->
---

## Features

- Adheres to Cerner standard design template
- Responsive
- Native-built graphs
- Default theme for data points
- Adheres to Cerner standard design template
- Responsive
- Native-built graphs
- Default theme for data points

### Graph types

- [Line](./packages/terra-graphs-docs/docs/controls/Line.md#usage)
- [Multi Line](./packages/terra-graphs-docs/docs/controls/Line.md#multi-line)
- [Spline Line](./packages/terra-graphs-docs/docs/controls/Line.md#spline-line)
- [Paired Result](./packages/terra-graphs-docs/docs/controls/PairedResult.md#usage)
- [Bar](./packages/terra-graphs-docs/docs/controls/Bar.md#usage)
- [Timeline](./packages/terra-graphs-docs/docs/controls/Timeline.md#usage)
- [Pie](./packages/terra-graphs-docs/docs/controls/Pie.md#usage)
- [Gantt](./packages/terra-graphs-docs/docs/controls/Gantt.md#usage)
- [Scatter](./packages/terra-graphs-docs/docs/controls/Scatter.md#usage)
- [Bubble](./packages/terra-graphs-docs/docs/controls/Bubble.md#usage)
- [Bubble Single Dataset](./packages/terra-graphs-docs/docs/controls/BubbleSingleDataset.md)
- [Bubble Multiple Dataset](./packages/terra-graphs-docs/docs/controls/BubbleMultipleDataset.md)

- [Line](./packages/terra-graphs-docs/docs/controls/Line.md#usage)
- [Multi Line](./packages/terra-graphs-docs/docs/controls/Line.md#multi-line)
- [Spline Line](./packages/terra-graphs-docs/docs/controls/Line.md#spline-line)
- [Paired Result](./packages/terra-graphs-docs/docs/controls/PairedResult.md#usage)
- [Bar](./packages/terra-graphs-docs/docs/controls/Bar.md#usage)
- [Timeline](./packages/terra-graphs-docs/docs/controls/Timeline.md#usage)
- [Pie](./packages/terra-graphs-docs/docs/controls/Pie.md#usage)
- [Gantt](./packages/terra-graphs-docs/docs/controls/Gantt.md#usage)
- [Scatter](./packages/terra-graphs-docs/docs/controls/Scatter.md#usage)
- [Bubble](./packages/terra-graphs-docs/docs/controls/Bubble.md#usage)
- [Bubble Single Dataset](./packages/terra-graphs-docs/docs/controls/BubbleSingleDataset.md)
- [Bubble Multiple Dataset](./packages/terra-graphs-docs/docs/controls/BubbleMultipleDataset.md)

### Graph Settings and Toggles

- Legend
- Labels
- Grid `vertical & horizontal`
- Axes `x and y or y2`
- Regions `horizontal`
- Legend
- Labels
- Grid `vertical & horizontal`
- Axes `x and y or y2`
- Regions `horizontal`

### Other highlights

- Supports different shapes for each data-set
- Supports custom SVG shapes for data-sets
- `Non-contiguous` data point line graph
- `Sparkline` graph (with Shapes as hidden)
- Criticality indicators for data point
- Locale support for axes ticks
- Y and Y2 Axes label along with respective shapes
- Graph Panning
- Supports different shapes for each data-set
- Supports custom SVG shapes for data-sets
- `Non-contiguous` data point line graph
- `Sparkline` graph (with Shapes as hidden)
- Criticality indicators for data point
- Locale support for axes ticks
- Y and Y2 Axes label along with respective shapes
- Graph Panning

<hr>
<!-- -->

<h2 id="internationalization-i18n">
Internationalization (I18n)
</h2>
## Internationalization (I18n)

Please review [Terra's Internationalization documentation](https://engineering.cerner.com/terra-ui/guides/terra-ui/internationalization/internationalization-intro) for more information. Included are directions on consumption and how internationalization is setup.

<hr>
<!-- -->

<h2 id="contributing">
Contributing
</h2>
## Contributing

Please read through our [contributing guidelines](CONTRIBUTING.md). Included are directions for issue reporting and pull requests.

<hr>
<!-- -->
---

## Local Development

<h2 id="local-development">
Local Development
</h2>
- For local development on Terra-graphs, first install dependencies using:

* For local development on Terra-graphs, first install dependencies using:
```sh
npm install
```

* Tests can be executed using:
- Tests can be executed using:

```sh
npm run test
```

* To view any visual changes, the dev site can be launched using:
- To view any visual changes, the dev site can be launched using:

```sh
npm run dev
npm run dev
```

<hr>
<!-- -->
---

<h2 id="license">
LICENSE
</h2>
## LICENSE

Copyright 2020 - present Cerner Innovation, Inc.

Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
"@cerner/stylelint-config-terra": "^4.0.0",
"@cerner/terra-aggregate-translations": "^2.0.1",
"@cerner/terra-cli": "^1.6.0",
"@cerner/terra-dev-site": "^7.0.0",
"@cerner/terra-functional-testing": "^1.0.1",
"@cerner/terra-open-source-scripts": "^1.0.1",
"@cerner/webpack-config-terra": "^1.3.1",
Expand Down Expand Up @@ -88,11 +89,13 @@
"raf": "^3.4.1",
"react": "^16.8.5",
"react-dom": "^16.8.5",
"react-intl": "^2.9.0",
"react-json-pretty": "^2.2.0",
"react-test-renderer": "^16.4.2",
"regenerator-runtime": "^0.13.2",
"style-loader": "^2.0.0",
"stylelint": "^13.0.0",
"terra-application": "^1.48.0",
"terra-disclosure-manager": "^4.9.0",
"terra-enzyme-intl": "^3.0.0",
"url-loader": "^4.1.1",
Expand Down Expand Up @@ -140,6 +143,6 @@
"wdio-default": "terra wdio",
"wdio-lowlight": "NODE_OPTIONS=--max-old-space-size=2048 terra wdio --themes clinical-lowlight-theme",
"wdio-fusion": "terra wdio --themes orion-fusion-theme",
"wdio": "npm run wdio-default && npm run wdio-lowlight && npm run wdio-fusion"
"wdio": "terra wdio --themes terra-default-theme clinical-lowlight-theme orion-fusion-theme"
}
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading