74 lines
2.9 KiB
Markdown
74 lines
2.9 KiB
Markdown
# hint.css
|
|
*A tooltip library in CSS*
|
|
|
|
`hint.css` is written as a pure CSS resource using which you can create cool tooltips for your web app. It does not rely on JavaScript and rather uses **data-* attribute**, **pseudo elements**, **content property** and **CSS3 transitions** to create the tooltips. Also it uses **BEM** naming convention particularly for the modifiers.
|
|
|
|
*Note: CSS3 Transitions on pseudo elements is currently available on Firefox only. On rest of the browsers it degrades gracefully without any transition. Though the good news is that it will be [coming soon on webkit](https://bugs.webkit.org/show_bug.cgi?id=92591) also.*
|
|
|
|
[Read more about it](http://kushagragour.in/blog/2013/02/years-first-side-project-hint/).
|
|
|
|
###Try it out:
|
|
http://kushagragour.in/lab/hint/
|
|
|
|
## Get Started
|
|
Download one of the 2 library version:
|
|
|
|
- [unminified] : https://raw.github.com/chinchang/hint.css/master/hint.css
|
|
- [minified] : https://raw.github.com/chinchang/hint.css/master/hint.min.css
|
|
|
|
And include it in the *HEAD* of your page:
|
|
|
|
```html
|
|
<link rel="stylesheet" href="hint.css"></link>
|
|
```
|
|
or
|
|
|
|
```html
|
|
<link rel="stylesheet" href="hint.min.css"></link>
|
|
```
|
|
|
|
Any element on your page which needs to have a tooltip has to be given at least one of the position classes: `hint--top`, `hint--bottom`, `hint--left`, `hint--right` to position the tooltip.
|
|
|
|
```html
|
|
Hello Sir, <span class="hint--bottom">hover me.</span>
|
|
```
|
|
|
|
The tooltip text needs to be given using the `data-hint` attribute on that element.
|
|
|
|
```html
|
|
Hello Sir, <span class="hint--bottom" data-hint="Thank you!">hover me.</span>
|
|
```
|
|
|
|
[ **Note**: The `hint` class is no more required and is deprecated. Tooltip is shown on elements which have the `data-hint` attribute instead.]
|
|
|
|
Use it with other available modifiers in various combinations. Available modifiers:
|
|
- `hint--error`
|
|
- `hint--info`
|
|
- `hint--warning`
|
|
- `hint--success`
|
|
- `hint--always`
|
|
- `hint--rounded`
|
|
|
|
Check out some examples at http://kushagragour.in/lab/hint/
|
|
|
|
|
|
## Contributing
|
|
`hint.css` is developed in SASS and the source files can be found in the `src/` directory.
|
|
|
|
If you would like to create more types of tooltips/ fix bugs/ enhance the library etc. you are more than welcome to submit your pull requests.
|
|
|
|
[Read more on contributing](./CONTRIBUTING.md).
|
|
|
|
## Changelog
|
|
See the [Changelog](https://github.com/chinchang/hint.css/wiki/Changelog)
|
|
|
|
To catch all updates and discussion, join the mailing list: **hintcss@googlegroups.com**.
|
|
|
|
To subscribe: **hintcss+subscribe@googlegroups.com** or visit [here](https://groups.google.com/forum/?fromgroups=#!forum/hintcss).
|
|
|
|
## License
|
|
Copyright (c) 2013 Kushagra Gour
|
|
Licensed under the MIT license.
|
|
|
|
## Credits
|
|
This doesn't make use of a lot of BEM methodology but big thanks to [@csswizardry](https://twitter.com/csswizardry), [@necolas](https://twitter.com/necolas) for their awesome articles on BEM and to [@joshnh](https://twitter.com/_joshnh) through whose work I came to know about it :) |