Customize Meeting Icons
Dyte's UI Kit provides all the necessary UI components to allow complete customization of all its UI Kit components. You can customize your meeting icons such as chat, clock, leave meeting, mic on and off, and more.
Customizing the meeting icons involve the following steps:
- Integrate Dyte's web SDK into your web application
- Customize the default icon pack
Step 1: Integrate Dyte's web SDK into your web application
To get started with customizing the icons for your meetings, you need to first integrate Dyte's Web SDK into your web application.
- Install the package using npm or Yarn.
- CDN
- npm
- yarn
To set up UI Kit components and web-core, add the following script tags inside
the <head />
tag.
<head>
<script type="module">
import { defineCustomElements } from 'https://cdn.jsdelivr.net/npm/@dytesdk/ui-kit/loader/index.es2017.js';
defineCustomElements();
</script>
<!-- Import Web Core via CDN too -->
<script src="https://cdn.dyte.in/core/dyte.js"></script>
</head>
You can also import utilities or any other export from CDN:
<head>
<script type="module">
import {
provideDyteDesignSystem, extendConfig,
} from 'https://cdn.jsdelivr.net/npm/@dytesdk/ui-kit/dist/esm/index.js';
</script>
</head>
- Create a meeting room using the Create Meeting API.
- Generate an
authToken
using the Add Participant API. AnauthToken
is a unique token that is used to identify a user in the meeting. - Initialize the Dyte client using the
DyteClient.init({ authToken })
. It returns the meeting object. - Pass the meeting object to the UI Kit.
The dyte-meeting
component generates the default UI experience. Read more about how to customize the UI here.
<body>
<dyte-meeting id="my-meeting"></dyte-meeting>
<script>
const init = async () => {
const meeting = await DyteClient.init({
authToken: '',
defaults: {
audio: true,
video: true,
},
});
const meetingEl = document.getElementById('my-meeting');
meetingEl.meeting = meeting;
};
init();
</script>
</body>
Step 2: Customize default icon pack
Now that you've integrated Dyte SDK into your application successfully, let's quickly understand how you can customize the icon set for your application.
Dyte's default icon set is available at icons.dyte.io. You can modify and generate your custom icon set from here.
In order to replace Dyte's default icon set with your own, you can pass the link to your icon set in the dyte-meeting
component like so.
<body>
<dyte-meeting id="my-meeting"></dyte-meeting>
<script>
const init = async () => {
const meeting = await DyteClient.init({
authToken: '',
defaults: {
audio: true,
video: true,
},
});
const meetingEl = document.getElementById('my-meeting');
meetingEl.meeting = meeting;
// Pass custom icon pack url
meetingEl.iconPackUrl = 'https://example.com/my-icon-pack.json';
};
init();
</script>
</body>
IconPack Reference
Ƭ IconPack: typeof defaultIconPack
Icon Pack object type:
- Object key denotes name of icon
- Object value stores the SVG string
defaultIconPack
• Const
defaultIconPack: Object
Type declaration
Name | Type |
---|---|
attach | string |
call_end | string |
chat | string |
checkmark | string |
chevron_down | string |
chevron_left | string |
chevron_right | string |
chevron_up | string |
clock | string |
copy | string |
disconnected | string |
dismiss | string |
download | string |
emoji_multiple | string |
full_screen_maximize | string |
full_screen_minimize | string |
image | string |
image_off | string |
join_stage | string |
leave_stage | string |
mic_off | string |
mic_on | string |
more_vertical | string |
participants | string |
people | string |
pin | string |
pin_off | string |
poll | string |
recording | string |
rocket | string |
search | string |
send | string |
settings | string |
share | string |
share_screen_person | string |
share_screen_start | string |
share_screen_stop | string |
speaker | string |
spinner | string |
spotlight | string |
stop_recording | string |
subtract | string |
vertical_scroll | string |
vertical_scroll_disabled | string |
video_off | string |
video_on | string |
wand | string |
warning | string |
wifi | string |