https://github.com/grapesjs/components-tooltip
Simple, CSS only, tooltip component for GrapesJS
https://github.com/grapesjs/components-tooltip
Last synced: 3 months ago
JSON representation
Simple, CSS only, tooltip component for GrapesJS
- Host: GitHub
- URL: https://github.com/grapesjs/components-tooltip
- Owner: GrapesJS
- License: bsd-3-clause
- Created: 2018-11-17T15:54:17.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-08T11:09:21.000Z (about 3 years ago)
- Last Synced: 2025-04-12T04:51:45.766Z (about 1 year ago)
- Language: TypeScript
- Size: 179 KB
- Stars: 21
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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
var editor = grapesjs.init({
container : '#gjs',
// ...
plugins: ['grapesjs-tooltip'],
pluginsOpts: {
'grapesjs-tooltip': { /* options */ }
}
});
```
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