Interface: ChatUIThemeStylingOptions
JSON schema for configuring the ChatKitty Chat UI theme options. It's designed to be intuitive and easy to understand for front-end developers, designers, and product managers alike.
Properties
$version
$version:
"0.0.2"
base-theme
base-theme:
"light"
|"dark"
The base theme to use for the Chat UI. This will be used as the default theme for all components.
overrides?
optional
overrides:object
Overrides for specific components. These will override the base theme for the specified component.
channels?
optional
channels:object
Channels list overrides.
channels.item?
optional
item:object
Channels item overrides.
channels.item.display-name?
optional
display-name:object
Channel display name overrides.
channels.item.display-name.color?
optional
color:string
The color of channel display names.
channels.item.last-message?
optional
last-message:object
Channel last message overrides.
channels.item.last-message.color?
optional
color:string
The color of channel last messages.
channels.item.last-message.timestamp?
optional
timestamp:object
Channel last message timestamp overrides.
channels.item.last-message.timestamp.color?
optional
color:string
The color of channel last message timestamps.
channels.item.unread?
optional
unread:object
Channel unread messages overrides.
channels.item.unread.counter?
optional
counter:object
Channel unread message counter overrides.
channels.item.unread.counter.background-color?
optional
background-color:string
The background color of channel unread message counters.
channels.item.unread.counter.color?
optional
color:string
The color of channel unread message counters.
channels.item.user?
optional
user:object
Channel user overrides. (DMs only)
channels.item.user.presence?
optional
presence:object
Channel user presence overrides.
channels.item.user.presence.status?
optional
status:object
Channel user presence status overrides.
channels.item.user.presence.status.offline?
optional
offline:object
Channel user presence offline status overrides.
channels.item.user.presence.status.offline.color?
optional
color:string
The color of channel user presence offline status.
channels.item.user.presence.status.online?
optional
online:object
Channel user presence online status overrides.
channels.item.user.presence.status.online.color?
optional
color:string
The color of channel user presence online status.
container?
optional
container:object
Chat container overrides.
container.border?
optional
border:object
Chat container border overrides.
container.border.radius?
optional
radius:string
The CSS radius of chat container borders.
container.border.style?
optional
style:string
The CSS style of chat container borders.
container.box-shadow?
optional
box-shadow:string
The CSS box shadow of chat containers.
content?
optional
content:object
Chat content overrides.
content.background-color?
optional
background-color:string
The background color of chat content.
dropdown?
optional
dropdown:object
Chat dropdown overrides.
dropdown.background-color?
optional
background-color:string
The background color of chat dropdowns.
dropdown.hover?
optional
hover:object
dropdown.hover.background-color?
optional
background-color:string
The background color of chat dropdown hover states.
emoji?
optional
emoji:object
Emoji picker overrides.
emoji.background-color?
optional
background-color:string
The emoji picker background color.
footer?
optional
footer:object
Chat footer overrides.
footer.background-color?
optional
background-color:string
The background color of chat footers.
footer.input?
optional
input:object
Chat footer input overrides.
footer.input.border?
optional
border:object
Chat footer input border overrides.
footer.input.border.selected?
optional
selected:string
The CSS style of chat footer input borders when selected.
footer.input.border.style?
optional
style:string
The CSS style of chat footer input borders.
footer.reply?
optional
reply:object
Chat footer reply overrides.
footer.reply.background-color?
optional
background-color:string
The background color of chat footer replies.
footer.tag?
optional
tag:object
Chat footer tag overrides.
footer.tag.active?
optional
active:object
Chat footer active tag overrides.
footer.tag.active.background-color?
optional
background-color:string
The background color of chat footer active tags.
footer.tag.background-color?
optional
background-color:string
The background color of chat footer tags.
general?
optional
general:object
General overrides for all components.
general.border?
optional
border:object
Border overrides for all components.
general.border.style?
optional
style:string
The CSS style of borders.
general.button?
optional
button:object
Button overrides for all components.
general.button.background-color?
optional
background-color:string
The default background color of buttons.
general.button.clear?
optional
clear:object
Clear button overrides for all components.
general.button.clear.color?
optional
color:string
The color of the clear button.
general.button.color?
optional
color:string
The default color of buttons.
general.input?
optional
input:object
Text input overrides for all components.
general.input.background-color?
optional
background-color:string
The background color of text inputs.
general.input.caret?
optional
caret:object
Text input caret overrides for all components.
general.input.caret.color?
optional
color:string
The color of the caret.
general.input.placeholder?
optional
placeholder:object
Input placeholder text overrides for all components.
general.input.placeholder.color?
optional
color:string
The color of placeholder text.
general.spinner?
optional
spinner:object
Spinner overrides for all components.
general.spinner.color?
optional
color:string
The color of spinners.
general.text?
optional
text:object
Text overrides for all components.
general.text.color?
optional
color:string
The color of text.
header?
optional
header:object
Chat header overrides.
header.background-color?
optional
background-color:string
The background color of chat headers.
header.channel?
optional
channel:object
Chat header channel overrides.
header.channel.description?
optional
description:object
header.channel.description.color?
optional
color:string
The color of chat header channel descriptions.
header.channel.name?
optional
name:object
header.channel.name.color?
optional
color:string
The color of chat header channel names.
icons?
optional
icons:object
Icon overrides.
icons.add?
optional
add:object
Add icon overrides.
icons.add.color?
optional
color:string
The color of add icons.
icons.audio?
optional
audio:object
Audio icon overrides.
icons.audio.cancel?
optional
cancel:object
Audio cancel icon overrides.
icons.audio.cancel.color?
optional
color:string
The color of audio cancel icons.
icons.audio.confirm?
optional
confirm:object
Audio confirm icon overrides.
icons.audio.confirm.color?
optional
color:string
The color of audio confirm icons.
icons.audio.pause?
optional
pause:object
Audio pause icon overrides.
icons.audio.pause.color?
optional
color:string
The color of audio pause icons.
icons.audio.play?
optional
play:object
Audio play icon overrides.
icons.audio.play.color?
optional
color:string
The color of audio play icons.
icons.close?
optional
close:object
Close icon overrides.
icons.close.color?
optional
color:string
The color of close icons.
icons.close.image?
optional
image:object
Close icon image overrides.
icons.close.image.color?
optional
color:string
The color of close icon images.
icons.close.outline?
optional
outline:object
Close icon outline overrides.
icons.close.outline.color?
optional
color:string
The color of close icon outlines.
icons.close.preview?
optional
preview:object
Close icon preview overrides.
icons.close.preview.color?
optional
color:string
The color of close icon previews.
icons.delivered?
optional
delivered:object
Delivered message status icon overrides.
icons.delivered.color?
optional
color:string
The color of delivered icons.
icons.document?
optional
document:object
Document icon overrides.
icons.document.color?
optional
color:string
The color of document icons.
icons.emoji?
optional
emoji:object
Emoji icon overrides.
icons.emoji.color?
optional
color:string
The color of emoji icons.
icons.file?
optional
file:object
File icon overrides.
icons.file.color?
optional
color:string
The color of file icons.
icons.menu?
optional
menu:object
Menu icon overrides.
icons.menu.color?
optional
color:string
The color of menu icons.
icons.microphone?
optional
microphone:object
Microphone icon overrides.
icons.microphone.color?
optional
color:string
The color of microphone icons.
icons.paperclip?
optional
paperclip:object
Paperclip icon overrides.
icons.paperclip.color?
optional
color:string
The color of paperclip icons.
icons.pencil?
optional
pencil:object
Pencil icon overrides.
icons.pencil.color?
optional
color:string
The color of pencil icons.
icons.preview?
optional
preview:object
Preview icon overrides.
icons.preview.color?
optional
color:string
The color of preview icons.
icons.reaction?
optional
reaction:object
Reaction icon overrides.
icons.reaction.color?
optional
color:string
The color of reaction icons.
icons.read?
optional
read:object
Read message status icon overrides.
icons.read.color?
optional
color:string
The color of read icons.
icons.scroll?
optional
scroll:object
Scroll icon overrides.
icons.scroll.background-color?
optional
background-color:string
The background color of scroll icons.
icons.search?
optional
search:object
Search icon overrides.
icons.search.color?
optional
color:string
The color of search icons.
icons.send?
optional
send:object
Send icon overrides.
icons.send.color?
optional
color:string
The color of send icons.
icons.send.disabled?
optional
disabled:object
Send icon disabled overrides.
icons.send.disabled.color?
optional
color:string
The color of disabled send icons.
icons.toggle?
optional
toggle:object
Toggle icon overrides.
icons.toggle.color?
optional
color:string
The color of toggle icons.
markdown?
optional
markdown:object
Chat markdown overrides.
markdown.background-color?
optional
background-color:string
The background color of chat markdown.
markdown.border?
optional
border:object
Chat markdown border overrides.
markdown.border.color?
optional
color:string
The color of chat markdown borders.
markdown.code?
optional
code:object
Chat markdown code overrides.
markdown.code.multi-line?
optional
multi-line:object
Chat markdown multi-line code overrides.
markdown.code.multi-line.color?
optional
color:string
The color of chat markdown multi-line code.
markdown.text?
optional
text:object
Chat markdown text overrides.
markdown.text.color?
optional
color:string
The color of chat markdown text.
message?
optional
message:object
Chat message overrides.
message.audio?
optional
audio:object
Chat message audio overrides.
message.audio.progress?
optional
progress:object
Chat message audio progress overrides.
message.audio.progress.background-color?
optional
background-color:string
The background color of chat message audio progress states.
message.audio.progress.line?
optional
line:object
Chat message audio progress line overrides.
message.audio.progress.line.background-color?
optional
background-color:string
The background color of chat message audio progress line states.
message.audio.progress.selector?
optional
selector:object
Chat message audio progress selector overrides.
message.audio.progress.selector.background-color?
optional
background-color:string
The background color of chat message audio progress selectors.
message.audio.record?
optional
record:object
Chat message audio record overrides.
message.audio.record.background-color?
optional
background-color:string
The background color of chat message audio record states.
message.date?
optional
date:object
Chat message date overrides.
message.date.background-color?
optional
background-color:string
The background color of chat message dates.
message.date.color?
optional
color:string
The color of chat message dates.
message.deleted?
optional
deleted:object
Chat deleted message overrides (messages deleted by the current user).
message.deleted.background-color?
optional
background-color:string
The background color of chat deleted messages.
message.deleted.color?
optional
color:string
The color of chat deleted message text.
message.draft?
optional
draft:object
Chat draft message overrides (messages started but not sent).
message.draft.text?
optional
text:object
Chat draft message text overrides.
message.draft.text.color?
optional
color:string
The color of chat draft message text.
message.file?
optional
file:object
Chat message file overrides.
message.file.extension?
optional
extension:object
Chat message file extension overrides.
message.file.extension.color?
optional
color:string
The color of chat message file extensions.
message.image?
optional
image:object
Chat message image overrides.
message.image.background-color?
optional
background-color:string
The background color of chat message images.
message.inbound?
optional
inbound:object
Chat inbound message overrides (messages sent by other users and received by the current user).
message.inbound.background-color?
optional
background-color:string
The background color of chat inbound messages.
message.media?
optional
media:object
message.media.background-color?
optional
background-color:string
The background color of chat media messages.
message.new?
optional
new:object
New (recently received) chat messages overrides.
message.new.color?
optional
color:string
The color of new chat message text.
message.new.counter?
optional
counter:object
New messages counter overrides.
message.new.counter.background-color?
optional
background-color:string
The background color of the new messages counter.
message.new.counter.color?
optional
color:string
The color of the new messages counter.
message.outbound?
optional
outbound:object
Chat outbound message overrides (messages sent by the current user).
message.outbound.background-color?
optional
background-color:string
The background color of chat outbound messages.
message.reaction?
optional
reaction:object
Chat message reaction overrides.
message.reaction.inbound?
optional
inbound:object
Inbound chat message reaction overrides. (reactions created by other users)
message.reaction.inbound.background-color?
optional
background-color:string
The background color of inbound chat message reactions.
message.reaction.inbound.border?
optional
border:object
Inbound chat message reaction border overrides.
message.reaction.inbound.border.style?
optional
style:string
The CSS style of inbound chat message reaction borders.
message.reaction.inbound.counter?
optional
counter:object
Inbound chat message reaction counter overrides.
message.reaction.inbound.counter.color?
optional
color:string
The color of inbound chat message reaction counters.
message.reaction.inbound.hover?
optional
hover:object
Inbound chat message reaction hover overrides.
message.reaction.inbound.hover.background-color?
optional
background-color:string
The background color of inbound chat message reaction hover states.
message.reaction.inbound.hover.border?
optional
border:object
Inbound chat message reaction hover border overrides.
message.reaction.inbound.hover.border.style?
optional
style:string
The CSS style of inbound chat message reaction hover borders.
message.reaction.outbound?
optional
outbound:object
Outbound chat message reaction overrides. (reactions created by the current user)
message.reaction.outbound.background-color?
optional
background-color:string
The background color of outbound chat message reactions.
message.reaction.outbound.border?
optional
border:object
Outbound chat message reaction border overrides.
message.reaction.outbound.border.style?
optional
style:string
The CSS style of outbound chat message reaction borders.
message.reaction.outbound.counter?
optional
counter:object
Outbound chat message reaction counter overrides.
message.reaction.outbound.counter.color?
optional
color:string
The color of outbound chat message reaction counters.
message.reaction.outbound.hover?
optional
hover:object
Outbound chat message reaction hover overrides.
message.reaction.outbound.hover.background-color?
optional
background-color:string
The background color of outbound chat message reaction hover states.
message.reaction.outbound.hover.border?
optional
border:object
Outbound chat message reaction hover border overrides.
message.reaction.outbound.hover.border.style?
optional
style:string
The CSS style of outbound chat message reaction hover borders.
message.reply?
optional
reply:object
Chat reply message overrides.
message.reply.background-color?
optional
background-color:string
The background color of chat reply messages.
message.reply.color?
optional
color:string
The color of chat reply message text.
message.reply.user?
optional
user:object
Chat reply message user overrides.
message.reply.user.display-name?
optional
display-name:object
Chat reply message user display name overrides.
message.reply.user.display-name.color?
optional
color:string
The color of chat reply message user display names.
message.selected?
optional
selected:object
Chat selected message overrides.
message.selected.background-color?
optional
background-color:string
The background color of chat selected messages.
message.system?
optional
system:object
Chat system message overrides.
message.system.background-color?
optional
background-color:string
The background color of chat system messages.
message.system.color?
optional
color:string
The color of chat system message text.
message.tag?
optional
tag:object
Chat message tag overrides.
message.tag.color?
optional
color:string
The color of chat message tags.
message.text?
optional
text:object
Chat message text overrides.
message.text.color?
optional
color:string
The color of chat message text.
message.timestamp?
optional
timestamp:object
Chat message timestamp overrides.
message.timestamp.color?
optional
color:string
The color of chat message timestamps.
message.user?
optional
user:object
Chat message user overrides.
message.user.display-name?
optional
display-name:object
Chat message user display name overrides.
message.user.display-name.color?
optional
color:string
The color of chat message user display names.
side-menu?
optional
side-menu:object
Chat side menu overrides.
side-menu.active?
optional
active:object
Chat side menu active overrides.
side-menu.active.background-color?
optional
background-color:string
The background color of chat side menu active states.
side-menu.active.color?
optional
color:string
The color of chat side menu active states.
side-menu.background-color?
optional
background-color:string
The background color of chat side menus.
side-menu.hover?
optional
hover:object
Chat side menu hover overrides.
side-menu.hover.background-color?
optional
background-color:string
The background color of chat side menu hover states.
side-menu.search?
optional
search:object
Chat side menu search overrides.
side-menu.search.border?
optional
border:object
Chat side menu search border overrides.
side-menu.search.border.color?
optional
color:string
The color of chat side menu search borders.
stylesheet?
optional
stylesheet:string
A custom stylesheet to be applied across the Chat UI. This will be applied after the base theme and component overrides.