Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 2.91 KB

README.md

File metadata and controls

95 lines (64 loc) · 2.91 KB

keebo

Keebo

A modern and customizable React component library built with Tailwind CSS. This library aims to provide reusable and themeable components that can be easily integrated into any project.

Components

Currently, the library includes the following components:

  • SearchBox: A customizable input box for search queries.
  • DatePicker: A customizable DatePicker for picking dates.

Usage

SearchBox

The SearchBox component can be used to create a search input field. It accepts the following props:

Prop Type Default Description
placeholder string "Search..." Placeholder text for the input.
onSearch (query: string) => void - Function called on input change with the current query.
theme `'light' 'dark'` 'light'
className string - Additional classes for custom styling.

Example

import React from 'react';
import { SearchBox } from 'keebo';

const App = () => {
  const handleSearch = (query) => {
    console.log(query);
  };

  return (
    <div className="p-4">
      <SearchBox onSearch={handleSearch} theme="dark" />
    </div>
  );
};

export default App;

DatePicker

The DatePicker component enables users to select a date. It comes with theme support and allows for custom styling.

Props

Prop Type Default Description
onSelectDate (date: Date) => void - Function called when a date is selected.
theme 'light' | 'dark' 'light' Theme of the input field.
className string '' Additional classes for custom styling.

Usage

To use the DatePicker component, import it into your React application:

import React from 'react';
import { DatePicker } from 'keebo';

const App = () => {
  const handleDateSelect = (date) => {
    console.log(date);
  };

  return (
    <div className="p-4">
      <DatePicker onSelectDate={handleDateSelect} theme="dark" />
    </div>
  );
};

export default App;

Installation

To install the component library, use npm or yarn:

npm install keebo

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue for any feature requests or bug reports.