Skip to content

Commit d9b533b

Browse files
committed
docs: adjustments to components naming
1 parent fa4077e commit d9b533b

File tree

4 files changed

+23
-23
lines changed

4 files changed

+23
-23
lines changed

src/components/Accordion/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# BBAccordion
1+
# BBBAccordion
22

3-
The `BBAccordion` component allows you to create collapsible sections of content. It's useful for showing and hiding information in a compact way.
3+
The `BBBAccordion` component allows you to create collapsible sections of content. It's useful for showing and hiding information in a compact way.
44

55
![Demo](assets/example.gif)
66

@@ -9,33 +9,33 @@ The `BBAccordion` component allows you to create collapsible sections of content
99
### Basic Accordion
1010

1111
```jsx
12-
import { BBAccordion } from 'bbb-ui-components-react';
12+
import { BBBAccordion } from 'bbb-ui-components-react';
1313

14-
<BBAccordion title="Click to expand">
14+
<BBBAccordion title="Click to expand">
1515
<p>This is the content of the accordion.</p>
1616
<p>It can contain any React nodes.</p>
17-
</BBAccordion>
17+
</BBBAccordion>
1818
```
1919

2020
### Accordion with Tooltip
2121

2222
```jsx
23-
import { BBAccordion } from 'bbb-ui-components';
23+
import { BBBAccordion } from 'bbb-ui-components-react';
2424

25-
<BBAccordion title="Hover for tooltip" tooltipLabel="This is a helpful tooltip!">
25+
<BBBAccordion title="Hover for tooltip" tooltipLabel="This is a helpful tooltip!">
2626
<p>Content for the accordion with a tooltip.</p>
27-
</BBAccordion>
27+
</BBBAccordion>
2828
```
2929

3030
### Accordion with custom button header
3131

3232
```jsx
33-
import { BBAccordion } from 'bbb-ui-components';
34-
import { MdFavorite } from "react-icons/md";
33+
import { BBBAccordion } from 'bbb-ui-components-react';
34+
import { MdFavorite } from 'react-icons/md';
3535

36-
<BBAccordion title="Hover for tooltip" tooltipLabel="This is a helpful tooltip!" buttonHeader={<MdFavorite>}>
36+
<BBBAccordion title="Hover for tooltip" tooltipLabel="This is a helpful tooltip!" buttonHeader={<MdFavorite>}>
3737
<p>Content for the accordion with a tooltip.</p>
38-
</BBAccordion>
38+
</BBBAccordion>
3939
```
4040

4141
## Props

src/components/Hint/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# BBHint
1+
# BBBHint
22

3-
The `BBHint` component is used to display informational messages to the user. It can be used to show tips, warnings, or other important information.
3+
The `BBBHint` component is used to display informational messages to the user. It can be used to show tips, warnings, or other important information.
44

55
![Demo](assets/example.png)
66

@@ -9,17 +9,17 @@ The `BBHint` component is used to display informational messages to the user. It
99
### Basic Hint
1010

1111
```jsx
12-
import { BBHint } from 'bbb-ui-components';
12+
import { BBBHint } from 'bbb-ui-components-react';
1313

14-
<BBHint label="This is a simple hint." />
14+
<BBBHint label="This is a simple hint." />
1515
```
1616

1717
### Hint with Title and Close Button
1818

1919
```jsx
20-
import { BBHint } from 'bbb-ui-components';
20+
import { BBBHint } from 'bbb-ui-components-react';
2121

22-
<BBHint
22+
<BBBHint
2323
title="Information"
2424
label="This hint has a title and a close button."
2525
onRequestClose={() => alert('Hint closed!')}

src/components/Select/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The `BBBSelect` component is a customizable select input that wraps the Material
99
### Basic Select
1010

1111
```jsx
12-
import { BBBSelect } from 'bbb-ui-components';
12+
import { BBBSelect } from 'bbb-ui-components-react';
1313
import MenuItem from '@mui/material/MenuItem';
1414

1515
<BBBSelect title="Choose an option" defaultValue="">
@@ -25,7 +25,7 @@ import MenuItem from '@mui/material/MenuItem';
2525
### Select with Icon
2626

2727
```jsx
28-
import { BBBSelect } from 'bbb-ui-components';
28+
import { BBBSelect } from 'bbb-ui-components-react';
2929
import MenuItem from '@mui/material/MenuItem';
3030
import { MdFilterList } from 'react-icons/md';
3131

src/components/TextInput/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,21 @@ The `BBBTextInput` component provides a styled, single-line text input field tha
88

99
### Text Input with label and placeholder
1010
```jsx
11-
import { BBBTextInput } from 'bbb-ui-components';
11+
import { BBBTextInput } from 'bbb-ui-components-react';
1212

1313
<BBBTextInput label="Username" placeholder="Enter your username" />
1414
```
1515

1616
### Text Input with label, placeholder and a helper text
1717
```jsx
18-
import { BBBTextInput } from 'bbb-ui-components';
18+
import { BBBTextInput } from 'bbb-ui-components-react';
1919

2020
<BBBTextInput label="Username" placeholder="Enter your username" helperText="Write here your username" />
2121
```
2222

2323
### Text Input with label and placeholder and error state
2424
```jsx
25-
import { BBBTextInput } from 'bbb-ui-components';
25+
import { BBBTextInput } from 'bbb-ui-components-react';
2626

2727
<BBBTextInput error label="Username" placeholder="Enter your username" />
2828
```

0 commit comments

Comments
 (0)