Skip to content

Commit

Permalink
Extend local example for the widget toggle module
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Weimann <michael.weimann@nordeck.net>
  • Loading branch information
weeman1337 committed Jul 10, 2024
1 parent 4acbd85 commit 77ec8ae
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions packages/element-web-widget-toggles-module/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,19 @@ Example configuration:

2. Checkout Element and set up the development environment according to [their documentation](https://github.com/vector-im/element-web/#building-from-source).

3. (In the `element-web` folder) Create a `build_config.yaml` with the following content:
3. (In the `element-web` folder) Add the following to the `config.json`:

```json
"net.nordeck.element_web.module.widget_toggles": {
"config": {
"types": ["jitsi", "net.nordeck"]
}
},
```

This will show toggles for the Jitsi and Nordeck widget

4. (In the `element-web` folder) Create a `build_config.yaml` with the following content:

```yaml
# Directory structure:
Expand All @@ -77,6 +89,8 @@ Example configuration:
- 'file:../element-web-modules/packages/element-web-widget-toggles-module'
```

4. (In the `element-web` folder) Run `yarn start` and access it at `http://localhost:8080`
5. (In the `element-web` folder) Run `yarn start` and access it at `http://localhost:8080`

6. Add a Jitsi and e.g. [NeoBoard](https://github.com/nordeck/matrix-neoboard?tab=readme-ov-file#demo) widget to a room

> **Important**: You must run `yarn build` in this repo and restart Element after each change in the module.

0 comments on commit 77ec8ae

Please sign in to comment.