@afc-org/react-tailwind

!version !license !GitHub issues open !GitHub issues closed

$3

@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.

Components

It comes with 8 dynamic components, that any website needs.
We plan on implementing more, in the weeks to come.

Table of Contents

* Versions
* Components
* Quick Start
* Documentation
* Dependencies
* Browser Support
* Reporting Issues
* Licensing
* Resources

Versions

|Angular|JavaScript|React|Svelte|VueJS|
| --- | --- | --- | --- | --- |
| !Check Angular | !Check JavaScript | !Check React | !Check Svelte | !Check VueJS|

Components

- Alert
- Button
- Dropdown
- Menu
- Modal
- Navbar
- Popover
- Tooltip
- Tab Pills

Quick start

``
npm i -E @afc-org/react-tailwind
`

Documentation - React

After you have installed @afc-org/react-tailwind into your project, you can import and use our components like so:

$3

Usage:

`
// with closing button

import React from "react";
import { Alert } from "@afc-org/react-tailwind";
// or direct import
// import Alert from "@afc-org/react-tailwind/Alert";

// With Function Components (hooks)
export default function YourFunctionName() {
return (
<>
Alert text

);
}

// With Class Components
// export default class YourClassName extends React.Component{
// render() {
// return (
// <>
// Alert text
//
// );
// }
//}
`

`
// without closing button
// this means, that you can controll whether the Alert is shown or not

import React from "react";
import { Alert } from "@afc-org/react-tailwind";
// or direct import
// import Alert from "@afc-org/react-tailwind/src/Alert";

// With Function Components (hooks)
export default function YourFunctionName() {
return (
<>
Alert text

);
}

// With Class Components
// export default class YourClassName extends React.Component{
// render() {
// return (
// <>
// Alert text
//
// );
// }
//}
`

Props:

`
Alert.defaultProps = {
controlled: false,
color: "pink",
icon: ""
};

Alert.propTypes = {
// if set to false, then a closing button will be rendered so that the alert can be closed
// if set to true, then the closing button will not be rendered
controlled: PropTypes.bool,
// set the background, border and text color for the alert
color: PropTypes.oneOf([
"black",
"white",
"gray",
"red",
"orange",
"yellow",
"green",
"teal",
"blue",
"indigo",
"purple",
"pink"
]),
// adds a font icon to the left of the message
// for example, if you have included into your project font-awesome free
// you could send "fa fa-heart"
icon: PropTypes.string,
children: PropTypes.node.isRequired
};
`

$3

Usage:

`
import React from "react";
import { Button } from "@afc-org/react-tailwind";

// With Function Components (hooks)
export default function YourFunctionName() {
return (
<>
Buton text

);
}
`

Props:

`
Button.defaultProps = {
color: "pink"
};

Button.propTypes = {
// set the background, border and text color
color: PropTypes.oneOf([
"black",
"white",
"gray",
"red",
"orange",
"yellow",
"green",
"teal",
"blue",
"indigo",
"purple",
"pink"
]),
children: PropTypes.node
}
`

$3

Usage:

`
// uncontrolled usage
import React from "react";
import {
Dropdown,
DropdownToggle,
DropdownMenu,
DropdownItem
} from "@afc-org/react-tailwind";

const YourComponent = () => {
return (


Dropdown


Item 1
Item 2

Item 3


);
}

export default YourComponent;

// controlled usage
import React from "react";
import {
Dropdown,
DropdownToggle,
DropdownMenu,
DropdownItem
} from "@afc-org/react-tailwind";

const YourComponent = () => {
const [show,setShow] = React.useState(false);
return (

setShow(!show)}>
Dropdown


Item 1
Item 2

Item 3


);
}

export default YourComponent;
`

Props:

`
Dropdown.defaultProps = {
placement: "bottom"
};

Dropdown.propTypes = {
// where the Dropdown should be rendered
// NOTE: if there is no place for the dropdown to be rendered
// on the choosen placement, PopperJS will rendered it
// where it has place
placement: PropTypes.oneOf(["top", "bottom", "left", "right"]),
// when using the uncontrolled version
// you need to send exactly two children
// - DropdownToggle
// and
// - DropdownMenu
// if you fail to do so, an error will be thrown
children: PropTypes.node.isRequired
};

DropdownToggle.defaultProps = {
color: "pink"
};

DropdownToggle.propTypes = {
// set the background
color: PropTypes.oneOf([
"black",
"white",
"gray",
"red",
"orange",
"yellow",
"green",
"teal",
"blue",
"indigo",
"purple",
"pink"
])
};

DropdownMenu.defaultProps = {
show: false,
placement: "top",
color: "white"
};

DropdownMenu.propTypes = {
// make the menu hidden or visible
show: PropTypes.bool,
// where the DropdownMenu should be rendered
// NOTE: if there is no place for the dropdown menu to be rendered
// on the choosen placement, PopperJS will rendered it
// where it has place
placement: PropTypes.oneOf(["top", "bottom", "left", "right"]),
// set the background
color: PropTypes.oneOf([
"black",
"white",
"gray",
"red",
"orange",
"yellow",
"green",
"teal",
"blue",
"indigo",
"purple",
"pink"
])
};

DropdownItem.defaultProps = {
divider: false,
disabled: false,
light: true,
dark: false,
children: null
};

DropdownItem.propTypes = {
// this will make the component to be rendered as a divider line
divider: PropTypes.bool,
// this will make the component to not be clickable
disabled: PropTypes.bool,
children: PropTypes.node
};
`

$3

This component is integrated in the Navbar one.
Please check that component to see how you can get nice React & Tailwind menus in your app.

$3

Usage:

`
import React from "react";
import {
Button,
Modal,
ModalBody,
ModalContent,
ModalDialog,
ModalFooter,
ModalHead,
ModalTitle
} from "@afc-org/react-tailwind";

const YourComponent = () => {
const [show, setShow] = React.useState(false);
return (
<>
{/ Uncontrolled version /}
setShow(!show)}>
Open Modal





This is the modal title, yo
type="button"
onClick={() => setShow(!show)}
className="float-right text-2xl font-bold text-black leading-none bg-transparent border-0 opacity-50 p-4 -mr-4 -mt-4 -mb-4 ml-auto cursor-pointer"
>
×






A long time ago in a galaxy far, far away....


The Normy Modal was just a normal-sized modal, working for the
better of the empire, day by day, being a loyal soldier, not
asking any questions, doing his part for empowering the empire.

setShow(!show)}>
Save changes

setShow(!show)}>
Close






);
};

export default YourComponent;
`

Props:

`
Modal.defaultProps = {
show: false
};

Modal.propTypes = {
// send true to it to open the modal
show: PropTypes.bool,
children: PropTypes.node
};


ModalBody.defaultProps = {};

ModalBody.propTypes = {
children: PropTypes.node
};


ModalContent.defaultProps = {};

ModalContent.propTypes = {
children: PropTypes.node
};


ModalDialog.defaultProps = {
size: "default"
};

ModalDialog.propTypes = {
// size of the modal
size: PropTypes.oneOf(["sm", "lg", "xl", "default"]),
children: PropTypes.node
};


ModalFooter.defaultProps = {};

ModalFooter.propTypes = {
children: PropTypes.node
};


ModalHead.defaultProps = {};

ModalHead.propTypes = {
children: PropTypes.node
};


ModalTitle.defaultProps = {};

ModalTitle.propTypes = {
children: PropTypes.node
};
`

$3

Usage:

`
// uncontrolled version
import React from "react";
import {
Navbar,
NavbarBrand,
NavbarCollapse,
NavbarContainer,
NavbarItem,
NavbarLink,
NavbarNav,
NavbarToggler
} from "@afc-org/react-tailwind";

const YourComponent = () => {
return (
<>


Brand text here

⁝⁝⁝




Active Link


Simple Link


Disabled Link






);
};

export default YourComponent;

// controlled version
import React from "react";
import {
Navbar,
NavbarBrand,
NavbarCollapse,
NavbarContainer,
NavbarItem,
NavbarLink,
NavbarNav,
NavbarToggler
} from "@afc-org/react-tailwind";

const YourComponent = () => {
const [show, setShow] = React.useState(false);
return (
<>


Brand text here
setShow(!show)}>
⁝⁝⁝




Active Link


Simple Link


Disabled Link






);
};

export default YourComponent;
`

Props:

`
Navbar.defaultProps = {
color: "pink",
menu: false
};

Navbar.propTypes = {
// if you do not want to use this component as a navbar,
// but as a small menu someplace in your page,
// you can add the menu prop on it
menu: PropTypes.bool,
// set the background and text color
color: PropTypes.oneOf([
"black",
"white",
"gray",
"red",
"orange",
"yellow",
"green",
"teal",
"blue",
"indigo",
"purple",
"pink"
]),
children: PropTypes.node
};


NavbarBrand.defaultProps = {};

NavbarBrand.propTypes = {
children: PropTypes.node
};


NavbarCollapse.defaultProps = {
show: false,
controlled: false
};

NavbarCollapse.propTypes = {
// if you want to controll yourself the opening and closing of the collapse
show: PropTypes.bool,
controlled: PropTypes.bool,
// for controlled version,
// you need to pass this so that the component can be opnened and closed
// it has to come like "#toggler-id", where toggler-id can be any string
toggler: PropTypes.string,
// on which breakpoint should collapse be hidden
expand: PropTypes.oneOf(["sm", "md", "lg", "xl"]),
children: PropTypes.node
};


NavbarContainer.defaultProps = {
size: "fluid"
};

NavbarContainer.propTypes = {
// set how large should the container be
size: PropTypes.oneOf(["sm", "md", "lg", "xl", "fluid"]),
children: PropTypes.node
};


NavbarItem.defaultProps = {};

NavbarItem.propTypes = {
children: PropTypes.node
};


NavbarLink.defaultProps = {
active: false,
disabled: false
};

NavbarLink.propTypes = {
// for active state
active: PropTypes.bool,
// for disabled state
disabled: PropTypes.bool,
children: PropTypes.node
};


NavbarNav.defaultProps = {};

NavbarNav.propTypes = {
// from which breakpoint should the items be set in row (inline)
expand: PropTypes.oneOf(["sm", "md", "lg", "xl"]),
children: PropTypes.node
};


NavbarToggler.defaultProps = {};

NavbarToggler.propTypes = {
// from which breakpoint should toggler be hidden
expand: PropTypes.oneOf(["sm", "md", "lg", "xl"]),
children: PropTypes.node
};
`

$3

Usage:

`
// controlled usage
import React from "react";
import { Button, Popover, PopoverHead, PopoverBody } from "@afc-org/react-tailwind";

const YourComponent = () => {
const [show, setShow] = React.useState(false);
return (
<>
{/ Uncontrolled version /}

Uncontrolled Popover


Uncontrolled Popover

This is the Body of the Uncontrolled Popover, and the above is the
Title, man!






{/ Controlled version /}
setShow(!show)}>
Controlled Popover

controlled
show={show}
placement="bottom"
target="#popover-654321"
>
Controlled Popover

This is the Body of the Controlled Popover, and the above is the
Title, man!



);
};

export default YourComponent;
`

Props:

`
Popover.defaultProps = {
placement: "top",
controlled: false,
show: false
};

Popover.propTypes = {
// target is the ID of the element we want the popover to be associated to
target: PropTypes.string,
// where the Popover should be rendered
// NOTE: if there is no place for the popover to be rendered
// on the choosen placement, PopperJS will rendered it
// where it has place
placement: PropTypes.oneOf(["top", "bottom", "left", "right"]),
// if you want to controll the popover yourself
// and decide when to show it, and when to close it
// but you will still need to pass the target element
show: PropTypes.bool,
controlled: PropTypes.bool,
children: PropTypes.node
};


PopoverHead.defaultProps = {};

PopoverHead.propTypes = {
children: PropTypes.node
};

PopoverBody.defaultProps = {};

PopoverBody.propTypes = {
children: PropTypes.node
};
`

$3

Usage:

`
// controlled usage
import React from "react";
import { Button, Tooltip } from "@afc-org/react-tailwind";

const YourComponent = () => {
const [show, setShow] = React.useState(false);
return (
<>
{/ Uncontrolled version /}

Uncontrolled Tooltip

Uncontrolled Tooltip




{/ Controlled version /}
color="pink"
id="tooltip-654321"
onMouseEnter={() => setShow(!show)}
onMouseLeave={() => setShow(!show)}
>
Controlled Tooltip

controlled
show={show}
placement="bottom"
target="#tooltip-654321"
>
Controlled Tooltip


);
};

export default YourComponent;

`

Props:

`
Tooltip.defaultProps = {
placement: "top",
controlled: false,
show: false
};

Tooltip.propTypes = {
// target is the ID of the element we want the tooltip to be associated to
target: PropTypes.string,
// where the Tooltip should be rendered
// NOTE: if there is no place for the tooltip to be rendered
// on the choosen placement, PopperJS will rendered it
// where it has place
placement: PropTypes.oneOf(["top", "bottom", "left", "right"]),
// if you want to controll the tooltip yourself
// and decide when to show it, and when to close it
// but you will still need to pass the target element
show: PropTypes.bool,
controlled: PropTypes.bool,
children: PropTypes.node
};
`

$3

Usage:

`
// uncontrolled version
import React from "react";
import { TabContainer, TabItem, TabLink, TabContent } from "@afc-org/react-tailwind";

const YourComponent = () => {
return (
<>


Simple



Active



Simple



Disabled







Collaboratively administrate empowered markets via plug-and-play
networks. Dynamically procrastinate B2C users after installed base
benefits.


Dramatically visualize customer directed convergence without
revolutionary ROI.

Completely synergize resource taxing relationships via premier niche
markets. Professionally cultivate one-to-one customer service with
robust ideas.

Efficiently unleash cross-media information without cross-media value.
Quickly maximize timely deliverables for real-time schemas.

Efficiently unleash cross-media information without cross-media value.
Quickly maximize timely deliverables for real-time schemas.

Dramatically maintain clicks-and-mortar solutions without functional
solutions.

Completely synergize resource taxing relationships via premier niche
markets. Professionally cultivate one-to-one customer service with
robust ideas.

Efficiently unleash cross-media information without cross-media value.
Quickly maximize timely deliverables for real-time schemas.

);
};

export default YourComponent;
`

`
// controlled version
// on the controlled version you will have to send the color
// of each tab-link individualy, the color from the tab-container
// will no longer be applied :(
import React from "react";
import { TabContainer, TabItem, TabLink, TabContent } from "@afc-org/react-tailwind";

const YourComponent = () => {
const [active, setActive] = React.useState("tab-id-2");
const toggleActiveTab = tab => {
setActive(tab);
};
return (
<>
{/ the color on the container does nothing on the controlled version /}


color="pink"
target="#tab-id-1"
active={active === "tab-id-1"}
onClick={() => toggleActiveTab("tab-id-1")}
>
Simple



color="pink"
target="#tab-id-2"
active={active === "tab-id-2"}
onClick={() => toggleActiveTab("tab-id-2")}
>
Active



color="pink"
target="#tab-id-3"
active={active === "tab-id-3"}
onClick={() => toggleActiveTab("tab-id-3")}
>
Simple



color="pink"
target="#tab-id-4"
disabled
active={active === "tab-id-4"}
onClick={() => toggleActiveTab("tab-id-4")}
>
Disabled







Collaboratively administrate empowered markets via plug-and-play
networks. Dynamically procrastinate B2C users after installed base
benefits.


Dramatically visualize customer directed convergence without
revolutionary ROI.

Completely synergize resource taxing relationships via premier niche
markets. Professionally cultivate one-to-one customer service with
robust ideas.

Efficiently unleash cross-media information without cross-media value.
Quickly maximize timely deliverables for real-time schemas.

Efficiently unleash cross-media information without cross-media value.
Quickly maximize timely deliverables for real-time schemas.

Dramatically maintain clicks-and-mortar solutions without functional
solutions.

Completely synergize resource taxing relationships via premier niche
markets. Professionally cultivate one-to-one customer service with
robust ideas.

Efficiently unleash cross-media information without cross-media value.
Quickly maximize timely deliverables for real-time schemas.

);
};

export default YourComponent;
`

Props:

`
TabContainer.defaultProps = {
color: "pink",
controlled: false
};

TabContainer.propTypes = {
// if you want to controll the behavior yourself
controlled: PropTypes.bool,
// set the background, border and text color for the tab-link
color: PropTypes.oneOf([
"black",
"white",
"gray",
"red",
"orange",
"yellow",
"green",
"teal",
"blue",
"indigo",
"purple",
"pink"
]),
children: PropTypes.node
};


TabContent.defaultProps = {
active: false
};

TabContent.propTypes = {
show: PropTypes.bool,
id: PropTypes.string.isRequired,
children: PropTypes.node
};


TabItem.defaultProps = {};

TabItem.propTypes = {
children: PropTypes.node
};


TabLink.defaultProps = {
disabled: false,
active: false,
color: "white"
};

TabLink.propTypes = {
disabled: PropTypes.bool,
active: PropTypes.bool,
// set the background, border and text color for the tab-link
color: PropTypes.oneOf([
"black",
"white",
"gray",
"red",
"orange",
"yellow",
"green",
"teal",
"blue",
"indigo",
"purple",
"pink"
]),
// the tab-content that will be displayed by pressing this tab-link
target: PropTypes.string.isRequired,
children: PropTypes.node
};
`




$3

Do not forget that you will need to either get a compiled version of TailwindCSS, or to compile your own version, but one that will have the following classes from TailwindCSS:
`
px-5 py-3 border border-solid rounded relative mb-4 absolute bg-transparent text-2xl font-semibold leading-none right-0 top-0 outline-none focus:outline-none opacity-50 hover:opacity-75 hover:text-black text-xl inline-block mr-5 align-middle mr-8 bg-indigo-200 text-indigo-800 border-indigo-300 bg-gray-300 text-gray-800 border-gray-400 bg-green-200 text-green-800 border-green-300 bg-red-200 text-red-800 border-red-300 bg-orange-200 text-orange-800 border-orange-300 bg-blue-200 text-blue-800 border-blue-300 bg-white text-gray-600 border-gray-100 bg-gray-400 border-gray-500 left-0 z-50 hidden py-2 text-base text-left list-none mt-1 mb-1 mr-1 ml-1 block w-full py-1 px-6 clear-both font-normal whitespace-no-wrap border-0 hover:text-gray-900 hover:bg-gray-100 active:text-white active:bg-blue-500 text-white bg-blue-500 text-gray-400 pointer-events-none mb-2 flex flex-wrap items-center bg-gray-600 justify-between px-4 bg-blue-600 container mx-auto lg:px-4 px-0 capitalize mr-4 leading-relaxed ml-auto cursor-pointer px-3 text-gray-300 lg:hidden lg:flex lg:w-auto flex-grow lg:items-center lg:ml-auto pl-0 mb-0 flex-col lg:flex-row px-2 no-underline mb-3 leading-normal text-sm break-words text-center bg-black mr-2 ml-2 bg-green-600 bg-red-600 bg-yellow-500 bg-teal-500 bg-gray-100 text-gray-900 text-black bg-gray-800 -mb-px flex-auto text-blue-600 hover:text-blue-700 cursor-default rounded-t border-transparent border-b-0 border-b border-gray-200 sm:flex-row md:flex-row xl:flex-row navbar-expand sm:hidden md:hidden xl:hidden p-4 pointer-events-auto border-gray-600 transition-transform duration-300 ease-out w-auto m-2 sm:my-8 sm:mx-auto transform -translate-y-1 sm:max-w-xs md:max-w-screen-md lg:max-w-screen-lg sm:max-w-screen-sm justify-end p-3 border-t border-gray-300 rounded-b items-start opacity-0 fixed h-full overflow-hidden transition-opacity duration-75 ease-linear font-medium leading-tight mb-3mr-3 ml-3 mt-3
`
If you use purge, postcss-purgecss, postcss or any other tool to delete unused css, you can add the following array into your ignore (i.e. keep classes / whitelist etc.):
`
["px-5","py-3","border","border-solid","rounded","relative","mb-4","absolute","bg-transparent","text-2xl","font-semibold","leading-none","right-0","top-0","outline-none","focus:outline-none","opacity-50","hover:opacity-75","hover:text-black","text-xl","inline-block","mr-5","align-middle","mr-8","bg-indigo-200","text-indigo-800","border-indigo-300","bg-gray-300","text-gray-800","border-gray-400","bg-green-200","text-green-800","border-green-300","bg-red-200","text-red-800","border-red-300","bg-orange-200","text-orange-800","border-orange-300","bg-blue-200","text-blue-800","border-blue-300","bg-white","text-gray-600","border-gray-100","bg-gray-400","border-gray-500","left-0","z-50","hidden","py-2","text-base","text-left","list-none","mt-1","mb-1","mr-1","ml-1","block","w-full","py-1","px-6","clear-both","font-normal","whitespace-no-wrap","border-0","hover:text-gray-900","hover:bg-gray-100","active:text-white","active:bg-blue-500","text-white","bg-blue-500","text-gray-400","pointer-events-none","mb-2","flex","flex-wrap","items-center","bg-gray-600","justify-between","px-4","bg-blue-600","container","mx-auto","lg:px-4","px-0","capitalize","mr-4","leading-relaxed","ml-auto","cursor-pointer","px-3","text-gray-300","lg:hidden","lg:flex","lg:w-auto","flex-grow","lg:items-center","lg:ml-auto","pl-0","mb-0","flex-col","lg:flex-row","px-2","no-underline","mb-3","leading-normal","text-sm","break-words","text-center","bg-black","mr-2","ml-2","bg-green-600","bg-red-600","bg-yellow-500","bg-teal-500","bg-gray-100","text-gray-900","text-black","bg-gray-800","-mb-px","flex-auto","text-blue-600","hover:text-blue-700","cursor-default","rounded-t","border-transparent","border-b-0","border-b","border-gray-200","sm:flex-row","md:flex-row","xl:flex-row","navbar-expand","sm:hidden","md:hidden","xl:hidden","p-4","pointer-events-auto","border-gray-600","transition-transform","duration-300","ease-out","w-auto","m-2","sm:my-8","sm:mx-auto","transform","-translate-y-1","sm:max-w-xs","md:max-w-screen-md","lg:max-w-screen-lg","sm:max-w-screen-sm","justify-end","p-3","border-t","border-gray-300","rounded-b","items-start","opacity-0","fixed","h-full","overflow-hidden","transition-opacity","duration-75","ease-linear","font-medium","leading-tight","mb-3mr-3","ml-3","mt-3"]
`
Then, you can import your styles inside your index.js file (mounting js file for your app) like so:
`
import "path/to/your/tailwindcss/compiled/styles.css";
`
NOTE: alternatively, you can leave the components without any TailwindCSS styling code and render only HTML.

Dependencies

@afc-org/react-tailwind to properly work needs the following dependencies:
- @popperjs/core@2.2.1
- react@16.13.1
- react-dom@16.13.1
`
npm i -E @popperjs/core@2.2.1 react@16.13.1 react-dom@16.13.1
``

Browser Support

At present, we officially aim to support the last two versions of the following browsers:

| Chrome | Firefox | Edge | Safari | Opera |
|:---:|:---:|:---:|:---:|:---:|
| | | | | |

Reporting Issues

We use GitHub Issues as the official bug tracker for the Angular Landing Page. Here are some advices for our users that want to report an issue:

1. Make sure that you are using the latest version of the @afc-org/react-tailwind.
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Licensing

- Copyright 2020 @afc-org/react-tailwind

- Licensed under MIT

Resources

- AFC-ORG projects: https://github.com/afc-org/
- JavaScript & TailwindCSS: https://github.com/afc-org/js-tailwind
- Angular & TailwindCSS: https://github.com/afc-org/angular-tailwind
- React & TailwindCSS: https://github.com/afc-org/react-tailwind
- Svelte & TailwindCSS: https://github.com/afc-org/svelte-tailwind
- VueJS & TailwindCSS: https://github.com/afc-org/vue-tailwind
- Issues: Github Issues Page