11# React ` <AwesomeButton /> ` UI Components
22
3- ` react-awesome-button ` provides three related button components:
3+ ` @rcaferati/ react-awesome-button` provides three related button components:
44
55- ** ` AwesomeButton ` ** — animated base button
66- ** ` AwesomeButtonProgress ` ** — progress flow wrapper on top of ` AwesomeButton `
@@ -13,7 +13,7 @@ This README is updated for the current component patterns and prop behavior.
1313## Installation
1414
1515``` bash
16- npm install react-awesome-button
16+ npm install @rcaferati/ react-awesome-button
1717```
1818
1919---
@@ -24,8 +24,8 @@ npm install react-awesome-button
2424
2525``` jsx
2626import React from ' react' ;
27- import { AwesomeButton } from ' react-awesome-button' ;
28- import ' react-awesome-button/dist /styles.css' ;
27+ import { AwesomeButton } from ' @rcaferati/ react-awesome-button' ;
28+ import ' @rcaferati/ react-awesome-button/styles.css' ;
2929
3030export default function Example () {
3131 return < AwesomeButton type= " primary" > Button< / AwesomeButton> ;
@@ -36,14 +36,14 @@ export default function Example() {
3636
3737## Styling with Theme CSS Modules (Blue Theme)
3838
39- If you want to use the package theme module object (for ` cssModule ` ), import the blue theme and pass it to the component.
39+ If you want to use the package theme module object (for ` cssModule ` ), import a built theme module and pass it to the component.
4040
4141> Note: depending on your bundler/module interop, the imported theme may be on ` .default ` .
4242
4343``` jsx
4444import React from ' react' ;
45- import { AwesomeButton } from ' react-awesome-button' ;
46- import themeBlue from ' react-awesome-button/src/styles /themes/theme-blue' ;
45+ import { AwesomeButton } from ' @rcaferati/ react-awesome-button' ;
46+ import themeBlue from ' @rcaferati/ react-awesome-button/themes/theme-blue' ;
4747
4848const blueTheme = themeBlue? .default ?? themeBlue;
4949
@@ -66,8 +66,8 @@ If `href` is **not** provided, `AwesomeButton` renders a button-like element and
6666
6767` ` ` jsx
6868import React from ' react' ;
69- import { AwesomeButton } from ' react-awesome-button' ;
70- import themeBlue from ' react-awesome-button/src/styles /themes/theme-blue' ;
69+ import { AwesomeButton } from ' @rcaferati/ react-awesome-button' ;
70+ import themeBlue from ' @rcaferati/ react-awesome-button/themes/theme-blue' ;
7171
7272const blueTheme = themeBlue? .default ?? themeBlue;
7373
@@ -91,8 +91,8 @@ If `href` is provided, it renders anchor-like behavior and lets native navigatio
9191
9292` ` ` jsx
9393import React from ' react' ;
94- import { AwesomeButton } from ' react-awesome-button' ;
95- import themeBlue from ' react-awesome-button/src/styles /themes/theme-blue' ;
94+ import { AwesomeButton } from ' @rcaferati/ react-awesome-button' ;
95+ import themeBlue from ' @rcaferati/ react-awesome-button/themes/theme-blue' ;
9696
9797const blueTheme = themeBlue? .default ?? themeBlue;
9898
@@ -117,8 +117,8 @@ For **icon-only** buttons, pass the icon using `before` and omit children.
117117` ` ` jsx
118118import React from ' react' ;
119119import { Play , ArrowRight , Sparkles } from ' lucide-react' ;
120- import { AwesomeButton } from ' react-awesome-button' ;
121- import themeBlue from ' react-awesome-button/src/styles /themes/theme-blue' ;
120+ import { AwesomeButton } from ' @rcaferati/ react-awesome-button' ;
121+ import themeBlue from ' @rcaferati/ react-awesome-button/themes/theme-blue' ;
122122
123123const blueTheme = themeBlue? .default ?? themeBlue;
124124
@@ -153,7 +153,7 @@ export default function Example() {
153153
154154` ` ` jsx
155155import React from ' react' ;
156- import { AwesomeButton } from ' react-awesome-button' ;
156+ import { AwesomeButton } from ' @rcaferati/ react-awesome-button' ;
157157
158158export default function Example () {
159159 return (
@@ -221,8 +221,8 @@ Its `onPress` receives a second callback argument:
221221
222222` ` ` jsx
223223import React from ' react' ;
224- import { AwesomeButtonProgress } from ' react-awesome-button' ;
225- import themeBlue from ' react-awesome-button/src/styles /themes/theme-blue' ;
224+ import { AwesomeButtonProgress } from ' @rcaferati/ react-awesome-button' ;
225+ import themeBlue from ' @rcaferati/ react-awesome-button/themes/theme-blue' ;
226226
227227const blueTheme = themeBlue? .default ?? themeBlue;
228228
@@ -250,7 +250,7 @@ export default function Example() {
250250
251251` ` ` jsx
252252import React from ' react' ;
253- import { AwesomeButtonProgress } from ' react-awesome-button' ;
253+ import { AwesomeButtonProgress } from ' @rcaferati/ react-awesome-button' ;
254254
255255const sleep = (ms ) => new Promise ((resolve ) => setTimeout (resolve, ms));
256256
@@ -275,8 +275,8 @@ export default function Example() {
275275` ` ` jsx
276276import React from ' react' ;
277277import { Shield } from ' lucide-react' ;
278- import { AwesomeButtonProgress } from ' react-awesome-button' ;
279- import themeBlue from ' react-awesome-button/src/styles /themes/theme-blue' ;
278+ import { AwesomeButtonProgress } from ' @rcaferati/ react-awesome-button' ;
279+ import themeBlue from ' @rcaferati/ react-awesome-button/themes/theme-blue' ;
280280
281281const blueTheme = themeBlue? .default ?? themeBlue;
282282const sleep = (ms ) => new Promise ((resolve ) => setTimeout (resolve, ms));
@@ -332,8 +332,8 @@ On press, the component follows this order:
332332` ` ` jsx
333333import React from ' react' ;
334334import { Github } from ' lucide-react' ;
335- import { AwesomeButtonSocial } from ' react-awesome-button' ;
336- import themeBlue from ' react-awesome-button/src/styles /themes/theme-blue' ;
335+ import { AwesomeButtonSocial } from ' @rcaferati/ react-awesome-button' ;
336+ import themeBlue from ' @rcaferati/ react-awesome-button/themes/theme-blue' ;
337337
338338const blueTheme = themeBlue? .default ?? themeBlue;
339339
@@ -357,7 +357,7 @@ export default function Example() {
357357
358358` ` ` jsx
359359import React from ' react' ;
360- import { AwesomeButtonSocial } from ' react-awesome-button' ;
360+ import { AwesomeButtonSocial } from ' @rcaferati/ react-awesome-button' ;
361361
362362export default function Example () {
363363 return (
@@ -380,7 +380,7 @@ export default function Example() {
380380
381381` ` ` jsx
382382import React from ' react' ;
383- import { AwesomeButtonSocial } from ' react-awesome-button' ;
383+ import { AwesomeButtonSocial } from ' @rcaferati/ react-awesome-button' ;
384384
385385export default function Example () {
386386 return (
@@ -402,7 +402,7 @@ If `href` is present, the component behaves like an anchor and does **not** exec
402402
403403` ` ` jsx
404404import React from ' react' ;
405- import { AwesomeButtonSocial } from ' react-awesome-button' ;
405+ import { AwesomeButtonSocial } from ' @rcaferati/ react-awesome-button' ;
406406
407407export default function Example () {
408408 return (
@@ -460,7 +460,7 @@ const blueTheme = themeBlue?.default ?? themeBlue;
460460Then pass it to any button component via:
461461
462462` ` ` jsx
463- cssModule = { blueTheme };
463+ < AwesomeButton cssModule = { blueTheme} > Button < / AwesomeButton >
464464` ` `
465465
466466---
0 commit comments