Skip to content

Paper

Paper is a basic surface to hold content.

Basic Usage

To implement the Paper component, you need to import it first:

import { Paper } from '@react-ui-org/react-ui';

And use it:

<Paper>
  Hello!
</Paper>

See API for all available options.

General Guidelines

  • Paper is designed for non-white background. You may want to either use its raised variant or customize the default appearance to make it stand out on white background.

  • Paper, or Card? Paper is a basic surface to put content on. However, there is also the Card component. While Paper is usually used to hold larger content areas like lists, grids, or forms, Card is designed for displaying items. Card also supports more visual options.

Raised Paper

Add optional shadow to lift the paper above background.

<Paper raised>
  Hello! I&apos;m paper and I&apos;m raised.
</Paper>

Muted Paper

Dim background and add transparency to visually suppress the Paper.

<Paper muted>
  Sssh! I&apos;m paper and I&apos;m muted.
</Paper>

Forwarding HTML Attributes

In addition to the options below in the component's API section, you can specify React synthetic events or any HTML attribute you like. All attributes that don't interfere with the API are forwarded to the root <div> HTML element. This enables making the component interactive and helps to improve its accessibility.

👉 Refer to the MDN reference for the full list of supported attributes of the div element.

API

Theming

Custom Property Description
--rui-Paper__padding Padding of Paper
--rui-Paper__border-width Border width
--rui-Paper__border-color Border color
--rui-Paper__border-radius Corner radius
--rui-Paper__background-color Paper background color
--rui-Paper--muted__background-color Background color of muted paper
--rui-Paper--muted__opacity Opacity of muted paper
--rui-Paper--raised__box-shadow Box shadow of raised paper