v1 to v2 upgrade guide

Jump to bottom

Callum Smith edited this page Nov 1, 2018 · 8 revisions

Additions

PlaceholderModule
- unifies DialogPlaceholder and ModalPlaceholder into one component
- provides a single service for components to render out of flow elements into

Deprecations

Switch has been deprecated in favor of Toggle. Switch is set to be removed with v3
- ToggleModule replaces SwitchModule
- ToggleChange replaces SwitchChange
- ToggleState replaces SwitchState
Banner has been deprecated in favour of Notification. Banner is set to be removed with v3
- NotificationModule replaces BannerModule
- NotificationContent replaces BannerContent
- Notification replaces Banner
- Toast stays the same
appendToBody has been deprecated in favour of appendInline. The default values have also been reversed - by default everything renders into an ibm-placeholder (or the body), appendInline="true" should be used if you need the component to render in the normal page flow.

Changes

removed the Component suffix where applicable. This doesn't change the selectors, just the exported class names.
- CheckboxComponent is now Checkbox
- DialogPlaceholderComponent is now DialogPlaceholder
- LabelComponent is now Label
- AlertModalComponent is now AlertModal
- ModalFooterComponent is now ModalFooter
- ModalHeaderComponent is now ModalHeader
- ModalPlaceholderComponent is now ModalPlaceholder
- ModalComponent is now Modal
- OverlayComponent is now Overlay
- RadioGroupComponent is now RadioGroup
- RadioComponent is now Radio
- SwitchComponent is now Switch
Modal and ModalOverlay now use theme instead of modalType

Removals

removed unused button-menu component
removed unused popover component
removed "default" as a size or type option for most cases