Deprecate customisations in favour of Module API (#25736)

This commit is contained in:
Michael Telatynski 2023-07-07 15:25:22 +01:00 committed by GitHub
parent 0a4a205fbe
commit bac0da3fe9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 0 deletions

View file

@ -1,5 +1,13 @@
# Customisations # Customisations
### 🦖 DEPRECATED
Customisations have been deprecated in favour of the [Module API](https://github.com/vector-im/element-web/blob/develop/docs/modules.md).
If you have use cases from customisations which are not yet available via the Module API please open an issue.
Customisations will be removed from the codebase in a future release.
---
Element Web and the React SDK support "customisation points" that can be used to Element Web and the React SDK support "customisation points" that can be used to
easily add custom logic specific to a particular deployment of Element Web. easily add custom logic specific to a particular deployment of Element Web.

View file

@ -61,6 +61,15 @@ try {
// stringify the output so it appears in logs correctly, as large files can sometimes get // stringify the output so it appears in logs correctly, as large files can sometimes get
// represented as `<Object>` which is less than helpful. // represented as `<Object>` which is less than helpful.
console.log("Using customisations.json : " + JSON.stringify(fileOverrides, null, 4)); console.log("Using customisations.json : " + JSON.stringify(fileOverrides, null, 4));
process.on("exit", () => {
console.log(""); // blank line
console.warn("!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!");
console.warn("!! Customisations have been deprecated and will be removed in a future release !!");
console.warn("!! See https://github.com/vector-im/element-web/blob/develop/docs/customisations.md !!");
console.warn("!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!");
console.log(""); // blank line
});
} catch (e) { } catch (e) {
// ignore - not important // ignore - not important
} }