Back to Help Tooltip-guidelines

Web ComponentThe latest version of this package is: 0.6.9, Opens in new window

Webcomponent for Help Tooltip

This component is compatible with ESM (ES6 module) and IIFE. See documentation examples below.

To be able to install this component, please refer to the Project Setup documentation.

View repository, Opens in new windowView package, Opens in new window
$ npm i @ids-wc/help-tooltip@0.6.9

Table of Contents

Usage

<ids-help-tooltip
  data-text="We need the last know adress to be able to pinpoint migration patterns..."
>
</ids-help-tooltip>
<script src="…help-tooltip-webcomponent.iife.js"></script>

Properties

Property Type Description Required
data-text String The text to use in Help Tooltip Yes
data-title String The title to use in Help Tooltip No
data-standalone String/Boolean To indicate that it is used alone, not next to text No

Events

The webcomponent fires a CustomEvent for opening and closing of the component.

document.addEventListener('ids:send:help-tooltip', e => { console.log(e); });
Event Type Description
ids:send:help-tooltip CustomEvent Event fired on open
ids:send:help-tooltip CustomEvent Event fired on close

The payload of the event looks something like this:

// For opened event
detail: { source: "IDS_HELP_TOOLTIP", type: "HELP_TOOLTIP_OPENED", payload: { id: "<uuid>" } }
// For closed event
detail: { source: "IDS_HELP_TOOLTIP", type: "HELP_TOOLTIP_CLOSED", payload: { id: "<uuid>" } }

Changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

0.6.9 (2023-01-11)

Bug Fixes

  • help tooltip: fixed a11y issues for help tooltip component (2eda563), closes #726017

0.3.7 (2022-03-09)

Miscellaneous chores

0.3.6 (2022-03-09)

Miscellaneous chores

0.3.5 (2022-03-08)

Miscellaneous chores

0.3.4 (2021-11-10)

Miscellaneous chores

  • Manually testing inclusion of CHANGELOG.md (f91eb76)

0.3.0 (2021-11-10)

Miscellaneous chores

0.2.3 (2021-10-28)

Miscellaneous chores

  • reinstall (0f764a7)

  • update after change of navigational structure (e8962a1)

0.2.0 (2021-10-14)

Documentation Updates

  • ✏️ Update documentation for Help Tooltip (7e80c3e), closes #467386

0.1.0 (2021-10-01)

⚠ BREAKING CHANGES

  • 🧨 We are now serving IIFE files instead of UMD, for a better dev

experience when including scripts with script-tag

  • 🧨 All webcomponent versions has been reset, due to new scope; @ids-wc

✅ Closes: 467386

Bug Fixes

  • 🐛 Add missing terser import (b3edea4)

  • 🐛 Rename required file to use IIFE, escape correctly (dff7a27)

  • 🐛 Use correct classnames for input-label and wrapper (04172fd)

Documentation Updates

  • ✏️ Add and update docs for webcomponents (18f4342), closes #467386

Miscellaneous chores

  • 🤖 prettier (c4334ab)

  • 🤖 Remove babel, no longer required (9f6497c)

  • 🤖 Remove unneeded rc files (fdcac58)

  • 🤖 Remove unwanted files, demo not needed for these pkgs (8ad75ba)

  • 🤖 Remove usage of .npmignore, use files-prop instead (8b7c55e)

  • 🤖 Reset CHANGELOG.md files (bf1ef63)

  • 🤖 Reset versions for webcomponents, due to new scope (f540b01)

  • 🤖 Set correct output name (98da4f6)

  • 🤖 Update prettier rc files (7d0e3c9)

  • 🤖 Use correct dependencies after renaming of scope (38aba43), closes #467386

  • 🤖 Use correct names for import (72e77f3)

  • 🤖 Use iife instead of umd (ae0ebcc)

  • bootstrap (420cc99)

  • initial commit (8d74b20)

  • use correct import path (1fff2cb)

Contact us, Opens in new window