@sozialhelden/ui 1.0.2 → 1.1.1

package/README.md

@@ -1 +1,85 @@
-# UI
+# @sozialhelden/ui
+
+> UI components shared by different sozialhelden projects.  
+
+Check the [Storybook](https://sozialhelden.github.io/ui/) for an overview of the available components.
+
+## Install
+
+Make sure you have Tailwind CSS installed in your project. If you don't have it yet, you should install and set it up first: https://tailwindcss.com/docs/installation/using-vite
+
+Then install the library:
+
+```bash
+npm i --save @sozialhelden/ui
+```
+
+Add the following to your main CSS file, make sure to adapt the path to the `@sozialhelden/ui` package if necessary:
+
+```css
+@import "tailwindcss";
+@import "tw-animate-css";
+@import "@sozialhelden/ui/style.css";
+
+@source "../../node_modules/@sozialhelden/ui";
+```
+## Usage
+
+Check the [Storybook](https://sozialhelden.github.io/ui/) for an overview of the available components.
+
+Now you can use tailwind classes and the components provided by the `@sozialhelden/ui` package in your project, for example:
+
+```tsx
+import { Button } from "@sozialhelden/ui";
+
+export function App() {
+    return (
+        <div className="p-4 bg-red-200">
+            <Button>Click me!</Button>
+        </div>
+    );
+}
+```
+
+## Development setup
+
+Install dependencies:
+
+```bash
+npm ci
+```
+
+Run the storybook dev-server:
+
+```bash
+npm run dev
+```
+
+Build a production version of the library and storybook:
+
+```bash
+npm run build
+```
+
+Run linter/formatters:
+
+```bash
+# Run linter
+npm run lint
+
+# Run linter and automatically fix fixable issues
+npm run lint:fix
+
+# Run formatter
+npm run format
+
+# Run formatter and automatically fix fixable issues
+npm run format:fix
+
+# Run typecheck
+npm run typecheck
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -1 +1,48 @@
-export {}
+import { ClassProp } from 'class-variance-authority/types';
+import * as DialogPrimitive from '@radix-ui/react-dialog';
+import { JSX } from 'react/jsx-runtime';
+import type * as React_2 from 'react';
+import { VariantProps } from 'class-variance-authority';
+
+export declare function Alert({ className, variant, ...props }: React_2.ComponentProps<"div"> & VariantProps<typeof alertVariants>): JSX.Element;
+
+export declare function AlertDescription({ className, ...props }: React_2.ComponentProps<"div">): JSX.Element;
+
+export declare function AlertTitle({ className, ...props }: React_2.ComponentProps<"div">): JSX.Element;
+
+declare const alertVariants: (props?: ({
+    variant?: "default" | "destructive" | null | undefined;
+} & ClassProp) | undefined) => string;
+
+export declare function Button({ className, variant, size, asChild, ...props }: React_2.ComponentProps<"button"> & VariantProps<typeof buttonVariants> & {
+    asChild?: boolean;
+}): JSX.Element;
+
+export declare const buttonVariants: (props?: ({
+    variant?: "default" | "destructive" | "link" | "outline" | "secondary" | "ghost" | null | undefined;
+    size?: "default" | "sm" | "lg" | "icon" | null | undefined;
+} & ClassProp) | undefined) => string;
+
+export declare function Dialog({ ...props }: React_2.ComponentProps<typeof DialogPrimitive.Root>): JSX.Element;
+
+export declare function DialogClose({ ...props }: React_2.ComponentProps<typeof DialogPrimitive.Close>): JSX.Element;
+
+export declare function DialogContent({ className, children, showCloseButton, ...props }: React_2.ComponentProps<typeof DialogPrimitive.Content> & {
+    showCloseButton?: boolean;
+}): JSX.Element;
+
+export declare function DialogDescription({ className, ...props }: React_2.ComponentProps<typeof DialogPrimitive.Description>): JSX.Element;
+
+export declare function DialogFooter({ className, ...props }: React_2.ComponentProps<"div">): JSX.Element;
+
+export declare function DialogHeader({ className, ...props }: React_2.ComponentProps<"div">): JSX.Element;
+
+export declare function DialogOverlay({ className, ...props }: React_2.ComponentProps<typeof DialogPrimitive.Overlay>): JSX.Element;
+
+export declare function DialogPortal({ ...props }: React_2.ComponentProps<typeof DialogPrimitive.Portal>): JSX.Element;
+
+export declare function DialogTitle({ className, ...props }: React_2.ComponentProps<typeof DialogPrimitive.Title>): JSX.Element;
+
+export declare function DialogTrigger({ ...props }: React_2.ComponentProps<typeof DialogPrimitive.Trigger>): JSX.Element;
+
+export { }