index.html

<html><head>
<!-- 
This file autogenerated by docbat.js (https://npmjs.com/docbat)  
Any manual edits may be lost.
-->
<link rel="stylesheet" href="https://unpkg.com/@highlightjs/cdn-assets@11.7.0/styles/default.min.css">
<script src="https://unpkg.com/@highlightjs/cdn-assets@11.7.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
<style>
*{box-sizing:border-box;}
.bw-def-page-setup{height:100%;width:90%;margin:0 auto;padding-left:2%;padding-right:2%;left:0;top:1%;box-sizing:border-box;}
.bw-font-serif{font-family:Times New Roman, Times, serif;}
.bw-font-sans-serif{font-family:Arial, Helvetica, sans-serif;}

.bw-left{text-align:left;}
.bw-right{text-align:right;}
.bw-center{text-align:center;margin:0 auto;}
.bw-justify{text-align:justify;}
.bw-code{font-family:monospace;white-space:pre-wrap;}
.bw-pad1{padding-left:1%;padding-right:1%;}

.bw-table{border-collapse:collapse;border-spacing:0;border:1px solid #444;}
.bw-table th{background-color:#bbb;padding:4px;border:1px solid #444;}
.bw-table td{padding:4px;border:1px solid #444;}
.bw-table-stripe tr:nth-child(even){background-color:#f0f0f0;}
.bw-table tr td:first-child{font-weight:700;}
.bw-table-border-round{border-radius:2px;}
.bw-table-sort-upa::after{content:"\2191";}
.bw-table-sort-dna::after{content:"\2193";}
.bw-table-sort-xxa::after{content:"\00a0";}

.bw-tab-item-list{margin:0;padding-inline-start:0;}
.bw-tab-item{display:inline;padding-top:0.75em;padding-left:0.75em;padding-right:0.75em;border-top-right-radius:7px;border-top-left-radius:7px;}
.bw-tab-active{font-weight:700;}
.bw-tab:hover{cursor:pointer;font-weight:700;}
.bw-tab-content-list{margin:0;padding-top:0.0em;}
.bw-tab-content{display:none;border-radius:0;}
.bw-tab-content, .bw-tab-active{background-color:#ddd;padding:0.5em;}

.bw-accordian-container > div{padding:0.5em;}

.bw-container{margin:0 auto;}
.bw-row{width:100%;display:block;}
.bw-row [class^="bw-col"]{float:left;}
.bw-row::after{content:"";display:table;clear:both;}
.bw-box-1{padding-top:10px;padding-bottom:10px;border-radius:8px;}

.bw-sign{position:inherit;display:table;height:100%;width:100%;}
.bw-sign > div{display:table-cell;vertical-align:middle;}
.bw-sign > div > div{text-align:center;}

.bw-hide{display:none;}
.bw-show{display:block;}
.bw-h1{font-size:2.312rem;}
.bw-h2{font-size:1.965rem;}
.bw-h3{font-size:1.67rem;}
.bw-h4{font-size:1.419rem;}
.bw-h5{font-size:1.206rem;}
.bw-h6{font-size:1.025rem;}

.bw-col-1{width:8.333%;}
.bw-col-2{width:16.666%;}
.bw-col-3{width:25%;}
.bw-col-4{width:33.333%;}
.bw-col-5{width:41.666%;}
.bw-col-6{width:50%;}
.bw-col-7{width:58.333%;}
.bw-col-8{width:66.666%;}
.bw-col-9{width:75%;}
.bw-col-10{width:83.333%;}
.bw-col-11{width:91.666%;}
.bw-col-12{width:100%;}

.bw-color-color {color:#000}
.bw-color-background-color {background-color:#ddd}
.bw-color-active {active:#222}
.bw-thm-light
{
  color: #020202 !important;; 
  background-color: #e2e2e2 !important;; 
}
.bw-thm-dark
{
  color: #e2e2e2 !important;; 
  background-color: #020202 !important;; 
}
@media only screen and (min-width: 540px) {.bw-def-page-setup {width: 96%;}}
@media only screen and (min-width: 720px) {.bw-def-page-setup {width: 92%;}}
@media only screen and (min-width: 960px) {.bw-def-page-setup {width: 88%;}}
@media only screen and (min-width: 1100px){.bw-def-page-setup {width: 86%;}}
@media only screen and (min-width: 1600px){.bw-def-page-setup {width: 84%;}}

</style><style>
.dbat {padding-left: 10%; padding-right: 10%;}


</style><link rel="stylesheet" href="https://unpkg.com/@highlightjs/cdn-assets@11.7.0/styles/default.min.css">
<script src="https://unpkg.com/@highlightjs/cdn-assets@11.7.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body class="bw-def-page-setup bw-font-sans-serif dbat" ><br><br><h1 id="yackboxjs">yackbox.js</h1>
<p>~ ~ note: alpha version frequent changes ~ ~ 
yackbox is a simple vanilla (no dependancies) JavaScript chat control that can be easily integrated into web applications. It provides a customizable chat interface with support for adding, updating, and removing messages, along with multi-user support and message history controls.</p>
<h2 id="features">Features</h2>
<p>Add messages with customizable user and alignment options.
Update existing messages with new content.
Remove messages from the chat interface.
Retrieve the chat log.  Log contains timestamps for all messages.
Callback function for message events.
Responsive design for various screen sizes.</p>
<h2 id="installation">Installation</h2>
<p>To use yackbox in your project, follow these steps:</p>
<p>Include the yackbox.js JavaScript file in your project.
Link the yackbox.css stylesheet to style the chat interface.
html</p>
<pre><code class="language-html">&lt;script src=&quot;./path/to/yackbox.js&quot;&gt;&lt;/script&gt;
&lt;link rel=&quot;stylesheet&quot; href=&quot;yackbox.css&quot;&gt;
</code></pre>
<p>Create a container element in your HTML where you want the chat interface to appear:</p>
<pre><code class="language-html">&lt;div id=&quot;chat-container&quot;&gt;&lt;/div&gt;
</code></pre>
<p>Initialize yackbox in your JavaScript code by providing the container element and a callback function for message events:</p>
<pre><code class="language-javascript">const chat = new yackbox(&#39;#chat-container&#39;, messageCallback);
//Use the provided methods to interact with the chat control:

// Add a message
chat.addMessage(&#39;Hello!&#39;, &#39;User&#39;, &#39;left&#39;);  // user should appear left or right justified

// Update a message
chat.updateMessage(1, &#39;New content&#39;);

// Remove a message
chat.removeMessage(1);

// Get the chat log
const log = chat.getLog();
console.log(log);
</code></pre>
<h2 id="usage">Usage</h2>
<p>Yackbox is highly customizable and can be integrated into various web applications. You can modify the appearance and behavior of the chat interface by adjusting the CSS styles and JavaScript code according to your requirements.</p>
<h2 id="examples">Examples</h2>
<p>Included are several examples including:
<a href="./examples/index.html">Example Code</a></p>
<ul>
<li>UMD and ESM usage in browser</li>
<li>Multiuser and multiple instance setups</li>
<li>Using message history and stats</li>
<li>Streaming and completions based LLM use</li>
</ul>
<h2 id="building-from-source">Building from Source</h2>
<p>Make sure to run npm install.  Then run npm run build.
Note that at run time yackbox has no dependancies, but at build time several tools are used for packing and minifying code.</p>
<h2 id="contributors">Contributors</h2>
<h2 id="license">License</h2>
<p>yackbox is licensed under the BSD-2 License.</p>
</body></html>