# Docs tooltip
A React Tooltip Component using the [docservice microservice](https://gitlab.genus.net/genus/microservices/docservice) to fetch documentation markdown snippets from [Genus Apps Documentation](https://docs.genus.no/)  
DocsTooltip component renders an information-icon. Click it to show the tooltip containing the referenced documentation markdown snippet. Click outside to hide.  
Third party Tooltip component used: [react-tooltip](https://www.npmjs.com/package/react-tooltip)  
Third party Markdown component used: [react-markdown](https://www.npmjs.com/package/react-markdown)

## Usage
Install:  
`npm install @genusbiz/docs-tooltip --save`

Import DocsTooltip component:  
`import DocsTooltip from 'docs-tooltip'`

### DocsTooltip component props
| Name        | Type   | Description |
| ---         | ---    | ---         |
| path        | string | Path to article (with/without anchor) **without** domain (e.g. 'https://docs.genus.no/'), e.g. 'users/analyze-report-and-discover/analysis/concepts.md#tile' |
| place       | string | Tooltip placement. Values: right, left, top, bottom. Default: top|
| style       | object | Tooltip content style. If you are having problems with displaying your tooltip content, consider setting e.g. width and height properties here |


## For developers
Clone repository if you want to test/debug it, and/or make changes to it  

### Run example
`npm run example` will open a window with a running example. The example(s) are placed in `/example` folder
