@@ -9,15 +9,15 @@ This is a working in progress project.
9
9
First you can install using npm or yarn into your project.
10
10
11
11
```
12
- npm i thon- ui
12
+ npm i @thonlabs/ ui
13
13
# or
14
- yarn add thon- ui
14
+ yarn add @thonlabs/ ui
15
15
```
16
16
17
17
On your project create a tailwind config file on root with this configuration below:
18
18
19
19
``` javascript
20
- const { thonUI , thonUIContent } = require (' thon- ui/plugin' );
20
+ const { thonUI , thonUIContent } = require (' @thonlabs/ ui/plugin' );
21
21
22
22
/** @type {import('tailwindcss').Config} */
23
23
module .exports = {
@@ -38,7 +38,7 @@ module.exports = {
38
38
};
39
39
```
40
40
41
- _ Note: The tailwind, postcss and autoprefixer libraries is already installed by thon- ui_
41
+ _ Note: The tailwind, postcss and autoprefixer libraries is already installed by @ thonlabs / ui_
42
42
43
43
## How to Use
44
44
@@ -49,16 +49,16 @@ You can import components, hooks or providers following those patterns below
49
49
On the main file off your application add the base styles from Thon.
50
50
51
51
``` javascript
52
- import ' thon- ui/core/base.css' ;
53
- import ' thon- ui/core/fonts.css' ; // Exclude in case of using other fronts
52
+ import ' @thonlabs/ ui/core/base.css' ;
53
+ import ' @thonlabs/ ui/core/fonts.css' ; // Exclude in case of using other fronts
54
54
```
55
55
56
56
_ Note: the default font from Thon UI is [ "Inter"] ( https://fonts.google.com/specimen/Inter ) from Google Fonts._
57
57
58
58
### Components
59
59
60
60
``` javascript
61
- import { Text , Card } from ' thon- ui' ;
61
+ import { Text , Card } from ' @thonlabs/ ui' ;
62
62
```
63
63
64
64
** Current Available Components**
@@ -79,7 +79,7 @@ import { Text, Card } from 'thon-ui';
79
79
### Providers
80
80
81
81
``` javascript
82
- import { ThemeProvider } from ' thon- ui/providers' ;
82
+ import { ThemeProvider } from ' @thonlabs/ ui/providers' ;
83
83
```
84
84
85
85
** Current Available Providers**
@@ -90,7 +90,7 @@ import { ThemeProvider } from 'thon-ui/providers';
90
90
### Hooks
91
91
92
92
``` javascript
93
- import { useTheme } from ' thon- ui/hooks' ;
93
+ import { useTheme } from ' @thonlabs/ ui/hooks' ;
94
94
```
95
95
96
96
** Current Available Hooks**
0 commit comments