History

Alexey Safronov a2302aa248 Merge branch 'hotfix/v2.6.1' into develop # Conflicts: # packages/client/src/components/PrivateRouteWrapper/index.tsx # packages/client/src/pages/Confirm/sub-components/activateUser.js # packages/client/src/pages/PortalSettings/categories/integration/LDAP/sub-components/CertificateDialog.js # packages/client/src/pages/PublicRoom/sub-components/RoomStyles.js # packages/login/src/app/(root)/layout.tsx # packages/login/src/app/(root)/page.tsx # packages/login/src/app/layout.tsx # packages/login/src/components/LoginForm/index.tsx # packages/login/src/types/index.ts # packages/login/src/utils/actions.ts # packages/shared/constants/index.ts # packages/shared/themes/base.ts		2024-08-09 17:23:25 +04:00
..
HelpButton.stories.tsx	Shared: refactor rtl	2024-07-16 10:30:28 +02:00
HelpButton.styled.ts	Shared: HelpButton: delete useless	2024-06-10 20:12:56 +05:00
HelpButton.test.tsx	Replaced copyright start year + format	2024-03-21 18:09:55 +04:00
HelpButton.tsx	Shared:Components: fix defaultProps	2024-08-07 17:44:47 +03:00
HelpButton.types.tsx	Fixed Bug 67164 – Rooms.InviteUsers. Show the popup helper window in the user's line with an invalid email when hovering the mouse over the ! icon, and not when clicking.	2024-04-02 13:35:25 +03:00
index.tsx	Replaced copyright start year + format	2024-03-21 18:09:55 +04:00
README.md	Client: fix wrong import - export for shared components	2024-01-10 11:01:43 +03:00

README.md

HelpButton

HelpButton is used for a action on a page

Usage

import { HelpButton } from "@docspace/shared/components/help-button";

<HelpButton tooltipContent={<Text>Tooltip content</Text>} />

Usage with link

<HelpButton
  tooltipContent={
    <Text>
      Tooltip content with{" "}
      <Link isHovered={true} href="/">
        link
      </Link>
    </Text>
  }
/>

Usage with aside

<HelpButton
  tooltipContent={
    <>
      <p>This is a global react component tooltip</p>
      <p>You can put every thing here</p>
      <ul>
        <li>Word</li>
        <li>Chart</li>
        <li>Else</li>
      </ul>
    </>
  }
/>

Properties

Props	Type	Required	Values	Default	Description
`className`	`string`	-	-	-	Accepts class
`displayType`	`oneOf`	-	`dropdown`, `aside`, `auto`	`auto`	Tooltip display type
`helpButtonHeaderContent`	`string`	-	-	-	Tooltip header content (tooltip opened in aside)	`id`	`string`	-	-	-	Accepts id