Skip to content
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.

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

Initial support for runtime modules #29104

Merged
merged 13 commits into from
Feb 6, 2025
Merged

Initial support for runtime modules #29104

merged 13 commits into from
Feb 6, 2025

Conversation

t3chguy
Copy link
Member

@t3chguy t3chguy commented Jan 27, 2025

Aims to replace https://github.com/matrix-org/matrix-react-sdk-module-api & https://github.com/element-hq/element-web/blob/develop/docs/customisations.md with a run-time alternative which will support similar use-cases and APIs.

Runtime extensions will make it easier to ship & test many variants of Element Web & Desktop and make it easier for consumers to make small tweaks without needing to fork or maintain their own CI/CD pipeline.

The initial implementation of runtime modules aims to replace the deprecated customisations & react-sdk-module-api by offering a way to load those legacy extensions via the new API. This is only temporary and to aid transition as we design the new API surface.

The intent is to provide a very stable API surface, with more being possible using unstable access to globals or by rendering things directly using ReactDOM, this strives to hit a flexible middle ground.

See https://github.com/element-hq/element-modules/tree/main/packages/element-web-module-api#readme

Signed-off-by: Michael Telatynski <[email protected]>
@t3chguy t3chguy self-assigned this Jan 27, 2025
Signed-off-by: Michael Telatynski <[email protected]>
@t3chguy t3chguy changed the title Initial runtime Modules work Initial support for runtime modules Jan 30, 2025
@t3chguy
Copy link
Member Author

t3chguy commented Jan 31, 2025

Will need to bypass coverage due to lack of ESM support in our Jest at this time. I added a Playwright test instead.

Signed-off-by: Michael Telatynski <[email protected]>
Copy link
Member

@dbkr dbkr left a comment

Choose a reason for hiding this comment

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

generally looking nice!

Copy link
Member

@dbkr dbkr left a comment

Choose a reason for hiding this comment

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

Thanks!

…to t3chguy/modules-2025

Signed-off-by: Michael Telatynski <[email protected]>

# Conflicts:
#	src/@types/global.d.ts
#	src/customisations/ChatExport.ts
#	src/customisations/ComponentVisibility.ts
#	src/customisations/WidgetVariables.ts
@t3chguy t3chguy merged commit 4a231c6 into develop Feb 6, 2025
30 of 31 checks passed
@t3chguy t3chguy deleted the t3chguy/modules-2025 branch February 6, 2025 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants