@workday/canvas-kit-react 10.3.21 → 10.3.22

package/tooltip/README.md

@@ -1,77 +0,0 @@
-# Canvas Kit Tooltip
-
-A Tooltip component that renders information/text when the user hovers over an element. A tooltip is
-used to label or describe an element. By default, a tooltip will label an element. This is useful
-for TertiaryButtons that render just an icon. A tooltip can also be used to describe additional
-information about an element
-
-[> Workday Design Reference](https://design.workday.com/components/popups/tooltips)
-
-## Installation
-
-```sh
-yarn add @workday/canvas-kit-react
-```
-
-## Usage
-
-```tsx
-import * as React from 'react';
-
-import {Tooltip} from '@workday/canvas-kit-react/tooltip';
-import {TertiaryButton} from '@workday/canvas-kit-react/button';
-
-const TooltipExample = () => {
-  return (
-    <Tooltip title="Close">
-      <TertiaryButton icon={xIcon} aria-label="Close" />
-    </Tooltip>
-  );
-};
-```
-
-## Static Properties
-
-> None
-
-## Component Props
-
-### Required
-
-#### title: string | React.ReactNode
-
-> This should be a string in most cases. HTML is supported, but only text is understood by assistive
-> technology. This is true for both `label` and `describe` modes.
-
-#### children: React.ReactNode
-
-> The target (anchor element) for the Tooltip.
->
-> **Note:** This **must** be an Element, StyledComponent or any other component that forwards extra
-> props to an Element. Tooltip works running `React.cloneElement` on the children and adds extra
-> properties like aria attributes and event handlers. This is currently a limitation of the Tooltip
-> component. Functionality will not work if this condition isn't met
-
----
-
-### Optional
-
-#### type: 'label' | 'describe'
-
-> Determines the tooltip type for accessibility.
->
-> - `label`: Sets the accessible name for the wrapped element. Use for icons or if tooltip `title`
->   prop is the same as the text content of the wrapped element. E.g. TertiaryButtons that render an
->   icon or Ellipsis tooltips.
-> - `describe`: Sets `aria-describedby` of the wrapped element. Use if the tooltip has additional
->   information about the target. **Note**: Assistive technology may ignore `describe` techniques
->   based on verbosity settings. Consider an alternate way to inform a user of additional important
->   information.
-
-Default: `'label'`
-
-#### placement: PopperJS.Placement
-
-> Sets the placement preference used by PopperJS.
-
-Default: `'top'`