cooltipz-css
Version:
Cooltipz.css is a pure CSS tooltip library that is lightweight, modern, accessible, customisable and easy to use
148 lines (100 loc) • 6.69 kB
Markdown
<div align="center">
[](https://github.com/jackdomleo7/Cooltipz.css/actions/workflows/pipeline.yml)
[](https://github.com/jackdomleo7/Cooltipz.css#license "Read license") [](https://github.com/jackdomleo7/Cooltipz.css/blob/master/cooltipz.min.css "File size - Brotli")
[](https://github.com/jackdomleo7/Cooltipz.css/stargazers "Total GitHub stars") [](https://github.com/jackdomleo7/Cooltipz.css/releases "Current version/release") [](https://www.npmjs.com/package/cooltipz-css "Monthly npm downloads") [](https://www.jsdelivr.com/package/npm/cooltipz-css)
</div>
---
# Cooltipz.css - Cool tooltips
**Cool customisable tooltips made from pure CSS**
_Lightweight • Accessible • Customisable • Simple_
Cooltipz.css is a pure CSS tooltip library that is lightweight, modern, accessible, customisable and easy to use.
Official documentation: [cooltipz.jackdomleo.dev](https://cooltipz.jackdomleo.dev).
Play with Cooltipz.css on [CodePen](https://codepen.io/JackDomleo/pen/mderEeG).
**Features**
- Easy and simple tooltips with **quick setup**
- Pure CSS, no JavaScript
- Highly customisable
- Accessible with `aria-label` attributes
- Automatically disables animation if the user [prefers reduced motion](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion?ref=cooltipz.jackdomleo.dev)
- Options to use classes or `data-` attributes
- Options to import via CDN, npm or yarn
- Options to import SCSS <sub><sup>(npm & yarn only)</sup></sub> or CSS stylesheets <sub><sup>(expanded or minified)</sup></sub>
- Supports a wide range of characters and languages (including emojis, [Font Awesome 4](https://fontawesome.com/v4.7.0?ref=cooltipz.jackdomleo.dev) and [Font Awesome 5](https://fontawesome.com?ref=cooltipz.jackdomleo.dev) icons)
- Uses [Autoprefixer](https://github.com/postcss/autoprefixer?ref=cooltipz.jackdomleo.dev) when generating the CSS stylesheets and [cssnano](https://github.com/cssnano/cssnano?ref=cooltipz.jackdomleo.dev) to minify the minfied stylesheet
---
## Examples
---
## Usage
### CDN
In the below CDN links:
- Replace `:version` with a version [listed here](https://www.npmjs.com/package/cooltipz-css?activeTab=versions) (latest version is always recommended). If you always want to get the latest stylesheet, remove `@:version` completely (Not recommended).
- Replace `:file` with one of the below:
- `cooltipz.css` <sub><sup>(Expanded stylesheet)</sup></sub>
- `cooltipz.min.css` <sub><sup>(Minfied stylesheet)</sup></sub>
```html
<!-- HTML -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/cooltipz-css@:version/:file" />
```
```css
/* Or CSS */
@import url('https://cdn.jsdelivr.net/npm/cooltipz-css@:version/:file');
```
### Package manager (npm or yarn)
It's best practice to install Cooltipz.css as a dependency rather than a dev dependency. You can install `cooltipz-css` via **npm** or **yarn**.
_First_ install via **npm**
```
npm install cooltipz-css --save
```
_Or_ install via **yarn**
```
yarn add cooltipz-css
```
_Then_ import into your JavaScript
```js
import 'cooltipz-css';
```
_Or_ use the SCSS or CSS into your Sass/SCSS
In the below example, replace `:file` with one of the options below:
- `src/cooltipz` <sub><sup>(.scss file)</sup></sub>
- `cooltipz.css` <sub><sup>(Expanded .css)</sup></sub>
- `cooltipz.min.css` <sub><sup>(Minified .css)</sup></sub>
```scss
/* Webpack */
@use '~cooltipz-css/:file' as *;
/* Non-webpack */
@use 'path/to/node_modules/cooltipz-css/:file' as *;
```
---
## License
Type - **MIT**
[Read license](https://github.com/jackdomleo7/Cooltipz.css/blob/master/LICENSE)
You have the right to use this library in any project FREE of charge for personal and commercial use.
You **do not** have the right to resell, sublicense or redistribute (even for free) this library.
Cooltipz.css is licensed under MIT. As a minimum, you are required to KEEP AND NOT REMOVE the following code at the beginning of your downloaded/installed Cooltipz.css CSS, where `:version` is replaced with the version number you are using:
```css
/*! Cooltipz.css v:version | MIT License | github.com/jackdomleo7/Cooltipz.css */
```
---
## Feedback and support
We appreciate any feedback, good or bad and are always looking for new ideas to improve the user experience (UX), developer experience (DX) and accessibility of the tooltips. You may want to consider:
- Raising a [GitHub issue](https://github.com/jackdomleo7/Cooltipz.css/issues)
- Contacting the [author](https://jackdomleo.dev?ref=cooltipz.jackdomleo.dev) directly
- Starring the [GitHub repository](https://github.com/jackdomleo7/Cooltipz.css)
- Giving the [CodePen](https://codepen.io/JackDomleo/pen/mderEeG) a like
- Mentioning '[Cooltipz.css](https://cooltipz.jackdomleo.dev)' in a README or footer
- Share on social media
---
## Development
### Setup
- Fork this repository if required
- `git clone https://github.com/jackdomleo7/Cooltipz.css.git` or clone your forked repository
- `cd Cooltipz.css`
- `npm ci`
- `npm run build` to compile development SCSS to CSS
### Branch
- All branches should be prefixed with the issue number
- All branches must have a descriptive name
---
[GitHub](https://github.com/jackdomleo7/Cooltipz.css "View the GitHub repo and maybe give us a star") • [npm](https://www.npmjs.com/package/cooltipz-css "View Cooltipz.css on npmjs.com") • [yarn](https://yarnpkg.com/package/cooltipz-css "View Cooltipz.css on yarnpkg.com") • [docs](https://cooltipz.jackdomleo.dev "Read the official documentation") • [CHANGELOG](https://github.com/jackdomleo7/Cooltipz.css/releases "Read all the releases") • [License](https://github.com/jackdomleo7/Cooltipz.css#license "MIT License")