{"bugs":{"url":"https://github.com/material-components/material-components-web/issues"},"dist":{"shasum":"11e9a1f640d3cbc004ca8bb6654cb5ec08bd4a51","tarball":"https://registry.npmjs.org/@material/tooltip/-/tooltip-9.0.0-canary.afb68894e.0.tgz","fileCount":36,"integrity":"sha512-/wkoQvRlGa6pizHXNSF7I26I3yXbt+trMrS1ziZ6muWgsosvkI+qLK4i4KdljkdcrET+2Dh4tFoqVHOFzLE8qA==","signatures":[{"sig":"MEYCIQCtyOVy3a6PqX/d5uEiH+iJZwAS/+u4OUoqoTzOmx5uvgIhANTKuDNOErk1U0OrwuAb+y0Hwjaq7QjHZt7vOX/WMt37","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":449703,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfz6rNCRA9TVsSAnZWagAACHUP/3PGWdu79sZPW1MH4+II\nv7v8W4KUHo48v2KrITUB+Rq4kHTBP8VaNDA3NfsClYBJ4IMPhpfd4JE8lwLL\nSWpDM1WLj7YCHP/whdFsRCHi+lFUIFSE6OC1KAKMk9BnF2drrqCcNWuFHUwf\n1YN7eEdnQo7qY5Vl4mYeEDVqZ49aJgaQO2icZsUKk4/B1kr5Bpg+tBRHsnZw\nomoahsvSLFCdbxkgDzTZfUHCNq4pBLbYe2o7nhEOHljUjxvsT0q5iajCQWxV\nyyB/eXGhymcGTr6bh9RKHazdk4RTHk8DcJsQX1gLHjC4T3HIDT1H+Pp8dntS\nVdk31XG+yVRGDqnD75ZzzxvWcGTR7exl6YrSrBZi2i7V4Z5pJGWrFcrSaOYk\nLM9/xCKsse9XzhZ7cTXHt8r2/YoVzv19hJSbKvTwDhn4AaC/tbR6P/B3w6vO\ndIpyw8rQghL8si+eiRA0ms8vHJITVjnWRBuSzKtrrLzeXycIPNEWIhOpTPo5\nr6n623rHsDdpj4N0IsZhSdF3Iw7DXsxHHTlBPYcfE8+vEq90VQZaix9dey63\nG9frUxmCLrZv2wVF/9uLXJLRshVOH/ZhzLLz4NOYPIElcs+veRD8ygdy9fZU\nH/nHMLcfNrTOS1iLLarh514+kBvEpQMp2IlLc99BfH78ZJtLotn3CoMrXSfm\nsFol\r\n=j3nP\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/mdc.tooltip.js","name":"@material/tooltip","types":"dist/mdc.tooltip.d.ts","module":"index.js","readme":"<!--docs:\ntitle: \"Tooltip\"\nlayout: detail\nsection: components\nexcerpt: \"Tooltips display informative text when users hover over, focus on, or tap an element.\"\niconId: tooltip\npath: /catalog/tooltips/\n-->\n\n# Tooltip\n\nTooltips display informative text when users hover over, focus on, or tap an element.\n\n![Tooltip example](images/tooltip.png)\n\n**Contents**\n\n* [Using tooltips](#using-tooltips)\n* [Tooltips](#tooltips)\n* [API](#api)\n* [Usage within web frameworks](#usage-within-web-frameworks)\n\n## Using tooltips\n\nTooltips, when activated, display a text label identifying an element, such as a\ndescription of its function. Tooltips should include only short, descriptive\ntext and avoid restating visible UI text.\n\nCommon use cases include:\n\n* Displaying full text that has been truncated\n* Identifying a UI affordance\n* Describing differences between similar elements\n* Distinguishing actions with related iconography\n\n### Tooltip positioning\nTooltip positioning is based on the anchor element (the element that, on user\ninteraction, results in showing or hiding of a tooltip). They appear directly\nbelow or above this anchor element and can be placed flush with either the end,\ncenter, or start of the anchor.\n\n![End, center, and start alignment of tooltip on icon button in a LTR page](images/plain_tooltip_alignment.png)\n<p align=\"center\"> *Tooltips aligned with the end, center, and start of an anchor element (in a LTR page flow).* </p>\n\n\nA threshold distance of 32px is expected to be maintained between the tooltip\nand the viewport edge. A valid tooltip position is calculated based on which of\nthe position options (start, center, or end for x-axis alignment and above or\nbelow for y-axis alignment) maintain this threshold. If all possible alignment\noptions violate the threshold, then a valid tooltip position is one that does\nnot collide with the viewport.\n\nA user specified position is honored only if the specified position is\nconsidered valid based on the logic outlined above.\n\n### Installing tooltips\n\n```\nnpm install @material/tooltip\n```\n\n### Styles\n\n```scss\n@use \"@material/tooltip/styles\";\n```\n\n### JavaScript instantiation\n\n```js\nimport {MDCTooltip} from '@material/tooltip';\nconst tooltip = new MDCTooltip(document.querySelector('.mdc-tooltip'));\n```\n\n> See [Importing the JS component](../../docs/importing-js.md) for more information on how to import JavaScript.\n\n### Making tooltips accessible\n\nEach tooltip element placed into the DOM is expected to have a unique `id`.\nTheir corresponding anchor element must be labeled with the `aria-describedby`\nattribute, establishing a relationship between the two elements.\n\n## Tooltips\n\n### Tooltip example\n\n```html\n<div id=\"tooltip-id\" class=\"mdc-tooltip\" role=\"tooltip\" aria-hidden=\"true\">\n  <div class=\"mdc-tooltip__surface\">\n    lorem ipsum dolor\n  </div>\n</div>\n```\n\nTo ensure proper positioning of the tooltip, it's important that this tooltip\nelement is an immediate child of the `<body>`, rather than nested underneath\nthe anchor element or other elements.\n\n\n```html\n<a aria-describedby=\"tooltip-id\" href=\"www.google.com\"> Link </a>\n```\n\nThe `aria-describedby` attribute (which is given the `id` for the associated tooltip)\ndesignates an element as being the anchor element for a particular tooltip.\n\nOther MDC components can be designated as anchor elements by adding this\nattribute.\n\n#### MDC Button:\n\n```html\n<button class=\"mdc-button mdc-button--outlined\" aria-describedby=\"tooltip-id\">\n  <div class=\"mdc-button__ripple\"></div>\n  <span class=\"mdc-button__label\">Button</span>\n</button>\n```\n#### MDC Icon Button:\n\n```html\n<button class=\"mdc-icon-button material-icons\" aria-describedby=\"tooltip-id\">favorite</button>\n```\n\nIf the information provided in the tooltip is duplicated from the anchor\nelement's `aria-label`, the tooltip can be hidden from the screenreader by\nannotating the anchor element with `data-tooltip-id` instead of\n`aria-describedby`. Hiding the tooltip from the screenreader will prevent the\nsame information from being announced twice (once from the `aria-label` and\na second time from the tooltip).\n\n```html\n<button class=\"mdc-icon-button material-icons\"\n        aria-label=\"toggle favorite\"\n        data-tooltip-id=\"tooltip-id\">\n  favorite\n</button>\n\n<div id=\"tooltip-id\" class=\"mdc-tooltip\" role=\"tooltip\" aria-hidden=\"true\">\n  <div class=\"mdc-tooltip__surface\">\n    toggle favorite\n  </div>\n</div>\n```\n\n\n## API\n\n### Sass mixins\n\nAccess to theme mixins require importing the tooltip's theme style module.\n\n```scss\n@use \"@material/tooltip\";\n```\n\nMixin | Description\n--- | ---\n`fill-color($color)` | Sets the fill color of the tooltip.\n`label-ink-color($color)` | Sets the color of the tooltip's label text.\n`shape-radius($radius, $rtl-reflexive)` | Sets the rounded shape to tooltip surface with given radius size. Set `$rtl-reflexive` to true to flip radius values in RTL context, defaults to false.\n`word-break($value, $fallbackValue)` | Sets the `word-break` property for the tooltip label. This is used to force-wrap long tooltip labels that lack spaces and hyphens. The optional $fallbackValue param can be used for IE11 as it does not support the `break-word` option. Users for IE11 who do not want their tooltip labels to be broken in the middle of the word can use this mixin to remove the default IE11 behavior of `break-all`.\n`z-index($z-index)` | Sets the z-index of the tooltip.\n\n### `MDCTooltip` Methods\n\nMethod Signature | Description\n--- | ---\n`setTooltipPosition(position: {xPos?: XPosition, yPos?: YPosition}) => void` | Specify how the tooltip should be aligned with the anchor element. See [tooltip positioning](#tooltip-positioning) section for more information.\n`setAnchorBoundaryType(type: AnchorBoundaryType) => void` | Specify whether the anchor element is `bounded` (element has an identifiable boundary such as a button) or `unbounded` (element does not have a visually declared boundary such as a text link). Tooltips are placed closer to bounded anchor elements compared to unbounded anchor elements. If no type is specified, defaults to `bounded`\n\n### Usage Within Frameworks\n\nIf you are using a JavaScript framework, such as React or Angular, you can create a Tooltip for your framework. Depending on your needs, you can use the _Simple Approach: Wrapping MDC Web Vanilla Components_, or the _Advanced Approach: Using Foundations and Adapters_. Please follow the instructions [here](../../docs/integrating-into-frameworks.md).\n\nSee [MDCTooltipAdapter](./adapter.ts) and [MDCTooltipFoundation](./foundation.ts) for up-to-date code documentation of tooltip foundation APIs.\n","gitHead":"8a3ec1a501083d67f1c342fcf5b11a765a586ca0","license":"MIT","_npmUser":{"name":"abhiomkar","email":"abhiomkar@gmail.com"},"homepage":"https://github.com/material-components/material-components-web#readme","keywords":["material components","material design","tooltip"],"repository":{"url":"git+https://github.com/material-components/material-components-web.git","type":"git","directory":"packages/mdc-tooltip"},"_npmVersion":"lerna/3.20.2/node@v10.23.0+x64 (linux)","description":"The Material Components Web tooltip component.","directories":{},"maintainers":[{"name":"taylorv","email":"brian.t.vann@gmail.com"},{"name":"ssuarez","email":"sayrisuarez@google.com"},{"name":"candysonya","email":"wangchan518@gmail.com"},{"name":"asyncliz","email":"asyncliz@gmail.com"},{"name":"esgonzalez","email":"esgonzalez@google.com"},{"name":"allanchen","email":"allanchen@google.com"},{"name":"emarquez","email":"emarquez@google.com"},{"name":"aomarks","email":"aomarks@gmail.com"},{"name":"abhiomkar","email":"abhiomkar@gmail.com"},{"name":"azakus","email":"dfreedm2@gmail.com"},{"name":"bicknellr","email":"bicknellr@gmail.com"},{"name":"material-admin","email":"aprigogin+npm@google.com"},{"name":"bwobrien","email":"obrien.test@gmail.com"},{"name":"lynnjepsen","email":"lynnjepsen@google.com"},{"name":"acdvorak","email":"acdvorak@gmail.com"},{"name":"kfranqueiro","email":"kenneth.franqueiro@gmail.com"},{"name":"aprigogin","email":"andrey.prigogin@gmail.com"},{"name":"patrickrodee","email":"prodee@google.com"},{"name":"bonniez","email":"bonniez@google.com"},{"name":"moog16","email":"mattgoo@gmail.com"},{"name":"williamernest","email":"williamernest@google.com"}],"sideEffects":false,"_nodeVersion":"10.23.0","dependencies":{"tslib":"^1.9.3","@material/dom":"9.0.0-canary.afb68894e.0","@material/rtl":"9.0.0-canary.afb68894e.0","@material/base":"9.0.0-canary.afb68894e.0","@material/shape":"9.0.0-canary.afb68894e.0","@material/theme":"9.0.0-canary.afb68894e.0","@material/animation":"9.0.0-canary.afb68894e.0","@material/elevation":"9.0.0-canary.afb68894e.0","@material/typography":"9.0.0-canary.afb68894e.0","@material/feature-targeting":"9.0.0-canary.afb68894e.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/tooltip_9.0.0-canary.afb68894e.0_1607445197323_0.2285382012967121","host":"s3://npm-registry-packages"},"_id":"@material/tooltip@9.0.0-canary.afb68894e.0","version":"9.0.0-canary.afb68894e.0"}