# grapesjs-tooltip

> GrapesJS Tooltip component

Latest version **0.1.8** (published 2023-06-08) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install grapesjs-tooltip
pnpm add grapesjs-tooltip
yarn add grapesjs-tooltip
bun add grapesjs-tooltip
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2023-06-08 |
| First published | 2018-11-17 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 29.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19 |
| Author | Artur Arseniev |
| Maintainers | artf |
| Keywords | grapesjs, plugin, component, tooltip |

## Links

- npm: https://www.npmjs.com/package/grapesjs-tooltip
- Repository: https://github.com/GrapesJS/components-tooltip
- Homepage: https://github.com/GrapesJS/components-tooltip#readme
- Issues: https://github.com/GrapesJS/components-tooltip/issues
- npm.io page: https://npm.io/package/grapesjs-tooltip

## Recent versions

- 0.1.8 (latest) — 2023-06-08
- 0.1.7 — 2022-08-25
- 0.1.5 — 2018-12-21
- 0.1.2 — 2018-11-17

## README

# GrapesJS Tooltip


Simple, CSS only, tooltip component for GrapesJS

[Demo](https://grapesjs.com/demo.html)

## Summary

* Plugin name: `grapesjs-tooltip`
* Components
  * `tooltip`
* Blocks
  * `tooltip`





## Options

| Option | Description | Default |
|-|-|-
| `id` | The ID used to create tooltip block and component | `tooltip` |
| `labelTooltip` | Label of the tooltip. Used for the block and component name | `Tooltip` |
| `blockTooltip` | Object to extend the default tooltip block, eg. { label: 'Tooltip', category: 'Extra', ... }. Pass a falsy value to avoid adding the block | `{}` |
| `propsTooltip` | Object to extend the default tooltip properties, eg. `{ name: 'Tooltip', droppable: false, ... }` | `{}` |
| `extendTraits` | A function which allows to extend default traits by receiving the original array and returning a new one | `traits => traits` |
| `attrTooltip` | Tooltip attribute prefix | `data-tooltip` |
| `classTooltip` | Tooltip class prefix | `tooltip-component` |
| `style` | Custom CSS styles, this will replace the default one | `''` |
| `styleAdditional` | Additional CSS styles | `''` |
| `privateClasses` | Make all tooltip relative classes private | `true` |
| `showTooltipOnStyle` | If true, force the tooltip to be shown when you're styling it | `true` |
| `stylableTooltip` | Indicate if the tooltip can be styled. You can also pass an array of which properties can be styled. Eg. `['color', 'background-color']` | `check the source...` |





## Download

* CDN
  * `https://unpkg.com/grapesjs-tooltip`
* NPM
  * `npm i grapesjs-tooltip`
* GIT
  * `git clone https://github.com/GrapesJS/components-tooltip.git`





## Usage

Directly in the browser
```html
<link href="https://unpkg.com/grapesjs/dist/css/grapes.min.css" rel="stylesheet"/>
<script src="https://unpkg.com/grapesjs"></script>
<script src="path/to/grapesjs-tooltip.min.js"></script>

<div id="gjs"></div>

<script type="text/javascript">
  var editor = grapesjs.init({
      container : '#gjs',
      // ...
      plugins: ['grapesjs-tooltip'],
      pluginsOpts: {
        'grapesjs-tooltip': { /* options */ }
      }
  });
</script>
```

Modern javascript
```js
import grapesjs from 'grapesjs';
import pluginTooltip from 'grapesjs-tooltip';

const editor = grapesjs.init({
  container : '#gjs',
  // ...
  plugins: [pluginTooltip],
  pluginsOpts: {
    [pluginTooltip]: { /* options */ }
  }
  // or
  plugins: [
    editor => pluginTooltip(editor, { /* options */ }),
  ],
});
```





## Development

Clone the repository

```sh
$ git clone https://github.com/GrapesJS/components-tooltip.git
$ cd grapesjs-tooltip
```

Install dependencies

```sh
$ npm i
```

Start the dev server

```sh
$ npm start
```





## License

BSD 3-Clause

---
_Source: https://npm.io/package/grapesjs-tooltip · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._