v0.1.0
Get startedComponentsTheming
Install

Getting started

  • Introduction
  • Installation
  • Tailwind CSS
  • Next.js

Theming

  • Design tokens
  • Dark mode
  • Customization

Layout

  • SectionHeader
  • Container & Divider
  • AppShell
  • PageHeader

Actions

  • Button
  • IconButton

Forms

  • Input
  • Textarea
  • Select
  • Checkbox
  • Switch
  • SegmentedControl
  • RadioGroup
  • Combobox
  • DatePicker & DateRangePicker

Disclosure

  • Tabs
  • Accordion

Overlay

  • Modal
  • Drawer
  • Tooltip
  • Popover
  • DropdownMenu

Data display

  • Badge
  • Avatar
  • Card
  • StatCard
  • Table & DataTable
  • Pagination
  • Sparkline & chart colours

Feedback

  • Banner
  • Spinner
  • Skeleton
  • EmptyState
  • Toast
  • Progress

A lightweight, Tailwind-friendly React component library.

Getting started

  • Introduction
  • Installation
  • Tailwind CSS
  • Next.js

Theming

  • Design tokens
  • Dark mode
  • Customization

Components

  • SectionHeader
  • Container & Divider
  • AppShell
  • PageHeader
  • Button
  • IconButton
  • Input

Released under the MIT License.kivu-ui on npm

Documentation

Getting started

  • Introduction
  • Installation
  • Tailwind CSS
  • Next.js

Theming

  • Design tokens
  • Dark mode
  • Customization

Layout

  • SectionHeader
  • Container & Divider
  • AppShell
  • PageHeader

Actions

  • Button
  • IconButton

Forms

  • Input
  • Textarea
  • Select
  • Checkbox
  • Switch
  • SegmentedControl
  • RadioGroup
  • Combobox
  • DatePicker & DateRangePicker

Disclosure

  • Tabs
  • Accordion

Overlay

  • Modal
  • Drawer
  • Tooltip
  • Popover
  • DropdownMenu

Data display

  • Badge
  • Avatar
  • Card
  • StatCard
  • Table & DataTable
  • Pagination
  • Sparkline & chart colours

Feedback

  • Banner
  • Spinner
  • Skeleton
  • EmptyState
  • Toast
  • Progress

Avatar

A profile picture with an automatic initials fallback, plus overlapping groups.

import { Avatar, AvatarGroup } from "kivu-ui"

On this page

UsageGroupProps

Getting started

  • Introduction
  • Installation
  • Tailwind CSS
  • Next.js

Theming

  • Design tokens
  • Dark mode
  • Customization

Layout

  • SectionHeader
  • Container & Divider
  • AppShell
  • PageHeader

Actions

  • Button
  • IconButton

Forms

  • Input
  • Textarea
  • Select
  • Checkbox
  • Switch
  • SegmentedControl
  • RadioGroup
  • Combobox
  • DatePicker & DateRangePicker

Disclosure

  • Tabs
  • Accordion

Overlay

  • Modal
  • Drawer
  • Tooltip
  • Popover
  • DropdownMenu

Data display

  • Badge
  • Avatar
  • Card
  • StatCard
  • Table & DataTable
  • Pagination
  • Sparkline & chart colours

Feedback

  • Banner
  • Spinner
  • Skeleton
  • EmptyState
  • Toast
  • Progress

Usage

import { Avatar, AvatarGroup } from "kivu-ui";
AUMTLFAOFallback Initials
import { Avatar } from "kivu-ui";

export default function Demo() {
  return (
    <div className="flex flex-wrap items-center gap-3">
      <Avatar name="Aline Uwase" size="sm" />
      <Avatar name="Mei Tanaka" />
      <Avatar name="Lucas Ferreira" size="lg" />
      <Avatar name="Amara Okafor" size="xl" />
      <Avatar src="/broken-image.png" name="Fallback Initials" />
    </div>
  );
}

Examples

Group

Use max to collapse the rest into a +N bubble.

AUMTLFAO+2
import { Avatar, AvatarGroup } from "kivu-ui";

export default function Demo() {
  return (
    <AvatarGroup max={4} size="lg">
      <Avatar name="Aline Uwase" />
      <Avatar name="Mei Tanaka" />
      <Avatar name="Lucas Ferreira" />
      <Avatar name="Amara Okafor" />
      <Avatar name="Kofi Mensah" />
      <Avatar name="Sofia Rossi" />
    </AvatarGroup>
  );
}

Props

Avatar

PropTypeDefaultDescription
srcstring-Image URL.
namestring-Used for the initials and alt text.
altstring-Overrides the alt text.
size"sm" | "md" | "lg" | "xl""md"Controls the size.
ringbooleanfalseOutline ring (applied automatically in groups).

AvatarGroup

PropTypeDefaultDescription
maxnumber-Avatars to show before +N.
size"sm" | "md" | "lg" | "xl""md"Controls the size.

Every component also accepts className and forwards its ref. Root CSS class: .kivu-avatar

PreviousBadgeNextCard