Skip to content

Latest commit

 

History

History
175 lines (149 loc) · 22.9 KB

README.md

File metadata and controls

175 lines (149 loc) · 22.9 KB
Raw

Terra Core

Cerner OSS Build Status lerna devDependencies status

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 Stable Stable

Terra Package Version Status
terra-abstract-modal NPM version Stable
terra-action-footer NPM version Stable
terra-action-header NPM version Stable
terra-alert NPM version Stable
terra-arrange NPM version Stable
terra-avatar NPM version Stable
terra-application NPM version Stable
terra-badge NPM version Stable
terra-base NPM version Stable
terra-button NPM version Stable
terra-button-group NPM version Stable
terra-card NPM version Stable
terra-collapsible-menu-view NPM version Stable
terra-content-container NPM version Stable
terra-date-picker NPM version Stable
terra-date-time-picker NPM version Stable
terra-demographics-banner NPM version Stable
terra-dialog NPM version Stable
terra-divider NPM version Stable
terra-doc-template NPM version Stable
terra-dynamic-grid NPM version Stable
terra-embedded-content-consumer NPM version Stable
terra-form NPM version Stable
terra-form-field NPM version Stable
terra-form-fieldset NPM version Stable
terra-form-input NPM version Stable
terra-form-radio NPM version Stable
terra-form-select NPM version Stable
terra-form-textarea NPM version Stable
terra-grid NPM version Stable
terra-heading NPM version Stable
terra-i18n NPM version Stable
terra-i18n-plugin NPM version Stable
terra-icon NPM version Stable
terra-image NPM version Stable
terra-legacy-theme NPM version Deprecated
terra-list NPM version Stable
terra-markdown NPM version Stable
terra-menu NPM version Stable
terra-mixins NPM version Stable
terra-modal NPM version Stable
terra-overlay NPM version Stable
terra-profile-image NPM version Stable
terra-progress-bar NPM version Stable
terra-props-table NPM version Stable
terra-responsive-element NPM version Stable
terra-search-field NPM version Stable
terra-slide-group NPM version Stable
terra-section-header NPM version Stable
terra-signature NPM version Stable
terra-slide-group NPM version Stable
terra-spacer NPM version Stable
terra-status NPM version Stable
terra-status-view NPM version Stable
terra-table NPM version Stable
terra-tabs NPM version Stable
terra-tag NPM version Stable
terra-text NPM version Stable
terra-time-input NPM version Stable
terra-toggle NPM version Stable
terra-toggle-button NPM version Stable
terra-toggle-section-header NPM version Stable

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. Please follow terra-i18n Aggregate Translations Guide to set up aggregated translations.
  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

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.