You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Please feel free to take on any issue that's currently open. Just send a comment
16
16
17
17
## Submitting a pull request
18
18
19
-
**@afc/react-tailwind** is an open-source project, so pull requests are always welcomed (_always_ ❤️).
19
+
**@afc-org/react-tailwind** is an open-source project, so pull requests are always welcomed (_always_ ❤️).
20
20
What we ask you, is that before working on a large change, it is best to open an issue first to discuss it with the maintainers or if an issue was already opened, comment your intention of opening up a PR.
21
21
22
22
When in doubt, keep your pull requests small. To give a PR the best chance of getting accepted, don't bundle more than one feature or bug fix per pull request. It's always best to create two smaller PRs than one big one.
@@ -78,5 +78,5 @@ Closes #12
78
78
## Branches explained
79
79
80
80
As you can see we have multiple branches:
81
-
-**master**: This branch stores the latest stable version of @afc/react-tailwind.
82
-
-**dev-master**: This is the **development** branch of @afc/react-tailwind, and this is where everything is happening before releasing on master
81
+
-**master**: This branch stores the latest stable version of @afc-org/react-tailwind.
82
+
-**dev-master**: This is the **development** branch of @afc-org/react-tailwind, and this is where everything is happening before releasing on master
@afc/react-tailwind is Free and Open Source. It does not change or add any CSS to the already one from TailwindCSS, It comes with code written with React as an extension to TailwindCSS for you to have dynamic components inside your app as well.
9
+
@afc-org/react-tailwind is Free and Open Source. It does not change or add any CSS to the already one from TailwindCSS, It comes with code written with React as an extension to TailwindCSS for you to have dynamic components inside your app as well.
10
10
11
11
**Components**
12
12
@@ -47,12 +47,12 @@ We plan on implementing more, in the weeks to come.
47
47
## Quick start
48
48
49
49
```
50
-
npm i -E @afc/react-tailwind
50
+
npm i -E @afc-org/react-tailwind
51
51
```
52
52
53
53
## Documentation - React
54
54
55
-
After you have installed `@afc/react-tailwind` into your project, you can import and use our components like so:
55
+
After you have installed `@afc-org/react-tailwind` into your project, you can import and use our components like so:
56
56
57
57
### Alert
58
58
@@ -62,9 +62,9 @@ Usage:
62
62
// with closing button
63
63
64
64
import React from "react";
65
-
import { Alert } from "@afc/react-tailwind";
65
+
import { Alert } from "@afc-org/react-tailwind";
66
66
// or direct import
67
-
// import Alert from "@afc/react-tailwind/Alert";
67
+
// import Alert from "@afc-org/react-tailwind/Alert";
68
68
69
69
// With Function Components (hooks)
70
70
export default function YourFunctionName() {
@@ -92,9 +92,9 @@ export default function YourFunctionName() {
92
92
// this means, that you can controll whether the Alert is shown or not
93
93
94
94
import React from "react";
95
-
import { Alert } from "@afc/react-tailwind";
95
+
import { Alert } from "@afc-org/react-tailwind";
96
96
// or direct import
97
-
// import Alert from "@afc/react-tailwind/src/Alert";
97
+
// import Alert from "@afc-org/react-tailwind/src/Alert";
98
98
99
99
// With Function Components (hooks)
100
100
export default function YourFunctionName() {
@@ -159,7 +159,7 @@ Usage:
159
159
160
160
```
161
161
import React from "react";
162
-
import { Button } from "@afc/react-tailwind";
162
+
import { Button } from "@afc-org/react-tailwind";
163
163
164
164
// With Function Components (hooks)
165
165
export default function YourFunctionName() {
@@ -210,7 +210,7 @@ import {
210
210
DropdownToggle,
211
211
DropdownMenu,
212
212
DropdownItem
213
-
} from "@afc/react-tailwind";
213
+
} from "@afc-org/react-tailwind";
214
214
215
215
const YourComponent = () => {
216
216
return (
@@ -237,7 +237,7 @@ import {
237
237
DropdownToggle,
238
238
DropdownMenu,
239
239
DropdownItem
240
-
} from "@afc/react-tailwind";
240
+
} from "@afc-org/react-tailwind";
241
241
242
242
const YourComponent = () => {
243
243
const [show,setShow] = React.useState(false);
@@ -371,7 +371,7 @@ import {
371
371
ModalFooter,
372
372
ModalHead,
373
373
ModalTitle
374
-
} from "@afc/react-tailwind";
374
+
} from "@afc-org/react-tailwind";
375
375
376
376
const YourComponent = () => {
377
377
const [show, setShow] = React.useState(false);
@@ -498,7 +498,7 @@ import {
498
498
NavbarLink,
499
499
NavbarNav,
500
500
NavbarToggler
501
-
} from "@afc/react-tailwind";
501
+
} from "@afc-org/react-tailwind";
502
502
503
503
const YourComponent = () => {
504
504
return (
@@ -541,7 +541,7 @@ import {
541
541
NavbarLink,
542
542
NavbarNav,
543
543
NavbarToggler
544
-
} from "@afc/react-tailwind";
544
+
} from "@afc-org/react-tailwind";
545
545
546
546
const YourComponent = () => {
547
547
const [show, setShow] = React.useState(false);
@@ -690,7 +690,7 @@ Usage:
690
690
```
691
691
// controlled usage
692
692
import React from "react";
693
-
import { Button, Popover, PopoverHead, PopoverBody } from "@afc/react-tailwind";
693
+
import { Button, Popover, PopoverHead, PopoverBody } from "@afc-org/react-tailwind";
694
694
695
695
const YourComponent = () => {
696
696
const [show, setShow] = React.useState(false);
@@ -778,7 +778,7 @@ Usage:
778
778
```
779
779
// controlled usage
780
780
import React from "react";
781
-
import { Button, Tooltip } from "@afc/react-tailwind";
781
+
import { Button, Tooltip } from "@afc-org/react-tailwind";
782
782
783
783
const YourComponent = () => {
784
784
const [show, setShow] = React.useState(false);
@@ -849,7 +849,7 @@ Usage:
849
849
```
850
850
// uncontrolled version
851
851
import React from "react";
852
-
import { TabContainer, TabItem, TabLink, TabContent } from "@afc/react-tailwind";
852
+
import { TabContainer, TabItem, TabLink, TabContent } from "@afc-org/react-tailwind";
853
853
854
854
const YourComponent = () => {
855
855
return (
@@ -928,7 +928,7 @@ export default YourComponent;
928
928
// of each tab-link individualy, the color from the tab-container
929
929
// will no longer be applied :(
930
930
import React from "react";
931
-
import { TabContainer, TabItem, TabLink, TabContent } from "@afc/react-tailwind";
931
+
import { TabContainer, TabItem, TabLink, TabContent } from "@afc-org/react-tailwind";
0 commit comments