|
| 1 | +# @element-hq/element-web-module-api |
| 2 | + |
| 3 | +API surface for extending Element Web in a safe & predictable way. |
| 4 | + |
| 5 | +This project is still in early development but aims to replace matrix-react-sdk-module-api and Element Web deprecated customisations. |
| 6 | + |
| 7 | +## Using the API |
| 8 | + |
| 9 | +Modules are loaded by Element Web at runtime via a dynamic ecmascript import, but can be bundled into a webapp for deployment convenience. |
| 10 | + |
| 11 | +The module's default export MUST be a class which accepts a single argument, an instance of `ModuleApi`. |
| 12 | +This class must also bear a static property `moduleApiVersion` which is a semver range string |
| 13 | +and a `load` method which is called when the module is to be loaded. |
| 14 | + |
| 15 | +```typescript |
| 16 | +import type { Module, Api, ModuleFactory } from "@element-hq/element-web-module-api"; |
| 17 | + |
| 18 | +class ExampleModule implements Module { |
| 19 | + public static readonly moduleApiVersion = "^0.1.0"; |
| 20 | + |
| 21 | + public constructor(private api: Api) {} |
| 22 | + |
| 23 | + public async load(): Promise<void> { |
| 24 | + // Your extension code goes here |
| 25 | + } |
| 26 | +} |
| 27 | + |
| 28 | +export default ExampleModule satisfies ModuleFactory; |
| 29 | +``` |
| 30 | + |
| 31 | +### Accessing application configuration |
| 32 | + |
| 33 | +The `api` object passed to the module constructor provides access to the application configuration. |
| 34 | +You can extend the Config types using declaration merging, though please ensure that you do not trust the types you specify, |
| 35 | +and opt for runtime validation due to the dynamic nature of the configuration. |
| 36 | + |
| 37 | +```typescript |
| 38 | +// ... |
| 39 | +declare module "@element-hq/element-web-module-api" { |
| 40 | + interface Config { |
| 41 | + "this.is.my.config.key": string; |
| 42 | + } |
| 43 | +} |
| 44 | + |
| 45 | +class ExampleModule implements Module { |
| 46 | + // ... |
| 47 | + public async load(): Promise<void> { |
| 48 | + const configValue = this.api.config.get("this.is.my.config.key"); |
| 49 | + // Your extension code goes here |
| 50 | + } |
| 51 | +} |
| 52 | +// ... |
| 53 | +``` |
| 54 | + |
| 55 | +## Releases |
| 56 | + |
| 57 | +The API is versioned using semver, with the major version incremented for breaking changes. |
| 58 | + |
| 59 | +## Copyright & License |
| 60 | + |
| 61 | +Copyright (c) 2025 New Vector Ltd |
| 62 | + |
| 63 | +This software is multi licensed by New Vector Ltd (Element). It can be used either: |
| 64 | + |
| 65 | +(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR |
| 66 | + |
| 67 | +(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to). |
| 68 | +Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses. |
0 commit comments