0.0.1-beta.3 • Published 5 months ago

@rajkrajpj/cultivate-ui-library v0.0.1-beta.3

Weekly downloads
-
License
ISC
Repository
-
Last release
5 months ago

@rajkrajpj/cultivate-ui-library

A modern, type-safe, accessible React component library for fintech investor forms.

Installation

npm install @rajkrajpj/cultivate-ui-library

Setup

  1. Import the library styles (in your app entry, e.g. src/app.tsx, src/index.tsx, or pages/_app.tsx):
import "@rajkrajpj/cultivate-ui-library/styles"
  1. Tailwind CSS Integration
  • Make sure your app uses Tailwind CSS.
  • Add the library's class names to your tailwind.config.js content array if using JIT mode:
module.exports = {
  content: [
    "./src/**/*.{js,ts,jsx,tsx}",
    "./node_modules/@rajkrajpj/cultivate-ui-library/**/*.{js,ts,jsx,tsx}",
  ],
  // ...rest of your config
}
  • The library uses CSS variables for theming. You can override these in your app's global CSS for custom branding.
  1. Customizing Theme Colors

Override any CSS variable in your app's CSS to change the look:

:root {
  --primary: #e11d48; /* Make all primary buttons pink! */
  --primary-foreground: #fff;
  --background: #f9fafb;
}
  1. Usage Example
import { InvestorFormWizard } from "@rajkrajpj/cultivate-ui-library"
import "@rajkrajpj/cultivate-ui-library/styles"

export default function MyInvestorForm() {
  return <InvestorFormWizard /* ...props */ />
}
  1. Storybook & Documentation
  • See the Storybook for live component examples and props.
  • More usage examples and advanced configuration can be found in the dev-docs/ folder.

For advanced theming, step configuration, and API integration, see the full documentation and usage guides.