@chayns-components/emoji-input 5.5.26 → 5.5.28

package/AGENTS.md

@@ -63,20 +63,50 @@ import { EmojiInput } from '@chayns-components/emoji-input';
 
 ### Props
 
-No prop documentation available.
+| name | type | required | description |
+| --- | --- | --- | --- |
+| `accessToken` | `string \| undefined` | no | Access token of the logged-in user. Is needed to load and save the history of the emojis. |
+| `container` | `Element \| undefined` | no | The DOM element that should receive the emoji picker popup portal. |
+| `height` | `Height<string \| number> \| undefined` | no | Sets the height of the input field to a fixed value. If this value is not set, the component will use the needed height until the maximum height is reached. |
+| `inputId` | `string \| undefined` | no | HTML id of the input element |
+| `isDisabled` | `boolean \| undefined` | no | Disables the input so that it cannot be changed anymore |
+| `maxHeight` | `MaxHeight<string \| number> \| undefined` | no | Sets the maximum height of the input field. |
+| `onBlur` | `FocusEventHandler<HTMLDivElement> \| undefined` | no | Function that is executed when the input field loses focus. |
+| `onCursorPositionChange` | `((position: number) => void) \| undefined` | no | Function to be executed when the cursor position is changed. |
+| `onFocus` | `FocusEventHandler<HTMLDivElement> \| undefined` | no | Function that is executed when the input field gets the focus. |
+| `onInput` | `((event: ChangeEvent<HTMLDivElement>, originalText: string) => void) \| undefined` | no | Function that is executed when the text of the input changes. In addition to the original<br />event, the original text is returned as second parameter, in which the internally used HTML<br />elements have been converted back to BB codes. |
+| `onKeyDown` | `KeyboardEventHandler<HTMLDivElement> \| undefined` | no | Function that is executed when a key is pressed down. |
+| `onPopupVisibilityChange` | `((isVisible: boolean) => void) \| undefined` | no | Function that is executed when the visibility of the popup changes. |
+| `onPrefixElementRemove` | `(() => void) \| undefined` | no | Function to be executed if the prefixElement is removed. |
+| `personId` | `string \| undefined` | no | Person id of the logged-in user. Is needed to load and save the history of the emojis. |
+| `placeholder` | `string \| ReactElement<any, string \| JSXElementConstructor<any>> \| undefined` | no | Placeholder for the input field |
+| `popupAlignment` | `PopupAlignment \| undefined` | no | Sets the alignment of the popup to a fixed value. If this value is not set, the component<br />calculates the best position on its own. Use the imported 'PopupAlignment' enum to set this<br />value. |
+| `prefixElement` | `string \| undefined` | no | Element that is rendered before the input field but the placeholder is still visible. |
+| `rightElement` | `ReactNode` | no | Element that is rendered inside the EmojiInput on the right side. |
+| `shouldHidePlaceholderOnFocus` | `boolean \| undefined` | no | Whether the placeholder should be shown after the input has focus. |
+| `shouldPreventEmojiPicker` | `boolean \| undefined` | no | Prevents the EmojiPickerPopup icon from being displayed |
+| `shouldRevertAsciiSmileyConversionOnBackspace` | `boolean \| undefined` | no | Allows the most recently auto-converted ASCII smiley to be reverted with Backspace. |
+| `value` | `string` | yes | The plain text value of the input field. Instead of HTML elements BB codes must be used at<br />this point. These are then converted by the input field into corresponding HTML elements. |
 
 ### Types
 
-No additional exported types documented.
+- `PopupAlignment` -> `enum PopupAlignment {
+    TopLeft,
+    BottomLeft,
+    TopRight,
+    BottomRight,
+}`
 
 ### Usage Notes
 
 - Import `EmojiInput` directly from `@chayns-components/emoji-input` instead of internal source paths.
 - Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
+- Pay special attention to required props: `value`.
 
 ### Anti Patterns
 
 - Avoid imports from internal paths such as `@chayns-components/emoji-input/src/...`; always use the public package export.
+- Avoid incomplete prop objects; follow the documented prop types and required fields.
 ## EmojiPicker
 
 `EmojiPicker` is exported by `@chayns-components/emoji-input` and should be imported from the public package entry point.
@@ -97,7 +127,11 @@ import { EmojiPicker } from '@chayns-components/emoji-input';
 
 ### Props
 
-No prop documentation available.
+| name | type | required | description |
+| --- | --- | --- | --- |
+| `accessToken` | `string \| undefined` | no | Access token of the logged-in user. Is needed to load and save the history of the emojis. |
+| `onSelect` | `(emoji: string) => void` | yes | Function executed when an emoji is selected in the popup |
+| `personId` | `string \| undefined` | no | Person id of the logged-in user. Is needed to load and save the history of the emojis. |
 
 ### Types
 
@@ -107,10 +141,12 @@ No additional exported types documented.
 
 - Import `EmojiPicker` directly from `@chayns-components/emoji-input` instead of internal source paths.
 - Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
+- Pay special attention to required props: `onSelect`.
 
 ### Anti Patterns
 
 - Avoid imports from internal paths such as `@chayns-components/emoji-input/src/...`; always use the public package export.
+- Avoid incomplete prop objects; follow the documented prop types and required fields.
 ## EmojiPickerPopup
 
 `EmojiPickerPopup` is exported by `@chayns-components/emoji-input` and should be imported from the public package entry point.
@@ -131,7 +167,13 @@ import { EmojiPickerPopup } from '@chayns-components/emoji-input';
 
 ### Props
 
-No prop documentation available.
+| name | type | required | description |
+| --- | --- | --- | --- |
+| `accessToken` | `string \| undefined` | no | Access token of the logged-in user. Is needed to load and save the history of the emojis. |
+| `container` | `Element \| undefined` | no | The DOM element that should receive the popup portal. |
+| `onPopupVisibilityChange` | `((isVisible: boolean) => void) \| undefined` | no | Function that is executed when the visibility of the popup changes. |
+| `onSelect` | `(emoji: string) => void` | yes | Function executed when an emoji is selected in the popup |
+| `personId` | `string \| undefined` | no | Person id of the logged-in user. Is needed to load and save the history of the emojis. |
 
 ### Types
 
@@ -141,7 +183,9 @@ No additional exported types documented.
 
 - Import `EmojiPickerPopup` directly from `@chayns-components/emoji-input` instead of internal source paths.
 - Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
+- Pay special attention to required props: `onSelect`.
 
 ### Anti Patterns
 
 - Avoid imports from internal paths such as `@chayns-components/emoji-input/src/...`; always use the public package export.
+- Avoid incomplete prop objects; follow the documented prop types and required fields.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chayns-components/emoji-input",
-    "version": "5.5.26",
+    "version": "5.5.28",
     "description": "Input field that supports HTML elements and emojis",
     "sideEffects": false,
     "browserslist": [
@@ -75,8 +75,8 @@
         "vitest": "^1.6.1"
     },
     "dependencies": {
-        "@chayns-components/core": "^5.5.26",
-        "@chayns-components/textstring": "^5.5.24",
+        "@chayns-components/core": "^5.5.28",
+        "@chayns-components/textstring": "^5.5.28",
         "emojilib": "^3.0.12",
         "react-compiler-runtime": "^1.0.0",
         "unicode-emoji-json": "^0.9.0"
@@ -91,5 +91,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "92d9195193d59f3180f001b3545b34167476d6a7"
+    "gitHead": "20b5354c0ee43c56e9919589f6b3bad7cf6b14bb"
 }