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 API | v2 migration |
|---|---|
FilePicker | Use file components in MobX RESTful table; check its current uploader API for prop changes |
FileUploader | Use file components in MobX RESTful table; check its current uploader API for prop changes |
MultipleFileUploader | Use file components in MobX RESTful table; check its current uploader API for prop changes |
FilterInput | Use searchable input facilities in MobX RESTful table |
IdeaForm | Use Form and the current REST form APIs in MobX RESTful table |
IdeaInfo | Use data-display facilities in MobX RESTful table |
IdeaTable | Use the current REST table APIs in MobX RESTful table |
PaginationBar | Use the pager in MobX RESTful table, or Pagination for presentation only |
ScrollBoundary | Use the scroll boundary/list components in MobX RESTful table |
AddressPicker | Build an application-level location picker with Open React Map |
MapData | Rework location data for Open React Map; the old embedded-map message API is not retained |
OpenMap | Migrate the component and its map, coordinate, marker and location types to Open React Map |
Added components
CountdownHorizontalMarqueeLiveTSXScrollNavShareBoxTextTruncateTimeTimelineToastUserRankVerticalMarqueeZodiacBar
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 component | v3 alternative |
|---|---|
Select | Combobox, or FormSelect for a native select |
Option | ComboboxOption |
Editor | React Bootstrap Editor for HTML editing; use an Editor.js integration for blocks |
EditorHTML | MarkdownView 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 API | v3 API |
|---|---|
Dialog | DialogBox |
DialogClose | DialogBoxClose |
DialogProps | DialogBoxProps |
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 API | Idea React v3 API |
|---|---|
Modal | Dialog |
Modal.Header | DialogHeader |
Modal.Title | DialogTitle |
Modal.Body | DialogBody |
Modal.Footer | DialogFooter |
Modal.show / Modal.onHide | Dialog.open / Dialog.onClose |
Offcanvas | Drawer |
Offcanvas.Header | DrawerHeader |
Offcanvas.Title | DrawerTitle |
Offcanvas.Body | DrawerBody |
Offcanvas.show / Offcanvas.onHide | Drawer.open / Drawer.onDismiss |
Dropdown | Menu |
Dropdown.show / Dropdown.onToggle | Menu manages its open state; Menu.onOpenChange reports changes |
Dropdown.Toggle | Menu.label and Menu.toggleProps |
Dropdown.Item | MenuItem |
Dropdown.Divider | MenuDivider |
Dropdown.Header | MenuHeader |
Form.Control | FormControl |
Form.Control.size / Form.Select.size | FormControl.controlSize / FormSelect.controlSize |
Form.Select | FormSelect |
Form.Check | FormCheck |
Form.Check with type="switch" | FormSwitch |
Form.Group | FormGroup or FormField |
Form.Label | FormLabel |
ProgressBar | Progress |
ProgressBar.now | Progress.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.