floating-chat
Advanced tools
Readme
A framework-agnostic floating chat window web component written in Svelte
The primary purpose is embedding engageable content, in particular: helpdesks, chatbots or anything else that requires a floating box
Features:
Add the following script to your <head>
<script defer src="https://unpkg.com/floating-chat@latest/dist/index.js"></script>
Install the floating-chat package
npm i floating-chat
Then import into your application with
import floatingChat from 'floating-chat'
Add the tag to your template
<floating-chat content="https://example.com" />
You can see the demo example in index.html
Content area
Available attributes:
content, content address (to be displayed in <iframe>)height, floating window height, default 600px, always 100% on mobilewidth, floating window width, default 400px, always 100% on mobiletextOpen, text when the window is closed, default Open, hidden on mobiletextClose, text when the window is opened, default Close, hidden on mobiletextColor, the colour of text, default #000000 (black)background, background color, can be either a color code or a css background property, default #FFFFFF (white)logo, logo url, css background property, eg url(https://storage.googleapis.com/cloudprod-apiai/a0b2e356-b43e-4ca5-a094-b219475fa4ca_x.png)position, y, x position on screen, default bottom right, possible options bottom, top, left, rightfont, font nameborderRadius, corner radius, default 28px, 0px on mobile when openedopened, boolean, whether floating window should start opened, default falseAvailable variables:
--height, floating window height, default 600px, always 100% on mobile--width, floating window width, default 400px, always 100% on mobile--textcolor, the colour of text, default #000000 (black)--background, background color, can be either a color code or a css background property, default #FFFFFF (white)--logo, logo url, css background property, eg url(https://storage.googleapis.com/cloudprod-apiai/a0b2e356-b43e-4ca5-a094-b219475fa4ca_x.png)--positiony, y position on screen, default bottom--positionx, x position on screen, default right--font, font name--borderradius, corner radius, default 28px, 0px on mobile when openedAvailable CSS classes (modifiers):
floating-chat-open, when floating chat is openfloating-chat-closed, when floating chat is closedYou can change the above HTML attributes in JS, example:
document.querySelector('floating-chat').width = '300px'
document.querySelector('floating-chat').opened = true
Following events are emmited:
open, when the floating window state went from closed to openclose, when the floating window state went from open to closedtoggle, when the floating window state was changedExample in Vue:
<template>
<floating-chat @open="open" />
</template>
<script>
export default {
methods: {
open () {
alert('Opened!')
}
}
}
</script>
Clone the repository
git clone https://github.com/mishushakov/floating-chat.git
Install the dependencies
npm i
Build
npm run build
FAQs
A framework-agnostic floating chat window web component written in Svelte
We found that floating-chat demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.