1.0.3 • Published 2 years ago

svelte-tooltip-simple v1.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

svelte-tooltip-simple

npm version npm downloads license

A simple Svelte component for displaying dynamic tooltips. Automatically decides where to place your tooltip based on your preferences.

How to install

Add to your Svelte or SvelteKit project with the following lines:

npm install svelte-pdf-simple

or

yarn add svelte-pdf-simple

How to use

<script lang="ts">
  import { Tooltip } from "svelte-tooltip-simple";
</script>

<Tooltip text="my tooltip text">
  <button>Click</button>
</Tooltip>

For adding HTML to you tooltip you could do the following

<script lang="ts">
  import { Tooltip } from "svelte-tooltip-simple";
</script>

<Tooltip>
  <button>Click</button>
  <svelte:fragment slot="content">
    <b>Bold</b> text with <i>italic</i> feel
  </svelte:fragment>
</Tooltip>

NOTE If you setup the tooltip text with both through property and slot, the text in the slot will be displayed.

Build

If you are using svelte-kit you shouldn't have any issues after installing the package.

With a simple svelte project though, you'll need to add the following to the plugin list inside rollup.config.js file.

replace({
  "process.env.NODE_ENV": process.env.ROLLUP_WATCH ? "development" : "production",
});

The replace function comes from the @rollup/plugin-replace package.

Props

Prop nameDescriptionTypeDefault valueRequired
textTooltip textstring""No
placementWhere to place the tooltip relative to the targetPlacement"top"No
themeWhich theme to useTheme"light"No
hoistWhether the tooltip should overflow parentbooleanfalseNo
arrowOffsetHow much offset should the tooltip have from the targetnumber8No
paddingPadding of the textRecord<Side, number>{top: 0.3, bottom: 0.3, left: 0.75, right: 0.75 } remNo
borderRadiusRadius of the tooltipnumber0.2 remNo
fontSizeSize of the text0.875 remNo
fallbackPlacementsList of possible fallback places in case the tooltip is not visible in the given position. NOTE This does not work perfectly.Placement[]Opposite side of the currently selected one by default the tooltip placement is 'top'No

Placement: top | left | right | bottom | top-start | top-end | left-start | left-end | right-start | right-end | bottom-start | bottom-end

Side: top | left | right | bottom

Theme: light | dark

License

MIT