dylanklohr / terra-core

Terra offers a set of configurable React components designed to help build scalable and modular application UIs. The library easily integrates with webpack-based workflows and was created to solve real-world issues in projects we work on day to day.

Terra Core

• Supported Browsers
• Packages
• Internationalization
  • Packages Required I18n
• Contributing
• LICENSE

Packages

Versioning

When a component reaches v1.0.0., it is considered to be stable and will follow SemVer 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

Consult the component CHANGELOGs, related issues, and PRs for more information.

We view the React.js props API of our components as our main public API. We use this to guide us when versioning components.

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.

Status

✅ Stable 🔶 Beta 🚧 In Progress ❌ Deprecated

Terra Package	Version	Status
terra-alert		✅
terra-arrange		✅
terra-app-delegate		✅
terra-application		❌
terra-badge		✅
terra-base		✅
terra-button		✅
terra-button-group		✅
terra-card		✅
terra-content-container		✅
terra-date-picker		✅
terra-demographics-banner		✅
terra-dynamic-grid		✅
terra-embedded-content-consumer		✅
terra-form		✅
terra-grid		✅
terra-heading		✅
terra-i18n		✅
terra-i18n-plugin		✅
terra-icon		✅
terra-image		✅
terra-legacy-theme		✅
terra-list		✅
terra-markdown		✅
terra-menu		✅
terra-mixins		✅
terra-modal		✅
terra-modal-manager		✅
terra-overlay		✅
terra-popup		✅
terra-progress-bar		✅
terra-props-table		✅
terra-responsive-element		✅
terra-search-field		✅
terra-slide-group		✅
terra-slide-panel		✅
terra-status		✅
terra-status-view		✅
terra-table		✅
terra-text		✅
terra-time-input		✅
terra-toggle		✅
terra-toggle-button		✅

Supported Browsers

Browser	Version
Chrome & Chrome for Android	Current
Edge	Current
Firefox	Current
Internet Explorer	10 & 11
Safari & Mobile Safari	Current

Internationalization (I18n)

1. Please follow Base Getting Started to install Base, and consume it with locale props.
2. Install and config terra-i18n-plugin:
   • Follow terra-i18n-plugin Getting Started to install terra-i18n-plugin to aggregate translations in node_modules.
   • Follow terra-i18n-plugin Wiki Guide to config i18n plugin.
3. Install and config react-intl
   • Install it npm install --save react-intl.
   • Add alias webpack config to avoid importing duplicate react-intl.

     resolve: {
       extensions: ['.js', '.jsx'],
       alias: {
         'react-intl': path.resolve(__dirname, 'node_modules/react-intl'),
       },
     },
     

4. Provide values for locale and customMessages prop of Base.
5. Follow react-intl wiki to use injectIntl(pass translations to props) or FormattedMessage(render translations) to consume translations.

Packages Requiring I18n

• terra-alert
• terra-date-picker
• terra-date-time-picker
• terra-demographics-banner
• terra-overlay
• terra-time-picker

Contributing

Please read through our contributing guidelines. Included are directions for issue reporting and pull requests.

Local Development

1. Install docker https://www.docker.com/ to run browser tests.
2. Install dependencies and run tests.

npm install
npm run test

LICENSE

Copyright 2017 Cerner Innovation, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.