@chayns-components/emoji-input 5.0.33 → 5.0.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/AI_USAGE.md +147 -0
  2. package/package.json +5 -4
package/AI_USAGE.md ADDED
@@ -0,0 +1,147 @@
1
+ # @chayns-components/emoji-input
2
+
3
+ React component package providing 3 documented components for chayns applications.
4
+
5
+ Documented components: `EmojiInput`, `EmojiPicker`, `EmojiPickerPopup`.
6
+
7
+ ## Import
8
+
9
+ ```ts
10
+ import { EmojiInput, EmojiPicker, EmojiPickerPopup } from '@chayns-components/emoji-input';
11
+ ```
12
+
13
+ ## Typical Usage
14
+
15
+ ```tsx
16
+ <EmojiInput
17
+ placeholder={'Nachricht schreiben'}
18
+ />
19
+ ```
20
+
21
+ ## Components
22
+
23
+ - `EmojiInput`
24
+ - `EmojiPicker`
25
+ - `EmojiPickerPopup`
26
+
27
+ ## EmojiInput
28
+
29
+ `EmojiInput` is exported by `@chayns-components/emoji-input` and should be imported from the public package entry point.
30
+
31
+ ### Import
32
+
33
+ ```ts
34
+ import { EmojiInput } from '@chayns-components/emoji-input';
35
+ ```
36
+
37
+ ### Examples
38
+
39
+ #### General
40
+
41
+ ```tsx
42
+ <EmojiInput
43
+ placeholder={'Nachricht schreiben'}
44
+ />
45
+ ```
46
+
47
+ #### Emoji Input With Progress
48
+
49
+ ```tsx
50
+ <EmojiInput
51
+ placeholder={'Nachricht schreiben'}
52
+ />
53
+ ```
54
+
55
+ #### Emoji Input With Prefix Element
56
+
57
+ ```tsx
58
+ <EmojiInput
59
+ placeholder={'Nachricht schreiben'}
60
+ prefixElement={'[lc_mention id="CHA-YNSAI"]Sidekick[/lc_mention],&nbsp;'}
61
+ />
62
+ ```
63
+
64
+ ### Props
65
+
66
+ No prop documentation available.
67
+
68
+ ### Types
69
+
70
+ No additional exported types documented.
71
+
72
+ ### Usage Notes
73
+
74
+ - Import `EmojiInput` directly from `@chayns-components/emoji-input` instead of internal source paths.
75
+ - Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
76
+
77
+ ### Anti Patterns
78
+
79
+ - Avoid imports from internal paths such as `@chayns-components/emoji-input/src/...`; always use the public package export.
80
+ ## EmojiPicker
81
+
82
+ `EmojiPicker` is exported by `@chayns-components/emoji-input` and should be imported from the public package entry point.
83
+
84
+ ### Import
85
+
86
+ ```ts
87
+ import { EmojiPicker } from '@chayns-components/emoji-input';
88
+ ```
89
+
90
+ ### Examples
91
+
92
+ #### General
93
+
94
+ ```tsx
95
+ <EmojiPicker />
96
+ ```
97
+
98
+ ### Props
99
+
100
+ No prop documentation available.
101
+
102
+ ### Types
103
+
104
+ No additional exported types documented.
105
+
106
+ ### Usage Notes
107
+
108
+ - Import `EmojiPicker` directly from `@chayns-components/emoji-input` instead of internal source paths.
109
+ - Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
110
+
111
+ ### Anti Patterns
112
+
113
+ - Avoid imports from internal paths such as `@chayns-components/emoji-input/src/...`; always use the public package export.
114
+ ## EmojiPickerPopup
115
+
116
+ `EmojiPickerPopup` is exported by `@chayns-components/emoji-input` and should be imported from the public package entry point.
117
+
118
+ ### Import
119
+
120
+ ```ts
121
+ import { EmojiPickerPopup } from '@chayns-components/emoji-input';
122
+ ```
123
+
124
+ ### Examples
125
+
126
+ #### General
127
+
128
+ ```tsx
129
+ <EmojiPickerPopup />
130
+ ```
131
+
132
+ ### Props
133
+
134
+ No prop documentation available.
135
+
136
+ ### Types
137
+
138
+ No additional exported types documented.
139
+
140
+ ### Usage Notes
141
+
142
+ - Import `EmojiPickerPopup` directly from `@chayns-components/emoji-input` instead of internal source paths.
143
+ - Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
144
+
145
+ ### Anti Patterns
146
+
147
+ - Avoid imports from internal paths such as `@chayns-components/emoji-input/src/...`; always use the public package export.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@chayns-components/emoji-input",
3
- "version": "5.0.33",
3
+ "version": "5.0.35",
4
4
  "description": "Input field that supports HTML elements and emojis",
5
5
  "sideEffects": false,
6
6
  "browserslist": [
@@ -36,7 +36,8 @@
36
36
  "test": "__tests__"
37
37
  },
38
38
  "files": [
39
- "lib"
39
+ "lib",
40
+ "AI_USAGE.md"
40
41
  ],
41
42
  "repository": {
42
43
  "type": "git",
@@ -73,7 +74,7 @@
73
74
  "typescript": "^5.9.3"
74
75
  },
75
76
  "dependencies": {
76
- "@chayns-components/core": "^5.0.33",
77
+ "@chayns-components/core": "^5.0.35",
77
78
  "emojilib": "^3.0.12",
78
79
  "unicode-emoji-json": "^0.8.0"
79
80
  },
@@ -87,5 +88,5 @@
87
88
  "publishConfig": {
88
89
  "access": "public"
89
90
  },
90
- "gitHead": "5e41d9af042b3c272c8c08b67a9c9bf4911902f6"
91
+ "gitHead": "9fabdc06522f6a9879e5ec03f8629ae0179b7495"
91
92
  }