Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[epic] Paper #3

Open
soroushm opened this issue Dec 23, 2022 · 0 comments
Open

[epic] Paper #3

soroushm opened this issue Dec 23, 2022 · 0 comments
Labels
component: paper This is the name of the generic UI component epic This is the beginning

Comments

@soroushm
Copy link
Member

soroushm commented Dec 23, 2022

In Material Design, a "paper" refers to a container that is used to hold content and that is designed to look like a sheet of paper. Papers are used to create a sense of depth and to visually separate content from the rest of the interface.

Papers in Material Design can be created using various HTML elements, such as div, span, or section, and styled using CSS. The Material Design guidelines provide a set of predefined classes that can be used to apply the desired visual styling to a paper.

Import

import Paper from '@mnui/material/Paper';
// or
import { Paper } from '@mnui/material';

Props

Props of the native component are also available.

Name Type Default Description
children node The content of the component.
component elementType The component used for the root node. Either a string to use a HTML element or a component.
elevation integer 1 Shadow depth, corresponds to dp in the spec. It accepts values between 0 and 24 inclusive.
square bool false If true, rounded corners are disabled.
sx Array<func,
object,
bool>,
func,
object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` epic for more details.
variant 'elevation',
'outlined',
string
'elevation' The variant to use.

The ref is forwarded to the root element.

@soroushm soroushm added component: paper This is the name of the generic UI component epic This is the beginning labels Dec 23, 2022
@soroushm soroushm mentioned this issue Dec 23, 2022
@soroushm soroushm changed the title Paper [epic] Paper Dec 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: paper This is the name of the generic UI component epic This is the beginning
Projects
None yet
Development

No branches or pull requests

1 participant