@nebularstreams/libmui 3.1.0 → 3.1.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nebularstreams/libmui",
   "description": "Lightweight, high-performance Mithril widget library for modern websites and JavaScript applications.",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "type": "module",
   "main": "src/index.js",
   "scripts": {

package/readme.md

@@ -273,6 +273,54 @@ m(SmileysButton, {
 
 The current `icon` may contain an `icon` field for a Font Awesome symbol, a `glyph` field for an emoji, or both. This widget uses `MainState` to open the `emoji` application panel, so that panel must be registered by the host application.
 
+#### Optional emoji picker package
+
+Install `@nebularstreams/libmui-extensions` when your application needs a ready-made emoji picker:
+
+```bash
+npm install @nebularstreams/libmui-extensions
+```
+
+The optional package provides `SmileysWidget`, a searchable picker organized into emoji categories. It can also include Font Awesome symbols and remembers selected emoji as favorites during the current session.
+
+```js
+import m from "mithril";
+import {SmileysWidget} from "@nebularstreams/libmui-extensions";
+
+m(SmileysWidget, {
+    icons: true,
+    onClick: (glyph, item) => {
+        state.marker = {
+            glyph,
+            icon: item.icon,
+            name: item.name
+        };
+    }
+});
+```
+
+| Attribute | Description |
+| --- | --- |
+| `onClick(glyph, item)` | Called with the selected character and its metadata. |
+| `icons` | Includes Font Awesome symbols alongside emoji. |
+| `noemojis` | Hides emoji and shows only the optional icon set. |
+| `horizontal` | Places the category navigation above the picker instead of beside it. |
+| `mainclass` | Replaces the picker's default root class. |
+
+The package also exports `SmileysPanel`, which wraps the picker in a horizontal panel with a title bar and optional back action:
+
+```js
+import {SmileysPanel} from "@nebularstreams/libmui-extensions";
+
+m(SmileysPanel, {
+    icons: true,
+    onClick: (glyph, item) => selectMarker(glyph, item),
+    onClose: closePicker
+});
+```
+
+Use `SmileysWidget` when embedding the picker in your own layout. Use `SmileysPanel` when you want a complete application panel. The extension package is optional; the rest of LibMui does not require it.
+
 ### `Selector`
 
 Builds a toolbar that switches between complete Mithril components.