https://github.com/pexip/webapp3-plugin-rename-participant
https://github.com/pexip/webapp3-plugin-rename-participant
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pexip/webapp3-plugin-rename-participant
- Owner: pexip
- License: apache-2.0
- Created: 2024-11-20T14:51:13.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-12-11T10:59:13.000Z (7 months ago)
- Last Synced: 2025-12-12T11:45:55.379Z (7 months ago)
- Language: TypeScript
- Size: 395 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Web App 3 Plugin: Rename Participant
This plugin allows hosts to rename participants in the participant list. When
the host clicks the "Rename Participant" entry in the participant action menu, a
modal appears. The new name can be provided and will be set to the related
participant.
## How to use
A additional entry appears in the participant action menu in participant list.
This item opens a dialog to rename to participant.
Provide the new name and click rename.
The applied name will be shown in participant list
## Internationalization
Path: /public/loclales/
```json
{
"rename": "Rename",
"title": "Rename {{participantName}}",
"description": "You can rename the participant by entering a new name in the text field.",
"inputLabel": "Enter new display name",
"submitButton": "Rename"
}
```
## Limitations
- Currently entries in participant menu do not support icons when added by
plugin.
- Technically the overlay_text is overwritten and shown in the participant list,
the actual display name does not change.
See
[Overlay Text API](https://docs.pexip.com/api_client/api_rest.htm#overlaytext)
- SSO authenticated participants can not be renamed for security reasons.
In this case the rename item does not appear for these participants.
## Run for development
- To be able to build the plugin, you need to comply with the following versions
or higher:
| NodeJS | NPM |
| -------- | ------- |
| v20.12.2 | v10.5.0 |
- Install all the dependencies:
```bash
$ npm i
```
- Run the dev environment:
```bash
$ npm start
```
The plugin will be served from https://localhost:5173 (visit that page and
accept the self-signed certificates), but you should access it thought the Web
App 3 URL. You have more information about how to configure your environment in
the
[Developer Portal: Setup guide for plugin developers](https://developer.pexip.com/docs/plugins/webapp-3/setup-guide-for-plugin-developers).
## Build for production
To create a package, you will need to first install all the dependencies:
```bash
$ npm i
```
And now to create the package itself:
```bash
$ npm run build
```
Congrats! Your package is ready and it will be available in the `dist` folder.
The next step is to create a Web App3 branding and copy `dist` into that
branding.
If you want to know more about how to deploy your plugin in Pexip Infinity,
check our [Developer Portal](https://developer.pexip.com).