Skip to content

Added migration instructions for the customized index.html #9042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
quinntracy merged 3 commits into from
Feb 13, 2025
Merged

Added migration instructions for the customized index.html #9042

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
225392d
Added migration instructions for the customized index.html
exec-astraea Feb 12, 2025
f9a8746
Proof
quinntracy Feb 13, 2025
e0c6921
Formatting
quinntracy Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions content/en/docs/refguide/runtime/mendix-client/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,16 @@ The migration mode will show deprecation warnings instead of errors for all inco

Read further for guides that allow you convert your app so it is ready for the React client.

### Custom `index.html`{#index}

The structure of the `index.html` file is different for React and Dojo clients. To make sure your application will work correctly, follow these steps:

1. Delete the custom `index.html`, or rename it temporarily.
2. Run the local deployment and copy the app/deployment/web/index-example.html to your app/theme/web/index.html. That will be your new `index.html`.
3. Apply any changes you want.
Copy link
Contributor

@Robinfr Robinfr Feb 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apply customization where required.


It is also possible to keep custom `index.html` files for both clients. To do this, name the React client index file *index-react.html*. This file will take precedence when the React client is enabled, while the `index.html` will be used for Dojo client deployments.
Copy link
Contributor

@Robinfr Robinfr Feb 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, let's also use code blocks for index-react.html.

Copy link
Collaborator

@quinntracy quinntracy Feb 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our style guide uses italics to clarify the name of something, which is why index-react.html is italicized rather than in code formatting. I will change the other places noted above to be in code formatting, though.

Copy link
Contributor

@Robinfr Robinfr Feb 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add why customers might want to do this, e.g. while they are migrating their app?


### Marketplace Components{#marketplace}

Not all Mendix Marketplace components are ready for the React client. Refer to [Marketplace Component React Status](/refguide/mendix-client/marketplace-react-status/) to see which of the most popular marketplace components are React ready. If a module or widget you are using is not on the list, test it for yourself then reach out to the authors to update it if not.
Expand Down