Loading...
Skip to main content

Migration

Import public components from idea-react rather than internal source paths.

v1 to v2

Removed APIs

Data-backed Table, List and Form components moved to MobX RESTful table, while Open Map and its model moved to Open React Map. These are migrations, not drop-in replacements:

v1 APIv2 migration
FilePickerUse file components in MobX RESTful table; check its current uploader API for prop changes
FileUploaderUse file components in MobX RESTful table; check its current uploader API for prop changes
MultipleFileUploaderUse file components in MobX RESTful table; check its current uploader API for prop changes
FilterInputUse searchable input facilities in MobX RESTful table
IdeaFormUse Form and the current REST form APIs in MobX RESTful table
IdeaInfoUse data-display facilities in MobX RESTful table
IdeaTableUse the current REST table APIs in MobX RESTful table
PaginationBarUse the pager in MobX RESTful table, or Pagination for presentation only
ScrollBoundaryUse the scroll boundary/list components in MobX RESTful table
AddressPickerBuild an application-level location picker with Open React Map
MapDataRework location data for Open React Map; the old embedded-map message API is not retained
OpenMapMigrate the component and its map, coordinate, marker and location types to Open React Map

Added components

  1. Countdown
  2. HorizontalMarquee
  3. LiveTSX
  4. ScrollNav
  5. ShareBox
  6. TextTruncate
  7. Time
  8. Timeline
  9. Toast
  10. UserRank
  11. VerticalMarquee
  12. ZodiacBar

Dialog input

The Promise-based dialog model gained a typed input parameter. Pass optional input to open(input); existing calls to open() remain valid. In v3, the model is named DialogBox.

v2 to v3

Removed components

v2 componentv3 alternative
SelectCombobox, or FormSelect for a native select
OptionComboboxOption
EditorReact Bootstrap Editor for HTML editing; use an Editor.js integration for blocks
EditorHTMLMarkdownView only after converting the Editor.js data to Markdown

MarkdownView accepts Markdown text; it does not convert or render Editor.js block data.

The recommended React Bootstrap Editor edits HTML, not Editor.js block data. Install it separately:

npm install react-bootstrap-editor

Existing Editor.js documents require explicit conversion or an application-owned Editor.js integration.

Renamed APIs

v2 APIv3 API
DialogDialogBox
DialogCloseDialogBoxClose
DialogPropsDialogBoxProps

Bootstrap CSS

Idea React v2 uses Bootstrap 5; v3 targets Bootstrap 6. Replace the Bootstrap 5 stylesheet with the Bootstrap 6 stylesheet used by your application. Idea React components do not bundle third-party CSS, so load both Bootstrap and the library stylesheet in the document head:

<link
rel="stylesheet"
href="https://unpkg.com/bootstrap@6.0.0-alpha.1/dist/css/bootstrap.min.css"
/>
<link rel="stylesheet" href="https://unpkg.com/idea-react/dist/style.css" />

Bootstrap utility names and component styles may differ between major versions; update custom classes and selectors along with the stylesheet.

React-Bootstrap v2 to Idea React v3

React-Bootstrap v2 targets Bootstrap 5, while Idea React v3 targets Bootstrap 6. The table lists only component and prop names that differ; same-named components are omitted.

React-Bootstrap v2 APIIdea React v3 API
ModalDialog
Modal.HeaderDialogHeader
Modal.TitleDialogTitle
Modal.BodyDialogBody
Modal.FooterDialogFooter
Modal.show / Modal.onHideDialog.open / Dialog.onClose
OffcanvasDrawer
Offcanvas.HeaderDrawerHeader
Offcanvas.TitleDrawerTitle
Offcanvas.BodyDrawerBody
Offcanvas.show / Offcanvas.onHideDrawer.open / Drawer.onDismiss
DropdownMenu
Dropdown.show / Dropdown.onToggleMenu manages its open state; Menu.onOpenChange reports changes
Dropdown.ToggleMenu.label and Menu.toggleProps
Dropdown.ItemMenuItem
Dropdown.DividerMenuDivider
Dropdown.HeaderMenuHeader
Form.ControlFormControl
Form.Control.size / Form.Select.sizeFormControl.controlSize / FormSelect.controlSize
Form.SelectFormSelect
Form.CheckFormCheck
Form.Check with type="switch"FormSwitch
Form.GroupFormGroup or FormField
Form.LabelFormLabel
ProgressBarProgress
ProgressBar.nowProgress.value

Idea React uses flat named exports instead of React-Bootstrap's nested component properties. A Modal's show/onHide pair does not transfer directly: control Dialog with open and update it from onClose. See the Dialog and Form guides for current props and examples.

Dependencies and stylesheets

Remove React-Bootstrap and install Idea React with the required peer dependencies:

npm uninstall react-bootstrap
npm install idea-react mobx mobx-react react react-dom react-element-to-jsx-string web-utility

Load Bootstrap 6 and Idea React CSS separately; replace any Bootstrap 5 stylesheet with the Bootstrap 6 version:

<link
rel="stylesheet"
href="https://unpkg.com/bootstrap@6.0.0-alpha.1/dist/css/bootstrap.min.css"
/>
<link rel="stylesheet" href="https://unpkg.com/idea-react/dist/style.css" />

If the application uses Icon, also load the Bootstrap Icons font stylesheet.

Documentation navigation
On this page
On this page