Skip to content

README.md

Latest commit

 

History

History
38 lines (27 loc) · 1.76 KB

README.md

File metadata and controls

38 lines (27 loc) · 1.76 KB

BBBHint

The BBBHint component is used to display informational messages to the user. It can be used to show tips, warnings, or other important information.

Demo

Usage Example

Basic Hint

import { BBBHint } from 'bbb-ui-components-react';

<BBBHint label="This is a simple hint." />

Hint with Title and Close Button

import { BBBHint } from 'bbb-ui-components-react';

<BBBHint
  title="Information"
  label="This hint has a title and a close button."
  onRequestClose={() => alert('Hint closed!')}
/>

Props

Property Type Default Description
label string The main text content of the hint.
title string An optional title for the hint. If provided, a close button will be displayed.
icon React.ReactNode An optional icon to be displayed next to the title or label.
onRequestClose () => void A callback function to be called when the close button is clicked.
children React.ReactNode Optional additional content to be displayed below the label.
...props HTMLAttributes<HTMLDivElement> Any other props will be passed down to the underlying container div.