Skip to content

Commit

Permalink
doc: update
Browse files Browse the repository at this point in the history
  • Loading branch information
mistic100 committed Sep 10, 2024
1 parent e7063b3 commit 5bb2e4e
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/guide/components/tooltip.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ Create a tooltip.

Updates the position of the tooltip, the parameters are the same `top`, `left` and `position` as above.

### `tooltip.update(content)`

Updates the content of the tooltip.

### `tooltip.hide()`

Hide and destroy the tooltip.
Expand Down
16 changes: 16 additions & 0 deletions docs/plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,22 @@ const viewer = new Viewer({
});
```

::: tip
When using Typescript you can also type-check the configuration object :

```ts
import { MarkersPlugin, MarkersPluginConfig } from '@photo-sphere-viewer/markers-plugin';

const viewer = new Viewer({
plugins: [
[MarkersPlugin, {
markers,
} satisfies MarkersPluginConfig],
],
});
```
:::

After initialization the plugin instance can be obtained with the `getPlugin` method, allowing to call methods on the plugin and subscribe to events.

```js
Expand Down

0 comments on commit 5bb2e4e

Please sign in to comment.