Mention documentation (#53)

ozanyurtsever · Jun 1, 2023 · f8780f2 · f8780f2
1 parent fd2fcf4
commit f8780f2
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -169,6 +169,22 @@ Add your own font sizes.
 | searchData         | `SearchData<A>`         | required | Searching data using input string |
 | getTypeaheadValues | `GetTypeaheadValues<A>` | required | Search data transormation         |
 
+`GetTypeaheadValues<A>`
+
+| Property    | Type             |          | description                                           |
+| ----------- | ---------------- | -------- | ----------------------------------------------------- |
+| url         | `string`         | required | URL adress                                            |
+| value       | `string`         | required | Mention menu option value                             |
+| picture     | `JSX.Element`    | required | Mention menu option picture                           |
+| popoverCard | `PopoverCard<A>` | optional | Displaying a popup card when hovering over a username |
+
+`PopoverCard<A>`
+
+| Property | Type                       |          | description                         |
+| -------- | -------------------------- | -------- | ----------------------------------- |
+| card     | `(data: A) => JSX.Element` | required | Popover card, depends on `<A>` type |
+| offset   | `OffsetCard`               | required | Card offset (left, top)             |
+
 ### Plugins support
 
 | Plugin name                | Working            | Description                                    | Source                     |