Configuring the name and appearance of the Web Widget



image avatar

Aimee Spanier

Zendesk Documentation Team

Edited Mar 19, 2025


0

55

57 comments

Hi all,

I'm unable to add any customisation to my widget. I've followed all of the suggested methods from https://developer.zendesk.com/api-reference/widget/api/, and also tried accessing the zIndex property from window.zE. I always put the window.zESettings script directly before the main snippet.js script, but no colours ever change. 

To demonstrate the issue, I've created a code sandbox: https://codesandbox.io/p/sandbox/admiring-colden-44k5kk

I've tried two approaches: 1. setting the scripts directly in index.html (currently commented out), 2. Creating a widget component in React. Both approaches set the widget, but neither can change the colours of the widget. I have removed our account key, so you will need to swap in a working key to see the widget.

I have a couple of questions regarding this:

1. Is there an example anywhere of a working web widget with JS customisation? So I can view the code. I'm aware of the one in your quick start guide, but that is exactly what I tried -- the settings script before the main script. Tried in both html and javascript.

2a. Is there a way to know if I'm using the classic web widget or not? It seems as though you have a classic version and a newer version, if I'm understanding correctly.

2b. Should the newer web widget be customised in a different way, or should it also be customised via a script that sets window.zESettings?

3. Any other tips / things I can check would be useful to know.

0


Hi Liam,
I'm not too sure that's possible at the moment. You might want to create a post as feedback, so our team can check that out!
 
Best,

0


How do we change the orientation of articles in the widget?  It is odd that they display horizontally in such a narrow window. 

0


Hi Kiichi,
 
If you have the Web Widget (Classic) or current Chat widget, at this time it is not possible to customize the shape or size of the Web Widget (Classic). If you have the Legacy Chat widget You can change the size between small, medium and large from the Chat dashboard. You can check this article for details How do I change the shape and size of the Zendesk widget?
 

0


Hello. Is it possible to change the size of the Zendesk widget? It doesn't matter if it's the old version or the new one.

0


Hi 1263082160589

Ahh I got it, Thank you!

0


Hi 1267965790010

It will apply all settings set in the Messaging - Style section in Mobile SDK. 

0


Hi, 1263082160589 
and what will show on Mobile?

is it the text "Hi, Need any help?" or what?

 

Thanks

0


Hi 1267965790010,

That setting is for Mobile SDK. If you have Mobile SDK and that option isn't enabled then that setting will not show in your app. 

0


What is this checkbox (Show on Mobile) for?

 

 

0


Sign in to leave a comment.