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/react 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

PageHeader

The top of a dashboard page: breadcrumbs, title, description and actions on the right.

import { PageHeader, Breadcrumbs, BreadcrumbItem } from "@kivu-ui/react"

On this page

UsageProps

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 { PageHeader, Breadcrumbs, BreadcrumbItem } from "@kivu-ui/react";
  1. Projects
  2. Brand refresh
  3. Settings

Project settings

Members, billing and integrations for Brand refresh.

import { BreadcrumbItem, Breadcrumbs, Button, PageHeader } from "@kivu-ui/react";

export default function Demo() {
  return (
    <PageHeader
      className="w-full"
      breadcrumbs={
        <Breadcrumbs>
          <BreadcrumbItem href="#usage">Projects</BreadcrumbItem>
          <BreadcrumbItem href="#usage">Brand refresh</BreadcrumbItem>
          <BreadcrumbItem current>Settings</BreadcrumbItem>
        </Breadcrumbs>
      }
      title="Project settings"
      description="Members, billing and integrations for Brand refresh."
      actions={
        <>
          <Button variant="outline">Cancel</Button>
          <Button>Save changes</Button>
        </>
      }
    />
  );
}

Props

PageHeader

Extends <div> attributes.

PropTypeDefaultDescription
titleReactNode-Required. The page title.
descriptionReactNode-Text under the title.
breadcrumbsReactNode-Usually <Breadcrumbs>, shown above the title.
actionsReactNode-Buttons on the right; they wrap below on small screens.
as"h1" | "h2" | "h3""h1"Heading level.

BreadcrumbItem

Extends <a> attributes.

PropTypeDefaultDescription
currentbooleanfalseThe current page: plain text with aria-current.
asChildbooleanfalseRender the single child (e.g. a router Link) with this link's styles and behaviour.

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

PreviousAppShellNextButton