mirror of
https://github.com/lingble/chatwoot.git
synced 2025-10-31 19:17:48 +00:00
# Pull Request Template
## Description
This PR allows users to dynamically pass custom welcome and availability
messages, along with UI feature toggles, via `window.chatwootSettings`.
If any of the following settings are provided, the widget will use them;
otherwise, it falls back to default behavior.
**New options:**
```
window.chatwootSettings = {
welcomeTitle: 'Need help?', // Custom widget title
welcomeDescription: 'We’re here to support you.', // Subtitle in the header
availableMessage: 'We’re online and ready to chat!', // Shown when team is online
unavailableMessage: 'We’re currently offline.', // Shown when team is unavailable
enableFileUpload: true, // Enable file attachments
enableEmojiPicker: true, // Enable emoji picker in chat input
enableEndConversation: true // Allow users to end the conversation
}
```
Fixes
https://linear.app/chatwoot/issue/CW-4589/add-options-to-windowchatwootsettings
## Type of change
- [x] New feature (non-breaking change which adds functionality)
## How Has This Been Tested?
### Loom video
https://www.loom.com/share/413fc4aa59384366b071450bd19d1bf8?sid=ff30fb4c-267c-4beb-80ab-d6f583aa960d
## Checklist:
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my code
- [ ] I have commented on my code, particularly in hard-to-understand
areas
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream
modules
---------
Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>
156 lines
4.8 KiB
JavaScript
156 lines
4.8 KiB
JavaScript
import {
|
|
SET_BUBBLE_VISIBILITY,
|
|
SET_COLOR_SCHEME,
|
|
SET_REFERRER_HOST,
|
|
SET_WIDGET_APP_CONFIG,
|
|
SET_WIDGET_COLOR,
|
|
TOGGLE_WIDGET_OPEN,
|
|
SET_ROUTE_UPDATE_STATE,
|
|
} from '../types';
|
|
|
|
const state = {
|
|
hideMessageBubble: false,
|
|
isCampaignViewClicked: false,
|
|
showUnreadMessagesDialog: true,
|
|
isWebWidgetTriggered: false,
|
|
isWidgetOpen: false,
|
|
position: 'right',
|
|
referrerHost: '',
|
|
showPopoutButton: false,
|
|
widgetColor: '',
|
|
widgetStyle: 'standard',
|
|
darkMode: 'light',
|
|
isUpdatingRoute: false,
|
|
welcomeTitle: '',
|
|
welcomeDescription: '',
|
|
availableMessage: '',
|
|
unavailableMessage: '',
|
|
enableFileUpload: true,
|
|
enableEmojiPicker: true,
|
|
enableEndConversation: true,
|
|
};
|
|
|
|
export const getters = {
|
|
getAppConfig: $state => $state,
|
|
isRightAligned: $state => $state.position === 'right',
|
|
getHideMessageBubble: $state => $state.hideMessageBubble,
|
|
getIsWidgetOpen: $state => $state.isWidgetOpen,
|
|
getWidgetColor: $state => $state.widgetColor,
|
|
getReferrerHost: $state => $state.referrerHost,
|
|
isWidgetStyleFlat: $state => $state.widgetStyle === 'flat',
|
|
darkMode: $state => $state.darkMode,
|
|
getShowUnreadMessagesDialog: $state => $state.showUnreadMessagesDialog,
|
|
getIsUpdatingRoute: _state => _state.isUpdatingRoute,
|
|
getWelcomeHeading: $state => $state.welcomeTitle,
|
|
getWelcomeTagline: $state => $state.welcomeDescription,
|
|
getAvailableMessage: $state => $state.availableMessage,
|
|
getUnavailableMessage: $state => $state.unavailableMessage,
|
|
getShouldShowFilePicker: $state => $state.enableFileUpload,
|
|
getShouldShowEmojiPicker: $state => $state.enableEmojiPicker,
|
|
getCanUserEndConversation: $state => $state.enableEndConversation,
|
|
};
|
|
|
|
export const actions = {
|
|
setAppConfig(
|
|
{ commit },
|
|
{
|
|
showPopoutButton,
|
|
position,
|
|
hideMessageBubble,
|
|
showUnreadMessagesDialog,
|
|
widgetStyle = 'rounded',
|
|
darkMode = 'light',
|
|
welcomeTitle = '',
|
|
welcomeDescription = '',
|
|
availableMessage = '',
|
|
unavailableMessage = '',
|
|
enableFileUpload = true,
|
|
enableEmojiPicker = true,
|
|
enableEndConversation = true,
|
|
}
|
|
) {
|
|
commit(SET_WIDGET_APP_CONFIG, {
|
|
hideMessageBubble: !!hideMessageBubble,
|
|
position: position || 'right',
|
|
showPopoutButton: !!showPopoutButton,
|
|
showUnreadMessagesDialog: !!showUnreadMessagesDialog,
|
|
widgetStyle,
|
|
darkMode,
|
|
welcomeTitle,
|
|
welcomeDescription,
|
|
availableMessage,
|
|
unavailableMessage,
|
|
enableFileUpload,
|
|
enableEmojiPicker,
|
|
enableEndConversation,
|
|
});
|
|
},
|
|
toggleWidgetOpen({ commit }, isWidgetOpen) {
|
|
commit(TOGGLE_WIDGET_OPEN, isWidgetOpen);
|
|
},
|
|
setWidgetColor({ commit }, widgetColor) {
|
|
commit(SET_WIDGET_COLOR, widgetColor);
|
|
},
|
|
setColorScheme({ commit }, darkMode) {
|
|
commit(SET_COLOR_SCHEME, darkMode);
|
|
},
|
|
setReferrerHost({ commit }, referrerHost) {
|
|
commit(SET_REFERRER_HOST, referrerHost);
|
|
},
|
|
setBubbleVisibility({ commit }, hideMessageBubble) {
|
|
commit(SET_BUBBLE_VISIBILITY, hideMessageBubble);
|
|
},
|
|
setRouteTransitionState: async ({ commit }, status) => {
|
|
// Handles the routing state during navigation to different screen
|
|
// Called before the navigation starts and after navigation completes
|
|
// Handling this state in app/javascript/widget/router.js
|
|
// See issue: https://github.com/chatwoot/chatwoot/issues/10736
|
|
commit(SET_ROUTE_UPDATE_STATE, status);
|
|
},
|
|
};
|
|
|
|
export const mutations = {
|
|
[SET_WIDGET_APP_CONFIG]($state, data) {
|
|
$state.showPopoutButton = data.showPopoutButton;
|
|
$state.position = data.position;
|
|
$state.hideMessageBubble = data.hideMessageBubble;
|
|
$state.widgetStyle = data.widgetStyle;
|
|
$state.darkMode = data.darkMode;
|
|
$state.locale = data.locale || $state.locale;
|
|
$state.showUnreadMessagesDialog = data.showUnreadMessagesDialog;
|
|
$state.welcomeTitle = data.welcomeTitle;
|
|
$state.welcomeDescription = data.welcomeDescription;
|
|
$state.availableMessage = data.availableMessage;
|
|
$state.unavailableMessage = data.unavailableMessage;
|
|
$state.enableFileUpload = data.enableFileUpload;
|
|
$state.enableEmojiPicker = data.enableEmojiPicker;
|
|
$state.enableEndConversation = data.enableEndConversation;
|
|
},
|
|
[TOGGLE_WIDGET_OPEN]($state, isWidgetOpen) {
|
|
$state.isWidgetOpen = isWidgetOpen;
|
|
},
|
|
[SET_WIDGET_COLOR]($state, widgetColor) {
|
|
$state.widgetColor = widgetColor;
|
|
},
|
|
[SET_REFERRER_HOST]($state, referrerHost) {
|
|
$state.referrerHost = referrerHost;
|
|
},
|
|
[SET_BUBBLE_VISIBILITY]($state, hideMessageBubble) {
|
|
$state.hideMessageBubble = hideMessageBubble;
|
|
},
|
|
[SET_COLOR_SCHEME]($state, darkMode) {
|
|
$state.darkMode = darkMode;
|
|
},
|
|
[SET_ROUTE_UPDATE_STATE]($state, status) {
|
|
$state.isUpdatingRoute = status;
|
|
},
|
|
};
|
|
|
|
export default {
|
|
namespaced: true,
|
|
state,
|
|
getters,
|
|
actions,
|
|
mutations,
|
|
};
|