ikui

@ikonintegration/ui

Welcome to @ikonintegration/ui – a stylish and customizable UI package for React that simplifies your frontend development. This package provides ready-to-use styles and components to kickstart your React projects. Follow the steps below to get started quickly.

Installation

To use @ikonintegration/ui in your React app, you need to install the package and import the main styles.

Install the package

npm install @ikonintegration/ui
# or
yarn add @ikonintegration/ui

Import styles

In your app entrypoint (usually src/main.tsx), import the @ikonintegration/ui styles:

import '@ikonintegration/ui/styles.css';

Integrate with Tailwind CSS

If your app is using Tailwind CSS, you can integrate IKUI with your Tailwind configuration so your app will be able to use IKUI colors and other configurations:

import { ikuiTwPlugin } from '@ikonintegration/ui';
import type { Config } from 'tailwindcss';

export default {
  content: ['./index.html', './src/**/*.{js,ts,jsx,tsx}'],
  corePlugins: {
    // As IKUI already provides preflight styles,
    // you should turn off your app's preflight to avoid conflicts
    preflight: false,
  },
  plugins: [ikuiTwPlugin],
} satisfies Config;

Now you should be able to use IKUI classes directly in your app:

<div className="border">
  <span className="text-foreground">Hey!</span>
</div>

Usage

With @ikonintegration/ui integrated into your project, you can start using the predefined React components right away.

import { Button } from '@ikonintegration/ui';

export function MyComponent() {
  return (
    <div>
      <Button onClick={() => console.log('Button clicked')}>
        Click me
      </Button>
    </div>
  );
}

Customization

@ikonintegration/ui is designed to be flexible and customizable to fit the unique styles of your React project. Feel free to override the styles, modify the components, or use the provided utility classes to achieve your desired look and feel.