README.md

Minimal component library built with TailwindCSS and React

Heavily inspired by ChakraUI

Installation

yarn add dragontail-experimental

Supported exports

import {
  Button,
  DragontailProvider,
  Drawer,
  FormControl,
  FormErrorMessage,
  FormHelperText,
  FormLabel,
  Input,
  Menu,
  MenuButton,
  MenuDivider,
  MenuItem,
  MenuList,
  PasswordInput,
  Select,
  Switch,
  Textarea,
  ToastProvider // automatically wrapped within `DragontailProvider`,
  useToast, // this is called in a functional component to show a toast message
} from "dragontail-experimental";

Get Started

Next.js

// pages/_app.tsx
import type { AppProps } from "next/app";
import { DragontailProvider } from "dragontail-experimental";

import "dragontail/dist/build.css"; // for non-tailwind projects
// OR
import "dragontail/dist/base.css"; // for tailwind projects

const App = ({ Component, pageProps }: AppProps) => {
  return (
    <DragontailProvider theme="light">
      <Component {...pageProps} />
    </DragontailProvider>
  );
};

export default App;

Create React App

// app.tsx
import { DragontailProvider } from "dragontail-experimental";

import "dragontail/dist/build.css"; // for non-tailwind projects
// OR
import "dragontail/dist/base.css"; // for tailwind projects

export const App = () => {
  return (
    <DragontailProvider theme="light">
      <div>...</div>
    </DragontailProvider>
  );
};

TailwindCSS Config

For react projects already using TailwindCSS, add the following content to your TailwindCSS configuration file:

module.exports = {
  content: [
     ...
    "node_modules/dragontail-experimental/dist/cjs/index.js"
  ]
};