Skip to content
This repository was archived by the owner on Nov 9, 2024. It is now read-only.

Commit e448805

Browse files
authored
readme: clarify usage
1 parent 9ed034d commit e448805

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,15 @@ Requires React 16.2+ and `prop-types` if using via CDN.
1414

1515
## Usage
1616

17+
Import the Tippy component and Tippy's CSS.
18+
19+
Required: tooltip content as `props.content` and a single element child (reference) as `props.children`.
20+
1721
```jsx
1822
import React from 'react'
1923
import ReactDOM from 'react-dom'
2024
import Tippy from '@tippy.js/react'
25+
import 'tippy.js/dist/tippy.css'
2126

2227
const RegularTooltip = () => (
2328
<Tippy content="Hello">

0 commit comments

Comments
 (0)