InputField Component

Description

The InputField component is a customizable Input field component.

Installation

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

npm install custom-headless-input-field"

Usage

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

import React, { useState } from "react";
import { InputField } from "rcustom-headless-input-field";

const App = () => {
  const [searchValue, setSearchValue] = useState("");

  return (
    <div>
      <InputField
        label={"Search"}
        inputValue={searchValue}
        placeholder={"Search by Name or by Title"}
        handleInputChange={(e) => setSearchValue(e.target.value)}
        className={
          "hover:ring-2 ring-olive-green focus:ring-2 focus:ring-inset focus:ring-olive-green"
        }
      />
    </div>
  );
};

export default App;

Props

InputField Props

| Prop | Type | Description | | ------------------- | ----------------- | --------------------------------------------------------------- | | label | React.ReactNode | Label to assign to the field. | | placeholder | string | Placeholder text for the InputField field. | | inputValue | string | Variable that holds the input value entered into nputField | | handleInputChange | function | A callback function that is called to save the InputField value | | className | string | Variable that holds the custom class (optional) | | fieldWidth | string | Variable that holds the width of the input field (optional) | | disabled | boolean | Variable indicating if input field is disabled |

Styles

The InputField 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:

1. Install Tailwind CSS:

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

2. Configure your tailwind.config.js file:

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

3. 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 InputField component as needed to fit the design of your application.