@kittycad/react-shared 0.1.0

package/README.md

@@ -0,0 +1,86 @@
+# @kittycad/react-shared
+
+Shared React components for KittyCAD applications.
+
+## Installation
+
+```bash
+npm install @kittycad/react-shared
+# or
+yarn add @kittycad/react-shared
+```
+
+## Usage
+
+```tsx
+import { Button } from '@kittycad/react-shared'
+
+function App() {
+  return (
+    <Button variant="primary" size="md" onClick={() => console.log('Clicked!')}>
+      Click me
+    </Button>
+  )
+}
+```
+
+## Development
+
+### Prerequisites
+
+- Node.js 20+
+- npm or yarn
+
+### Setup
+
+```bash
+# Install dependencies
+npm install
+
+# Start Storybook for development
+npm run dev
+
+# Build the library
+npm run build
+
+# Run tests
+npm test
+
+# Type checking
+npm run tsc
+
+# Linting and formatting
+npm run lint
+npm run fmt
+```
+
+### Available Components
+
+- **Button**: A customizable button component with multiple variants and sizes
+
+### Storybook
+
+This project uses Storybook for component development and documentation. Run `npm run dev` to start the Storybook development server.
+
+### Publishing
+
+The library is automatically published to npm when a new git tag is created:
+
+```bash
+# Create a new version
+npm version patch  # or minor, major
+
+# Push with tags
+git push --follow-tags
+```
+
+This will trigger the GitHub Action to publish to npm.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests and stories for new components
+5. Run `npm run lint` and `npm run type-check`
+6. Submit a pull request

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+import { ClassValue } from 'clsx';
+
+interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
+    variant?: 'primary' | 'secondary' | 'outline' | 'ghost';
+    size?: 'sm' | 'md' | 'lg';
+    children: React.ReactNode;
+}
+declare const Button: React.ForwardRefExoticComponent<ButtonProps & React.RefAttributes<HTMLButtonElement>>;
+
+declare function cn(...inputs: ClassValue[]): string;
+
+export { Button, cn };
+export type { ButtonProps };