static-pages/packages/ui

@immich/ui

A component library for Immich, written in Svelte.

Install

npm i -D @immich/ui

Usage

Import components from @immich/ui. For example:

<script lang="ts">
  import { Card, CardBody, CardHeader, CardTitle, CardDescription, Heading, Text } from '@immich/ui';
</script>

<Card>
  <CardHeader>
    <CardTitle>@immich/ui</CardTitle>
    <CardDescription>A component library</CardDescription>
  </CardHeader>
  <CardBody>
    <Lorem />
  </CardBody>
  <CardFooter>Privacy should not be a luxury</CardFooter>
</Card>

Contributing

PR's are welcome! Also feel free to reach out to the team on Discord.

mise install             # install pnpm, npm, etc.
pnpm install             # install deps
pnpm -w watch            # automatically rebuild `@immich/ui` on changes
cd apps/ui.immich.app
pnpm start               # view component documentation and examples

Technology

• Svelte
• tailwindcss
• Material Design icons (@mdi/js)