1.0.0-alpha-end • Published 1 year ago

tw-elements-react v1.0.0-alpha-end

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

TW Elements React

TW Elements React is a huge collection of free, interactive React components for Tailwind CSS.


Table of Contents


License

TWE React Alpha licensing information is available at the license file


Coming soon

Check out the upcoming features - watch our social profiles to get early access!


Components

A collection of stunning components made with attention to the smallest details. Forms, cards, buttons, and hundreds of others – in TW Elements React you will find all the essential elements necessary for every project.


Installation

NPM
  1. Before starting the project make sure to install Node.js (LTS) version 14+, 16+ and TailwindCSS.

  2. Run the following command to install the package via NPM:

npm i git+https://oauth2:ACCESS_TOKEN@git.mdbootstrap.com/mdb/twe-react/prd/twe-react-pro-essential
  1. Add the TW Elements React css file to your main js/tsx file
import "tw-elements-react/dist/css/tw-elements-react.min.css";
  1. TW Elements is a plugin and should be included inside the tailwind.config.js file. It is also recommended to extend the content array with a js file that loads dynamic component classes:
module.exports = {
  content: [
    "./index.html",
    "./src/**/*.{js,ts,jsx,tsx}",
    "./node_modules/tw-elements-react/dist/js/**/*.js",
  ],
  theme: {
    extend: {},
  },
  darkMode: "class",
  plugins: [require("tw-elements-react/dist/plugin.cjs")],
};
  1. Components will work after importing the package:
import { TECollapse } from "tw-elements-react";