@altair/ui-components

A modern React component library featuring accessible and customizable UI components.

Installation

npm install @altair/ui-components
# or
yarn add @altair/ui-components

Usage

Important: Make sure to import the CSS file along with the components:

import { Checkbox, Radio, RadioGroup } from '@altair/ui-components';
import '@altair/ui-components/dist/index.css';

function App() {
  return (
    <div>
      <Checkbox label="Accept terms" onChange={(checked) => console.log(checked)} />
      
      <RadioGroup name="options" onChange={(value) => console.log(value)}>
        <Radio value="option1" label="Option 1" />
        <Radio value="option2" label="Option 2" />
        <Radio value="option3" label="Option 3" />
      </RadioGroup>
    </div>
  );
}

Components

Checkbox

A customizable checkbox component with support for labels, disabled state, and error messages.

Radio & RadioGroup

Radio buttons and radio groups for selecting a single option from multiple choices.

Development

1. Clone the repository
2. Install dependencies: npm install
3. Start Storybook: npm run storybook
4. Build the library: npm run build

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT