custom-headless-button

Button Component

Description

The Button component is a customizable tailwind Button compoennt.

Installation

To use the Button component in your project, you can install it via npm (or include it as part of your component library):

npm install custom-headless-button@latest

Usage

Here’s a simple example of how to use the Button component in your application:

import React, { useState } from "react";
import { Button } from "custom-headless-Button";

const App = () => {
  const handleSubmit = () => {
    console.log("submitted");
  };
  return (
    <div className="mt-4">
      <Button
        onClick={handleSubmit}
        disabled={false}
        title="button"
        className={`flex-none h-10 w-24 rounded-md bg-walnut-brown px-3.5 py-2.5 text-sm font-semibold text-white shadow-sm hover:backdrop-blur-sm hover:bg-opacity-80 transition duration-300 focus-visible:outline focus-visible:outline-2 focus-visible:outline-offset-2 `}
        buttonName="SUBMIT"
      />
    </div>
  );
};

export default App;

Props

Button Props

Prop	Type	Description
buttonName	string	The name the button component should display
onClick	() => void	Function to call when the Button is clicked.
title	string	Title of the Button displayed when hovering over the button.
disabled	boolean	Determines if the Button is clickable.
className	string	Custom class for the button

Styles

The Button component is styled using Tailwind CSS classes. Make sure to include Tailwind CSS in your project to apply the styles correctly.

Example CSS Setup

If you haven’t set up Tailwind CSS yet, here’s a basic example of how to do it:

• Install Tailwind CSS:

npm install -D tailwindcss postcss autoprefixer
npx tailwindcss init -p

• Configure your tailwind.config.js file:

module.exports = {
  content: ["./src/**/*.{js,jsx,ts,tsx}", "./public/index.html"],
  theme: {
    extend: {},
  },
  plugins: [],
};

• Include Tailwind in your CSS file: Add the following lines to your main CSS file to include Tailwind’s base, components, and utilities:

@tailwind base;
@tailwind components;
@tailwind utilities;

Customization

Feel free to customize the Tailwind classes used in the Button component as needed to fit the design of your application.