farm-react

React UI component library for building farmer product websites and applications with ease and consistency.

Overview

farm-react provides a set of reusable, accessible, and customizable React components specifically designed for farm product e-shops, dashboards, and supply chain UIs. It streamlines frontend development for agriculture and farm supply product interfaces.

Features

• Accessible and flexible components (Accordion, Button, Label, RatingDisplay, TextInput, Layouts)
• TypeScript support with full typings
• Customizable through classnames and attributes
• Built on top of React and React-Bootstrap for rapid integration
• Easy theming with SCSS support

Installation

Install from npm:

npm install farm-react
# or
yarn add farm-react

Peer dependencies: Ensure your project has React (v18+) installed.

Usage Example

import { Accordion, Button, Label, RatingDisplay, TextInput } from 'farm-react';

function App() {
  return (
    <div>
      <Accordion data={[{ title: 'Demo Section', desc: 'Accordion Content' }]} />
      <Button />
      <Label label="This is a label" />
      <RatingDisplay value={4} activeIcons={4} totalCount={5} />
      <TextInput placeholder="Enter something..." />
    </div>
  );
}

Components

• Accordion: Expandable/collapsible sections with custom headers and bodies.
• Button: Simple button placeholder for customization.
• Label: Label with optional icon and tooltip features.
• RatingDisplay: Flexible star (or icon) rating component, custom icons/labels.
• TextInput: Text input with optional label and password toggle.
• Layout/Header/Footer/Sidebar: Basic prebuilt layout scaffolding.

Theming & Customization

• Customize appearance using the provided classnames and attributes props.
• Use your preferred SCSS, CSS, or a CSS-in-JS solution. Comes with some default SCSS styles.

License

ISC

© 2025 Nikhil Kumar. Distributed under the ISC License.