Skip to content

Commit 6dbb08e

Browse files
authored
Merge pull request #13 from Arthurk12/fixes-2
fix(tooltips): adds missing tippy style && docs: improve readme information
2 parents 50c3706 + 44bd58c commit 6dbb08e

File tree

5 files changed

+57
-43
lines changed

5 files changed

+57
-43
lines changed

.storybook/global.d.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
declare module '*.css' {
2+
const content: string;
3+
export default content;
4+
}
5+
6+
declare module 'tippy.js/dist/tippy.css';

README.md

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,49 @@
22

33
This repository contains a library of reusable React components extracted from the main [**BigBlueButton (BBB)**](https://github.com/bigbluebutton/bigbluebutton) project. These components provide a consistent and customizable interface that can be reused in other projects, allowing them to easily adopt the BBB visual identity.
44

5+
## Available Components
6+
7+
Below is a list of the components available in this library. Each component has its own detailed documentation with usage examples and a complete list of props.
8+
9+
- [BBBAccordion](./src/components/Accordion/README.md)
10+
- [BBButton](./src/components/Button/README.md)
11+
- [BBBCheckbox](./src/components/Checkbox/README.md)
12+
- [BBBDivider](./src/components/Divider/README.md)
13+
- [BBBHint](./src/components/Hint/README.md)
14+
- [BBBModal](./src/components/Modal//README.md)
15+
- [BBBNavigation](./src/components/Navigation/README.md)
16+
- [BBBSelect](./src/components/Select/README.md)
17+
- [BBBSpinner](./src/components/Spinner//README.md)
18+
- [BBBTextAreaInput](./src/components/TextAreaInput/README.md)
19+
- [BBBTextInput](./src/components/TextInput/README.md)
20+
- [BBBToggle](./src/components/Toggle/README.md)
21+
- [BBBTypography](./src/components/Typography/README.md)
22+
23+
## Installation
24+
25+
This library is under active development and has not yet been published on npm. For now, you can clone the repository and install it locally.
26+
27+
### Building the bundle
28+
29+
```
30+
npm install
31+
npm run build
32+
```
33+
34+
### Using npm link
35+
36+
When developing and testing locally with `npm link`, you may need to adjust your Webpack configuration to ensure compatibility with `styled-components` and `react`, which do not handle multiple instances well. Add the following alias configuration to the project that uses this library:
37+
38+
```json
39+
resolve: {
40+
alias: {
41+
'styled-components': path.resolve('./node_modules/styled-components'),
42+
react: path.resolve('./node_modules/react'),
43+
'react-dom': path.resolve('./node_modules/react-dom'),
44+
},
45+
}
46+
```
47+
548
## Peer Dependencies
649

750
This library requires the following peer dependencies to be installed in your project:
@@ -78,46 +121,3 @@ The following table lists the supported CSS variables for color overriding, extr
78121
```
79122

80123
If you need to override colors for specific components or add new variables, refer to the component's `styles.ts` file for implementation details.
81-
82-
## Installation
83-
84-
This library is under active development and has not yet been published on npm. For now, you can clone the repository and install it locally.
85-
86-
### Building the bundle
87-
88-
```
89-
npm install
90-
npm run build
91-
```
92-
93-
### Using npm link
94-
95-
When developing and testing locally with `npm link`, you may need to adjust your Webpack configuration to ensure compatibility with `styled-components` and `react`, which do not handle multiple instances well. Add the following alias configuration to the project that uses this library:
96-
97-
```json
98-
resolve: {
99-
alias: {
100-
'styled-components': path.resolve('./node_modules/styled-components'),
101-
react: path.resolve('./node_modules/react'),
102-
'react-dom': path.resolve('./node_modules/react-dom'),
103-
},
104-
}
105-
```
106-
107-
## Available Components
108-
109-
Below is a list of the components available in this library. Each component has its own detailed documentation with usage examples and a complete list of props.
110-
111-
- [BBBAccordion](./src/components/Accordion/README.md)
112-
- [BBButton](./src/components/Button/README.md)
113-
- [BBBCheckbox](./src/components/Checkbox/README.md)
114-
- [BBBDivider](./src/components/Divider/README.md)
115-
- [BBBHint](./src/components/Hint/README.md)
116-
- [BBBModal](./src/components/Modal//README.md)
117-
- [BBBNavigation](./src/components/Navigation/README.md)
118-
- [BBBSelect](./src/components/Select/README.md)
119-
- [BBBSpinner](./src/components/Spinner//README.md)
120-
- [BBBTextAreaInput](./src/components/TextAreaInput/README.md)
121-
- [BBBTextInput](./src/components/TextInput/README.md)
122-
- [BBBToggle](./src/components/Toggle/README.md)
123-
- [BBBTypography](./src/components/Typography/README.md)

src/components/Accordion/component.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import { AccordionProps } from './types';
33
import * as Styled from './styles';
44
import { MdExpandMore } from 'react-icons/md';
55
import Tippy from '@tippyjs/react';
6+
import 'tippy.js/dist/tippy.css';
67
import { DEFAULT_TOOLTIP_PLACEMENT } from './constants';
78

89
/**

src/components/Button/component.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import {
1111
} from './constants';
1212
import * as Styled from './styles';
1313
import Tippy from '@tippyjs/react';
14+
import 'tippy.js/dist/tippy.css';
1415

1516
/**
1617
* A versatile Button component.

src/global.d.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
declare module '*.css' {
2+
const content: string;
3+
export default content;
4+
}
5+
6+
declare module 'tippy.js/dist/tippy.css';

0 commit comments

Comments
 (0)