@akinon/ui-tooltip 0.4.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,16 @@
1
1
  import * as React from 'react';
2
2
  import type { TooltipProps } from './types';
3
3
  export type { TooltipProps } from './types';
4
+ /**
5
+ * Tooltip component for displaying contextual information.
6
+ *
7
+ * The Tooltip component provides additional details about an element or action when the user hovers over, focuses on, or interacts with the target element.
8
+ * It supports rich content, multiple trigger actions, and advanced alignment configurations to fit seamlessly into various UI designs.
9
+ *
10
+ * The component is built with flexibility in mind, supporting motion effects, custom containers, and precise placement. It also allows for dynamic content
11
+ * rendering, ensuring the tooltip adapts to different use cases and layouts.
12
+ *
13
+ * Tooltip is a part of the design system, adhering to accessibility standards and offering intuitive user experiences.
14
+ */
4
15
  export declare const Tooltip: ({ children, ...restTooltipProps }: TooltipProps) => React.JSX.Element;
5
16
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,eAAO,MAAM,OAAO,sCAAuC,YAAY,sBAgCtE,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C;;;;;;;;;;GAUG;AAEH,eAAO,MAAM,OAAO,sCAAuC,YAAY,sBAgCtE,CAAC"}
package/dist/esm/index.js CHANGED
@@ -13,6 +13,17 @@ import { useToken } from '@akinon/ui-theme';
13
13
  import { useStyleRegister } from '@ant-design/cssinjs';
14
14
  import { ConfigProvider, Tooltip as AntTooltip } from 'antd';
15
15
  import * as React from 'react';
16
+ /**
17
+ * Tooltip component for displaying contextual information.
18
+ *
19
+ * The Tooltip component provides additional details about an element or action when the user hovers over, focuses on, or interacts with the target element.
20
+ * It supports rich content, multiple trigger actions, and advanced alignment configurations to fit seamlessly into various UI designs.
21
+ *
22
+ * The component is built with flexibility in mind, supporting motion effects, custom containers, and precise placement. It also allows for dynamic content
23
+ * rendering, ensuring the tooltip adapts to different use cases and layouts.
24
+ *
25
+ * Tooltip is a part of the design system, adhering to accessibility standards and offering intuitive user experiences.
26
+ */
16
27
  export const Tooltip = (_a) => {
17
28
  var { children } = _a, restTooltipProps = __rest(_a, ["children"]);
18
29
  const { getPrefixCls, theme } = React.useContext(ConfigProvider.ConfigContext);