SearchField Component

Description

The SearchField component is a Form field where users can enter the field they want to search for. It comes with built in Search button that turns into a spinner once clicked.

Installation

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

npm install custom-headless-searchfield

Usage

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

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

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

  const handleSearch = () => {
    // Perform search logic here
    console.log("Search initiated for:", searchValue);
  };

  return (
    <div className="app-container">
      <SearchField
        searchValue={searchValue}
        setSearchValue={(e) => setSearchValue(e.target.value)}
        showButton={showButton}
        handleSearch={handleSearch}
      />
    </div>
  );
};

export default App;

Props

SearchField Props

| Prop | Type | Default | Description | | ---------------- | ------------------------------------------------ | --------- | ------------------------------------------------------------------------ | | searchValue | string | - | The current value of the search input field. | | setSearchValue | (event: ChangeEvent<HTMLInputElement>) => void | - | Handler function to update the searchValue based on user input. | | showButton | boolean | - | Determines if the search button is shown or if the spinner is displayed. | | handleSearch | () => void | - | Function triggered when the search button is clicked. | | buttonColor | string | "#BCAF9C" | Button color | | placeholder | string | - | Placeholder for the form field to display if provided |

Styles

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