Please see the 5.0 Migration Guide for more information about migrating your application code.

---

Backward Compatibility

We had to revert some changes made in 4.x to provide backward compatibility with pre-4.x applications.

• rxApp and related items have been reverted back to a compatible state.
  • Many page objects were reverted to support bringing rxApp back.
• rxBreadcrumbs is back
• rxEnvironment.get() is back, but deprecated
  • Please do not use this function!
• rxPageObjects reverted back to plain javascript
  • Converting rxPageObjects to TypeScript is still possible for a future release.

Breaking Changes

Upgrade to Angular 1.6

For security reasons and to bring functionality closer to current support, we've upgraded our AngularJS dependency to the latest 1.6 version. Please read the Angular Migration Guide for more information.

Removed Angular Bootstrap

To remove limitations around upgrading Angular in the future, we've ported relevant Angular Bootstrap functionality into EncoreUI. Functionality will behave as it did before, but things will have new names in Javascript and HTML. Please check the documentation for updated usage.

Other Breaking Changes

• rxApp - removed hotkeys
  • built-in hotkey support to expand/collapse the nav has been removed
• rxCharacterCount highlighting functionality removed
  • Highlighting functionality has been broken for quite some time.
  • Support and plans to correctly implement highlighting are no longer on the roadmap.
• Tooltip page object renamed to rxTooltip
• Tabs page object renamed to rxTabset

Deprecations

• LESS Color Palette Variables deprecated
  • Replacement: Use the new CSS Custom Properties described in the Color Documentation
• rxEnvironment.get()
  • Replacement: Use appropriate functions available in rxEnvironment service.

Fixed

• rxCharacterCount compatibility with ng-required has been corrected
• rxCopy CSS less greedy
  • rxCopy will only be hidden if it is a direct child of an .rxCopyTable cell
• Notifications visual change
  • rxNotification and rxNotifications recieved layout corrections to ensure a more consistent behavior and appearance among notifications.

Updated

• rxInlineError has been updated to insert an icon before the text to provide better accessibility for visually impaired users.

Added

• CSS Custom Properties (a.k.a. "CSS Variables")
  • The majority of the colors used across EncoreUI have been replaced with CSS Custom Properties.
  • This provides the foundation to develop custom stylesheets for theming purposes without the need to compile from LESS sources.
  • Read more about CSS Custom Properties

Merged

• #2025 - refactor(rxCopy): updated css styles for tables with rxCopy element
• #2024 - frmw434 -rxcharactercount
• #2021 - refactor(deprecations): Remove rxOptionTable and dependencies
• #2020 - frmw1374-backportdeprecated
• #1991 - fix(angular): Angular 1.6 upgrade
• #1988 - frmw821-replacesbstabs

Fixed

Corrected a major styling issue with regards to the recent notifications update.

before	after

Merged

• #1987 - fix(Notifications): correct notification styling

Added

• Added missing documentation around the controller attribute for rxModalAction.

Updated

Updated Styles for Banner Alerts

• Colors were updated to comply with the approved color palette.
• Icons updated to provide the best contrast for new colors.

Before	After

New Tooling for Test Docs

We've updated from jsdoc to tsdoc for documenting the test objects. It's not 100%, but it should be enough to navigate documentation.

Please note: given our current priorities, we cannot guarantee fixing any issues with this documentation.

Merged

• #1986 - refactor(modaljsdocs): missing rxmodalaction documentation
• #1985 - refactor(Notifications): implement new styles for alert banners
• #1983 - chore(rxPageObjects): Update docs README.md
• #1982 - chore(rxPageObjects): Refine doc comments and display
• #1981 - chore(rxPageObjects): TypeDoc config & explicit types
• #1980 - chore(rxPageObjects): FRMW-1321 - Convert rxPageObjects docs to TypeDoc [4.x]

Summary

You could call this the "Spring Clean" release. The changes made for this release were done to support only the Origin application and to clean up or remove technical debt code that few dared to touch. As such, this release is not backward compatible with applications that were written against older versions. The 4.0 Migration Guide is available to help port your applications to Origin as it consumes EncoreUI 4.0.0.

Removed

Components

If you take a look at the documentation, you might have noticed that the remaining Components have disappeared. This is not a trick. rxApp, rxOptionTable, and closely dependent items were removed to simplify the code base for use and to remove long-lived technical debt.

If you need an option table, it's not too difficult to write one from scratch using radios or checkboxes (with or without the help of rxBulkSelect). The vast majority of rxApp functionality was ported, overridden, or rewritten in the Origin application.

Hotkeys

The hotkeys dependency is no longer bundled with EncoreUI. Should you need hotkeys, you can always add it or an equivalent library as a dependency of your application.

Utilities

In 3.x, many utilities were deprecated or renamed. With the exception of PaginatedItemsSummary (slated for removal in 5.0.0) all injectables and directives within EncoreUI should begin with a rx prefix.

rxPageObjects

With the removal of Components and deprecated items, several page objects were also removed. See the 4.0 Migration Guide for a full list of removed items.

Updated

TypeScript

rxPageObjects has been converted to be written in TypeScript and generate ES5-compatible JavaScript.

Updated Docs

With the removal of the rxApp Component (see below), the documentation had to be updated accordingly. Since we were in there, we also took the opportunity to apply a new coat of paint and updated to use the new "Encore Black" style to the documentation.

Supported Versions

As documented in our Release Cadence, this release brings a new set of supported versions.

• EncoreUI 1.x is no longer supported
• EncoreUI 2.x is no longer supported
• EncoreUI 3.x is now in long-term support
• EncoreUI 4.x will be supported until 5.0 releases at the end of June, 2017.

Given that we must support some legacy applications that still rely on rxApp, 3.x will be supported for the foreseeable future, or until it can be proven to no longer be necessary.

Merged

• #1974 - FRMW-1273 - chore(rxPageObjects): Convert to TypeScript - part4 [4.x]
• #1973 - FRMW-1273 - chore(rxPageObjects): Convert to TypeScript - part3 [4.x]
• #1972 - fix(demo): correct angular error in Layout 2 demo [4.x]
• #1971 - FRMW-1273 - chore(rxPageObjects): Convert to TypeScript - part2 [4.x]
• #1970 - fix(navHighlighting): correct multi-highlight [4.x]
• #1968 - chore(audit): Remove remaining 3.x deprecations [4.x]
• #1966 - FRMW-1303 - remove hotkeys [4.x]
• #1965 - FRMW-1273 - chore(rxPageObjects): Convert to TypeScript - part1 [4.x]
• #1963 - refactor(rxEnvironmentUrl): remove rxEnvironmentUrl filter [4.x]
• #1946 - refactor(4dot0): remove rxApp and ilk
• #1939 - FRMW-1214 - Remove rxOptionTable [4.x]
• #1933 - FRMW-1245 - Remove 3.x Deprecations [4.x]
• #1930 - chore(rxPageObjects): FRMW-1264 - Remove rx-page-objects 3.x Deprecations [4.x]
• #1887 - chore(demo): New Layout for 4.x

Fixed

• Corrected circular dependency error on $http(introduced in 3.4.0)
• Corrected styling of rxApp background when browser width is constrained to the point of scrolling horizontally.

Added

• Newly added class-based, 12-column grid system!
  • Technically available in 3.4.2, but that release had issues anyway (better late than never).
  • See FlexboxGrid for documentation on how to consume the new grid.
  • The old attribute-based grid system is still available.
    • Slated for removal in the 5.0.0 release in the fall of 2017

Updated

• Corrected many element and utility stabilities. Lots of items were deprecated recently, but the documentation wasn't updated to reflect the proper stability.

Merged

• #1945 - feat(FlexboxGrid): add 12-column grid system
• #1951 - refactor(rxEnvironment): stop using rxEnvironment.get()
• #1959 - fix(rxApp): 3.x FRMW-1310 rxApp Background Color
• #1960 - fix(circularDeps): correct $http circular dependency
• #1964 - refactor(stabilitypills): updated to correct stability

Fixed

• rxAccountInfo - corrected bug preventing tooltips from appearing when hovering over account badges

Fixed rxFloatingHeader

• Corrected memory leak from leftover window event listeners
• Fixed phantom pixel (table grew by 1px to account for floating header)
• Within a table with nested content, corrected contrast ratio of chevron when expanded
• Corrected jumpy table data when transitioning to/from floating headers (smooth float)

Deprecated

The following items have been marked as deprecated and will be removed in EncoreUI 4.0.0:

• Paginate filter - use rxPaginate filter instead
• Permission - use rxAuth instead
• Session - use rxAuth instead
• StatusUtil - no replacement

Deprecated rxPageObjects

• rxApp - no replacement
• rxButton - no replacement
• rxEnvironment - no replacement
• rxInfoPanel - no replacement
• rxMisc.currencyToPennies() - no replacement
• rxMisc.newDate() - no replacement
• rxMisc.negate() - no replacement
• rxMisc.unless() - no replacement
• rxMisc.scrollPosition - no replacement
• rxMisc.compareXLocations() - no replacement
• rxMisc.compareYLocations() - no replacement
• rxMisc.transformLocation() - no replacement
• rxOptionTable - no replacement
• rxPage - no replacement
• rxSpinner - no replacement

Added

• rxPaginate filter - renamed from Paginate
• (Tables with nested content) Added visual separator between nested content and following table row

Added Functionality to rxFloatingHeader

There are a handful of edge cases where header geometry got out of sync with the table data. The following cases have been addressed:

• Float + Resize Window: will recalculate header geometry after a short delay
• Float + rxPaginate: will recalculate header geometry when columns shift as you navigate
• Float + rxBulkSelect: will recalculate geometry when bulk select message header appears/disappears.

Updated

• API Docs - corrected many inconsistencies in API documentation
• rxAuth - updated API docs to better reflect functionality in logic

Merged

• #1941 - fix(rxFloatingHeader): correct styling and rendering bugs [3.x]
• #1937 - fix(AccountInfo): correct bug with badge tooltips [3.x]
• #1927 - chore(rxPageObjects): FRMW-1264 - Deprecate Several rx-page-objects
• #1926 - refactor(ngdocs): Refactor ng docs with updated changes
• #1924 - refactor(StatusUtil): deprecate StatusUtil
• #1923 - refactor(rxPaginate): rxprefix Paginate filter
• #1922 - refactor(SessionPermission): refactor into rxAuth

Fixed

rxFloatingHeader

• Corrected memory leak from leftover window event listeners

Style Corrections

• Fixed phantom pixel (table grew by 1px to account for floating header)
• Nested Content
  • Corrected contrast ratio of chevron
  • Added visual separator between nested content and the following row

Ensure Smooth Scrolling

• Corrected jumpy table data when transitioning to/from floating headers

Automatically Recalculate Header Geometry

There are a handful of edge cases where header geometry got out of sync with the table data. The following cases were addressed:

• Float + Resize Window: will recalculate header geometry after a short delay
• Float + rxPaginate: will recalculate header geometry when columns shift as you navigate pages of data.
• Float + rxBulkSelect: will recalculate geometry when bulk select message header appears/disappears.

Merged

• #1940 - fix(rxFloatingHeader): correct styling and rendering bugs [2.x]

Fixed

rxFloatingHeader

• Corrected memory leak from leftover window event listeners

Style Corrections

• Fixed phantom pixel (table grew by 1px to account for floating header)
• Nested Content
  • Corrected contrast ratio of chevron
  • Added visual separator between nested content and the following row

Ensure Smooth Scrolling

• Corrected jumpy table data when transitioning to/from floating headers

Automatically Recalculate Header Geometry

There are a handful of edge cases where header geometry got out of sync with the table data. The following cases were addressed:

• Float + Resize Window: will recalculate header geometry after a short delay
• Float + rxPaginate: will recalculate header geometry when columns shift as you navigate pages of data.
• Float + rxBulkSelect: will recalculate geometry when bulk select message header appears/disappears.

Merged

• #1921 - fix(tables): correct table styles [1.x]
• #1934 - fix(rxFloatingHeader): correct numerous rendering bugs [1.x]

Fixed

• Corrected bug with missing badge tooltips in Account Info element.

Merged

• #1936 - fix(AccountInfo): correct bug with badge tooltips [2.x]

Summary

TL;DR: lots of stuff got deprecated. See the list below for information about how to update your code.

With the 3.3.0 release, we're on track with preparations for the 4.0 release at the end of March. The gist of this release is to normalize injectable names for those injectables we plan on keeping around for 4.0. Some items are marked for deprecation without replacement, because we plan on dropping those injectables for the 4.0 release.

Deprecated

Utilities

• Auth: use rxAuth instead
• devicePaths: use rxDevicePaths instead
• encoreRoutes: use rxEncoreRoutes instead
• feedbackApi: use rxFeedbackApi instead
• feedbackTypes: use rxFeedbackTypes instead
• Identity: use rxAuth instead
• rxAppRoutes (no replacement)
• rxVisibility (no replacement)
• rxVisibilityPathParams (no replacement)
• Status: use rxStatus instead
• titleize: use rxTitleize instead
• TokenInterceptor: use rxTokenInterceptor instead
• UnauthorizedInterceptor: use rxUnauthorizedInterceptor instead
• urlUtils: use rxUrlUtils instead
• UtcOffsets: use rxUtcOffsets instead
• xor: use rxXor instead

LESS Mixins

• .transition(): use standard transition property instead
• .transition-property(): use standard transition property instead
• .transition-value(): use standard transition property instead

Added

• rxAuth: new name for Auth service
• rxDevicePaths: new name for devicePaths value
• rxEncoreRoutes: new name for encoreRoutes service
• rxFeedbackApi: new name for feedbackApi constant
• rxFeedbackTypes: new name for feedbackTypes value
• rxStatus: new name for Status service
• rxTitleize: new name for titleize filter
• rxTokenInterceptor: new name for TokenInterceptor service
• rxUnauthorizedInterceptor: new name for UnauthorizedInterceptor provider
• rxUrlUtils: new name for urlUtils service
• rxUtcOffsets: new name for UtcOffsets constant
• rxXor: new name for xor filter

Updated

• Refactoring in preparation for removal of rxApp in EncoreUI 4.0.0

Merged

• #1891 - refactor(rxTokenInterceptor): rx-prefixes update to TokenInterceptor
• #1893 - refactor(rxUnauthorizedInterceptor): rx-prefixes update
• #1894 - refactor(rxUtcOffsets): rx-prefixes update UtcOffsets
• #1896 - refactor(rxFeedbackApi): rx-prefixes update
• #1897 - refactor(rxFeedbackTypes): rx-prefixes update feedbackTypes
• #1899 - refactor(rxXor): rx-prefixes update to xor
• #1890 - refactor(rxStatus): rx-prefixes update to Status
• #1895 - refactor(rxEncoreRoutes): rx-prefixes update to encoreRoutes
• #1900 - refactor(multiple): Deprecates multiple modules
• #1903 - refactor(rxUrlUtils): rename urlUtils with rx prefix
• #1904 - refactor(rxTitleize): Renames titleize to rxTitleize
• #1908 - fix(midways): QoL and Flaky Test Fix
• #1910 - refactor(rxAuth): rx-prefixes update Auth
• #1911 - refactor(rxDevicePaths): rename devicePaths with rx prefix
• #1912 - refactor(CSS): reorganize common.less
• #1914 - refactor(src): ensure proper testing and usage of deprecated items
• #1916 - refactor(Identity): refactor Identity into rxAuth
• #1917 - fix(docs): correct documentation
• #1920 - refactor(mixins): deprecate transition mixins