Skip to content

Commit ec8081c

Browse files
committed
docs: Update migration guide for device changes
1 parent 905f384 commit ec8081c

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/introduction/migration_v2.md

+4
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,9 @@ In version 1, the [**`theme`**](https://react-chatbotify.com/legacy/v1/docs/api/
6464
Changes Required:
6565
- Replace `theme` section with `general` section inside `settings` prop
6666

67+
### Moved desktopEnabled and mobileEnabled properties to device section
68+
The `desktopEnabled` and `mobileEnabled` properties were previously under the `theme` (now `general`) section. These have been moved to a new `device` section for better clarity and extensibility.
69+
6770
### Renamed Render Attribute to Component Attribute
6871
The [**`render`**](https://react-chatbotify.com/legacy/v1/docs/api/attributes#pre-processing-attributes) is understandably poorly named and has been a source of confusion for some users who mistakenly tried using `component` instead. Indeed, the purpose of this attribute was to allow users to provide their own components. With that said, it felt appropriate to update the name of this attribute to [**`component`**](/docs/api/attributes#pre-processing-attributes).
6972

@@ -172,6 +175,7 @@ For a quick upgrade, follow these succinct instructions:
172175
- Rename **BotOptions** to **Settings**, and adjust context and function names accordingly.
173176
- Utilize the new [**`styles`**](/docs/concepts/styles) prop and `getDefaultStyles`.
174177
- Rename `theme` section to `general` section under `settings` (previously `options`).
178+
- Move `desktopEnabled` and `mobileEnabled` properties from `theme` (now `general`) section to the new `device` section.
175179
- Rename `render` attribute in blocks to `component` attribute.
176180
- Rename `sendAttachmentOutput` to `sendFileName` **and** move it from `chatInput` section to `fileAttachment` section.
177181
- Rename `useAdvancedBotOptions` to `useAdvancedSettings` in `advance` section under `settings` (previously `options`).

0 commit comments

Comments
 (0)