2.0.0-rc.4 • Published 9 months ago

@asphalt-react/card v2.0.0-rc.4

Weekly downloads
-
License
UNLICENSED
Repository
-
Last release
9 months ago

Card

npm

A Card is container to display related pieces of information in a single unit. Cards also provide summary of the information and a linked entry point to further details of that content. Few uses of Card is to show movie titles on an OTT platform, product on an e-commerce website, feed of posts or articles on a website.

Card expands to occupy all available horizontal within its container by default, you can change it to fit the content as well. Card comes in three sizes small (s), medium (m) & large (l).

Usage

import { Card } from "@asphalt-react/card"

function App() {
  return (
    <Card>
      <div>Content</div>
    </Card>
  )
}

Variants

Card have two variants -

  1. Elevated - Card appears with shadow around it, which makes it visually distinct from the container surface and has more emphasis.

  2. Outlined - Card appears with border around it, has less emphasis that the elevated variant.

Card can also appears without shadow and border to have more subdued look and minimal emphasis.

If values for none of them is set, then the Card will appear in the elevated variant.

Supported intents

  • primary

  • secondary

  • tertiary

  • success

  • info

  • warning

  • danger

  • brand

  • inverse

Props

children

Node for card content.

typerequireddefault
nodetrueN/A

size

Controls size of card. Possible values are "s", "m" & "l" for small, medium & large respectively.

typerequireddefault
stringfalse"m"

outlined

Adds outline around card.

typerequireddefault
boolfalsenull

elevated

Elevates the card from the container surface.

typerequireddefault
boolfalsenull

bezel

Adds padding inside card.

typerequireddefault
boolfalsetrue

fitWidth

Adjusts the width of the card as per its content.

typerequireddefault
boolfalsefalse

primary

Applies primary intent.

typerequireddefault
boolfalsefalse

secondary

Applies secondary intent.

typerequireddefault
boolfalsefalse

tertiary

Applies tertiary intent.

typerequireddefault
boolfalsefalse

brand

Applies brand intent.

typerequireddefault
boolfalsefalse

inverse

Applies inverse intent.

typerequireddefault
boolfalsefalse

danger

Applies danger intent.

typerequireddefault
boolfalsefalse

warning

Applies warning intent.

typerequireddefault
boolfalsefalse

success

Applies success intent.

typerequireddefault
boolfalsefalse

info

Applies info intent.

typerequireddefault
boolfalsefalse