Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make Tooltip title visible under component section in the vx-tooltip readme file #403

Merged
merged 1 commit into from
Jan 7, 2019
Merged

Make Tooltip title visible under component section in the vx-tooltip readme file #403

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/vx-tooltip/Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class Chart extends React.Component {
} = this.props;

return (
// note React.Frament is only available in >= react@16.2
// note React.Fragment is only available in >= react@16.2
<React.Fragment>
<svg width={...} height={...}>
// Chart here...
Expand Down Expand Up @@ -80,7 +80,7 @@ You may override the container by specifying `containerProps` as the second argu


### Components
#### <Tooltip />
#### Tooltip
This is a simple Tooltip container component meant to be used to actually render a Tooltip. It accepts the following props, and will spread any additional props on the tooltip container div (i.e., ...restProps):

| Name | Type | Default | Description |
Expand All @@ -104,4 +104,4 @@ This tooltip component is exactly the same as `Tooltip` above, but it is aware o
| style | object | -- | Sets / overrides any styles on the tooltip container (including top and left)
| children | node | -- | Sets the children of the tooltip, i.e., the actual content

Note that this component is positioned using a `tranform`, so overriding `left` and `top` via styles may have no effect.
Note that this component is positioned using a `transform`, so overriding `left` and `top` via styles may have no effect.