Skip to content

Commit ece5c6b

Browse files
authored
docs: Add missing prop in API table
1 parent b9496f8 commit ece5c6b

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,12 @@ yarn add @untemps/svelte-use-tooltip
4141
closeOnCallback: true
4242
},
4343
},
44-
contentClassName: 'tooltip',
45-
disabled: false,
46-
animated: true
44+
containerClassName: 'tooltip',
45+
position: 'right',
46+
animated: true,
47+
animationEnterClassName: 'tooltip-enter',
48+
animationLeaveClassName: 'tooltip-leave',
49+
disabled: false
4750
}
4851
} class="tooltip__target">
4952
Hover me
@@ -99,14 +102,18 @@ yarn add @untemps/svelte-use-tooltip
99102

100103
## API
101104

102-
| Props | Type | Default | Description |
103-
| -------------------- | ------- | ------- | --------------------------------------------------------------------------------------------------------------- |
104-
| `contentSelector` | string | null | Selector of the content to display in the tooltip. |
105-
| `contentClone` | boolean | null | Flag to clone the content to display in the tooltip. If false, the content is removed from its previous parent. |
106-
| `contentActions` | object | null | Configuration of the tooltip actions (see [Content Actions](#content-actions)). |
107-
| `containerClassName` | string | null | Class name to apply to the tooltip container. |
108-
| `disabled` | boolean | false | Flag to disable the tooltip content. |
109-
| `animated` | boolean | false | Flag to animate tooltip transitions. |
105+
| Props | Type | Default | Description |
106+
| -------------------------- | ------- | ------- | --------------------------------------------------------------------------------------------------------------- |
107+
| `content` | string | null | Text content to display in the tooltip. |
108+
| `contentSelector` | string | null | Selector of the content to display in the tooltip. |
109+
| `contentClone` | boolean | null | Flag to clone the content to display in the tooltip. If false, the content is removed from its previous parent. |
110+
| `contentActions` | object | null | Configuration of the tooltip actions (see [Content Actions](#content-actions)). |
111+
| `containerClassName` | string | null | Class name to apply to the tooltip container. |
112+
| `position` | string | 'top' | Position of the tooltip. Available values: 'top', 'bottom', 'left', 'right' |
113+
| `animated` | boolean | false | Flag to animate tooltip transitions. |
114+
| `animationEnterClassName` | string | null | Class name to apply to the tooltip enter transition. |
115+
| `animationLeaveClassName` | string | null | Class name to apply to the tooltip leave transition. |
116+
| `disabled` | boolean | false | Flag to disable the tooltip content. |
110117

111118
### Content Actions
112119

0 commit comments

Comments
 (0)