@chat-ui/solid
v1.0.6
Published
This library is generated using [Mitosis](https://github.com/BuilderIO/mitosis)
Downloads
8
Readme
Warning: Generated Code
This library is generated using Mitosis
@chat-ui/solid
This Chat is fully customizable.
Usage
import { Chat } from '@chat-ui/solid'
function handleMessage(input) {
console.log(input);
}
function App() {
return (
<Chat chat={[]} onSend={(text) => handleMessage(text)}
/>
);
}
export default App;
Props
The options you can pass into the component are listed below.
Required
onSend:
function
. onSend gives you the messagestring
the user has send within the chat. The string can be empty, when the user sends an empty messagechat:
array
. chat is an array of chatmessagesobject
that has the keys "message", "type", "timestamp". All 3 keys are strings. The Timestamp key is optional. The message and the type key ('chatbot', 'customer') are required. Ex. [ { message: 'Hi! How are you?', type: 'chatbot' }, { message: 'Hello, im fine, thanks.', type: 'person', timestamp: '3:46 PM' } ]
Optional
bgColorHeader:
string
. Define Background Color of HeaderbgColorChat:
string
. Define Background Color of the ChatboxbgColorIcon:
string
. Define Background Color of the Chatbox Icon in the HeaderbgColorInput:
string
. Define Background Color of the Chatbox InputBoxbgColorMessageChatbot:
string
. Define Background Color of the Message from the ChatbotbgColorMessagePerson:
string
. Define Background Color of the Message from a PersonbgColorMessageTimestamp:
string
. Define Background Color of the Timestamp from MessagestextColorMessageChatbot:
string
. Define Text Color of the Message from a ChatbottextColorMessagePerson:
string
. Define Text Color of the Timestamp from PersontextColorMessageTimestamp:
string
. Define Text Color of the Timestamp from MessagestextColorHeader:
string
. Define Text Color of the Chat HeadertextColorInput:
string
. Define Text Color of the Input FieldfillColorIcon:
string
. Define Fill Color of the Icon in the Headermargin:
string
. Define Margin of the Chat ex. '10px'boxShadow:
string
. Define Box Shadow of the Chatheight:
string
. Define the height of the Chatwidth:
string
. Define the width of the Chatoffline:
boolean
. Changes the Online to Offline.colorOnline:
string
. Define the dot color of Online StatuscolorOffline:
string
. Define the dot color of Offline StatusheaderHeight:
string
. Define Header Heigth of the ChatinputHeight:
string
. Define Input Field Heigth of the ChatinputPlaceholder:
string
. Defines a Custom Input Placeholder
License
MIT License
Copyright (c) 2023 nvima
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.